OSDN Git Service

PR middle-end/35853
[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
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
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 * Running Protoize::    Automatically adding or removing function prototypes.
152 @end menu
153
154 @c man begin OPTIONS
155
156 @node Option Summary
157 @section Option Summary
158
159 Here is a summary of all the options, grouped by type.  Explanations are
160 in the following sections.
161
162 @table @emph
163 @item Overall Options
164 @xref{Overall Options,,Options Controlling the Kind of Output}.
165 @gccoptlist{-c  -S  -E  -o @var{file}  -combine  -pipe  -pass-exit-codes  @gol
166 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{]}  --target-help  @gol
167 --version -wrapper@@@var{file}}
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 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
193 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
194 -fno-default-inline  -fvisibility-inlines-hidden @gol
195 -fvisibility-ms-compat @gol
196 -Wabi  -Wctor-dtor-privacy @gol
197 -Wnon-virtual-dtor  -Wreorder @gol
198 -Weffc++  -Wstrict-null-sentinel @gol
199 -Wno-non-template-friend  -Wold-style-cast @gol
200 -Woverloaded-virtual  -Wno-pmf-conversions @gol
201 -Wsign-promo}
202
203 @item Objective-C and Objective-C++ Language Options
204 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
205 Objective-C and Objective-C++ Dialects}.
206 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
207 -fgnu-runtime  -fnext-runtime @gol
208 -fno-nil-receivers @gol
209 -fobjc-call-cxx-cdtors @gol
210 -fobjc-direct-dispatch @gol
211 -fobjc-exceptions @gol
212 -fobjc-gc @gol
213 -freplace-objc-classes @gol
214 -fzero-link @gol
215 -gen-decls @gol
216 -Wassign-intercept @gol
217 -Wno-protocol  -Wselector @gol
218 -Wstrict-selector-match @gol
219 -Wundeclared-selector}
220
221 @item Language Independent Options
222 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
223 @gccoptlist{-fmessage-length=@var{n}  @gol
224 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
225 -fdiagnostics-show-option}
226
227 @item Warning Options
228 @xref{Warning Options,,Options to Request or Suppress Warnings}.
229 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
230 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
231 -Wno-attributes -Wno-builtin-macro-redefined @gol
232 -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
233 -Wchar-subscripts -Wclobbered  -Wcomment @gol
234 -Wconversion  -Wcoverage-mismatch  -Wno-deprecated  @gol
235 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
236 -Wdisallowed-function-list=@var{sym},@var{sym},@dots{} @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} -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  -Wpadded @gol
253 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
254 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
255 -Wredundant-decls @gol
256 -Wreturn-type  -Wsequence-point  -Wshadow @gol
257 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
258 -Wstrict-aliasing -Wstrict-aliasing=n @gol
259 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
260 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
261 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
262 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
263 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
264 -Wunused-value  -Wunused-variable @gol
265 -Wvariadic-macros -Wvla @gol
266 -Wvolatile-register-var  -Wwrite-strings}
267
268 @item C and Objective-C-only Warning Options
269 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
270 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
271 -Wold-style-declaration  -Wold-style-definition @gol
272 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
273 -Wdeclaration-after-statement -Wpointer-sign}
274
275 @item Debugging Options
276 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
277 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
278 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
279 -fdump-noaddr -fdump-unnumbered @gol
280 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
281 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
282 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
283 -fdump-statistics @gol
284 -fdump-tree-all @gol
285 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
286 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
288 -fdump-tree-ch @gol
289 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-nrv -fdump-tree-vect @gol
298 -fdump-tree-sink @gol
299 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
300 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
301 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
302 -ftree-vectorizer-verbose=@var{n} @gol
303 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
304 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
305 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
306 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
307 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
308 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
309 -ftest-coverage  -ftime-report -fvar-tracking @gol
310 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
311 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
312 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
313 -fdebug-prefix-map=@var{old}=@var{new} @gol
314 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
315 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
316 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
317 -print-multi-directory  -print-multi-lib @gol
318 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
319 -print-sysroot -print-sysroot-headers-suffix @gol
320 -save-temps  -time}
321
322 @item Optimization Options
323 @xref{Optimize Options,,Options that Control Optimization}.
324 @gccoptlist{
325 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
326 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
327 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
328 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
329 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
330 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
331 -fdata-sections -fdce -fdce @gol
332 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
333 -fearly-inlining -fexpensive-optimizations -ffast-math @gol
334 -ffinite-math-only -ffloat-store -fforward-propagate @gol
335 -ffunction-sections -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
336 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
337 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
338 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-marix-reorg -fipa-pta @gol 
339 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
340 -fipa-type-escape -fira -fira-algorithm=@var{algorithm} @gol
341 -fira-coalesce -fno-ira-share-save-slots @gol
342 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
343 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
344 -floop-block -floop-interchange -floop-strip-mine @gol
345 -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
346 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
347 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
348 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
349 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
350 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
351 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
352 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
353 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
354 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
355 -fprofile-generate=@var{path} @gol
356 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
357 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
358 -freorder-blocks-and-partition -freorder-functions @gol
359 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
360 -frounding-math -frtl-abstract-sequences -fsched2-use-superblocks @gol
361 -fsched2-use-traces -fsched-spec-load -fsched-spec-load-dangerous @gol
362 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
363 -fschedule-insns -fschedule-insns2 -fsection-anchors -fsee @gol
364 -fselective-scheduling -fselective-scheduling2 @gol
365 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
366 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
367 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
368 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
369 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
370 -ftree-copyrename -ftree-dce @gol
371 -ftree-dominator-opts -ftree-dse -ftree-fre -ftree-loop-im @gol
372 -ftree-loop-distribution @gol
373 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
374 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-reassoc @gol
375 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
376 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
377 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
378 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
379 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
380 -fwhole-program @gol
381 --param @var{name}=@var{value}
382 -O  -O0  -O1  -O2  -O3  -Os}
383
384 @item Preprocessor Options
385 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
386 @gccoptlist{-A@var{question}=@var{answer} @gol
387 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
388 -C  -dD  -dI  -dM  -dN @gol
389 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
390 -idirafter @var{dir} @gol
391 -include @var{file}  -imacros @var{file} @gol
392 -iprefix @var{file}  -iwithprefix @var{dir} @gol
393 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
394 -imultilib @var{dir} -isysroot @var{dir} @gol
395 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
396 -P  -fworking-directory  -remap @gol
397 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
398 -Xpreprocessor @var{option}}
399
400 @item Assembler Option
401 @xref{Assembler Options,,Passing Options to the Assembler}.
402 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
403
404 @item Linker Options
405 @xref{Link Options,,Options for Linking}.
406 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
407 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
408 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
409 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
410 -u @var{symbol}}
411
412 @item Directory Options
413 @xref{Directory Options,,Options for Directory Search}.
414 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
415 -specs=@var{file}  -I- --sysroot=@var{dir}}
416
417 @item Target Options
418 @c I wrote this xref this way to avoid overfull hbox. -- rms
419 @xref{Target Options}.
420 @gccoptlist{-V @var{version}  -b @var{machine}}
421
422 @item Machine Dependent Options
423 @xref{Submodel Options,,Hardware Models and Configurations}.
424 @c This list is ordered alphanumerically by subsection name.
425 @c Try and put the significant identifier (CPU or system) first,
426 @c so users have a clue at guessing where the ones they want will be.
427
428 @emph{ARC Options}
429 @gccoptlist{-EB  -EL @gol
430 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
431 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
432
433 @emph{ARM Options}
434 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
435 -mabi=@var{name} @gol
436 -mapcs-stack-check  -mno-apcs-stack-check @gol
437 -mapcs-float  -mno-apcs-float @gol
438 -mapcs-reentrant  -mno-apcs-reentrant @gol
439 -msched-prolog  -mno-sched-prolog @gol
440 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
441 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
442 -mthumb-interwork  -mno-thumb-interwork @gol
443 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
444 -mstructure-size-boundary=@var{n} @gol
445 -mabort-on-noreturn @gol
446 -mlong-calls  -mno-long-calls @gol
447 -msingle-pic-base  -mno-single-pic-base @gol
448 -mpic-register=@var{reg} @gol
449 -mnop-fun-dllimport @gol
450 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
451 -mpoke-function-name @gol
452 -mthumb  -marm @gol
453 -mtpcs-frame  -mtpcs-leaf-frame @gol
454 -mcaller-super-interworking  -mcallee-super-interworking @gol
455 -mtp=@var{name}
456 -mword-relocations}
457
458 @emph{AVR Options}
459 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
460 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
461
462 @emph{Blackfin Options}
463 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
464 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
465 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
466 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
467 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
468 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
469 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
470 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram}
471
472 @emph{CRIS Options}
473 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
474 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
475 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
476 -mstack-align  -mdata-align  -mconst-align @gol
477 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
478 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
479 -mmul-bug-workaround  -mno-mul-bug-workaround}
480
481 @emph{CRX Options}
482 @gccoptlist{-mmac -mpush-args}
483
484 @emph{Darwin Options}
485 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
486 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
487 -client_name  -compatibility_version  -current_version @gol
488 -dead_strip @gol
489 -dependency-file  -dylib_file  -dylinker_install_name @gol
490 -dynamic  -dynamiclib  -exported_symbols_list @gol
491 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
492 -force_flat_namespace  -headerpad_max_install_names @gol
493 -iframework @gol
494 -image_base  -init  -install_name  -keep_private_externs @gol
495 -multi_module  -multiply_defined  -multiply_defined_unused @gol
496 -noall_load   -no_dead_strip_inits_and_terms @gol
497 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
498 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
499 -private_bundle  -read_only_relocs  -sectalign @gol
500 -sectobjectsymbols  -whyload  -seg1addr @gol
501 -sectcreate  -sectobjectsymbols  -sectorder @gol
502 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
503 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
504 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
505 -single_module  -static  -sub_library  -sub_umbrella @gol
506 -twolevel_namespace  -umbrella  -undefined @gol
507 -unexported_symbols_list  -weak_reference_mismatches @gol
508 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
509 -mkernel -mone-byte-bool}
510
511 @emph{DEC Alpha Options}
512 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
513 -mieee  -mieee-with-inexact  -mieee-conformant @gol
514 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
515 -mtrap-precision=@var{mode}  -mbuild-constants @gol
516 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
517 -mbwx  -mmax  -mfix  -mcix @gol
518 -mfloat-vax  -mfloat-ieee @gol
519 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
520 -msmall-text  -mlarge-text @gol
521 -mmemory-latency=@var{time}}
522
523 @emph{DEC Alpha/VMS Options}
524 @gccoptlist{-mvms-return-codes}
525
526 @emph{FRV Options}
527 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
528 -mhard-float  -msoft-float @gol
529 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
530 -mdouble  -mno-double @gol
531 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
532 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
533 -mlinked-fp  -mlong-calls  -malign-labels @gol
534 -mlibrary-pic  -macc-4  -macc-8 @gol
535 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
536 -moptimize-membar -mno-optimize-membar @gol
537 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
538 -mvliw-branch  -mno-vliw-branch @gol
539 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
540 -mno-nested-cond-exec  -mtomcat-stats @gol
541 -mTLS -mtls @gol
542 -mcpu=@var{cpu}}
543
544 @emph{GNU/Linux Options}
545 @gccoptlist{-muclibc}
546
547 @emph{H8/300 Options}
548 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
549
550 @emph{HPPA Options}
551 @gccoptlist{-march=@var{architecture-type} @gol
552 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
553 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
554 -mfixed-range=@var{register-range} @gol
555 -mjump-in-delay -mlinker-opt -mlong-calls @gol
556 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
557 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
558 -mno-jump-in-delay  -mno-long-load-store @gol
559 -mno-portable-runtime  -mno-soft-float @gol
560 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
561 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
562 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
563 -munix=@var{unix-std}  -nolibdld  -static  -threads}
564
565 @emph{i386 and x86-64 Options}
566 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
567 -mfpmath=@var{unit} @gol
568 -masm=@var{dialect}  -mno-fancy-math-387 @gol
569 -mno-fp-ret-in-387  -msoft-float @gol
570 -mno-wide-multiply  -mrtd  -malign-double @gol
571 -mpreferred-stack-boundary=@var{num}
572 -mincoming-stack-boundary=@var{num}
573 -mcld -mcx16 -msahf -mrecip @gol
574 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
575 -maes -mpclmul @gol
576 -msse4a -m3dnow -mpopcnt -mabm -msse5 @gol
577 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
578 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
579 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
580 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
581 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
582 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
583 -mcmodel=@var{code-model} @gol
584 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
585 -mfused-madd -mno-fused-madd -msse2avx}
586
587 @emph{IA-64 Options}
588 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
589 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
590 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
591 -minline-float-divide-max-throughput @gol
592 -minline-int-divide-min-latency @gol
593 -minline-int-divide-max-throughput  @gol
594 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
595 -mno-dwarf2-asm -mearly-stop-bits @gol
596 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
597 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
598 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
599 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
600 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
601 -mno-sched-prefer-non-data-spec-insns @gol
602 -mno-sched-prefer-non-control-spec-insns @gol
603 -mno-sched-count-spec-in-critical-path}
604
605 @emph{M32R/D Options}
606 @gccoptlist{-m32r2 -m32rx -m32r @gol
607 -mdebug @gol
608 -malign-loops -mno-align-loops @gol
609 -missue-rate=@var{number} @gol
610 -mbranch-cost=@var{number} @gol
611 -mmodel=@var{code-size-model-type} @gol
612 -msdata=@var{sdata-type} @gol
613 -mno-flush-func -mflush-func=@var{name} @gol
614 -mno-flush-trap -mflush-trap=@var{number} @gol
615 -G @var{num}}
616
617 @emph{M32C Options}
618 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
619
620 @emph{M680x0 Options}
621 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
622 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
623 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
624 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
625 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
626 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
627 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
628 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
629 -mxgot -mno-xgot}
630
631 @emph{M68hc1x Options}
632 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
633 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
634 -msoft-reg-count=@var{count}}
635
636 @emph{MCore Options}
637 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
638 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
639 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
640 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
641 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
642
643 @emph{MIPS Options}
644 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
645 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
646 -mips64  -mips64r2 @gol
647 -mips16  -mno-mips16  -mflip-mips16 @gol
648 -minterlink-mips16  -mno-interlink-mips16 @gol
649 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
650 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
651 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
652 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
653 -mfpu=@var{fpu-type} @gol
654 -msmartmips  -mno-smartmips @gol
655 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
656 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
657 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
658 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
659 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
660 -membedded-data  -mno-embedded-data @gol
661 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
662 -mcode-readable=@var{setting} @gol
663 -msplit-addresses  -mno-split-addresses @gol
664 -mexplicit-relocs  -mno-explicit-relocs @gol
665 -mcheck-zero-division  -mno-check-zero-division @gol
666 -mdivide-traps  -mdivide-breaks @gol
667 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
668 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
669 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
670 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130  -mno-fix-vr4130 @gol
671 -mfix-sb1  -mno-fix-sb1 @gol
672 -mflush-func=@var{func}  -mno-flush-func @gol
673 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
674 -mfp-exceptions -mno-fp-exceptions @gol
675 -mvr4130-align -mno-vr4130-align}
676
677 @emph{MMIX Options}
678 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
679 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
680 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
681 -mno-base-addresses  -msingle-exit  -mno-single-exit}
682
683 @emph{MN10300 Options}
684 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
685 -mam33  -mno-am33 @gol
686 -mam33-2  -mno-am33-2 @gol
687 -mreturn-pointer-on-d0 @gol
688 -mno-crt0  -mrelax}
689
690 @emph{PDP-11 Options}
691 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
692 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
693 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
694 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
695 -mbranch-expensive  -mbranch-cheap @gol
696 -msplit  -mno-split  -munix-asm  -mdec-asm}
697
698 @emph{picoChip Options}
699 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
700 -msymbol-as-address -mno-inefficient-warnings}
701
702 @emph{PowerPC Options}
703 See RS/6000 and PowerPC Options.
704
705 @emph{RS/6000 and PowerPC Options}
706 @gccoptlist{-mcpu=@var{cpu-type} @gol
707 -mtune=@var{cpu-type} @gol
708 -mpower  -mno-power  -mpower2  -mno-power2 @gol
709 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
710 -maltivec  -mno-altivec @gol
711 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
712 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
713 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
714 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
715 -mnew-mnemonics  -mold-mnemonics @gol
716 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
717 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
718 -malign-power  -malign-natural @gol
719 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
720 -msingle-float -mdouble-float -msimple-fpu @gol
721 -mstring  -mno-string  -mupdate  -mno-update @gol
722 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
723 -mstrict-align  -mno-strict-align  -mrelocatable @gol
724 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
725 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
726 -mdynamic-no-pic  -maltivec  -mswdiv @gol
727 -mprioritize-restricted-insns=@var{priority} @gol
728 -msched-costly-dep=@var{dependence_type} @gol
729 -minsert-sched-nops=@var{scheme} @gol
730 -mcall-sysv  -mcall-netbsd @gol
731 -maix-struct-return  -msvr4-struct-return @gol
732 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
733 -misel -mno-isel @gol
734 -misel=yes  -misel=no @gol
735 -mspe -mno-spe @gol
736 -mspe=yes  -mspe=no @gol
737 -mpaired @gol
738 -mgen-cell-microcode -mwarn-cell-microcode @gol
739 -mvrsave -mno-vrsave @gol
740 -mmulhw -mno-mulhw @gol
741 -mdlmzb -mno-dlmzb @gol
742 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
743 -mprototype  -mno-prototype @gol
744 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
745 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
746
747 @emph{S/390 and zSeries Options}
748 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
749 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
750 -mlong-double-64 -mlong-double-128 @gol
751 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
752 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
753 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
754 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
755 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
756
757 @emph{Score Options}
758 @gccoptlist{-meb -mel @gol
759 -mnhwloop @gol
760 -muls @gol
761 -mmac @gol
762 -mscore5 -mscore5u -mscore7 -mscore7d}
763
764 @emph{SH Options}
765 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
766 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
767 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
768 -m5-64media  -m5-64media-nofpu @gol
769 -m5-32media  -m5-32media-nofpu @gol
770 -m5-compact  -m5-compact-nofpu @gol
771 -mb  -ml  -mdalign  -mrelax @gol
772 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
773 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
774 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
775 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
776 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
777 -minvalid-symbols}
778
779 @emph{SPARC Options}
780 @gccoptlist{-mcpu=@var{cpu-type} @gol
781 -mtune=@var{cpu-type} @gol
782 -mcmodel=@var{code-model} @gol
783 -m32  -m64  -mapp-regs  -mno-app-regs @gol
784 -mfaster-structs  -mno-faster-structs @gol
785 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
786 -mhard-quad-float  -msoft-quad-float @gol
787 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
788 -mstack-bias  -mno-stack-bias @gol
789 -munaligned-doubles  -mno-unaligned-doubles @gol
790 -mv8plus  -mno-v8plus  -mvis  -mno-vis
791 -threads -pthreads -pthread}
792
793 @emph{SPU Options}
794 @gccoptlist{-mwarn-reloc -merror-reloc @gol
795 -msafe-dma -munsafe-dma @gol
796 -mbranch-hints @gol
797 -msmall-mem -mlarge-mem -mstdmain @gol
798 -mfixed-range=@var{register-range}}
799
800 @emph{System V Options}
801 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
802
803 @emph{V850 Options}
804 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
805 -mprolog-function  -mno-prolog-function  -mspace @gol
806 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
807 -mapp-regs  -mno-app-regs @gol
808 -mdisable-callt  -mno-disable-callt @gol
809 -mv850e1 @gol
810 -mv850e @gol
811 -mv850  -mbig-switch}
812
813 @emph{VAX Options}
814 @gccoptlist{-mg  -mgnu  -munix}
815
816 @emph{VxWorks Options}
817 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
818 -Xbind-lazy  -Xbind-now}
819
820 @emph{x86-64 Options}
821 See i386 and x86-64 Options.
822
823 @emph{Xstormy16 Options}
824 @gccoptlist{-msim}
825
826 @emph{Xtensa Options}
827 @gccoptlist{-mconst16 -mno-const16 @gol
828 -mfused-madd  -mno-fused-madd @gol
829 -mserialize-volatile  -mno-serialize-volatile @gol
830 -mtext-section-literals  -mno-text-section-literals @gol
831 -mtarget-align  -mno-target-align @gol
832 -mlongcalls  -mno-longcalls}
833
834 @emph{zSeries Options}
835 See S/390 and zSeries Options.
836
837 @item Code Generation Options
838 @xref{Code Gen Options,,Options for Code Generation Conventions}.
839 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
840 -ffixed-@var{reg}  -fexceptions @gol
841 -fnon-call-exceptions  -funwind-tables @gol
842 -fasynchronous-unwind-tables @gol
843 -finhibit-size-directive  -finstrument-functions @gol
844 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
845 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
846 -fno-common  -fno-ident @gol
847 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
848 -fno-jump-tables @gol
849 -frecord-gcc-switches @gol
850 -freg-struct-return  -fshort-enums @gol
851 -fshort-double  -fshort-wchar @gol
852 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
853 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
854 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
855 -fargument-noalias-global  -fargument-noalias-anything @gol
856 -fleading-underscore  -ftls-model=@var{model} @gol
857 -ftrapv  -fwrapv  -fbounds-check @gol
858 -fvisibility}
859 @end table
860
861 @menu
862 * Overall Options::     Controlling the kind of output:
863                         an executable, object files, assembler files,
864                         or preprocessed source.
865 * C Dialect Options::   Controlling the variant of C language compiled.
866 * C++ Dialect Options:: Variations on C++.
867 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
868                         and Objective-C++.
869 * Language Independent Options:: Controlling how diagnostics should be
870                         formatted.
871 * Warning Options::     How picky should the compiler be?
872 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
873 * Optimize Options::    How much optimization?
874 * Preprocessor Options:: Controlling header files and macro definitions.
875                          Also, getting dependency information for Make.
876 * Assembler Options::   Passing options to the assembler.
877 * Link Options::        Specifying libraries and so on.
878 * Directory Options::   Where to find header files and libraries.
879                         Where to find the compiler executable files.
880 * Spec Files::          How to pass switches to sub-processes.
881 * Target Options::      Running a cross-compiler, or an old version of GCC.
882 @end menu
883
884 @node Overall Options
885 @section Options Controlling the Kind of Output
886
887 Compilation can involve up to four stages: preprocessing, compilation
888 proper, assembly and linking, always in that order.  GCC is capable of
889 preprocessing and compiling several files either into several
890 assembler input files, or into one assembler input file; then each
891 assembler input file produces an object file, and linking combines all
892 the object files (those newly compiled, and those specified as input)
893 into an executable file.
894
895 @cindex file name suffix
896 For any given input file, the file name suffix determines what kind of
897 compilation is done:
898
899 @table @gcctabopt
900 @item @var{file}.c
901 C source code which must be preprocessed.
902
903 @item @var{file}.i
904 C source code which should not be preprocessed.
905
906 @item @var{file}.ii
907 C++ source code which should not be preprocessed.
908
909 @item @var{file}.m
910 Objective-C source code.  Note that you must link with the @file{libobjc}
911 library to make an Objective-C program work.
912
913 @item @var{file}.mi
914 Objective-C source code which should not be preprocessed.
915
916 @item @var{file}.mm
917 @itemx @var{file}.M
918 Objective-C++ source code.  Note that you must link with the @file{libobjc}
919 library to make an Objective-C++ program work.  Note that @samp{.M} refers
920 to a literal capital M@.
921
922 @item @var{file}.mii
923 Objective-C++ source code which should not be preprocessed.
924
925 @item @var{file}.h
926 C, C++, Objective-C or Objective-C++ header file to be turned into a
927 precompiled header.
928
929 @item @var{file}.cc
930 @itemx @var{file}.cp
931 @itemx @var{file}.cxx
932 @itemx @var{file}.cpp
933 @itemx @var{file}.CPP
934 @itemx @var{file}.c++
935 @itemx @var{file}.C
936 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
937 the last two letters must both be literally @samp{x}.  Likewise,
938 @samp{.C} refers to a literal capital C@.
939
940 @item @var{file}.mm
941 @itemx @var{file}.M
942 Objective-C++ source code which must be preprocessed.
943
944 @item @var{file}.mii
945 Objective-C++ source code which should not be preprocessed.
946
947 @item @var{file}.hh
948 @itemx @var{file}.H
949 @itemx @var{file}.hp
950 @itemx @var{file}.hxx
951 @itemx @var{file}.hpp
952 @itemx @var{file}.HPP
953 @itemx @var{file}.h++
954 @itemx @var{file}.tcc
955 C++ header file to be turned into a precompiled header.
956
957 @item @var{file}.f
958 @itemx @var{file}.for
959 @itemx @var{file}.ftn
960 Fixed form Fortran source code which should not be preprocessed.
961
962 @item @var{file}.F
963 @itemx @var{file}.FOR
964 @itemx @var{file}.fpp
965 @itemx @var{file}.FPP
966 @itemx @var{file}.FTN
967 Fixed form Fortran source code which must be preprocessed (with the traditional
968 preprocessor).
969
970 @item @var{file}.f90
971 @itemx @var{file}.f95
972 @itemx @var{file}.f03
973 @itemx @var{file}.f08
974 Free form Fortran source code which should not be preprocessed.
975
976 @item @var{file}.F90
977 @itemx @var{file}.F95
978 @itemx @var{file}.F03
979 @itemx @var{file}.F08
980 Free form Fortran source code which must be preprocessed (with the
981 traditional preprocessor).
982
983 @c FIXME: Descriptions of Java file types.
984 @c @var{file}.java
985 @c @var{file}.class
986 @c @var{file}.zip
987 @c @var{file}.jar
988
989 @item @var{file}.ads
990 Ada source code file which contains a library unit declaration (a
991 declaration of a package, subprogram, or generic, or a generic
992 instantiation), or a library unit renaming declaration (a package,
993 generic, or subprogram renaming declaration).  Such files are also
994 called @dfn{specs}.
995
996 @item @var{file}.adb
997 Ada source code file containing a library unit body (a subprogram or
998 package body).  Such files are also called @dfn{bodies}.
999
1000 @c GCC also knows about some suffixes for languages not yet included:
1001 @c Pascal:
1002 @c @var{file}.p
1003 @c @var{file}.pas
1004 @c Ratfor:
1005 @c @var{file}.r
1006
1007 @item @var{file}.s
1008 Assembler code.
1009
1010 @item @var{file}.S
1011 @itemx @var{file}.sx
1012 Assembler code which must be preprocessed.
1013
1014 @item @var{other}
1015 An object file to be fed straight into linking.
1016 Any file name with no recognized suffix is treated this way.
1017 @end table
1018
1019 @opindex x
1020 You can specify the input language explicitly with the @option{-x} option:
1021
1022 @table @gcctabopt
1023 @item -x @var{language}
1024 Specify explicitly the @var{language} for the following input files
1025 (rather than letting the compiler choose a default based on the file
1026 name suffix).  This option applies to all following input files until
1027 the next @option{-x} option.  Possible values for @var{language} are:
1028 @smallexample
1029 c  c-header  c-cpp-output
1030 c++  c++-header  c++-cpp-output
1031 objective-c  objective-c-header  objective-c-cpp-output
1032 objective-c++ objective-c++-header objective-c++-cpp-output
1033 assembler  assembler-with-cpp
1034 ada
1035 f77  f77-cpp-input f95  f95-cpp-input
1036 java
1037 @end smallexample
1038
1039 @item -x none
1040 Turn off any specification of a language, so that subsequent files are
1041 handled according to their file name suffixes (as they are if @option{-x}
1042 has not been used at all).
1043
1044 @item -pass-exit-codes
1045 @opindex pass-exit-codes
1046 Normally the @command{gcc} program will exit with the code of 1 if any
1047 phase of the compiler returns a non-success return code.  If you specify
1048 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1049 numerically highest error produced by any phase that returned an error
1050 indication.  The C, C++, and Fortran frontends return 4, if an internal
1051 compiler error is encountered.
1052 @end table
1053
1054 If you only want some of the stages of compilation, you can use
1055 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1056 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1057 @command{gcc} is to stop.  Note that some combinations (for example,
1058 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1059
1060 @table @gcctabopt
1061 @item -c
1062 @opindex c
1063 Compile or assemble the source files, but do not link.  The linking
1064 stage simply is not done.  The ultimate output is in the form of an
1065 object file for each source file.
1066
1067 By default, the object file name for a source file is made by replacing
1068 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1069
1070 Unrecognized input files, not requiring compilation or assembly, are
1071 ignored.
1072
1073 @item -S
1074 @opindex S
1075 Stop after the stage of compilation proper; do not assemble.  The output
1076 is in the form of an assembler code file for each non-assembler input
1077 file specified.
1078
1079 By default, the assembler file name for a source file is made by
1080 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1081
1082 Input files that don't require compilation are ignored.
1083
1084 @item -E
1085 @opindex E
1086 Stop after the preprocessing stage; do not run the compiler proper.  The
1087 output is in the form of preprocessed source code, which is sent to the
1088 standard output.
1089
1090 Input files which don't require preprocessing are ignored.
1091
1092 @cindex output file option
1093 @item -o @var{file}
1094 @opindex o
1095 Place output in file @var{file}.  This applies regardless to whatever
1096 sort of output is being produced, whether it be an executable file,
1097 an object file, an assembler file or preprocessed C code.
1098
1099 If @option{-o} is not specified, the default is to put an executable
1100 file in @file{a.out}, the object file for
1101 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1102 assembler file in @file{@var{source}.s}, a precompiled header file in
1103 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1104 standard output.
1105
1106 @item -v
1107 @opindex v
1108 Print (on standard error output) the commands executed to run the stages
1109 of compilation.  Also print the version number of the compiler driver
1110 program and of the preprocessor and the compiler proper.
1111
1112 @item -###
1113 @opindex ###
1114 Like @option{-v} except the commands are not executed and all command
1115 arguments are quoted.  This is useful for shell scripts to capture the
1116 driver-generated command lines.
1117
1118 @item -pipe
1119 @opindex pipe
1120 Use pipes rather than temporary files for communication between the
1121 various stages of compilation.  This fails to work on some systems where
1122 the assembler is unable to read from a pipe; but the GNU assembler has
1123 no trouble.
1124
1125 @item -combine
1126 @opindex combine
1127 If you are compiling multiple source files, this option tells the driver
1128 to pass all the source files to the compiler at once (for those
1129 languages for which the compiler can handle this).  This will allow
1130 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1131 language for which this is supported is C@.  If you pass source files for
1132 multiple languages to the driver, using this option, the driver will invoke
1133 the compiler(s) that support IMA once each, passing each compiler all the
1134 source files appropriate for it.  For those languages that do not support
1135 IMA this option will be ignored, and the compiler will be invoked once for
1136 each source file in that language.  If you use this option in conjunction
1137 with @option{-save-temps}, the compiler will generate multiple
1138 pre-processed files
1139 (one for each source file), but only one (combined) @file{.o} or
1140 @file{.s} file.
1141
1142 @item --help
1143 @opindex help
1144 Print (on the standard output) a description of the command line options
1145 understood by @command{gcc}.  If the @option{-v} option is also specified
1146 then @option{--help} will also be passed on to the various processes
1147 invoked by @command{gcc}, so that they can display the command line options
1148 they accept.  If the @option{-Wextra} option has also been specified
1149 (prior to the @option{--help} option), then command line options which
1150 have no documentation associated with them will also be displayed.
1151
1152 @item --target-help
1153 @opindex target-help
1154 Print (on the standard output) a description of target-specific command
1155 line options for each tool.  For some targets extra target-specific
1156 information may also be printed.
1157
1158 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
1159 Print (on the standard output) a description of the command line
1160 options understood by the compiler that fit into a specific class.
1161 The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
1162 @samp{params}, or @var{language}:
1163
1164 @table @asis
1165 @item @samp{optimizers}
1166 This will display all of the optimization options supported by the
1167 compiler.
1168
1169 @item @samp{warnings}
1170 This will display all of the options controlling warning messages
1171 produced by the compiler.
1172
1173 @item @samp{target}
1174 This will display target-specific options.  Unlike the
1175 @option{--target-help} option however, target-specific options of the
1176 linker and assembler will not be displayed.  This is because those
1177 tools do not currently support the extended @option{--help=} syntax.
1178
1179 @item @samp{params}
1180 This will display the values recognized by the @option{--param}
1181 option.
1182
1183 @item @var{language}
1184 This will display the options supported for @var{language}, where 
1185 @var{language} is the name of one of the languages supported in this 
1186 version of GCC.
1187
1188 @item @samp{common}
1189 This will display the options that are common to all languages.
1190 @end table
1191
1192 It is possible to further refine the output of the @option{--help=}
1193 option by adding a comma separated list of qualifiers after the
1194 class.  These can be any from the following list:
1195
1196 @table @asis
1197 @item @samp{undocumented}
1198 Display only those options which are undocumented.
1199
1200 @item @samp{joined}
1201 Display options which take an argument that appears after an equal
1202 sign in the same continuous piece of text, such as:
1203 @samp{--help=target}.
1204
1205 @item @samp{separate}
1206 Display options which take an argument that appears as a separate word
1207 following the original option, such as: @samp{-o output-file}.
1208 @end table
1209
1210 Thus for example to display all the undocumented target-specific
1211 switches supported by the compiler the following can be used:
1212
1213 @smallexample
1214 --help=target,undocumented
1215 @end smallexample
1216
1217 The sense of a qualifier can be inverted by prefixing it with the
1218 @var{^} character, so for example to display all binary warning
1219 options (i.e., ones that are either on or off and that do not take an
1220 argument), which have a description the following can be used:
1221
1222 @smallexample
1223 --help=warnings,^joined,^undocumented
1224 @end smallexample
1225
1226 A class can also be used as a qualifier, although this usually
1227 restricts the output by so much that there is nothing to display.  One
1228 case where it does work however is when one of the classes is
1229 @var{target}.  So for example to display all the target-specific
1230 optimization options the following can be used:
1231
1232 @smallexample
1233 --help=target,optimizers
1234 @end smallexample
1235
1236 The @option{--help=} option can be repeated on the command line.  Each
1237 successive use will display its requested class of options, skipping
1238 those that have already been displayed.
1239
1240 If the @option{-Q} option appears on the command line before the
1241 @option{--help=} option, then the descriptive text displayed by
1242 @option{--help=} is changed.  Instead of describing the displayed
1243 options, an indication is given as to whether the option is enabled,
1244 disabled or set to a specific value (assuming that the compiler
1245 knows this at the point where the @option{--help=} option is used).
1246
1247 Here is a truncated example from the ARM port of @command{gcc}:
1248
1249 @smallexample
1250   % gcc -Q -mabi=2 --help=target -c
1251   The following options are target specific:
1252   -mabi=                                2
1253   -mabort-on-noreturn                   [disabled]
1254   -mapcs                                [disabled]
1255 @end smallexample
1256
1257 The output is sensitive to the effects of previous command line
1258 options, so for example it is possible to find out which optimizations
1259 are enabled at @option{-O2} by using:
1260
1261 @smallexample
1262 -O2 --help=optimizers
1263 @end smallexample
1264
1265 Alternatively you can discover which binary optimizations are enabled
1266 by @option{-O3} by using:
1267
1268 @smallexample
1269 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1270 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1271 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1272 @end smallexample
1273
1274 @item --version
1275 @opindex version
1276 Display the version number and copyrights of the invoked GCC@.
1277
1278 @item -wrapper
1279 @opindex wrapper
1280 Invoke all subcommands under a wrapper program. It takes a single
1281 comma separated list as an argument, which will be used to invoke
1282 the wrapper:
1283
1284 @smallexample
1285 gcc -c t.c -wrapper gdb,--args
1286 @end smallexample
1287
1288 This will invoke all subprograms of gcc under "gdb --args",
1289 thus cc1 invocation will be "gdb --args cc1 ...".
1290
1291 @include @value{srcdir}/../libiberty/at-file.texi
1292 @end table
1293
1294 @node Invoking G++
1295 @section Compiling C++ Programs
1296
1297 @cindex suffixes for C++ source
1298 @cindex C++ source file suffixes
1299 C++ source files conventionally use one of the suffixes @samp{.C},
1300 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1301 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1302 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1303 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1304 files with these names and compiles them as C++ programs even if you
1305 call the compiler the same way as for compiling C programs (usually
1306 with the name @command{gcc}).
1307
1308 @findex g++
1309 @findex c++
1310 However, the use of @command{gcc} does not add the C++ library.
1311 @command{g++} is a program that calls GCC and treats @samp{.c},
1312 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1313 files unless @option{-x} is used, and automatically specifies linking
1314 against the C++ library.  This program is also useful when
1315 precompiling a C header file with a @samp{.h} extension for use in C++
1316 compilations.  On many systems, @command{g++} is also installed with
1317 the name @command{c++}.
1318
1319 @cindex invoking @command{g++}
1320 When you compile C++ programs, you may specify many of the same
1321 command-line options that you use for compiling programs in any
1322 language; or command-line options meaningful for C and related
1323 languages; or options that are meaningful only for C++ programs.
1324 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1325 explanations of options for languages related to C@.
1326 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1327 explanations of options that are meaningful only for C++ programs.
1328
1329 @node C Dialect Options
1330 @section Options Controlling C Dialect
1331 @cindex dialect options
1332 @cindex language dialect options
1333 @cindex options, dialect
1334
1335 The following options control the dialect of C (or languages derived
1336 from C, such as C++, Objective-C and Objective-C++) that the compiler
1337 accepts:
1338
1339 @table @gcctabopt
1340 @cindex ANSI support
1341 @cindex ISO support
1342 @item -ansi
1343 @opindex ansi
1344 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1345 equivalent to @samp{-std=c++98}.
1346
1347 This turns off certain features of GCC that are incompatible with ISO
1348 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1349 such as the @code{asm} and @code{typeof} keywords, and
1350 predefined macros such as @code{unix} and @code{vax} that identify the
1351 type of system you are using.  It also enables the undesirable and
1352 rarely used ISO trigraph feature.  For the C compiler,
1353 it disables recognition of C++ style @samp{//} comments as well as
1354 the @code{inline} keyword.
1355
1356 The alternate keywords @code{__asm__}, @code{__extension__},
1357 @code{__inline__} and @code{__typeof__} continue to work despite
1358 @option{-ansi}.  You would not want to use them in an ISO C program, of
1359 course, but it is useful to put them in header files that might be included
1360 in compilations done with @option{-ansi}.  Alternate predefined macros
1361 such as @code{__unix__} and @code{__vax__} are also available, with or
1362 without @option{-ansi}.
1363
1364 The @option{-ansi} option does not cause non-ISO programs to be
1365 rejected gratuitously.  For that, @option{-pedantic} is required in
1366 addition to @option{-ansi}.  @xref{Warning Options}.
1367
1368 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1369 option is used.  Some header files may notice this macro and refrain
1370 from declaring certain functions or defining certain macros that the
1371 ISO standard doesn't call for; this is to avoid interfering with any
1372 programs that might use these names for other things.
1373
1374 Functions that would normally be built in but do not have semantics
1375 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1376 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1377 built-in functions provided by GCC}, for details of the functions
1378 affected.
1379
1380 @item -std=
1381 @opindex std
1382 Determine the language standard. @xref{Standards,,Language Standards
1383 Supported by GCC}, for details of these standard versions.  This option
1384 is currently only supported when compiling C or C++. 
1385
1386 The compiler can accept several base standards, such as @samp{c89} or
1387 @samp{c++98}, and GNU dialects of those standards, such as
1388 @samp{gnu89} or @samp{gnu++98}.  By specifing a base standard, the
1389 compiler will accept all programs following that standard and those
1390 using GNU extensions that do not contradict it.  For example,
1391 @samp{-std=c89} turns off certain features of GCC that are
1392 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1393 keywords, but not other GNU extensions that do not have a meaning in
1394 ISO C90, such as omitting the middle term of a @code{?:}
1395 expression. On the other hand, by specifing a GNU dialect of a
1396 standard, all features the compiler support are enabled, even when
1397 those features change the meaning of the base standard and some
1398 strict-conforming programs may be rejected.  The particular standard
1399 is used by @option{-pedantic} to identify which features are GNU
1400 extensions given that version of the standard. For example
1401 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1402 comments, while @samp{-std=gnu99 -pedantic} would not.
1403
1404 A value for this option must be provided; possible values are
1405
1406 @table @samp
1407 @item c89
1408 @itemx iso9899:1990
1409 Support all ISO C90 programs (certain GNU extensions that conflict
1410 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1411
1412 @item iso9899:199409
1413 ISO C90 as modified in amendment 1.
1414
1415 @item c99
1416 @itemx c9x
1417 @itemx iso9899:1999
1418 @itemx iso9899:199x
1419 ISO C99.  Note that this standard is not yet fully supported; see
1420 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1421 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1422
1423 @item gnu89
1424 GNU dialect of ISO C90 (including some C99 features). This
1425 is the default for C code.
1426
1427 @item gnu99
1428 @itemx gnu9x
1429 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1430 this will become the default.  The name @samp{gnu9x} is deprecated.
1431
1432 @item c++98
1433 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1434 C++ code.
1435
1436 @item gnu++98
1437 GNU dialect of @option{-std=c++98}.  This is the default for
1438 C++ code.
1439
1440 @item c++0x
1441 The working draft of the upcoming ISO C++0x standard. This option
1442 enables experimental features that are likely to be included in
1443 C++0x. The working draft is constantly changing, and any feature that is
1444 enabled by this flag may be removed from future versions of GCC if it is
1445 not part of the C++0x standard.
1446
1447 @item gnu++0x
1448 GNU dialect of @option{-std=c++0x}. This option enables
1449 experimental features that may be removed in future versions of GCC.
1450 @end table
1451
1452 @item -fgnu89-inline
1453 @opindex fgnu89-inline
1454 The option @option{-fgnu89-inline} tells GCC to use the traditional
1455 GNU semantics for @code{inline} functions when in C99 mode.
1456 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1457 is accepted and ignored by GCC versions 4.1.3 up to but not including
1458 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1459 C99 mode.  Using this option is roughly equivalent to adding the
1460 @code{gnu_inline} function attribute to all inline functions
1461 (@pxref{Function Attributes}).
1462
1463 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1464 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1465 specifies the default behavior).  This option was first supported in
1466 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1467
1468 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1469 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1470 in effect for @code{inline} functions.  @xref{Common Predefined
1471 Macros,,,cpp,The C Preprocessor}.
1472
1473 @item -aux-info @var{filename}
1474 @opindex aux-info
1475 Output to the given filename prototyped declarations for all functions
1476 declared and/or defined in a translation unit, including those in header
1477 files.  This option is silently ignored in any language other than C@.
1478
1479 Besides declarations, the file indicates, in comments, the origin of
1480 each declaration (source file and line), whether the declaration was
1481 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1482 @samp{O} for old, respectively, in the first character after the line
1483 number and the colon), and whether it came from a declaration or a
1484 definition (@samp{C} or @samp{F}, respectively, in the following
1485 character).  In the case of function definitions, a K&R-style list of
1486 arguments followed by their declarations is also provided, inside
1487 comments, after the declaration.
1488
1489 @item -fno-asm
1490 @opindex fno-asm
1491 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1492 keyword, so that code can use these words as identifiers.  You can use
1493 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1494 instead.  @option{-ansi} implies @option{-fno-asm}.
1495
1496 In C++, this switch only affects the @code{typeof} keyword, since
1497 @code{asm} and @code{inline} are standard keywords.  You may want to
1498 use the @option{-fno-gnu-keywords} flag instead, which has the same
1499 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1500 switch only affects the @code{asm} and @code{typeof} keywords, since
1501 @code{inline} is a standard keyword in ISO C99.
1502
1503 @item -fno-builtin
1504 @itemx -fno-builtin-@var{function}
1505 @opindex fno-builtin
1506 @cindex built-in functions
1507 Don't recognize built-in functions that do not begin with
1508 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1509 functions provided by GCC}, for details of the functions affected,
1510 including those which are not built-in functions when @option{-ansi} or
1511 @option{-std} options for strict ISO C conformance are used because they
1512 do not have an ISO standard meaning.
1513
1514 GCC normally generates special code to handle certain built-in functions
1515 more efficiently; for instance, calls to @code{alloca} may become single
1516 instructions that adjust the stack directly, and calls to @code{memcpy}
1517 may become inline copy loops.  The resulting code is often both smaller
1518 and faster, but since the function calls no longer appear as such, you
1519 cannot set a breakpoint on those calls, nor can you change the behavior
1520 of the functions by linking with a different library.  In addition,
1521 when a function is recognized as a built-in function, GCC may use
1522 information about that function to warn about problems with calls to
1523 that function, or to generate more efficient code, even if the
1524 resulting code still contains calls to that function.  For example,
1525 warnings are given with @option{-Wformat} for bad calls to
1526 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1527 known not to modify global memory.
1528
1529 With the @option{-fno-builtin-@var{function}} option
1530 only the built-in function @var{function} is
1531 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1532 function is named that is not built-in in this version of GCC, this
1533 option is ignored.  There is no corresponding
1534 @option{-fbuiltin-@var{function}} option; if you wish to enable
1535 built-in functions selectively when using @option{-fno-builtin} or
1536 @option{-ffreestanding}, you may define macros such as:
1537
1538 @smallexample
1539 #define abs(n)          __builtin_abs ((n))
1540 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1541 @end smallexample
1542
1543 @item -fhosted
1544 @opindex fhosted
1545 @cindex hosted environment
1546
1547 Assert that compilation takes place in a hosted environment.  This implies
1548 @option{-fbuiltin}.  A hosted environment is one in which the
1549 entire standard library is available, and in which @code{main} has a return
1550 type of @code{int}.  Examples are nearly everything except a kernel.
1551 This is equivalent to @option{-fno-freestanding}.
1552
1553 @item -ffreestanding
1554 @opindex ffreestanding
1555 @cindex hosted environment
1556
1557 Assert that compilation takes place in a freestanding environment.  This
1558 implies @option{-fno-builtin}.  A freestanding environment
1559 is one in which the standard library may not exist, and program startup may
1560 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1561 This is equivalent to @option{-fno-hosted}.
1562
1563 @xref{Standards,,Language Standards Supported by GCC}, for details of
1564 freestanding and hosted environments.
1565
1566 @item -fopenmp
1567 @opindex fopenmp
1568 @cindex openmp parallel
1569 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1570 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1571 compiler generates parallel code according to the OpenMP Application
1572 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.  This option
1573 implies @option{-pthread}, and thus is only supported on targets that
1574 have support for @option{-pthread}.
1575
1576 @item -fms-extensions
1577 @opindex fms-extensions
1578 Accept some non-standard constructs used in Microsoft header files.
1579
1580 Some cases of unnamed fields in structures and unions are only
1581 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1582 fields within structs/unions}, for details.
1583
1584 @item -trigraphs
1585 @opindex trigraphs
1586 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1587 options for strict ISO C conformance) implies @option{-trigraphs}.
1588
1589 @item -no-integrated-cpp
1590 @opindex no-integrated-cpp
1591 Performs a compilation in two passes: preprocessing and compiling.  This
1592 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1593 @option{-B} option.  The user supplied compilation step can then add in
1594 an additional preprocessing step after normal preprocessing but before
1595 compiling.  The default is to use the integrated cpp (internal cpp)
1596
1597 The semantics of this option will change if "cc1", "cc1plus", and
1598 "cc1obj" are merged.
1599
1600 @cindex traditional C language
1601 @cindex C language, traditional
1602 @item -traditional
1603 @itemx -traditional-cpp
1604 @opindex traditional-cpp
1605 @opindex traditional
1606 Formerly, these options caused GCC to attempt to emulate a pre-standard
1607 C compiler.  They are now only supported with the @option{-E} switch.
1608 The preprocessor continues to support a pre-standard mode.  See the GNU
1609 CPP manual for details.
1610
1611 @item -fcond-mismatch
1612 @opindex fcond-mismatch
1613 Allow conditional expressions with mismatched types in the second and
1614 third arguments.  The value of such an expression is void.  This option
1615 is not supported for C++.
1616
1617 @item -flax-vector-conversions
1618 @opindex flax-vector-conversions
1619 Allow implicit conversions between vectors with differing numbers of
1620 elements and/or incompatible element types.  This option should not be
1621 used for new code.
1622
1623 @item -funsigned-char
1624 @opindex funsigned-char
1625 Let the type @code{char} be unsigned, like @code{unsigned char}.
1626
1627 Each kind of machine has a default for what @code{char} should
1628 be.  It is either like @code{unsigned char} by default or like
1629 @code{signed char} by default.
1630
1631 Ideally, a portable program should always use @code{signed char} or
1632 @code{unsigned char} when it depends on the signedness of an object.
1633 But many programs have been written to use plain @code{char} and
1634 expect it to be signed, or expect it to be unsigned, depending on the
1635 machines they were written for.  This option, and its inverse, let you
1636 make such a program work with the opposite default.
1637
1638 The type @code{char} is always a distinct type from each of
1639 @code{signed char} or @code{unsigned char}, even though its behavior
1640 is always just like one of those two.
1641
1642 @item -fsigned-char
1643 @opindex fsigned-char
1644 Let the type @code{char} be signed, like @code{signed char}.
1645
1646 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1647 the negative form of @option{-funsigned-char}.  Likewise, the option
1648 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1649
1650 @item -fsigned-bitfields
1651 @itemx -funsigned-bitfields
1652 @itemx -fno-signed-bitfields
1653 @itemx -fno-unsigned-bitfields
1654 @opindex fsigned-bitfields
1655 @opindex funsigned-bitfields
1656 @opindex fno-signed-bitfields
1657 @opindex fno-unsigned-bitfields
1658 These options control whether a bit-field is signed or unsigned, when the
1659 declaration does not use either @code{signed} or @code{unsigned}.  By
1660 default, such a bit-field is signed, because this is consistent: the
1661 basic integer types such as @code{int} are signed types.
1662 @end table
1663
1664 @node C++ Dialect Options
1665 @section Options Controlling C++ Dialect
1666
1667 @cindex compiler options, C++
1668 @cindex C++ options, command line
1669 @cindex options, C++
1670 This section describes the command-line options that are only meaningful
1671 for C++ programs; but you can also use most of the GNU compiler options
1672 regardless of what language your program is in.  For example, you
1673 might compile a file @code{firstClass.C} like this:
1674
1675 @smallexample
1676 g++ -g -frepo -O -c firstClass.C
1677 @end smallexample
1678
1679 @noindent
1680 In this example, only @option{-frepo} is an option meant
1681 only for C++ programs; you can use the other options with any
1682 language supported by GCC@.
1683
1684 Here is a list of options that are @emph{only} for compiling C++ programs:
1685
1686 @table @gcctabopt
1687
1688 @item -fabi-version=@var{n}
1689 @opindex fabi-version
1690 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1691 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1692 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1693 the version that conforms most closely to the C++ ABI specification.
1694 Therefore, the ABI obtained using version 0 will change as ABI bugs
1695 are fixed.
1696
1697 The default is version 2.
1698
1699 @item -fno-access-control
1700 @opindex fno-access-control
1701 Turn off all access checking.  This switch is mainly useful for working
1702 around bugs in the access control code.
1703
1704 @item -fcheck-new
1705 @opindex fcheck-new
1706 Check that the pointer returned by @code{operator new} is non-null
1707 before attempting to modify the storage allocated.  This check is
1708 normally unnecessary because the C++ standard specifies that
1709 @code{operator new} will only return @code{0} if it is declared
1710 @samp{throw()}, in which case the compiler will always check the
1711 return value even without this option.  In all other cases, when
1712 @code{operator new} has a non-empty exception specification, memory
1713 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1714 @samp{new (nothrow)}.
1715
1716 @item -fconserve-space
1717 @opindex fconserve-space
1718 Put uninitialized or runtime-initialized global variables into the
1719 common segment, as C does.  This saves space in the executable at the
1720 cost of not diagnosing duplicate definitions.  If you compile with this
1721 flag and your program mysteriously crashes after @code{main()} has
1722 completed, you may have an object that is being destroyed twice because
1723 two definitions were merged.
1724
1725 This option is no longer useful on most targets, now that support has
1726 been added for putting variables into BSS without making them common.
1727
1728 @item -ffriend-injection
1729 @opindex ffriend-injection
1730 Inject friend functions into the enclosing namespace, so that they are
1731 visible outside the scope of the class in which they are declared.
1732 Friend functions were documented to work this way in the old Annotated
1733 C++ Reference Manual, and versions of G++ before 4.1 always worked
1734 that way.  However, in ISO C++ a friend function which is not declared
1735 in an enclosing scope can only be found using argument dependent
1736 lookup.  This option causes friends to be injected as they were in
1737 earlier releases.
1738
1739 This option is for compatibility, and may be removed in a future
1740 release of G++.
1741
1742 @item -fno-elide-constructors
1743 @opindex fno-elide-constructors
1744 The C++ standard allows an implementation to omit creating a temporary
1745 which is only used to initialize another object of the same type.
1746 Specifying this option disables that optimization, and forces G++ to
1747 call the copy constructor in all cases.
1748
1749 @item -fno-enforce-eh-specs
1750 @opindex fno-enforce-eh-specs
1751 Don't generate code to check for violation of exception specifications
1752 at runtime.  This option violates the C++ standard, but may be useful
1753 for reducing code size in production builds, much like defining
1754 @samp{NDEBUG}.  This does not give user code permission to throw
1755 exceptions in violation of the exception specifications; the compiler
1756 will still optimize based on the specifications, so throwing an
1757 unexpected exception will result in undefined behavior.
1758
1759 @item -ffor-scope
1760 @itemx -fno-for-scope
1761 @opindex ffor-scope
1762 @opindex fno-for-scope
1763 If @option{-ffor-scope} is specified, the scope of variables declared in
1764 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1765 as specified by the C++ standard.
1766 If @option{-fno-for-scope} is specified, the scope of variables declared in
1767 a @i{for-init-statement} extends to the end of the enclosing scope,
1768 as was the case in old versions of G++, and other (traditional)
1769 implementations of C++.
1770
1771 The default if neither flag is given to follow the standard,
1772 but to allow and give a warning for old-style code that would
1773 otherwise be invalid, or have different behavior.
1774
1775 @item -fno-gnu-keywords
1776 @opindex fno-gnu-keywords
1777 Do not recognize @code{typeof} as a keyword, so that code can use this
1778 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1779 @option{-ansi} implies @option{-fno-gnu-keywords}.
1780
1781 @item -fno-implicit-templates
1782 @opindex fno-implicit-templates
1783 Never emit code for non-inline templates which are instantiated
1784 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1785 @xref{Template Instantiation}, for more information.
1786
1787 @item -fno-implicit-inline-templates
1788 @opindex fno-implicit-inline-templates
1789 Don't emit code for implicit instantiations of inline templates, either.
1790 The default is to handle inlines differently so that compiles with and
1791 without optimization will need the same set of explicit instantiations.
1792
1793 @item -fno-implement-inlines
1794 @opindex fno-implement-inlines
1795 To save space, do not emit out-of-line copies of inline functions
1796 controlled by @samp{#pragma implementation}.  This will cause linker
1797 errors if these functions are not inlined everywhere they are called.
1798
1799 @item -fms-extensions
1800 @opindex fms-extensions
1801 Disable pedantic warnings about constructs used in MFC, such as implicit
1802 int and getting a pointer to member function via non-standard syntax.
1803
1804 @item -fno-nonansi-builtins
1805 @opindex fno-nonansi-builtins
1806 Disable built-in declarations of functions that are not mandated by
1807 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1808 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1809
1810 @item -fno-operator-names
1811 @opindex fno-operator-names
1812 Do not treat the operator name keywords @code{and}, @code{bitand},
1813 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1814 synonyms as keywords.
1815
1816 @item -fno-optional-diags
1817 @opindex fno-optional-diags
1818 Disable diagnostics that the standard says a compiler does not need to
1819 issue.  Currently, the only such diagnostic issued by G++ is the one for
1820 a name having multiple meanings within a class.
1821
1822 @item -fpermissive
1823 @opindex fpermissive
1824 Downgrade some diagnostics about nonconformant code from errors to
1825 warnings.  Thus, using @option{-fpermissive} will allow some
1826 nonconforming code to compile.
1827
1828 @item -frepo
1829 @opindex frepo
1830 Enable automatic template instantiation at link time.  This option also
1831 implies @option{-fno-implicit-templates}.  @xref{Template
1832 Instantiation}, for more information.
1833
1834 @item -fno-rtti
1835 @opindex fno-rtti
1836 Disable generation of information about every class with virtual
1837 functions for use by the C++ runtime type identification features
1838 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1839 of the language, you can save some space by using this flag.  Note that
1840 exception handling uses the same information, but it will generate it as
1841 needed. The @samp{dynamic_cast} operator can still be used for casts that
1842 do not require runtime type information, i.e.@: casts to @code{void *} or to
1843 unambiguous base classes.
1844
1845 @item -fstats
1846 @opindex fstats
1847 Emit statistics about front-end processing at the end of the compilation.
1848 This information is generally only useful to the G++ development team.
1849
1850 @item -ftemplate-depth-@var{n}
1851 @opindex ftemplate-depth
1852 Set the maximum instantiation depth for template classes to @var{n}.
1853 A limit on the template instantiation depth is needed to detect
1854 endless recursions during template class instantiation.  ANSI/ISO C++
1855 conforming programs must not rely on a maximum depth greater than 17.
1856
1857 @item -fno-threadsafe-statics
1858 @opindex fno-threadsafe-statics
1859 Do not emit the extra code to use the routines specified in the C++
1860 ABI for thread-safe initialization of local statics.  You can use this
1861 option to reduce code size slightly in code that doesn't need to be
1862 thread-safe.
1863
1864 @item -fuse-cxa-atexit
1865 @opindex fuse-cxa-atexit
1866 Register destructors for objects with static storage duration with the
1867 @code{__cxa_atexit} function rather than the @code{atexit} function.
1868 This option is required for fully standards-compliant handling of static
1869 destructors, but will only work if your C library supports
1870 @code{__cxa_atexit}.
1871
1872 @item -fno-use-cxa-get-exception-ptr
1873 @opindex fno-use-cxa-get-exception-ptr
1874 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1875 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1876 if the runtime routine is not available.
1877
1878 @item -fvisibility-inlines-hidden
1879 @opindex fvisibility-inlines-hidden
1880 This switch declares that the user does not attempt to compare
1881 pointers to inline methods where the addresses of the two functions
1882 were taken in different shared objects.
1883
1884 The effect of this is that GCC may, effectively, mark inline methods with
1885 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1886 appear in the export table of a DSO and do not require a PLT indirection
1887 when used within the DSO@.  Enabling this option can have a dramatic effect
1888 on load and link times of a DSO as it massively reduces the size of the
1889 dynamic export table when the library makes heavy use of templates.
1890
1891 The behavior of this switch is not quite the same as marking the
1892 methods as hidden directly, because it does not affect static variables
1893 local to the function or cause the compiler to deduce that
1894 the function is defined in only one shared object.
1895
1896 You may mark a method as having a visibility explicitly to negate the
1897 effect of the switch for that method.  For example, if you do want to
1898 compare pointers to a particular inline method, you might mark it as
1899 having default visibility.  Marking the enclosing class with explicit
1900 visibility will have no effect.
1901
1902 Explicitly instantiated inline methods are unaffected by this option
1903 as their linkage might otherwise cross a shared library boundary.
1904 @xref{Template Instantiation}.
1905
1906 @item -fvisibility-ms-compat
1907 @opindex fvisibility-ms-compat
1908 This flag attempts to use visibility settings to make GCC's C++
1909 linkage model compatible with that of Microsoft Visual Studio.
1910
1911 The flag makes these changes to GCC's linkage model:
1912
1913 @enumerate
1914 @item
1915 It sets the default visibility to @code{hidden}, like
1916 @option{-fvisibility=hidden}.
1917
1918 @item
1919 Types, but not their members, are not hidden by default.
1920
1921 @item
1922 The One Definition Rule is relaxed for types without explicit
1923 visibility specifications which are defined in more than one different
1924 shared object: those declarations are permitted if they would have
1925 been permitted when this option was not used.
1926 @end enumerate
1927
1928 In new code it is better to use @option{-fvisibility=hidden} and
1929 export those classes which are intended to be externally visible.
1930 Unfortunately it is possible for code to rely, perhaps accidentally,
1931 on the Visual Studio behavior.
1932
1933 Among the consequences of these changes are that static data members
1934 of the same type with the same name but defined in different shared
1935 objects will be different, so changing one will not change the other;
1936 and that pointers to function members defined in different shared
1937 objects may not compare equal.  When this flag is given, it is a
1938 violation of the ODR to define types with the same name differently.
1939
1940 @item -fno-weak
1941 @opindex fno-weak
1942 Do not use weak symbol support, even if it is provided by the linker.
1943 By default, G++ will use weak symbols if they are available.  This
1944 option exists only for testing, and should not be used by end-users;
1945 it will result in inferior code and has no benefits.  This option may
1946 be removed in a future release of G++.
1947
1948 @item -nostdinc++
1949 @opindex nostdinc++
1950 Do not search for header files in the standard directories specific to
1951 C++, but do still search the other standard directories.  (This option
1952 is used when building the C++ library.)
1953 @end table
1954
1955 In addition, these optimization, warning, and code generation options
1956 have meanings only for C++ programs:
1957
1958 @table @gcctabopt
1959 @item -fno-default-inline
1960 @opindex fno-default-inline
1961 Do not assume @samp{inline} for functions defined inside a class scope.
1962 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1963 functions will have linkage like inline functions; they just won't be
1964 inlined by default.
1965
1966 @item -Wabi @r{(C++ and Objective-C++ only)}
1967 @opindex Wabi
1968 @opindex Wno-abi
1969 Warn when G++ generates code that is probably not compatible with the
1970 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1971 all such cases, there are probably some cases that are not warned about,
1972 even though G++ is generating incompatible code.  There may also be
1973 cases where warnings are emitted even though the code that is generated
1974 will be compatible.
1975
1976 You should rewrite your code to avoid these warnings if you are
1977 concerned about the fact that code generated by G++ may not be binary
1978 compatible with code generated by other compilers.
1979
1980 The known incompatibilities at this point include:
1981
1982 @itemize @bullet
1983
1984 @item
1985 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1986 pack data into the same byte as a base class.  For example:
1987
1988 @smallexample
1989 struct A @{ virtual void f(); int f1 : 1; @};
1990 struct B : public A @{ int f2 : 1; @};
1991 @end smallexample
1992
1993 @noindent
1994 In this case, G++ will place @code{B::f2} into the same byte
1995 as@code{A::f1}; other compilers will not.  You can avoid this problem
1996 by explicitly padding @code{A} so that its size is a multiple of the
1997 byte size on your platform; that will cause G++ and other compilers to
1998 layout @code{B} identically.
1999
2000 @item
2001 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2002 tail padding when laying out virtual bases.  For example:
2003
2004 @smallexample
2005 struct A @{ virtual void f(); char c1; @};
2006 struct B @{ B(); char c2; @};
2007 struct C : public A, public virtual B @{@};
2008 @end smallexample
2009
2010 @noindent
2011 In this case, G++ will not place @code{B} into the tail-padding for
2012 @code{A}; other compilers will.  You can avoid this problem by
2013 explicitly padding @code{A} so that its size is a multiple of its
2014 alignment (ignoring virtual base classes); that will cause G++ and other
2015 compilers to layout @code{C} identically.
2016
2017 @item
2018 Incorrect handling of bit-fields with declared widths greater than that
2019 of their underlying types, when the bit-fields appear in a union.  For
2020 example:
2021
2022 @smallexample
2023 union U @{ int i : 4096; @};
2024 @end smallexample
2025
2026 @noindent
2027 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2028 union too small by the number of bits in an @code{int}.
2029
2030 @item
2031 Empty classes can be placed at incorrect offsets.  For example:
2032
2033 @smallexample
2034 struct A @{@};
2035
2036 struct B @{
2037   A a;
2038   virtual void f ();
2039 @};
2040
2041 struct C : public B, public A @{@};
2042 @end smallexample
2043
2044 @noindent
2045 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2046 it should be placed at offset zero.  G++ mistakenly believes that the
2047 @code{A} data member of @code{B} is already at offset zero.
2048
2049 @item
2050 Names of template functions whose types involve @code{typename} or
2051 template template parameters can be mangled incorrectly.
2052
2053 @smallexample
2054 template <typename Q>
2055 void f(typename Q::X) @{@}
2056
2057 template <template <typename> class Q>
2058 void f(typename Q<int>::X) @{@}
2059 @end smallexample
2060
2061 @noindent
2062 Instantiations of these templates may be mangled incorrectly.
2063
2064 @end itemize
2065
2066 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2067 @opindex Wctor-dtor-privacy
2068 @opindex Wno-ctor-dtor-privacy
2069 Warn when a class seems unusable because all the constructors or
2070 destructors in that class are private, and it has neither friends nor
2071 public static member functions.
2072
2073 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2074 @opindex Wnon-virtual-dtor
2075 @opindex Wno-non-virtual-dtor
2076 Warn when a class has virtual functions and accessible non-virtual
2077 destructor, in which case it would be possible but unsafe to delete
2078 an instance of a derived class through a pointer to the base class.
2079 This warning is also enabled if -Weffc++ is specified.
2080
2081 @item -Wreorder @r{(C++ and Objective-C++ only)}
2082 @opindex Wreorder
2083 @opindex Wno-reorder
2084 @cindex reordering, warning
2085 @cindex warning for reordering of member initializers
2086 Warn when the order of member initializers given in the code does not
2087 match the order in which they must be executed.  For instance:
2088
2089 @smallexample
2090 struct A @{
2091   int i;
2092   int j;
2093   A(): j (0), i (1) @{ @}
2094 @};
2095 @end smallexample
2096
2097 The compiler will rearrange the member initializers for @samp{i}
2098 and @samp{j} to match the declaration order of the members, emitting
2099 a warning to that effect.  This warning is enabled by @option{-Wall}.
2100 @end table
2101
2102 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2103
2104 @table @gcctabopt
2105 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2106 @opindex Weffc++
2107 @opindex Wno-effc++
2108 Warn about violations of the following style guidelines from Scott Meyers'
2109 @cite{Effective C++} book:
2110
2111 @itemize @bullet
2112 @item
2113 Item 11:  Define a copy constructor and an assignment operator for classes
2114 with dynamically allocated memory.
2115
2116 @item
2117 Item 12:  Prefer initialization to assignment in constructors.
2118
2119 @item
2120 Item 14:  Make destructors virtual in base classes.
2121
2122 @item
2123 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2124
2125 @item
2126 Item 23:  Don't try to return a reference when you must return an object.
2127
2128 @end itemize
2129
2130 Also warn about violations of the following style guidelines from
2131 Scott Meyers' @cite{More Effective C++} book:
2132
2133 @itemize @bullet
2134 @item
2135 Item 6:  Distinguish between prefix and postfix forms of increment and
2136 decrement operators.
2137
2138 @item
2139 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2140
2141 @end itemize
2142
2143 When selecting this option, be aware that the standard library
2144 headers do not obey all of these guidelines; use @samp{grep -v}
2145 to filter out those warnings.
2146
2147 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2148 @opindex Wstrict-null-sentinel
2149 @opindex Wno-strict-null-sentinel
2150 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2151 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2152 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2153 it is guaranteed to of the same size as a pointer.  But this use is
2154 not portable across different compilers.
2155
2156 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2157 @opindex Wno-non-template-friend
2158 @opindex Wnon-template-friend
2159 Disable warnings when non-templatized friend functions are declared
2160 within a template.  Since the advent of explicit template specification
2161 support in G++, if the name of the friend is an unqualified-id (i.e.,
2162 @samp{friend foo(int)}), the C++ language specification demands that the
2163 friend declare or define an ordinary, nontemplate function.  (Section
2164 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2165 could be interpreted as a particular specialization of a templatized
2166 function.  Because this non-conforming behavior is no longer the default
2167 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2168 check existing code for potential trouble spots and is on by default.
2169 This new compiler behavior can be turned off with
2170 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2171 but disables the helpful warning.
2172
2173 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2174 @opindex Wold-style-cast
2175 @opindex Wno-old-style-cast
2176 Warn if an old-style (C-style) cast to a non-void type is used within
2177 a C++ program.  The new-style casts (@samp{dynamic_cast},
2178 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2179 less vulnerable to unintended effects and much easier to search for.
2180
2181 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2182 @opindex Woverloaded-virtual
2183 @opindex Wno-overloaded-virtual
2184 @cindex overloaded virtual fn, warning
2185 @cindex warning for overloaded virtual fn
2186 Warn when a function declaration hides virtual functions from a
2187 base class.  For example, in:
2188
2189 @smallexample
2190 struct A @{
2191   virtual void f();
2192 @};
2193
2194 struct B: public A @{
2195   void f(int);
2196 @};
2197 @end smallexample
2198
2199 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2200 like:
2201
2202 @smallexample
2203 B* b;
2204 b->f();
2205 @end smallexample
2206
2207 will fail to compile.
2208
2209 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2210 @opindex Wno-pmf-conversions
2211 @opindex Wpmf-conversions
2212 Disable the diagnostic for converting a bound pointer to member function
2213 to a plain pointer.
2214
2215 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2216 @opindex Wsign-promo
2217 @opindex Wno-sign-promo
2218 Warn when overload resolution chooses a promotion from unsigned or
2219 enumerated type to a signed type, over a conversion to an unsigned type of
2220 the same size.  Previous versions of G++ would try to preserve
2221 unsignedness, but the standard mandates the current behavior.
2222
2223 @smallexample
2224 struct A @{
2225   operator int ();
2226   A& operator = (int);
2227 @};
2228
2229 main ()
2230 @{
2231   A a,b;
2232   a = b;
2233 @}
2234 @end smallexample
2235
2236 In this example, G++ will synthesize a default @samp{A& operator =
2237 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2238 @end table
2239
2240 @node Objective-C and Objective-C++ Dialect Options
2241 @section Options Controlling Objective-C and Objective-C++ Dialects
2242
2243 @cindex compiler options, Objective-C and Objective-C++
2244 @cindex Objective-C and Objective-C++ options, command line
2245 @cindex options, Objective-C and Objective-C++
2246 (NOTE: This manual does not describe the Objective-C and Objective-C++
2247 languages themselves.  See @xref{Standards,,Language Standards
2248 Supported by GCC}, for references.)
2249
2250 This section describes the command-line options that are only meaningful
2251 for Objective-C and Objective-C++ programs, but you can also use most of
2252 the language-independent GNU compiler options.
2253 For example, you might compile a file @code{some_class.m} like this:
2254
2255 @smallexample
2256 gcc -g -fgnu-runtime -O -c some_class.m
2257 @end smallexample
2258
2259 @noindent
2260 In this example, @option{-fgnu-runtime} is an option meant only for
2261 Objective-C and Objective-C++ programs; you can use the other options with
2262 any language supported by GCC@.
2263
2264 Note that since Objective-C is an extension of the C language, Objective-C
2265 compilations may also use options specific to the C front-end (e.g.,
2266 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2267 C++-specific options (e.g., @option{-Wabi}).
2268
2269 Here is a list of options that are @emph{only} for compiling Objective-C
2270 and Objective-C++ programs:
2271
2272 @table @gcctabopt
2273 @item -fconstant-string-class=@var{class-name}
2274 @opindex fconstant-string-class
2275 Use @var{class-name} as the name of the class to instantiate for each
2276 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2277 class name is @code{NXConstantString} if the GNU runtime is being used, and
2278 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2279 @option{-fconstant-cfstrings} option, if also present, will override the
2280 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2281 to be laid out as constant CoreFoundation strings.
2282
2283 @item -fgnu-runtime
2284 @opindex fgnu-runtime
2285 Generate object code compatible with the standard GNU Objective-C
2286 runtime.  This is the default for most types of systems.
2287
2288 @item -fnext-runtime
2289 @opindex fnext-runtime
2290 Generate output compatible with the NeXT runtime.  This is the default
2291 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2292 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2293 used.
2294
2295 @item -fno-nil-receivers
2296 @opindex fno-nil-receivers
2297 Assume that all Objective-C message dispatches (e.g.,
2298 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2299 is not @code{nil}.  This allows for more efficient entry points in the runtime
2300 to be used.  Currently, this option is only available in conjunction with
2301 the NeXT runtime on Mac OS X 10.3 and later.
2302
2303 @item -fobjc-call-cxx-cdtors
2304 @opindex fobjc-call-cxx-cdtors
2305 For each Objective-C class, check if any of its instance variables is a
2306 C++ object with a non-trivial default constructor.  If so, synthesize a
2307 special @code{- (id) .cxx_construct} instance method that will run
2308 non-trivial default constructors on any such instance variables, in order,
2309 and then return @code{self}.  Similarly, check if any instance variable
2310 is a C++ object with a non-trivial destructor, and if so, synthesize a
2311 special @code{- (void) .cxx_destruct} method that will run
2312 all such default destructors, in reverse order.
2313
2314 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2315 thusly generated will only operate on instance variables declared in the
2316 current Objective-C class, and not those inherited from superclasses.  It
2317 is the responsibility of the Objective-C runtime to invoke all such methods
2318 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2319 will be invoked by the runtime immediately after a new object
2320 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2321 be invoked immediately before the runtime deallocates an object instance.
2322
2323 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2324 support for invoking the @code{- (id) .cxx_construct} and
2325 @code{- (void) .cxx_destruct} methods.
2326
2327 @item -fobjc-direct-dispatch
2328 @opindex fobjc-direct-dispatch
2329 Allow fast jumps to the message dispatcher.  On Darwin this is
2330 accomplished via the comm page.
2331
2332 @item -fobjc-exceptions
2333 @opindex fobjc-exceptions
2334 Enable syntactic support for structured exception handling in Objective-C,
2335 similar to what is offered by C++ and Java.  This option is
2336 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2337 earlier.
2338
2339 @smallexample
2340   @@try @{
2341     @dots{}
2342        @@throw expr;
2343     @dots{}
2344   @}
2345   @@catch (AnObjCClass *exc) @{
2346     @dots{}
2347       @@throw expr;
2348     @dots{}
2349       @@throw;
2350     @dots{}
2351   @}
2352   @@catch (AnotherClass *exc) @{
2353     @dots{}
2354   @}
2355   @@catch (id allOthers) @{
2356     @dots{}
2357   @}
2358   @@finally @{
2359     @dots{}
2360       @@throw expr;
2361     @dots{}
2362   @}
2363 @end smallexample
2364
2365 The @code{@@throw} statement may appear anywhere in an Objective-C or
2366 Objective-C++ program; when used inside of a @code{@@catch} block, the
2367 @code{@@throw} may appear without an argument (as shown above), in which case
2368 the object caught by the @code{@@catch} will be rethrown.
2369
2370 Note that only (pointers to) Objective-C objects may be thrown and
2371 caught using this scheme.  When an object is thrown, it will be caught
2372 by the nearest @code{@@catch} clause capable of handling objects of that type,
2373 analogously to how @code{catch} blocks work in C++ and Java.  A
2374 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2375 any and all Objective-C exceptions not caught by previous @code{@@catch}
2376 clauses (if any).
2377
2378 The @code{@@finally} clause, if present, will be executed upon exit from the
2379 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2380 regardless of whether any exceptions are thrown, caught or rethrown
2381 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2382 of the @code{finally} clause in Java.
2383
2384 There are several caveats to using the new exception mechanism:
2385
2386 @itemize @bullet
2387 @item
2388 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2389 idioms provided by the @code{NSException} class, the new
2390 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2391 systems, due to additional functionality needed in the (NeXT) Objective-C
2392 runtime.
2393
2394 @item
2395 As mentioned above, the new exceptions do not support handling
2396 types other than Objective-C objects.   Furthermore, when used from
2397 Objective-C++, the Objective-C exception model does not interoperate with C++
2398 exceptions at this time.  This means you cannot @code{@@throw} an exception
2399 from Objective-C and @code{catch} it in C++, or vice versa
2400 (i.e., @code{throw @dots{} @@catch}).
2401 @end itemize
2402
2403 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2404 blocks for thread-safe execution:
2405
2406 @smallexample
2407   @@synchronized (ObjCClass *guard) @{
2408     @dots{}
2409   @}
2410 @end smallexample
2411
2412 Upon entering the @code{@@synchronized} block, a thread of execution shall
2413 first check whether a lock has been placed on the corresponding @code{guard}
2414 object by another thread.  If it has, the current thread shall wait until
2415 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2416 the current thread will place its own lock on it, execute the code contained in
2417 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2418 making @code{guard} available to other threads).
2419
2420 Unlike Java, Objective-C does not allow for entire methods to be marked
2421 @code{@@synchronized}.  Note that throwing exceptions out of
2422 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2423 to be unlocked properly.
2424
2425 @item -fobjc-gc
2426 @opindex fobjc-gc
2427 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2428
2429 @item -freplace-objc-classes
2430 @opindex freplace-objc-classes
2431 Emit a special marker instructing @command{ld(1)} not to statically link in
2432 the resulting object file, and allow @command{dyld(1)} to load it in at
2433 run time instead.  This is used in conjunction with the Fix-and-Continue
2434 debugging mode, where the object file in question may be recompiled and
2435 dynamically reloaded in the course of program execution, without the need
2436 to restart the program itself.  Currently, Fix-and-Continue functionality
2437 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2438 and later.
2439
2440 @item -fzero-link
2441 @opindex fzero-link
2442 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2443 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2444 compile time) with static class references that get initialized at load time,
2445 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2446 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2447 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2448 for individual class implementations to be modified during program execution.
2449
2450 @item -gen-decls
2451 @opindex gen-decls
2452 Dump interface declarations for all classes seen in the source file to a
2453 file named @file{@var{sourcename}.decl}.
2454
2455 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2456 @opindex Wassign-intercept
2457 @opindex Wno-assign-intercept
2458 Warn whenever an Objective-C assignment is being intercepted by the
2459 garbage collector.
2460
2461 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2462 @opindex Wno-protocol
2463 @opindex Wprotocol
2464 If a class is declared to implement a protocol, a warning is issued for
2465 every method in the protocol that is not implemented by the class.  The
2466 default behavior is to issue a warning for every method not explicitly
2467 implemented in the class, even if a method implementation is inherited
2468 from the superclass.  If you use the @option{-Wno-protocol} option, then
2469 methods inherited from the superclass are considered to be implemented,
2470 and no warning is issued for them.
2471
2472 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2473 @opindex Wselector
2474 @opindex Wno-selector
2475 Warn if multiple methods of different types for the same selector are
2476 found during compilation.  The check is performed on the list of methods
2477 in the final stage of compilation.  Additionally, a check is performed
2478 for each selector appearing in a @code{@@selector(@dots{})}
2479 expression, and a corresponding method for that selector has been found
2480 during compilation.  Because these checks scan the method table only at
2481 the end of compilation, these warnings are not produced if the final
2482 stage of compilation is not reached, for example because an error is
2483 found during compilation, or because the @option{-fsyntax-only} option is
2484 being used.
2485
2486 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2487 @opindex Wstrict-selector-match
2488 @opindex Wno-strict-selector-match
2489 Warn if multiple methods with differing argument and/or return types are
2490 found for a given selector when attempting to send a message using this
2491 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2492 is off (which is the default behavior), the compiler will omit such warnings
2493 if any differences found are confined to types which share the same size
2494 and alignment.
2495
2496 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2497 @opindex Wundeclared-selector
2498 @opindex Wno-undeclared-selector
2499 Warn if a @code{@@selector(@dots{})} expression referring to an
2500 undeclared selector is found.  A selector is considered undeclared if no
2501 method with that name has been declared before the
2502 @code{@@selector(@dots{})} expression, either explicitly in an
2503 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2504 an @code{@@implementation} section.  This option always performs its
2505 checks as soon as a @code{@@selector(@dots{})} expression is found,
2506 while @option{-Wselector} only performs its checks in the final stage of
2507 compilation.  This also enforces the coding style convention
2508 that methods and selectors must be declared before being used.
2509
2510 @item -print-objc-runtime-info
2511 @opindex print-objc-runtime-info
2512 Generate C header describing the largest structure that is passed by
2513 value, if any.
2514
2515 @end table
2516
2517 @node Language Independent Options
2518 @section Options to Control Diagnostic Messages Formatting
2519 @cindex options to control diagnostics formatting
2520 @cindex diagnostic messages
2521 @cindex message formatting
2522
2523 Traditionally, diagnostic messages have been formatted irrespective of
2524 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2525 below can be used to control the diagnostic messages formatting
2526 algorithm, e.g.@: how many characters per line, how often source location
2527 information should be reported.  Right now, only the C++ front end can
2528 honor these options.  However it is expected, in the near future, that
2529 the remaining front ends would be able to digest them correctly.
2530
2531 @table @gcctabopt
2532 @item -fmessage-length=@var{n}
2533 @opindex fmessage-length
2534 Try to format error messages so that they fit on lines of about @var{n}
2535 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2536 the front ends supported by GCC@.  If @var{n} is zero, then no
2537 line-wrapping will be done; each error message will appear on a single
2538 line.
2539
2540 @opindex fdiagnostics-show-location
2541 @item -fdiagnostics-show-location=once
2542 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2543 reporter to emit @emph{once} source location information; that is, in
2544 case the message is too long to fit on a single physical line and has to
2545 be wrapped, the source location won't be emitted (as prefix) again,
2546 over and over, in subsequent continuation lines.  This is the default
2547 behavior.
2548
2549 @item -fdiagnostics-show-location=every-line
2550 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2551 messages reporter to emit the same source location information (as
2552 prefix) for physical lines that result from the process of breaking
2553 a message which is too long to fit on a single line.
2554
2555 @item -fdiagnostics-show-option
2556 @opindex fdiagnostics-show-option
2557 This option instructs the diagnostic machinery to add text to each
2558 diagnostic emitted, which indicates which command line option directly
2559 controls that diagnostic, when such an option is known to the
2560 diagnostic machinery.
2561
2562 @item -Wcoverage-mismatch
2563 @opindex Wcoverage-mismatch
2564 Warn if feedback profiles do not match when using the
2565 @option{-fprofile-use} option.
2566 If a source file was changed between @option{-fprofile-gen} and
2567 @option{-fprofile-use}, the files with the profile feedback can fail
2568 to match the source file and GCC can not use the profile feedback
2569 information.  By default, GCC emits an error message in this case.
2570 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2571 error.  GCC does not use appropriate feedback profiles, so using this
2572 option can result in poorly optimized code.  This option is useful
2573 only in the case of very minor changes such as bug fixes to an
2574 existing code-base.
2575
2576 @end table
2577
2578 @node Warning Options
2579 @section Options to Request or Suppress Warnings
2580 @cindex options to control warnings
2581 @cindex warning messages
2582 @cindex messages, warning
2583 @cindex suppressing warnings
2584
2585 Warnings are diagnostic messages that report constructions which
2586 are not inherently erroneous but which are risky or suggest there
2587 may have been an error.
2588
2589 The following language-independent options do not enable specific
2590 warnings but control the kinds of diagnostics produced by GCC.
2591
2592 @table @gcctabopt
2593 @cindex syntax checking
2594 @item -fsyntax-only
2595 @opindex fsyntax-only
2596 Check the code for syntax errors, but don't do anything beyond that.
2597
2598 @item -w
2599 @opindex w
2600 Inhibit all warning messages.
2601
2602 @item -Werror
2603 @opindex Werror
2604 @opindex Wno-error
2605 Make all warnings into errors.
2606
2607 @item -Werror=
2608 @opindex Werror=
2609 @opindex Wno-error=
2610 Make the specified warning into an error.  The specifier for a warning
2611 is appended, for example @option{-Werror=switch} turns the warnings
2612 controlled by @option{-Wswitch} into errors.  This switch takes a
2613 negative form, to be used to negate @option{-Werror} for specific
2614 warnings, for example @option{-Wno-error=switch} makes
2615 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2616 is in effect.  You can use the @option{-fdiagnostics-show-option}
2617 option to have each controllable warning amended with the option which
2618 controls it, to determine what to use with this option.
2619
2620 Note that specifying @option{-Werror=}@var{foo} automatically implies
2621 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2622 imply anything.
2623
2624 @item -Wfatal-errors
2625 @opindex Wfatal-errors
2626 @opindex Wno-fatal-errors
2627 This option causes the compiler to abort compilation on the first error
2628 occurred rather than trying to keep going and printing further error
2629 messages.
2630
2631 @end table
2632
2633 You can request many specific warnings with options beginning
2634 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2635 implicit declarations.  Each of these specific warning options also
2636 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2637 example, @option{-Wno-implicit}.  This manual lists only one of the
2638 two forms, whichever is not the default.  For further,
2639 language-specific options also refer to @ref{C++ Dialect Options} and
2640 @ref{Objective-C and Objective-C++ Dialect Options}.
2641
2642 @table @gcctabopt
2643 @item -pedantic
2644 @opindex pedantic
2645 Issue all the warnings demanded by strict ISO C and ISO C++;
2646 reject all programs that use forbidden extensions, and some other
2647 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2648 version of the ISO C standard specified by any @option{-std} option used.
2649
2650 Valid ISO C and ISO C++ programs should compile properly with or without
2651 this option (though a rare few will require @option{-ansi} or a
2652 @option{-std} option specifying the required version of ISO C)@.  However,
2653 without this option, certain GNU extensions and traditional C and C++
2654 features are supported as well.  With this option, they are rejected.
2655
2656 @option{-pedantic} does not cause warning messages for use of the
2657 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2658 warnings are also disabled in the expression that follows
2659 @code{__extension__}.  However, only system header files should use
2660 these escape routes; application programs should avoid them.
2661 @xref{Alternate Keywords}.
2662
2663 Some users try to use @option{-pedantic} to check programs for strict ISO
2664 C conformance.  They soon find that it does not do quite what they want:
2665 it finds some non-ISO practices, but not all---only those for which
2666 ISO C @emph{requires} a diagnostic, and some others for which
2667 diagnostics have been added.
2668
2669 A feature to report any failure to conform to ISO C might be useful in
2670 some instances, but would require considerable additional work and would
2671 be quite different from @option{-pedantic}.  We don't have plans to
2672 support such a feature in the near future.
2673
2674 Where the standard specified with @option{-std} represents a GNU
2675 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2676 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2677 extended dialect is based.  Warnings from @option{-pedantic} are given
2678 where they are required by the base standard.  (It would not make sense
2679 for such warnings to be given only for features not in the specified GNU
2680 C dialect, since by definition the GNU dialects of C include all
2681 features the compiler supports with the given option, and there would be
2682 nothing to warn about.)
2683
2684 @item -pedantic-errors
2685 @opindex pedantic-errors
2686 Like @option{-pedantic}, except that errors are produced rather than
2687 warnings.
2688
2689 @item -Wall
2690 @opindex Wall
2691 @opindex Wno-all
2692 This enables all the warnings about constructions that some users
2693 consider questionable, and that are easy to avoid (or modify to
2694 prevent the warning), even in conjunction with macros.  This also
2695 enables some language-specific warnings described in @ref{C++ Dialect
2696 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2697
2698 @option{-Wall} turns on the following warning flags:
2699
2700 @gccoptlist{-Waddress   @gol
2701 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2702 -Wc++0x-compat  @gol
2703 -Wchar-subscripts  @gol
2704 -Wimplicit-int  @gol
2705 -Wimplicit-function-declaration  @gol
2706 -Wcomment  @gol
2707 -Wformat   @gol
2708 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2709 -Wmissing-braces  @gol
2710 -Wnonnull  @gol
2711 -Wparentheses  @gol
2712 -Wpointer-sign  @gol
2713 -Wreorder   @gol
2714 -Wreturn-type  @gol
2715 -Wsequence-point  @gol
2716 -Wsign-compare @r{(only in C++)}  @gol
2717 -Wstrict-aliasing  @gol
2718 -Wstrict-overflow=1  @gol
2719 -Wswitch  @gol
2720 -Wtrigraphs  @gol
2721 -Wuninitialized  @gol
2722 -Wunknown-pragmas  @gol
2723 -Wunused-function  @gol
2724 -Wunused-label     @gol
2725 -Wunused-value     @gol
2726 -Wunused-variable  @gol
2727 -Wvolatile-register-var @gol
2728 }
2729
2730 Note that some warning flags are not implied by @option{-Wall}.  Some of
2731 them warn about constructions that users generally do not consider
2732 questionable, but which occasionally you might wish to check for;
2733 others warn about constructions that are necessary or hard to avoid in
2734 some cases, and there is no simple way to modify the code to suppress
2735 the warning. Some of them are enabled by @option{-Wextra} but many of
2736 them must be enabled individually.
2737
2738 @item -Wextra
2739 @opindex W
2740 @opindex Wextra
2741 @opindex Wno-extra
2742 This enables some extra warning flags that are not enabled by
2743 @option{-Wall}. (This option used to be called @option{-W}.  The older
2744 name is still supported, but the newer name is more descriptive.)
2745
2746 @gccoptlist{-Wclobbered  @gol
2747 -Wempty-body  @gol
2748 -Wignored-qualifiers @gol
2749 -Wmissing-field-initializers  @gol
2750 -Wmissing-parameter-type @r{(C only)}  @gol
2751 -Wold-style-declaration @r{(C only)}  @gol
2752 -Woverride-init  @gol
2753 -Wsign-compare  @gol
2754 -Wtype-limits  @gol
2755 -Wuninitialized  @gol
2756 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2757 }
2758
2759 The option @option{-Wextra} also prints warning messages for the
2760 following cases:
2761
2762 @itemize @bullet
2763
2764 @item
2765 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2766 @samp{>}, or @samp{>=}.
2767
2768 @item 
2769 (C++ only) An enumerator and a non-enumerator both appear in a
2770 conditional expression.
2771
2772 @item 
2773 (C++ only) Ambiguous virtual bases.
2774
2775 @item 
2776 (C++ only) Subscripting an array which has been declared @samp{register}.
2777
2778 @item 
2779 (C++ only) Taking the address of a variable which has been declared
2780 @samp{register}.
2781
2782 @item 
2783 (C++ only) A base class is not initialized in a derived class' copy
2784 constructor.
2785
2786 @end itemize
2787
2788 @item -Wchar-subscripts
2789 @opindex Wchar-subscripts
2790 @opindex Wno-char-subscripts
2791 Warn if an array subscript has type @code{char}.  This is a common cause
2792 of error, as programmers often forget that this type is signed on some
2793 machines.
2794 This warning is enabled by @option{-Wall}.
2795
2796 @item -Wcomment
2797 @opindex Wcomment
2798 @opindex Wno-comment
2799 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2800 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2801 This warning is enabled by @option{-Wall}.
2802
2803 @item -Wformat
2804 @opindex Wformat
2805 @opindex Wno-format
2806 @opindex ffreestanding
2807 @opindex fno-builtin
2808 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2809 the arguments supplied have types appropriate to the format string
2810 specified, and that the conversions specified in the format string make
2811 sense.  This includes standard functions, and others specified by format
2812 attributes (@pxref{Function Attributes}), in the @code{printf},
2813 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2814 not in the C standard) families (or other target-specific families).
2815 Which functions are checked without format attributes having been
2816 specified depends on the standard version selected, and such checks of
2817 functions without the attribute specified are disabled by
2818 @option{-ffreestanding} or @option{-fno-builtin}.
2819
2820 The formats are checked against the format features supported by GNU
2821 libc version 2.2.  These include all ISO C90 and C99 features, as well
2822 as features from the Single Unix Specification and some BSD and GNU
2823 extensions.  Other library implementations may not support all these
2824 features; GCC does not support warning about features that go beyond a
2825 particular library's limitations.  However, if @option{-pedantic} is used
2826 with @option{-Wformat}, warnings will be given about format features not
2827 in the selected standard version (but not for @code{strfmon} formats,
2828 since those are not in any version of the C standard).  @xref{C Dialect
2829 Options,,Options Controlling C Dialect}.
2830
2831 Since @option{-Wformat} also checks for null format arguments for
2832 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2833
2834 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2835 aspects of format checking, the options @option{-Wformat-y2k},
2836 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2837 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2838 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2839
2840 @item -Wformat-y2k
2841 @opindex Wformat-y2k
2842 @opindex Wno-format-y2k
2843 If @option{-Wformat} is specified, also warn about @code{strftime}
2844 formats which may yield only a two-digit year.
2845
2846 @item -Wno-format-contains-nul
2847 @opindex Wno-format-contains-nul
2848 @opindex Wformat-contains-nul
2849 If @option{-Wformat} is specified, do not warn about format strings that
2850 contain NUL bytes.
2851
2852 @item -Wno-format-extra-args
2853 @opindex Wno-format-extra-args
2854 @opindex Wformat-extra-args
2855 If @option{-Wformat} is specified, do not warn about excess arguments to a
2856 @code{printf} or @code{scanf} format function.  The C standard specifies
2857 that such arguments are ignored.
2858
2859 Where the unused arguments lie between used arguments that are
2860 specified with @samp{$} operand number specifications, normally
2861 warnings are still given, since the implementation could not know what
2862 type to pass to @code{va_arg} to skip the unused arguments.  However,
2863 in the case of @code{scanf} formats, this option will suppress the
2864 warning if the unused arguments are all pointers, since the Single
2865 Unix Specification says that such unused arguments are allowed.
2866
2867 @item -Wno-format-zero-length @r{(C and Objective-C only)}
2868 @opindex Wno-format-zero-length
2869 @opindex Wformat-zero-length
2870 If @option{-Wformat} is specified, do not warn about zero-length formats.
2871 The C standard specifies that zero-length formats are allowed.
2872
2873 @item -Wformat-nonliteral
2874 @opindex Wformat-nonliteral
2875 @opindex Wno-format-nonliteral
2876 If @option{-Wformat} is specified, also warn if the format string is not a
2877 string literal and so cannot be checked, unless the format function
2878 takes its format arguments as a @code{va_list}.
2879
2880 @item -Wformat-security
2881 @opindex Wformat-security
2882 @opindex Wno-format-security
2883 If @option{-Wformat} is specified, also warn about uses of format
2884 functions that represent possible security problems.  At present, this
2885 warns about calls to @code{printf} and @code{scanf} functions where the
2886 format string is not a string literal and there are no format arguments,
2887 as in @code{printf (foo);}.  This may be a security hole if the format
2888 string came from untrusted input and contains @samp{%n}.  (This is
2889 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2890 in future warnings may be added to @option{-Wformat-security} that are not
2891 included in @option{-Wformat-nonliteral}.)
2892
2893 @item -Wformat=2
2894 @opindex Wformat=2
2895 @opindex Wno-format=2
2896 Enable @option{-Wformat} plus format checks not included in
2897 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2898 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2899
2900 @item -Wnonnull @r{(C and Objective-C only)}
2901 @opindex Wnonnull
2902 @opindex Wno-nonnull
2903 Warn about passing a null pointer for arguments marked as
2904 requiring a non-null value by the @code{nonnull} function attribute.
2905
2906 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2907 can be disabled with the @option{-Wno-nonnull} option.
2908
2909 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2910 @opindex Winit-self
2911 @opindex Wno-init-self
2912 Warn about uninitialized variables which are initialized with themselves.
2913 Note this option can only be used with the @option{-Wuninitialized} option.
2914
2915 For example, GCC will warn about @code{i} being uninitialized in the
2916 following snippet only when @option{-Winit-self} has been specified:
2917 @smallexample
2918 @group
2919 int f()
2920 @{
2921   int i = i;
2922   return i;
2923 @}
2924 @end group
2925 @end smallexample
2926
2927 @item -Wimplicit-int @r{(C and Objective-C only)}
2928 @opindex Wimplicit-int
2929 @opindex Wno-implicit-int
2930 Warn when a declaration does not specify a type.
2931 This warning is enabled by @option{-Wall}.
2932
2933 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
2934 @opindex Wimplicit-function-declaration
2935 @opindex Wno-implicit-function-declaration
2936 Give a warning whenever a function is used before being declared. In
2937 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
2938 enabled by default and it is made into an error by
2939 @option{-pedantic-errors}. This warning is also enabled by
2940 @option{-Wall}.
2941
2942 @item -Wimplicit
2943 @opindex Wimplicit
2944 @opindex Wno-implicit
2945 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2946 This warning is enabled by @option{-Wall}.
2947
2948 @item -Wignored-qualifiers @r{(C and C++ only)}
2949 @opindex Wignored-qualifiers
2950 @opindex Wno-ignored-qualifiers
2951 Warn if the return type of a function has a type qualifier
2952 such as @code{const}.  For ISO C such a type qualifier has no effect,
2953 since the value returned by a function is not an lvalue.
2954 For C++, the warning is only emitted for scalar types or @code{void}.
2955 ISO C prohibits qualified @code{void} return types on function
2956 definitions, so such return types always receive a warning
2957 even without this option.
2958
2959 This warning is also enabled by @option{-Wextra}.
2960
2961 @item -Wmain
2962 @opindex Wmain
2963 @opindex Wno-main
2964 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
2965 a function with external linkage, returning int, taking either zero
2966 arguments, two, or three arguments of appropriate types.  This warning
2967 is enabled by default in C++ and is enabled by either @option{-Wall}
2968 or @option{-pedantic}.
2969
2970 @item -Wmissing-braces
2971 @opindex Wmissing-braces
2972 @opindex Wno-missing-braces
2973 Warn if an aggregate or union initializer is not fully bracketed.  In
2974 the following example, the initializer for @samp{a} is not fully
2975 bracketed, but that for @samp{b} is fully bracketed.
2976
2977 @smallexample
2978 int a[2][2] = @{ 0, 1, 2, 3 @};
2979 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2980 @end smallexample
2981
2982 This warning is enabled by @option{-Wall}.
2983
2984 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2985 @opindex Wmissing-include-dirs
2986 @opindex Wno-missing-include-dirs
2987 Warn if a user-supplied include directory does not exist.
2988
2989 @item -Wparentheses
2990 @opindex Wparentheses
2991 @opindex Wno-parentheses
2992 Warn if parentheses are omitted in certain contexts, such
2993 as when there is an assignment in a context where a truth value
2994 is expected, or when operators are nested whose precedence people
2995 often get confused about.
2996
2997 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2998 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2999 interpretation from that of ordinary mathematical notation.
3000
3001 Also warn about constructions where there may be confusion to which
3002 @code{if} statement an @code{else} branch belongs.  Here is an example of
3003 such a case:
3004
3005 @smallexample
3006 @group
3007 @{
3008   if (a)
3009     if (b)
3010       foo ();
3011   else
3012     bar ();
3013 @}
3014 @end group
3015 @end smallexample
3016
3017 In C/C++, every @code{else} branch belongs to the innermost possible
3018 @code{if} statement, which in this example is @code{if (b)}.  This is
3019 often not what the programmer expected, as illustrated in the above
3020 example by indentation the programmer chose.  When there is the
3021 potential for this confusion, GCC will issue a warning when this flag
3022 is specified.  To eliminate the warning, add explicit braces around
3023 the innermost @code{if} statement so there is no way the @code{else}
3024 could belong to the enclosing @code{if}.  The resulting code would
3025 look like this:
3026
3027 @smallexample
3028 @group
3029 @{
3030   if (a)
3031     @{
3032       if (b)
3033         foo ();
3034       else
3035         bar ();
3036     @}
3037 @}
3038 @end group
3039 @end smallexample
3040
3041 This warning is enabled by @option{-Wall}.
3042
3043 @item -Wsequence-point
3044 @opindex Wsequence-point
3045 @opindex Wno-sequence-point
3046 Warn about code that may have undefined semantics because of violations
3047 of sequence point rules in the C and C++ standards.
3048
3049 The C and C++ standards defines the order in which expressions in a C/C++
3050 program are evaluated in terms of @dfn{sequence points}, which represent
3051 a partial ordering between the execution of parts of the program: those
3052 executed before the sequence point, and those executed after it.  These
3053 occur after the evaluation of a full expression (one which is not part
3054 of a larger expression), after the evaluation of the first operand of a
3055 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3056 function is called (but after the evaluation of its arguments and the
3057 expression denoting the called function), and in certain other places.
3058 Other than as expressed by the sequence point rules, the order of
3059 evaluation of subexpressions of an expression is not specified.  All
3060 these rules describe only a partial order rather than a total order,
3061 since, for example, if two functions are called within one expression
3062 with no sequence point between them, the order in which the functions
3063 are called is not specified.  However, the standards committee have
3064 ruled that function calls do not overlap.
3065
3066 It is not specified when between sequence points modifications to the
3067 values of objects take effect.  Programs whose behavior depends on this
3068 have undefined behavior; the C and C++ standards specify that ``Between
3069 the previous and next sequence point an object shall have its stored
3070 value modified at most once by the evaluation of an expression.
3071 Furthermore, the prior value shall be read only to determine the value
3072 to be stored.''.  If a program breaks these rules, the results on any
3073 particular implementation are entirely unpredictable.
3074
3075 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3076 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3077 diagnosed by this option, and it may give an occasional false positive
3078 result, but in general it has been found fairly effective at detecting
3079 this sort of problem in programs.
3080
3081 The standard is worded confusingly, therefore there is some debate
3082 over the precise meaning of the sequence point rules in subtle cases.
3083 Links to discussions of the problem, including proposed formal
3084 definitions, may be found on the GCC readings page, at
3085 @w{@uref{http://gcc.gnu.org/readings.html}}.
3086
3087 This warning is enabled by @option{-Wall} for C and C++.
3088
3089 @item -Wreturn-type
3090 @opindex Wreturn-type
3091 @opindex Wno-return-type
3092 Warn whenever a function is defined with a return-type that defaults
3093 to @code{int}.  Also warn about any @code{return} statement with no
3094 return-value in a function whose return-type is not @code{void}
3095 (falling off the end of the function body is considered returning
3096 without a value), and about a @code{return} statement with a
3097 expression in a function whose return-type is @code{void}.
3098
3099 For C++, a function without return type always produces a diagnostic
3100 message, even when @option{-Wno-return-type} is specified.  The only
3101 exceptions are @samp{main} and functions defined in system headers.
3102
3103 This warning is enabled by @option{-Wall}.
3104
3105 @item -Wswitch
3106 @opindex Wswitch
3107 @opindex Wno-switch
3108 Warn whenever a @code{switch} statement has an index of enumerated type
3109 and lacks a @code{case} for one or more of the named codes of that
3110 enumeration.  (The presence of a @code{default} label prevents this
3111 warning.)  @code{case} labels outside the enumeration range also
3112 provoke warnings when this option is used.
3113 This warning is enabled by @option{-Wall}.
3114
3115 @item -Wswitch-default
3116 @opindex Wswitch-default
3117 @opindex Wno-switch-default
3118 Warn whenever a @code{switch} statement does not have a @code{default}
3119 case.
3120
3121 @item -Wswitch-enum
3122 @opindex Wswitch-enum
3123 @opindex Wno-switch-enum
3124 Warn whenever a @code{switch} statement has an index of enumerated type
3125 and lacks a @code{case} for one or more of the named codes of that
3126 enumeration.  @code{case} labels outside the enumeration range also
3127 provoke warnings when this option is used.
3128
3129 @item -Wtrigraphs
3130 @opindex Wtrigraphs
3131 @opindex Wno-trigraphs
3132 Warn if any trigraphs are encountered that might change the meaning of
3133 the program (trigraphs within comments are not warned about).
3134 This warning is enabled by @option{-Wall}.
3135
3136 @item -Wunused-function
3137 @opindex Wunused-function
3138 @opindex Wno-unused-function
3139 Warn whenever a static function is declared but not defined or a
3140 non-inline static function is unused.
3141 This warning is enabled by @option{-Wall}.
3142
3143 @item -Wunused-label
3144 @opindex Wunused-label
3145 @opindex Wno-unused-label
3146 Warn whenever a label is declared but not used.
3147 This warning is enabled by @option{-Wall}.
3148
3149 To suppress this warning use the @samp{unused} attribute
3150 (@pxref{Variable Attributes}).
3151
3152 @item -Wunused-parameter
3153 @opindex Wunused-parameter
3154 @opindex Wno-unused-parameter
3155 Warn whenever a function parameter is unused aside from its declaration.
3156
3157 To suppress this warning use the @samp{unused} attribute
3158 (@pxref{Variable Attributes}).
3159
3160 @item -Wunused-variable
3161 @opindex Wunused-variable
3162 @opindex Wno-unused-variable
3163 Warn whenever a local variable or non-constant static variable is unused
3164 aside from its declaration.
3165 This warning is enabled by @option{-Wall}.
3166
3167 To suppress this warning use the @samp{unused} attribute
3168 (@pxref{Variable Attributes}).
3169
3170 @item -Wunused-value
3171 @opindex Wunused-value
3172 @opindex Wno-unused-value
3173 Warn whenever a statement computes a result that is explicitly not
3174 used. To suppress this warning cast the unused expression to
3175 @samp{void}. This includes an expression-statement or the left-hand
3176 side of a comma expression that contains no side effects. For example,
3177 an expression such as @samp{x[i,j]} will cause a warning, while
3178 @samp{x[(void)i,j]} will not.
3179
3180 This warning is enabled by @option{-Wall}.
3181
3182 @item -Wunused
3183 @opindex Wunused
3184 @opindex Wno-unused
3185 All the above @option{-Wunused} options combined.
3186
3187 In order to get a warning about an unused function parameter, you must
3188 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3189 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3190
3191 @item -Wuninitialized
3192 @opindex Wuninitialized
3193 @opindex Wno-uninitialized
3194 Warn if an automatic variable is used without first being initialized
3195 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3196 warn if a non-static reference or non-static @samp{const} member
3197 appears in a class without constructors.
3198
3199 If you want to warn about code which uses the uninitialized value of the
3200 variable in its own initializer, use the @option{-Winit-self} option.
3201
3202 These warnings occur for individual uninitialized or clobbered
3203 elements of structure, union or array variables as well as for
3204 variables which are uninitialized or clobbered as a whole.  They do
3205 not occur for variables or elements declared @code{volatile}.  Because
3206 these warnings depend on optimization, the exact variables or elements
3207 for which there are warnings will depend on the precise optimization
3208 options and version of GCC used.
3209
3210 Note that there may be no warning about a variable that is used only
3211 to compute a value that itself is never used, because such
3212 computations may be deleted by data flow analysis before the warnings
3213 are printed.
3214
3215 These warnings are made optional because GCC is not smart
3216 enough to see all the reasons why the code might be correct
3217 despite appearing to have an error.  Here is one example of how
3218 this can happen:
3219
3220 @smallexample
3221 @group
3222 @{
3223   int x;
3224   switch (y)
3225     @{
3226     case 1: x = 1;
3227       break;
3228     case 2: x = 4;
3229       break;
3230     case 3: x = 5;
3231     @}
3232   foo (x);
3233 @}
3234 @end group
3235 @end smallexample
3236
3237 @noindent
3238 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3239 always initialized, but GCC doesn't know this.  Here is
3240 another common case:
3241
3242 @smallexample
3243 @{
3244   int save_y;
3245   if (change_y) save_y = y, y = new_y;
3246   @dots{}
3247   if (change_y) y = save_y;
3248 @}
3249 @end smallexample
3250
3251 @noindent
3252 This has no bug because @code{save_y} is used only if it is set.
3253
3254 @cindex @code{longjmp} warnings
3255 This option also warns when a non-volatile automatic variable might be
3256 changed by a call to @code{longjmp}.  These warnings as well are possible
3257 only in optimizing compilation.
3258
3259 The compiler sees only the calls to @code{setjmp}.  It cannot know
3260 where @code{longjmp} will be called; in fact, a signal handler could
3261 call it at any point in the code.  As a result, you may get a warning
3262 even when there is in fact no problem because @code{longjmp} cannot
3263 in fact be called at the place which would cause a problem.
3264
3265 Some spurious warnings can be avoided if you declare all the functions
3266 you use that never return as @code{noreturn}.  @xref{Function
3267 Attributes}.
3268
3269 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3270
3271 @item -Wunknown-pragmas
3272 @opindex Wunknown-pragmas
3273 @opindex Wno-unknown-pragmas
3274 @cindex warning for unknown pragmas
3275 @cindex unknown pragmas, warning
3276 @cindex pragmas, warning of unknown
3277 Warn when a #pragma directive is encountered which is not understood by
3278 GCC@.  If this command line option is used, warnings will even be issued
3279 for unknown pragmas in system header files.  This is not the case if
3280 the warnings were only enabled by the @option{-Wall} command line option.
3281
3282 @item -Wno-pragmas
3283 @opindex Wno-pragmas
3284 @opindex Wpragmas
3285 Do not warn about misuses of pragmas, such as incorrect parameters,
3286 invalid syntax, or conflicts between pragmas.  See also
3287 @samp{-Wunknown-pragmas}.
3288
3289 @item -Wstrict-aliasing
3290 @opindex Wstrict-aliasing
3291 @opindex Wno-strict-aliasing
3292 This option is only active when @option{-fstrict-aliasing} is active.
3293 It warns about code which might break the strict aliasing rules that the
3294 compiler is using for optimization.  The warning does not catch all
3295 cases, but does attempt to catch the more common pitfalls.  It is
3296 included in @option{-Wall}.
3297 It is equivalent to @option{-Wstrict-aliasing=3}
3298
3299 @item -Wstrict-aliasing=n
3300 @opindex Wstrict-aliasing=n
3301 @opindex Wno-strict-aliasing=n
3302 This option is only active when @option{-fstrict-aliasing} is active.
3303 It warns about code which might break the strict aliasing rules that the
3304 compiler is using for optimization.
3305 Higher levels correspond to higher accuracy (fewer false positives).
3306 Higher levels also correspond to more effort, similar to the way -O works.
3307 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3308 with n=3.
3309
3310 Level 1: Most aggressive, quick, least accurate.
3311 Possibly useful when higher levels
3312 do not warn but -fstrict-aliasing still breaks the code, as it has very few 
3313 false negatives.  However, it has many false positives.
3314 Warns for all pointer conversions between possibly incompatible types, 
3315 even if never dereferenced.  Runs in the frontend only.
3316
3317 Level 2: Aggressive, quick, not too precise.
3318 May still have many false positives (not as many as level 1 though),
3319 and few false negatives (but possibly more than level 1).
3320 Unlike level 1, it only warns when an address is taken.  Warns about
3321 incomplete types.  Runs in the frontend only.
3322
3323 Level 3 (default for @option{-Wstrict-aliasing}): 
3324 Should have very few false positives and few false 
3325 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3326 Takes care of the common punn+dereference pattern in the frontend:
3327 @code{*(int*)&some_float}.
3328 If optimization is enabled, it also runs in the backend, where it deals 
3329 with multiple statement cases using flow-sensitive points-to information.
3330 Only warns when the converted pointer is dereferenced.
3331 Does not warn about incomplete types.
3332
3333 @item -Wstrict-overflow
3334 @itemx -Wstrict-overflow=@var{n}
3335 @opindex Wstrict-overflow
3336 @opindex Wno-strict-overflow
3337 This option is only active when @option{-fstrict-overflow} is active.
3338 It warns about cases where the compiler optimizes based on the
3339 assumption that signed overflow does not occur.  Note that it does not
3340 warn about all cases where the code might overflow: it only warns
3341 about cases where the compiler implements some optimization.  Thus
3342 this warning depends on the optimization level.
3343
3344 An optimization which assumes that signed overflow does not occur is
3345 perfectly safe if the values of the variables involved are such that
3346 overflow never does, in fact, occur.  Therefore this warning can
3347 easily give a false positive: a warning about code which is not
3348 actually a problem.  To help focus on important issues, several
3349 warning levels are defined.  No warnings are issued for the use of
3350 undefined signed overflow when estimating how many iterations a loop
3351 will require, in particular when determining whether a loop will be
3352 executed at all.
3353
3354 @table @gcctabopt
3355 @item -Wstrict-overflow=1
3356 Warn about cases which are both questionable and easy to avoid.  For
3357 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3358 compiler will simplify this to @code{1}.  This level of
3359 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3360 are not, and must be explicitly requested.
3361
3362 @item -Wstrict-overflow=2
3363 Also warn about other cases where a comparison is simplified to a
3364 constant.  For example: @code{abs (x) >= 0}.  This can only be
3365 simplified when @option{-fstrict-overflow} is in effect, because
3366 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3367 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3368 @option{-Wstrict-overflow=2}.
3369
3370 @item -Wstrict-overflow=3
3371 Also warn about other cases where a comparison is simplified.  For
3372 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3373
3374 @item -Wstrict-overflow=4
3375 Also warn about other simplifications not covered by the above cases.
3376 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3377
3378 @item -Wstrict-overflow=5
3379 Also warn about cases where the compiler reduces the magnitude of a
3380 constant involved in a comparison.  For example: @code{x + 2 > y} will
3381 be simplified to @code{x + 1 >= y}.  This is reported only at the
3382 highest warning level because this simplification applies to many
3383 comparisons, so this warning level will give a very large number of
3384 false positives.
3385 @end table
3386
3387 @item -Warray-bounds
3388 @opindex Wno-array-bounds
3389 @opindex Warray-bounds
3390 This option is only active when @option{-ftree-vrp} is active
3391 (default for -O2 and above). It warns about subscripts to arrays
3392 that are always out of bounds. This warning is enabled by @option{-Wall}.
3393
3394 @item -Wno-div-by-zero
3395 @opindex Wno-div-by-zero
3396 @opindex Wdiv-by-zero
3397 Do not warn about compile-time integer division by zero.  Floating point
3398 division by zero is not warned about, as it can be a legitimate way of
3399 obtaining infinities and NaNs.
3400
3401 @item -Wsystem-headers
3402 @opindex Wsystem-headers
3403 @opindex Wno-system-headers
3404 @cindex warnings from system headers
3405 @cindex system headers, warnings from
3406 Print warning messages for constructs found in system header files.
3407 Warnings from system headers are normally suppressed, on the assumption
3408 that they usually do not indicate real problems and would only make the
3409 compiler output harder to read.  Using this command line option tells
3410 GCC to emit warnings from system headers as if they occurred in user
3411 code.  However, note that using @option{-Wall} in conjunction with this
3412 option will @emph{not} warn about unknown pragmas in system
3413 headers---for that, @option{-Wunknown-pragmas} must also be used.
3414
3415 @item -Wfloat-equal
3416 @opindex Wfloat-equal
3417 @opindex Wno-float-equal
3418 Warn if floating point values are used in equality comparisons.
3419
3420 The idea behind this is that sometimes it is convenient (for the
3421 programmer) to consider floating-point values as approximations to
3422 infinitely precise real numbers.  If you are doing this, then you need
3423 to compute (by analyzing the code, or in some other way) the maximum or
3424 likely maximum error that the computation introduces, and allow for it
3425 when performing comparisons (and when producing output, but that's a
3426 different problem).  In particular, instead of testing for equality, you
3427 would check to see whether the two values have ranges that overlap; and
3428 this is done with the relational operators, so equality comparisons are
3429 probably mistaken.
3430
3431 @item -Wtraditional @r{(C and Objective-C only)}
3432 @opindex Wtraditional
3433 @opindex Wno-traditional
3434 Warn about certain constructs that behave differently in traditional and
3435 ISO C@.  Also warn about ISO C constructs that have no traditional C
3436 equivalent, and/or problematic constructs which should be avoided.
3437
3438 @itemize @bullet
3439 @item
3440 Macro parameters that appear within string literals in the macro body.
3441 In traditional C macro replacement takes place within string literals,
3442 but does not in ISO C@.
3443
3444 @item
3445 In traditional C, some preprocessor directives did not exist.
3446 Traditional preprocessors would only consider a line to be a directive
3447 if the @samp{#} appeared in column 1 on the line.  Therefore
3448 @option{-Wtraditional} warns about directives that traditional C
3449 understands but would ignore because the @samp{#} does not appear as the
3450 first character on the line.  It also suggests you hide directives like
3451 @samp{#pragma} not understood by traditional C by indenting them.  Some
3452 traditional implementations would not recognize @samp{#elif}, so it
3453 suggests avoiding it altogether.
3454
3455 @item
3456 A function-like macro that appears without arguments.
3457
3458 @item
3459 The unary plus operator.
3460
3461 @item
3462 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3463 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3464 constants.)  Note, these suffixes appear in macros defined in the system
3465 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3466 Use of these macros in user code might normally lead to spurious
3467 warnings, however GCC's integrated preprocessor has enough context to
3468 avoid warning in these cases.
3469
3470 @item
3471 A function declared external in one block and then used after the end of
3472 the block.
3473
3474 @item
3475 A @code{switch} statement has an operand of type @code{long}.
3476
3477 @item
3478 A non-@code{static} function declaration follows a @code{static} one.
3479 This construct is not accepted by some traditional C compilers.
3480
3481 @item
3482 The ISO type of an integer constant has a different width or
3483 signedness from its traditional type.  This warning is only issued if
3484 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3485 typically represent bit patterns, are not warned about.
3486
3487 @item
3488 Usage of ISO string concatenation is detected.
3489
3490 @item
3491 Initialization of automatic aggregates.
3492
3493 @item
3494 Identifier conflicts with labels.  Traditional C lacks a separate
3495 namespace for labels.
3496
3497 @item
3498 Initialization of unions.  If the initializer is zero, the warning is
3499 omitted.  This is done under the assumption that the zero initializer in
3500 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3501 initializer warnings and relies on default initialization to zero in the
3502 traditional C case.
3503
3504 @item
3505 Conversions by prototypes between fixed/floating point values and vice
3506 versa.  The absence of these prototypes when compiling with traditional
3507 C would cause serious problems.  This is a subset of the possible
3508 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3509
3510 @item
3511 Use of ISO C style function definitions.  This warning intentionally is
3512 @emph{not} issued for prototype declarations or variadic functions
3513 because these ISO C features will appear in your code when using
3514 libiberty's traditional C compatibility macros, @code{PARAMS} and
3515 @code{VPARAMS}.  This warning is also bypassed for nested functions
3516 because that feature is already a GCC extension and thus not relevant to
3517 traditional C compatibility.
3518 @end itemize
3519
3520 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3521 @opindex Wtraditional-conversion
3522 @opindex Wno-traditional-conversion
3523 Warn if a prototype causes a type conversion that is different from what
3524 would happen to the same argument in the absence of a prototype.  This
3525 includes conversions of fixed point to floating and vice versa, and
3526 conversions changing the width or signedness of a fixed point argument
3527 except when the same as the default promotion.
3528
3529 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3530 @opindex Wdeclaration-after-statement
3531 @opindex Wno-declaration-after-statement
3532 Warn when a declaration is found after a statement in a block.  This
3533 construct, known from C++, was introduced with ISO C99 and is by default
3534 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3535 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3536
3537 @item -Wundef
3538 @opindex Wundef
3539 @opindex Wno-undef
3540 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3541
3542 @item -Wno-endif-labels
3543 @opindex Wno-endif-labels
3544 @opindex Wendif-labels
3545 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3546
3547 @item -Wshadow
3548 @opindex Wshadow
3549 @opindex Wno-shadow
3550 Warn whenever a local variable shadows another local variable, parameter or
3551 global variable or whenever a built-in function is shadowed.
3552
3553 @item -Wlarger-than=@var{len}
3554 @opindex Wlarger-than=@var{len}
3555 @opindex Wlarger-than-@var{len}
3556 Warn whenever an object of larger than @var{len} bytes is defined.
3557
3558 @item -Wframe-larger-than=@var{len}
3559 @opindex Wframe-larger-than
3560 Warn if the size of a function frame is larger than @var{len} bytes.
3561 The computation done to determine the stack frame size is approximate
3562 and not conservative.
3563 The actual requirements may be somewhat greater than @var{len}
3564 even if you do not get a warning.  In addition, any space allocated
3565 via @code{alloca}, variable-length arrays, or related constructs
3566 is not included by the compiler when determining
3567 whether or not to issue a warning.
3568
3569 @item -Wunsafe-loop-optimizations
3570 @opindex Wunsafe-loop-optimizations
3571 @opindex Wno-unsafe-loop-optimizations
3572 Warn if the loop cannot be optimized because the compiler could not
3573 assume anything on the bounds of the loop indices.  With
3574 @option{-funsafe-loop-optimizations} warn if the compiler made
3575 such assumptions.
3576
3577 @item -Wno-pedantic-ms-format
3578 @opindex Wno-pedantic-ms-format
3579 @opindex Wpedantic-ms-format
3580 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3581 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3582 depending on the MS runtime, when you are using the options @option{-Wformat}
3583 and @option{-pedantic} without gnu-extensions.
3584
3585 @item -Wpointer-arith
3586 @opindex Wpointer-arith
3587 @opindex Wno-pointer-arith
3588 Warn about anything that depends on the ``size of'' a function type or
3589 of @code{void}.  GNU C assigns these types a size of 1, for
3590 convenience in calculations with @code{void *} pointers and pointers
3591 to functions.  In C++, warn also when an arithmetic operation involves
3592 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3593
3594 @item -Wtype-limits
3595 @opindex Wtype-limits
3596 @opindex Wno-type-limits
3597 Warn if a comparison is always true or always false due to the limited
3598 range of the data type, but do not warn for constant expressions.  For
3599 example, warn if an unsigned variable is compared against zero with
3600 @samp{<} or @samp{>=}.  This warning is also enabled by
3601 @option{-Wextra}.
3602
3603 @item -Wbad-function-cast @r{(C and Objective-C only)}
3604 @opindex Wbad-function-cast
3605 @opindex Wno-bad-function-cast
3606 Warn whenever a function call is cast to a non-matching type.
3607 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3608
3609 @item -Wc++-compat @r{(C and Objective-C only)}
3610 Warn about ISO C constructs that are outside of the common subset of
3611 ISO C and ISO C++, e.g.@: request for implicit conversion from
3612 @code{void *} to a pointer to non-@code{void} type.
3613
3614 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3615 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3616 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3617 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3618
3619 @item -Wcast-qual
3620 @opindex Wcast-qual
3621 @opindex Wno-cast-qual
3622 Warn whenever a pointer is cast so as to remove a type qualifier from
3623 the target type.  For example, warn if a @code{const char *} is cast
3624 to an ordinary @code{char *}.
3625
3626 @item -Wcast-align
3627 @opindex Wcast-align
3628 @opindex Wno-cast-align
3629 Warn whenever a pointer is cast such that the required alignment of the
3630 target is increased.  For example, warn if a @code{char *} is cast to
3631 an @code{int *} on machines where integers can only be accessed at
3632 two- or four-byte boundaries.
3633
3634 @item -Wwrite-strings
3635 @opindex Wwrite-strings
3636 @opindex Wno-write-strings
3637 When compiling C, give string constants the type @code{const
3638 char[@var{length}]} so that copying the address of one into a
3639 non-@code{const} @code{char *} pointer will get a warning.  These
3640 warnings will help you find at compile time code that can try to write
3641 into a string constant, but only if you have been very careful about
3642 using @code{const} in declarations and prototypes.  Otherwise, it will
3643 just be a nuisance. This is why we did not make @option{-Wall} request
3644 these warnings.
3645
3646 When compiling C++, warn about the deprecated conversion from string
3647 literals to @code{char *}.  This warning is enabled by default for C++
3648 programs.
3649
3650 @item -Wclobbered
3651 @opindex Wclobbered
3652 @opindex Wno-clobbered
3653 Warn for variables that might be changed by @samp{longjmp} or
3654 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3655
3656 @item -Wconversion
3657 @opindex Wconversion
3658 @opindex Wno-conversion
3659 Warn for implicit conversions that may alter a value. This includes
3660 conversions between real and integer, like @code{abs (x)} when
3661 @code{x} is @code{double}; conversions between signed and unsigned,
3662 like @code{unsigned ui = -1}; and conversions to smaller types, like
3663 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3664 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3665 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3666 conversions between signed and unsigned integers can be disabled by
3667 using @option{-Wno-sign-conversion}.
3668
3669 For C++, also warn for conversions between @code{NULL} and non-pointer
3670 types; confusing overload resolution for user-defined conversions; and
3671 conversions that will never use a type conversion operator:
3672 conversions to @code{void}, the same type, a base class or a reference
3673 to them. Warnings about conversions between signed and unsigned
3674 integers are disabled by default in C++ unless
3675 @option{-Wsign-conversion} is explicitly enabled.
3676
3677 @item -Wempty-body
3678 @opindex Wempty-body
3679 @opindex Wno-empty-body
3680 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3681 while} statement.  Additionally, in C++, warn when an empty body occurs
3682 in a @samp{while} or @samp{for} statement with no whitespacing before
3683 the semicolon.  This warning is also enabled by @option{-Wextra}.
3684
3685 @item -Wenum-compare @r{(C++ and Objective-C++ only)}
3686 @opindex Wenum-compare
3687 @opindex Wno-enum-compare
3688 Warn about a comparison between values of different enum types. This
3689 warning is enabled by default.
3690
3691 @item -Wsign-compare
3692 @opindex Wsign-compare
3693 @opindex Wno-sign-compare
3694 @cindex warning for comparison of signed and unsigned values
3695 @cindex comparison of signed and unsigned values, warning
3696 @cindex signed and unsigned values, comparison warning
3697 Warn when a comparison between signed and unsigned values could produce
3698 an incorrect result when the signed value is converted to unsigned.
3699 This warning is also enabled by @option{-Wextra}; to get the other warnings
3700 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3701
3702 @item -Wsign-conversion
3703 @opindex Wsign-conversion
3704 @opindex Wno-sign-conversion
3705 Warn for implicit conversions that may change the sign of an integer
3706 value, like assigning a signed integer expression to an unsigned
3707 integer variable. An explicit cast silences the warning. In C, this
3708 option is enabled also by @option{-Wconversion}.
3709
3710 @item -Waddress
3711 @opindex Waddress
3712 @opindex Wno-address
3713 Warn about suspicious uses of memory addresses. These include using
3714 the address of a function in a conditional expression, such as
3715 @code{void func(void); if (func)}, and comparisons against the memory
3716 address of a string literal, such as @code{if (x == "abc")}.  Such
3717 uses typically indicate a programmer error: the address of a function
3718 always evaluates to true, so their use in a conditional usually
3719 indicate that the programmer forgot the parentheses in a function
3720 call; and comparisons against string literals result in unspecified
3721 behavior and are not portable in C, so they usually indicate that the
3722 programmer intended to use @code{strcmp}.  This warning is enabled by
3723 @option{-Wall}.
3724
3725 @item -Wlogical-op
3726 @opindex Wlogical-op
3727 @opindex Wno-logical-op
3728 Warn about suspicious uses of logical operators in expressions.
3729 This includes using logical operators in contexts where a
3730 bit-wise operator is likely to be expected.
3731
3732 @item -Waggregate-return
3733 @opindex Waggregate-return
3734 @opindex Wno-aggregate-return
3735 Warn if any functions that return structures or unions are defined or
3736 called.  (In languages where you can return an array, this also elicits
3737 a warning.)
3738
3739 @item -Wno-attributes
3740 @opindex Wno-attributes
3741 @opindex Wattributes
3742 Do not warn if an unexpected @code{__attribute__} is used, such as
3743 unrecognized attributes, function attributes applied to variables,
3744 etc.  This will not stop errors for incorrect use of supported
3745 attributes.
3746
3747 @item -Wno-builtin-macro-redefined
3748 @opindex Wno-builtin-macro-redefined
3749 @opindex Wbuiltin-macro-redefined
3750 Do not warn if certain built-in macros are redefined.  This suppresses
3751 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
3752 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
3753
3754 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3755 @opindex Wstrict-prototypes
3756 @opindex Wno-strict-prototypes
3757 Warn if a function is declared or defined without specifying the
3758 argument types.  (An old-style function definition is permitted without
3759 a warning if preceded by a declaration which specifies the argument
3760 types.)
3761
3762 @item -Wold-style-declaration @r{(C and Objective-C only)}
3763 @opindex Wold-style-declaration
3764 @opindex Wno-old-style-declaration
3765 Warn for obsolescent usages, according to the C Standard, in a
3766 declaration. For example, warn if storage-class specifiers like
3767 @code{static} are not the first things in a declaration.  This warning
3768 is also enabled by @option{-Wextra}.
3769
3770 @item -Wold-style-definition @r{(C and Objective-C only)}
3771 @opindex Wold-style-definition
3772 @opindex Wno-old-style-definition
3773 Warn if an old-style function definition is used.  A warning is given
3774 even if there is a previous prototype.
3775
3776 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3777 @opindex Wmissing-parameter-type
3778 @opindex Wno-missing-parameter-type
3779 A function parameter is declared without a type specifier in K&R-style
3780 functions:
3781
3782 @smallexample
3783 void foo(bar) @{ @}
3784 @end smallexample
3785
3786 This warning is also enabled by @option{-Wextra}.
3787
3788 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3789 @opindex Wmissing-prototypes
3790 @opindex Wno-missing-prototypes
3791 Warn if a global function is defined without a previous prototype
3792 declaration.  This warning is issued even if the definition itself
3793 provides a prototype.  The aim is to detect global functions that fail
3794 to be declared in header files.
3795
3796 @item -Wmissing-declarations
3797 @opindex Wmissing-declarations
3798 @opindex Wno-missing-declarations
3799 Warn if a global function is defined without a previous declaration.
3800 Do so even if the definition itself provides a prototype.
3801 Use this option to detect global functions that are not declared in
3802 header files.  In C++, no warnings are issued for function templates,
3803 or for inline functions, or for functions in anonymous namespaces.
3804
3805 @item -Wmissing-field-initializers
3806 @opindex Wmissing-field-initializers
3807 @opindex Wno-missing-field-initializers
3808 @opindex W
3809 @opindex Wextra
3810 @opindex Wno-extra
3811 Warn if a structure's initializer has some fields missing.  For
3812 example, the following code would cause such a warning, because
3813 @code{x.h} is implicitly zero:
3814
3815 @smallexample
3816 struct s @{ int f, g, h; @};
3817 struct s x = @{ 3, 4 @};
3818 @end smallexample
3819
3820 This option does not warn about designated initializers, so the following
3821 modification would not trigger a warning:
3822
3823 @smallexample
3824 struct s @{ int f, g, h; @};
3825 struct s x = @{ .f = 3, .g = 4 @};
3826 @end smallexample
3827
3828 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3829 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3830
3831 @item -Wmissing-noreturn
3832 @opindex Wmissing-noreturn
3833 @opindex Wno-missing-noreturn
3834 Warn about functions which might be candidates for attribute @code{noreturn}.
3835 Note these are only possible candidates, not absolute ones.  Care should
3836 be taken to manually verify functions actually do not ever return before
3837 adding the @code{noreturn} attribute, otherwise subtle code generation
3838 bugs could be introduced.  You will not get a warning for @code{main} in
3839 hosted C environments.
3840
3841 @item -Wmissing-format-attribute
3842 @opindex Wmissing-format-attribute
3843 @opindex Wno-missing-format-attribute
3844 @opindex Wformat
3845 @opindex Wno-format
3846 Warn about function pointers which might be candidates for @code{format}
3847 attributes.  Note these are only possible candidates, not absolute ones.
3848 GCC will guess that function pointers with @code{format} attributes that
3849 are used in assignment, initialization, parameter passing or return
3850 statements should have a corresponding @code{format} attribute in the
3851 resulting type.  I.e.@: the left-hand side of the assignment or
3852 initialization, the type of the parameter variable, or the return type
3853 of the containing function respectively should also have a @code{format}
3854 attribute to avoid the warning.
3855
3856 GCC will also warn about function definitions which might be
3857 candidates for @code{format} attributes.  Again, these are only
3858 possible candidates.  GCC will guess that @code{format} attributes
3859 might be appropriate for any function that calls a function like
3860 @code{vprintf} or @code{vscanf}, but this might not always be the
3861 case, and some functions for which @code{format} attributes are
3862 appropriate may not be detected.
3863
3864 @item -Wno-multichar
3865 @opindex Wno-multichar
3866 @opindex Wmultichar
3867 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3868 Usually they indicate a typo in the user's code, as they have
3869 implementation-defined values, and should not be used in portable code.
3870
3871 @item -Wnormalized=<none|id|nfc|nfkc>
3872 @opindex Wnormalized=
3873 @cindex NFC
3874 @cindex NFKC
3875 @cindex character set, input normalization
3876 In ISO C and ISO C++, two identifiers are different if they are
3877 different sequences of characters.  However, sometimes when characters
3878 outside the basic ASCII character set are used, you can have two
3879 different character sequences that look the same.  To avoid confusion,
3880 the ISO 10646 standard sets out some @dfn{normalization rules} which
3881 when applied ensure that two sequences that look the same are turned into
3882 the same sequence.  GCC can warn you if you are using identifiers which
3883 have not been normalized; this option controls that warning.
3884
3885 There are four levels of warning that GCC supports.  The default is
3886 @option{-Wnormalized=nfc}, which warns about any identifier which is
3887 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3888 recommended form for most uses.
3889
3890 Unfortunately, there are some characters which ISO C and ISO C++ allow
3891 in identifiers that when turned into NFC aren't allowable as
3892 identifiers.  That is, there's no way to use these symbols in portable
3893 ISO C or C++ and have all your identifiers in NFC@.
3894 @option{-Wnormalized=id} suppresses the warning for these characters.
3895 It is hoped that future versions of the standards involved will correct
3896 this, which is why this option is not the default.
3897
3898 You can switch the warning off for all characters by writing
3899 @option{-Wnormalized=none}.  You would only want to do this if you
3900 were using some other normalization scheme (like ``D''), because
3901 otherwise you can easily create bugs that are literally impossible to see.
3902
3903 Some characters in ISO 10646 have distinct meanings but look identical
3904 in some fonts or display methodologies, especially once formatting has
3905 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3906 LETTER N'', will display just like a regular @code{n} which has been
3907 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3908 normalization scheme to convert all these into a standard form as
3909 well, and GCC will warn if your code is not in NFKC if you use
3910 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3911 about every identifier that contains the letter O because it might be
3912 confused with the digit 0, and so is not the default, but may be
3913 useful as a local coding convention if the programming environment is
3914 unable to be fixed to display these characters distinctly.
3915
3916 @item -Wno-deprecated
3917 @opindex Wno-deprecated
3918 @opindex Wdeprecated
3919 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
3920
3921 @item -Wno-deprecated-declarations
3922 @opindex Wno-deprecated-declarations
3923 @opindex Wdeprecated-declarations
3924 Do not warn about uses of functions (@pxref{Function Attributes}),
3925 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3926 Attributes}) marked as deprecated by using the @code{deprecated}
3927 attribute.
3928
3929 @item -Wno-overflow
3930 @opindex Wno-overflow
3931 @opindex Woverflow
3932 Do not warn about compile-time overflow in constant expressions.
3933
3934 @item -Woverride-init @r{(C and Objective-C only)}
3935 @opindex Woverride-init
3936 @opindex Wno-override-init
3937 @opindex W
3938 @opindex Wextra
3939 @opindex Wno-extra
3940 Warn if an initialized field without side effects is overridden when
3941 using designated initializers (@pxref{Designated Inits, , Designated
3942 Initializers}).
3943
3944 This warning is included in @option{-Wextra}.  To get other
3945 @option{-Wextra} warnings without this one, use @samp{-Wextra
3946 -Wno-override-init}.
3947
3948 @item -Wpacked
3949 @opindex Wpacked
3950 @opindex Wno-packed
3951 Warn if a structure is given the packed attribute, but the packed
3952 attribute has no effect on the layout or size of the structure.
3953 Such structures may be mis-aligned for little benefit.  For
3954 instance, in this code, the variable @code{f.x} in @code{struct bar}
3955 will be misaligned even though @code{struct bar} does not itself
3956 have the packed attribute:
3957
3958 @smallexample
3959 @group
3960 struct foo @{
3961   int x;
3962   char a, b, c, d;
3963 @} __attribute__((packed));
3964 struct bar @{
3965   char z;
3966   struct foo f;
3967 @};
3968 @end group
3969 @end smallexample
3970
3971 @item -Wpadded
3972 @opindex Wpadded
3973 @opindex Wno-padded
3974 Warn if padding is included in a structure, either to align an element
3975 of the structure or to align the whole structure.  Sometimes when this
3976 happens it is possible to rearrange the fields of the structure to
3977 reduce the padding and so make the structure smaller.
3978
3979 @item -Wredundant-decls
3980 @opindex Wredundant-decls
3981 @opindex Wno-redundant-decls
3982 Warn if anything is declared more than once in the same scope, even in
3983 cases where multiple declaration is valid and changes nothing.
3984
3985 @item -Wnested-externs @r{(C and Objective-C only)}
3986 @opindex Wnested-externs
3987 @opindex Wno-nested-externs
3988 Warn if an @code{extern} declaration is encountered within a function.
3989
3990 @item -Wunreachable-code
3991 @opindex Wunreachable-code
3992 @opindex Wno-unreachable-code
3993 Warn if the compiler detects that code will never be executed.
3994
3995 This option is intended to warn when the compiler detects that at
3996 least a whole line of source code will never be executed, because
3997 some condition is never satisfied or because it is after a
3998 procedure that never returns.
3999
4000 It is possible for this option to produce a warning even though there
4001 are circumstances under which part of the affected line can be executed,
4002 so care should be taken when removing apparently-unreachable code.
4003
4004 For instance, when a function is inlined, a warning may mean that the
4005 line is unreachable in only one inlined copy of the function.
4006
4007 This option is not made part of @option{-Wall} because in a debugging
4008 version of a program there is often substantial code which checks
4009 correct functioning of the program and is, hopefully, unreachable
4010 because the program does work.  Another common use of unreachable
4011 code is to provide behavior which is selectable at compile-time.
4012
4013 @item -Winline
4014 @opindex Winline
4015 @opindex Wno-inline
4016 Warn if a function can not be inlined and it was declared as inline.
4017 Even with this option, the compiler will not warn about failures to
4018 inline functions declared in system headers.
4019
4020 The compiler uses a variety of heuristics to determine whether or not
4021 to inline a function.  For example, the compiler takes into account
4022 the size of the function being inlined and the amount of inlining
4023 that has already been done in the current function.  Therefore,
4024 seemingly insignificant changes in the source program can cause the
4025 warnings produced by @option{-Winline} to appear or disappear.
4026
4027 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4028 @opindex Wno-invalid-offsetof
4029 @opindex Winvalid-offsetof
4030 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4031 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4032 to a non-POD type is undefined.  In existing C++ implementations,
4033 however, @samp{offsetof} typically gives meaningful results even when
4034 applied to certain kinds of non-POD types. (Such as a simple
4035 @samp{struct} that fails to be a POD type only by virtue of having a
4036 constructor.)  This flag is for users who are aware that they are
4037 writing nonportable code and who have deliberately chosen to ignore the
4038 warning about it.
4039
4040 The restrictions on @samp{offsetof} may be relaxed in a future version
4041 of the C++ standard.
4042
4043 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4044 @opindex Wno-int-to-pointer-cast
4045 @opindex Wint-to-pointer-cast
4046 Suppress warnings from casts to pointer type of an integer of a
4047 different size.
4048
4049 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4050 @opindex Wno-pointer-to-int-cast
4051 @opindex Wpointer-to-int-cast
4052 Suppress warnings from casts from a pointer to an integer type of a
4053 different size.
4054
4055 @item -Winvalid-pch
4056 @opindex Winvalid-pch
4057 @opindex Wno-invalid-pch
4058 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4059 the search path but can't be used.
4060
4061 @item -Wlong-long
4062 @opindex Wlong-long
4063 @opindex Wno-long-long
4064 Warn if @samp{long long} type is used.  This is default.  To inhibit
4065 the warning messages, use @option{-Wno-long-long}.  Flags
4066 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
4067 only when @option{-pedantic} flag is used.
4068
4069 @item -Wvariadic-macros
4070 @opindex Wvariadic-macros
4071 @opindex Wno-variadic-macros
4072 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4073 alternate syntax when in pedantic ISO C99 mode.  This is default.
4074 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4075
4076 @item -Wvla
4077 @opindex Wvla
4078 @opindex Wno-vla
4079 Warn if variable length array is used in the code.
4080 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4081 the variable length array.
4082
4083 @item -Wvolatile-register-var
4084 @opindex Wvolatile-register-var
4085 @opindex Wno-volatile-register-var
4086 Warn if a register variable is declared volatile.  The volatile
4087 modifier does not inhibit all optimizations that may eliminate reads
4088 and/or writes to register variables.  This warning is enabled by
4089 @option{-Wall}.
4090
4091 @item -Wdisabled-optimization
4092 @opindex Wdisabled-optimization
4093 @opindex Wno-disabled-optimization
4094 Warn if a requested optimization pass is disabled.  This warning does
4095 not generally indicate that there is anything wrong with your code; it
4096 merely indicates that GCC's optimizers were unable to handle the code
4097 effectively.  Often, the problem is that your code is too big or too
4098 complex; GCC will refuse to optimize programs when the optimization
4099 itself is likely to take inordinate amounts of time.
4100
4101 @item -Wpointer-sign @r{(C and Objective-C only)}
4102 @opindex Wpointer-sign
4103 @opindex Wno-pointer-sign
4104 Warn for pointer argument passing or assignment with different signedness.
4105 This option is only supported for C and Objective-C@.  It is implied by
4106 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4107 @option{-Wno-pointer-sign}.
4108
4109 @item -Wstack-protector
4110 @opindex Wstack-protector
4111 @opindex Wno-stack-protector
4112 This option is only active when @option{-fstack-protector} is active.  It
4113 warns about functions that will not be protected against stack smashing.
4114
4115 @item -Wno-mudflap
4116 @opindex Wno-mudflap
4117 Suppress warnings about constructs that cannot be instrumented by
4118 @option{-fmudflap}.
4119
4120 @item -Woverlength-strings
4121 @opindex Woverlength-strings
4122 @opindex Wno-overlength-strings
4123 Warn about string constants which are longer than the ``minimum
4124 maximum'' length specified in the C standard.  Modern compilers
4125 generally allow string constants which are much longer than the
4126 standard's minimum limit, but very portable programs should avoid
4127 using longer strings.
4128
4129 The limit applies @emph{after} string constant concatenation, and does
4130 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4131 C99, it was raised to 4095.  C++98 does not specify a normative
4132 minimum maximum, so we do not diagnose overlength strings in C++@.
4133
4134 This option is implied by @option{-pedantic}, and can be disabled with
4135 @option{-Wno-overlength-strings}.
4136
4137 @item -Wdisallowed-function-list=@var{sym},@var{sym},@dots{}
4138 @opindex Wdisallowed-function-list
4139
4140 If any of @var{sym} is called, GCC will issue a warning. This can be useful
4141 in enforcing coding conventions that ban calls to certain functions, for
4142 example, @code{alloca}, @code{malloc}, etc.
4143 @end table
4144
4145 @node Debugging Options
4146 @section Options for Debugging Your Program or GCC
4147 @cindex options, debugging
4148 @cindex debugging information options
4149
4150 GCC has various special options that are used for debugging
4151 either your program or GCC:
4152
4153 @table @gcctabopt
4154 @item -g
4155 @opindex g
4156 Produce debugging information in the operating system's native format
4157 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4158 information.
4159
4160 On most systems that use stabs format, @option{-g} enables use of extra
4161 debugging information that only GDB can use; this extra information
4162 makes debugging work better in GDB but will probably make other debuggers
4163 crash or
4164 refuse to read the program.  If you want to control for certain whether
4165 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4166 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4167
4168 GCC allows you to use @option{-g} with
4169 @option{-O}.  The shortcuts taken by optimized code may occasionally
4170 produce surprising results: some variables you declared may not exist
4171 at all; flow of control may briefly move where you did not expect it;
4172 some statements may not be executed because they compute constant
4173 results or their values were already at hand; some statements may
4174 execute in different places because they were moved out of loops.
4175
4176 Nevertheless it proves possible to debug optimized output.  This makes
4177 it reasonable to use the optimizer for programs that might have bugs.
4178
4179 The following options are useful when GCC is generated with the
4180 capability for more than one debugging format.
4181
4182 @item -ggdb
4183 @opindex ggdb
4184 Produce debugging information for use by GDB@.  This means to use the
4185 most expressive format available (DWARF 2, stabs, or the native format
4186 if neither of those are supported), including GDB extensions if at all
4187 possible.
4188
4189 @item -gstabs
4190 @opindex gstabs
4191 Produce debugging information in stabs format (if that is supported),
4192 without GDB extensions.  This is the format used by DBX on most BSD
4193 systems.  On MIPS, Alpha and System V Release 4 systems this option
4194 produces stabs debugging output which is not understood by DBX or SDB@.
4195 On System V Release 4 systems this option requires the GNU assembler.
4196
4197 @item -feliminate-unused-debug-symbols
4198 @opindex feliminate-unused-debug-symbols
4199 Produce debugging information in stabs format (if that is supported),
4200 for only symbols that are actually used.
4201
4202 @item -femit-class-debug-always
4203 Instead of emitting debugging information for a C++ class in only one
4204 object file, emit it in all object files using the class.  This option
4205 should be used only with debuggers that are unable to handle the way GCC
4206 normally emits debugging information for classes because using this
4207 option will increase the size of debugging information by as much as a
4208 factor of two.
4209
4210 @item -gstabs+
4211 @opindex gstabs+
4212 Produce debugging information in stabs format (if that is supported),
4213 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4214 use of these extensions is likely to make other debuggers crash or
4215 refuse to read the program.
4216
4217 @item -gcoff
4218 @opindex gcoff
4219 Produce debugging information in COFF format (if that is supported).
4220 This is the format used by SDB on most System V systems prior to
4221 System V Release 4.
4222
4223 @item -gxcoff
4224 @opindex gxcoff
4225 Produce debugging information in XCOFF format (if that is supported).
4226 This is the format used by the DBX debugger on IBM RS/6000 systems.
4227
4228 @item -gxcoff+
4229 @opindex gxcoff+
4230 Produce debugging information in XCOFF format (if that is supported),
4231 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4232 use of these extensions is likely to make other debuggers crash or
4233 refuse to read the program, and may cause assemblers other than the GNU
4234 assembler (GAS) to fail with an error.
4235
4236 @item -gdwarf-2
4237 @opindex gdwarf-2
4238 Produce debugging information in DWARF version 2 format (if that is
4239 supported).  This is the format used by DBX on IRIX 6.  With this
4240 option, GCC uses features of DWARF version 3 when they are useful;
4241 version 3 is upward compatible with version 2, but may still cause
4242 problems for older debuggers.
4243
4244 @item -gvms
4245 @opindex gvms
4246 Produce debugging information in VMS debug format (if that is
4247 supported).  This is the format used by DEBUG on VMS systems.
4248
4249 @item -g@var{level}
4250 @itemx -ggdb@var{level}
4251 @itemx -gstabs@var{level}
4252 @itemx -gcoff@var{level}
4253 @itemx -gxcoff@var{level}
4254 @itemx -gvms@var{level}
4255 Request debugging information and also use @var{level} to specify how
4256 much information.  The default level is 2.
4257
4258 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4259 @option{-g}.
4260
4261 Level 1 produces minimal information, enough for making backtraces in
4262 parts of the program that you don't plan to debug.  This includes
4263 descriptions of functions and external variables, but no information
4264 about local variables and no line numbers.
4265
4266 Level 3 includes extra information, such as all the macro definitions
4267 present in the program.  Some debuggers support macro expansion when
4268 you use @option{-g3}.
4269
4270 @option{-gdwarf-2} does not accept a concatenated debug level, because
4271 GCC used to support an option @option{-gdwarf} that meant to generate
4272 debug information in version 1 of the DWARF format (which is very
4273 different from version 2), and it would have been too confusing.  That
4274 debug format is long obsolete, but the option cannot be changed now.
4275 Instead use an additional @option{-g@var{level}} option to change the
4276 debug level for DWARF2.
4277
4278 @item -feliminate-dwarf2-dups
4279 @opindex feliminate-dwarf2-dups
4280 Compress DWARF2 debugging information by eliminating duplicated
4281 information about each symbol.  This option only makes sense when
4282 generating DWARF2 debugging information with @option{-gdwarf-2}.
4283
4284 @item -femit-struct-debug-baseonly
4285 Emit debug information for struct-like types
4286 only when the base name of the compilation source file
4287 matches the base name of file in which the struct was defined.
4288
4289 This option substantially reduces the size of debugging information,
4290 but at significant potential loss in type information to the debugger.
4291 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4292 See @option{-femit-struct-debug-detailed} for more detailed control.
4293
4294 This option works only with DWARF 2.
4295
4296 @item -femit-struct-debug-reduced
4297 Emit debug information for struct-like types
4298 only when the base name of the compilation source file
4299 matches the base name of file in which the type was defined,
4300 unless the struct is a template or defined in a system header.
4301
4302 This option significantly reduces the size of debugging information,
4303 with some potential loss in type information to the debugger.
4304 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4305 See @option{-femit-struct-debug-detailed} for more detailed control.
4306
4307 This option works only with DWARF 2.
4308
4309 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4310 Specify the struct-like types
4311 for which the compiler will generate debug information.
4312 The intent is to reduce duplicate struct debug information
4313 between different object files within the same program.
4314
4315 This option is a detailed version of
4316 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4317 which will serve for most needs.
4318
4319 A specification has the syntax
4320 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4321
4322 The optional first word limits the specification to
4323 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4324 A struct type is used directly when it is the type of a variable, member.
4325 Indirect uses arise through pointers to structs.
4326 That is, when use of an incomplete struct would be legal, the use is indirect.
4327 An example is
4328 @samp{struct one direct; struct two * indirect;}.
4329
4330 The optional second word limits the specification to
4331 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4332 Generic structs are a bit complicated to explain.
4333 For C++, these are non-explicit specializations of template classes,
4334 or non-template classes within the above.
4335 Other programming languages have generics,
4336 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4337
4338 The third word specifies the source files for those
4339 structs for which the compiler will emit debug information.
4340 The values @samp{none} and @samp{any} have the normal meaning.
4341 The value @samp{base} means that
4342 the base of name of the file in which the type declaration appears
4343 must match the base of the name of the main compilation file.
4344 In practice, this means that
4345 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4346 but types declared in other header will not.
4347 The value @samp{sys} means those types satisfying @samp{base}
4348 or declared in system or compiler headers.
4349
4350 You may need to experiment to determine the best settings for your application.
4351
4352 The default is @samp{-femit-struct-debug-detailed=all}.
4353
4354 This option works only with DWARF 2.
4355
4356 @item -fno-merge-debug-strings
4357 @opindex fmerge-debug-strings
4358 @opindex fno-merge-debug-strings
4359 Direct the linker to merge together strings which are identical in
4360 different object files.  This is not supported by all assemblers or
4361 linker.  This decreases the size of the debug information in the
4362 output file at the cost of increasing link processing time.  This is
4363 on by default.
4364
4365 @item -fdebug-prefix-map=@var{old}=@var{new}
4366 @opindex fdebug-prefix-map
4367 When compiling files in directory @file{@var{old}}, record debugging
4368 information describing them as in @file{@var{new}} instead.
4369
4370 @item -fno-dwarf2-cfi-asm
4371 @opindex fdwarf2-cfi-asm
4372 @opindex fno-dwarf2-cfi-asm
4373 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4374 instead of using GAS @code{.cfi_*} directives.
4375
4376 @cindex @command{prof}
4377 @item -p
4378 @opindex p
4379 Generate extra code to write profile information suitable for the
4380 analysis program @command{prof}.  You must use this option when compiling
4381 the source files you want data about, and you must also use it when
4382 linking.
4383
4384 @cindex @command{gprof}
4385 @item -pg
4386 @opindex pg
4387 Generate extra code to write profile information suitable for the
4388 analysis program @command{gprof}.  You must use this option when compiling
4389 the source files you want data about, and you must also use it when
4390 linking.
4391
4392 @item -Q
4393 @opindex Q
4394 Makes the compiler print out each function name as it is compiled, and
4395 print some statistics about each pass when it finishes.
4396
4397 @item -ftime-report
4398 @opindex ftime-report
4399 Makes the compiler print some statistics about the time consumed by each
4400 pass when it finishes.
4401
4402 @item -fmem-report
4403 @opindex fmem-report
4404 Makes the compiler print some statistics about permanent memory
4405 allocation when it finishes.
4406
4407 @item -fpre-ipa-mem-report
4408 @opindex fpre-ipa-mem-report
4409 @item -fpost-ipa-mem-report
4410 @opindex fpost-ipa-mem-report
4411 Makes the compiler print some statistics about permanent memory
4412 allocation before or after interprocedural optimization.
4413
4414 @item -fprofile-arcs
4415 @opindex fprofile-arcs
4416 Add code so that program flow @dfn{arcs} are instrumented.  During
4417 execution the program records how many times each branch and call is
4418 executed and how many times it is taken or returns.  When the compiled
4419 program exits it saves this data to a file called
4420 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4421 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4422 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4423 @var{auxname} is generated from the name of the output file, if
4424 explicitly specified and it is not the final executable, otherwise it is
4425 the basename of the source file.  In both cases any suffix is removed
4426 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4427 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4428 @xref{Cross-profiling}.
4429
4430 @cindex @command{gcov}
4431 @item --coverage
4432 @opindex coverage
4433
4434 This option is used to compile and link code instrumented for coverage
4435 analysis.  The option is a synonym for @option{-fprofile-arcs}
4436 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4437 linking).  See the documentation for those options for more details.
4438
4439 @itemize
4440
4441 @item
4442 Compile the source files with @option{-fprofile-arcs} plus optimization
4443 and code generation options.  For test coverage analysis, use the
4444 additional @option{-ftest-coverage} option.  You do not need to profile
4445 every source file in a program.
4446
4447 @item
4448 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4449 (the latter implies the former).
4450
4451 @item
4452 Run the program on a representative workload to generate the arc profile
4453 information.  This may be repeated any number of times.  You can run
4454 concurrent instances of your program, and provided that the file system
4455 supports locking, the data files will be correctly updated.  Also
4456 @code{fork} calls are detected and correctly handled (double counting
4457 will not happen).
4458
4459 @item
4460 For profile-directed optimizations, compile the source files again with
4461 the same optimization and code generation options plus
4462 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4463 Control Optimization}).
4464
4465 @item
4466 For test coverage analysis, use @command{gcov} to produce human readable
4467 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4468 @command{gcov} documentation for further information.
4469
4470 @end itemize
4471
4472 With @option{-fprofile-arcs}, for each function of your program GCC
4473 creates a program flow graph, then finds a spanning tree for the graph.
4474 Only arcs that are not on the spanning tree have to be instrumented: the
4475 compiler adds code to count the number of times that these arcs are
4476 executed.  When an arc is the only exit or only entrance to a block, the
4477 instrumentation code can be added to the block; otherwise, a new basic
4478 block must be created to hold the instrumentation code.
4479
4480 @need 2000
4481 @item -ftest-coverage
4482 @opindex ftest-coverage
4483 Produce a notes file that the @command{gcov} code-coverage utility
4484 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4485 show program coverage.  Each source file's note file is called
4486 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4487 above for a description of @var{auxname} and instructions on how to
4488 generate test coverage data.  Coverage data will match the source files
4489 more closely, if you do not optimize.
4490
4491 @item -fdbg-cnt-list
4492 @opindex fdbg-cnt-list
4493 Print the name and the counter upperbound for all debug counters.
4494
4495 @item -fdbg-cnt=@var{counter-value-list}
4496 @opindex fdbg-cnt
4497 Set the internal debug counter upperbound. @var{counter-value-list} 
4498 is a comma-separated list of @var{name}:@var{value} pairs
4499 which sets the upperbound of each debug counter @var{name} to @var{value}.
4500 All debug counters have the initial upperbound of @var{UINT_MAX},
4501 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4502 e.g. With -fdbg-cnt=dce:10,tail_call:0
4503 dbg_cnt(dce) will return true only for first 10 invocations
4504 and dbg_cnt(tail_call) will return false always.
4505
4506 @item -d@var{letters}
4507 @itemx -fdump-rtl-@var{pass}
4508 @opindex d
4509 Says to make debugging dumps during compilation at times specified by
4510 @var{letters}.    This is used for debugging the RTL-based passes of the
4511 compiler.  The file names for most of the dumps are made by appending a
4512 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
4513 from the name of the output file, if explicitly specified and it is not
4514 an executable, otherwise it is the basename of the source file. These
4515 switches may have different effects when @option{-E} is used for
4516 preprocessing.
4517
4518 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4519 @option{-d} option @var{letters}.  Here are the possible
4520 letters for use in @var{letters} and @var{pass}, and their meanings:
4521
4522 @table @gcctabopt
4523 @item -dA
4524 @opindex dA
4525 Annotate the assembler output with miscellaneous debugging information.
4526
4527 @item -fdump-rtl-bbro
4528 @opindex fdump-rtl-bbro
4529 Dump after block reordering, to @file{@var{file}.148r.bbro}.
4530
4531 @item -fdump-rtl-combine
4532 @opindex fdump-rtl-combine
4533 Dump after the RTL instruction combination pass, to the file
4534 @file{@var{file}.129r.combine}.
4535
4536 @item -fdump-rtl-ce1
4537 @itemx -fdump-rtl-ce2
4538 @opindex fdump-rtl-ce1
4539 @opindex fdump-rtl-ce2
4540 @option{-fdump-rtl-ce1} enable dumping after the
4541 first if conversion, to the file @file{@var{file}.117r.ce1}. 
4542 @option{-fdump-rtl-ce2} enable dumping after the second if
4543 conversion, to the file @file{@var{file}.130r.ce2}.
4544
4545 @item -fdump-rtl-btl
4546 @itemx -fdump-rtl-dbr
4547 @opindex fdump-rtl-btl
4548 @opindex fdump-rtl-dbr
4549 @option{-fdump-rtl-btl} enable dumping after branch
4550 target load optimization, to @file{@var{file}.31.btl}.  
4551 @option{-fdump-rtl-dbr} enable dumping after delayed branch
4552 scheduling, to @file{@var{file}.36.dbr}.
4553
4554 @item -dD
4555 @opindex dD
4556 Dump all macro definitions, at the end of preprocessing, in addition to
4557 normal output.
4558
4559 @item -fdump-rtl-ce3
4560 @opindex fdump-rtl-ce3
4561 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
4562
4563 @item -fdump-rtl-cfg
4564 @itemx -fdump-rtl-life
4565 @opindex fdump-rtl-cfg
4566 @opindex fdump-rtl-life
4567 @option{-fdump-rtl-cfg} enable dumping after control
4568 and data flow analysis, to @file{@var{file}.116r.cfg}.  
4569 @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
4570 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
4571
4572 @item -fdump-rtl-greg
4573 @opindex fdump-rtl-greg
4574 Dump after global register allocation, to @file{@var{file}.139r.greg}.
4575
4576 @item -fdump-rtl-gcse
4577 @itemx -fdump-rtl-bypass
4578 @opindex fdump-rtl-gcse
4579 @opindex fdump-rtl-bypass
4580 @option{-fdump-rtl-gcse} enable dumping after GCSE, to
4581 @file{@var{file}.114r.gcse}.  @option{-fdump-rtl-bypass}
4582 enable dumping after jump bypassing and control flow optimizations, to
4583 @file{@var{file}.115r.bypass}.
4584
4585 @item -fdump-rtl-eh
4586 @opindex fdump-rtl-eh
4587 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
4588
4589 @item -fdump-rtl-sibling
4590 @opindex fdump-rtl-sibling
4591 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
4592
4593 @item -fdump-rtl-jump
4594 @opindex fdump-rtl-jump
4595 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
4596
4597 @item -fdump-rtl-stack
4598 @opindex fdump-rtl-stack
4599 Dump after conversion from GCC's "flat register file" registers to the
4600 x87's stack-like registers, to @file{@var{file}.152r.stack}.
4601
4602 @item -fdump-rtl-lreg
4603 @opindex fdump-rtl-lreg
4604 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
4605
4606 @item -fdump-rtl-loop2
4607 @opindex fdump-rtl-loop2
4608 @option{-fdump-rtl-loop2} enables dumping after the
4609 loop optimization pass, to @file{@var{file}.119r.loop2},
4610 @file{@var{file}.120r.loop2_init},
4611 @file{@var{file}.121r.loop2_invariant}, and
4612 @file{@var{file}.125r.loop2_done}.
4613
4614 @item -fdump-rtl-sms
4615 @opindex fdump-rtl-sms
4616 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4617
4618 @item -fdump-rtl-mach
4619 @opindex fdump-rtl-mach
4620 Dump after performing the machine dependent reorganization pass, to
4621 @file{@var{file}.155r.mach} if that pass exists.
4622
4623 @item -fdump-rtl-rnreg
4624 @opindex fdump-rtl-rnreg
4625 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4626
4627 @item -fdump-rtl-regmove
4628 @opindex fdump-rtl-regmove
4629 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4630
4631 @item -fdump-rtl-postreload
4632 @opindex fdump-rtl-postreload
4633 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4634
4635 @item -fdump-rtl-expand
4636 @opindex fdump-rtl-expand
4637 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4638
4639 @item -fdump-rtl-sched2
4640 @opindex fdump-rtl-sched2
4641 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4642
4643 @item -fdump-rtl-cse
4644 @opindex fdump-rtl-cse
4645 Dump after CSE (including the jump optimization that sometimes follows
4646 CSE), to @file{@var{file}.113r.cse}.
4647
4648 @item -fdump-rtl-sched1
4649 @opindex fdump-rtl-sched1
4650 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4651
4652 @item -fdump-rtl-cse2
4653 @opindex fdump-rtl-cse2
4654 Dump after the second CSE pass (including the jump optimization that
4655 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4656
4657 @item -fdump-rtl-tracer
4658 @opindex fdump-rtl-tracer
4659 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4660
4661 @item -fdump-rtl-vpt
4662 @itemx -fdump-rtl-vartrack
4663 @opindex fdump-rtl-vpt
4664 @opindex fdump-rtl-vartrack
4665 @option{-fdump-rtl-vpt} enable dumping after the value
4666 profile transformations, to @file{@var{file}.10.vpt}.
4667 @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4668 to @file{@var{file}.154r.vartrack}.
4669
4670 @item -fdump-rtl-flow2
4671 @opindex fdump-rtl-flow2
4672 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4673
4674 @item -fdump-rtl-peephole2
4675 @opindex fdump-rtl-peephole2
4676 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4677
4678 @item -fdump-rtl-web
4679 @opindex fdump-rtl-web
4680 Dump after live range splitting, to @file{@var{file}.126r.web}.
4681
4682 @item -fdump-rtl-all
4683 @opindex fdump-rtl-all
4684 Produce all the dumps listed above.
4685
4686 @item -dH
4687 @opindex dH
4688 Produce a core dump whenever an error occurs.
4689
4690 @item -dm
4691 @opindex dm
4692 Print statistics on memory usage, at the end of the run, to
4693 standard error.
4694
4695 @item -dp
4696 @opindex dp
4697 Annotate the assembler output with a comment indicating which
4698 pattern and alternative was used.  The length of each instruction is
4699 also printed.
4700
4701 @item -dP
4702 @opindex dP
4703 Dump the RTL in the assembler output as a comment before each instruction.
4704 Also turns on @option{-dp} annotation.
4705
4706 @item -dv
4707 @opindex dv
4708 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
4709 dump a representation of the control flow graph suitable for viewing with VCG
4710 to @file{@var{file}.@var{pass}.vcg}.
4711
4712 @item -dx
4713 @opindex dx
4714 Just generate RTL for a function instead of compiling it.  Usually used
4715 with @option{-fdump-rtl-expand}.
4716
4717 @item -dy
4718 @opindex dy
4719 Dump debugging information during parsing, to standard error.
4720 @end table
4721
4722 @item -fdump-noaddr
4723 @opindex fdump-noaddr
4724 When doing debugging dumps, suppress address output.  This makes it more
4725 feasible to use diff on debugging dumps for compiler invocations with
4726 different compiler binaries and/or different
4727 text / bss / data / heap / stack / dso start locations.
4728
4729 @item -fdump-unnumbered
4730 @opindex fdump-unnumbered
4731 When doing debugging dumps, suppress instruction numbers and address output.
4732 This makes it more feasible to use diff on debugging dumps for compiler
4733 invocations with different options, in particular with and without
4734 @option{-g}.
4735
4736 @item -fdump-translation-unit @r{(C++ only)}
4737 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4738 @opindex fdump-translation-unit
4739 Dump a representation of the tree structure for the entire translation
4740 unit to a file.  The file name is made by appending @file{.tu} to the
4741 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4742 controls the details of the dump as described for the
4743 @option{-fdump-tree} options.
4744
4745 @item -fdump-class-hierarchy @r{(C++ only)}
4746 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4747 @opindex fdump-class-hierarchy
4748 Dump a representation of each class's hierarchy and virtual function
4749 table layout to a file.  The file name is made by appending @file{.class}
4750 to the source file name.  If the @samp{-@var{options}} form is used,
4751 @var{options} controls the details of the dump as described for the
4752 @option{-fdump-tree} options.
4753
4754 @item -fdump-ipa-@var{switch}
4755 @opindex fdump-ipa
4756 Control the dumping at various stages of inter-procedural analysis
4757 language tree to a file.  The file name is generated by appending a switch
4758 specific suffix to the source file name.  The following dumps are possible:
4759
4760 @table @samp
4761 @item all
4762 Enables all inter-procedural analysis dumps.
4763
4764 @item cgraph
4765 Dumps information about call-graph optimization, unused function removal,
4766 and inlining decisions.
4767
4768 @item inline
4769 Dump after function inlining.
4770
4771 @end table
4772
4773 @item -fdump-statistics-@var{option}
4774 @opindex -fdump-statistics
4775 Enable and control dumping of pass statistics in a separate file.  The
4776 file name is generated by appending a suffix ending in @samp{.statistics}
4777 to the source file name.  If the @samp{-@var{option}} form is used,
4778 @samp{-stats} will cause counters to be summed over the whole compilation unit
4779 while @samp{-details} will dump every event as the passes generate them.
4780 The default with no option is to sum counters for each function compiled.
4781
4782 @item -fdump-tree-@var{switch}
4783 @itemx -fdump-tree-@var{switch}-@var{options}
4784 @opindex fdump-tree
4785 Control the dumping at various stages of processing the intermediate
4786 language tree to a file.  The file name is generated by appending a switch
4787 specific suffix to the source file name.  If the @samp{-@var{options}}
4788 form is used, @var{options} is a list of @samp{-} separated options that
4789 control the details of the dump.  Not all options are applicable to all
4790 dumps, those which are not meaningful will be ignored.  The following
4791 options are available
4792
4793 @table @samp
4794 @item address
4795 Print the address of each node.  Usually this is not meaningful as it
4796 changes according to the environment and source file.  Its primary use
4797 is for tying up a dump file with a debug environment.
4798 @item slim
4799 Inhibit dumping of members of a scope or body of a function merely
4800 because that scope has been reached.  Only dump such items when they
4801 are directly reachable by some other path.  When dumping pretty-printed
4802 trees, this option inhibits dumping the bodies of control structures.
4803 @item raw
4804 Print a raw representation of the tree.  By default, trees are
4805 pretty-printed into a C-like representation.
4806 @item details
4807 Enable more detailed dumps (not honored by every dump option).
4808 @item stats
4809 Enable dumping various statistics about the pass (not honored by every dump
4810 option).
4811 @item blocks
4812 Enable showing basic block boundaries (disabled in raw dumps).
4813 @item vops
4814 Enable showing virtual operands for every statement.
4815 @item lineno
4816 Enable showing line numbers for statements.
4817 @item uid
4818 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4819 @item verbose
4820 Enable showing the tree dump for each statement.
4821 @item all
4822 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
4823 and @option{lineno}.
4824 @end table
4825
4826 The following tree dumps are possible:
4827 @table @samp
4828
4829 @item original
4830 Dump before any tree based optimization, to @file{@var{file}.original}.
4831
4832 @item optimized
4833 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4834
4835 @item gimple
4836 @opindex fdump-tree-gimple
4837 Dump each function before and after the gimplification pass to a file.  The
4838 file name is made by appending @file{.gimple} to the source file name.
4839
4840 @item cfg
4841 @opindex fdump-tree-cfg
4842 Dump the control flow graph of each function to a file.  The file name is
4843 made by appending @file{.cfg} to the source file name.
4844
4845 @item vcg
4846 @opindex fdump-tree-vcg
4847 Dump the control flow graph of each function to a file in VCG format.  The
4848 file name is made by appending @file{.vcg} to the source file name.  Note
4849 that if the file contains more than one function, the generated file cannot
4850 be used directly by VCG@.  You will need to cut and paste each function's
4851 graph into its own separate file first.
4852
4853 @item ch
4854 @opindex fdump-tree-ch
4855 Dump each function after copying loop headers.  The file name is made by
4856 appending @file{.ch} to the source file name.
4857
4858 @item ssa
4859 @opindex fdump-tree-ssa
4860 Dump SSA related information to a file.  The file name is made by appending
4861 @file{.ssa} to the source file name.
4862
4863 @item alias
4864 @opindex fdump-tree-alias
4865 Dump aliasing information for each function.  The file name is made by
4866 appending @file{.alias} to the source file name.
4867
4868 @item ccp
4869 @opindex fdump-tree-ccp
4870 Dump each function after CCP@.  The file name is made by appending
4871 @file{.ccp} to the source file name.
4872
4873 @item storeccp
4874 @opindex fdump-tree-storeccp
4875 Dump each function after STORE-CCP@.  The file name is made by appending
4876 @file{.storeccp} to the source file name.
4877
4878 @item pre
4879 @opindex fdump-tree-pre
4880 Dump trees after partial redundancy elimination.  The file name is made
4881 by appending @file{.pre} to the source file name.
4882
4883 @item fre
4884 @opindex fdump-tree-fre
4885 Dump trees after full redundancy elimination.  The file name is made
4886 by appending @file{.fre} to the source file name.
4887
4888 @item copyprop
4889 @opindex fdump-tree-copyprop
4890 Dump trees after copy propagation.  The file name is made
4891 by appending @file{.copyprop} to the source file name.
4892
4893 @item store_copyprop
4894 @opindex fdump-tree-store_copyprop
4895 Dump trees after store copy-propagation.  The file name is made
4896 by appending @file{.store_copyprop} to the source file name.
4897
4898 @item dce
4899 @opindex fdump-tree-dce
4900 Dump each function after dead code elimination.  The file name is made by
4901 appending @file{.dce} to the source file name.
4902
4903 @item mudflap
4904 @opindex fdump-tree-mudflap
4905 Dump each function after adding mudflap instrumentation.  The file name is
4906 made by appending @file{.mudflap} to the source file name.
4907
4908 @item sra
4909 @opindex fdump-tree-sra
4910 Dump each function after performing scalar replacement of aggregates.  The
4911 file name is made by appending @file{.sra} to the source file name.
4912
4913 @item sink
4914 @opindex fdump-tree-sink
4915 Dump each function after performing code sinking.  The file name is made
4916 by appending @file{.sink} to the source file name.
4917
4918 @item dom
4919 @opindex fdump-tree-dom
4920 Dump each function after applying dominator tree optimizations.  The file
4921 name is made by appending @file{.dom} to the source file name.
4922
4923 @item dse
4924 @opindex fdump-tree-dse
4925 Dump each function after applying dead store elimination.  The file
4926 name is made by appending @file{.dse} to the source file name.
4927
4928 @item phiopt
4929 @opindex fdump-tree-phiopt
4930 Dump each function after optimizing PHI nodes into straightline code.  The file
4931 name is made by appending @file{.phiopt} to the source file name.
4932
4933 @item forwprop
4934 @opindex fdump-tree-forwprop
4935 Dump each function after forward propagating single use variables.  The file
4936 name is made by appending @file{.forwprop} to the source file name.
4937
4938 @item copyrename
4939 @opindex fdump-tree-copyrename
4940 Dump each function after applying the copy rename optimization.  The file
4941 name is made by appending @file{.copyrename} to the source file name.
4942
4943 @item nrv
4944 @opindex fdump-tree-nrv
4945 Dump each function after applying the named return value optimization on
4946 generic trees.  The file name is made by appending @file{.nrv} to the source
4947 file name.
4948
4949 @item vect
4950 @opindex fdump-tree-vect
4951 Dump each function after applying vectorization of loops.  The file name is
4952 made by appending @file{.vect} to the source file name.
4953
4954 @item vrp
4955 @opindex fdump-tree-vrp
4956 Dump each function after Value Range Propagation (VRP).  The file name
4957 is made by appending @file{.vrp} to the source file name.
4958
4959 @item all
4960 @opindex fdump-tree-all
4961 Enable all the available tree dumps with the flags provided in this option.
4962 @end table
4963
4964 @item -ftree-vectorizer-verbose=@var{n}
4965 @opindex ftree-vectorizer-verbose
4966 This option controls the amount of debugging output the vectorizer prints.
4967 This information is written to standard error, unless
4968 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4969 in which case it is output to the usual dump listing file, @file{.vect}.
4970 For @var{n}=0 no diagnostic information is reported.
4971 If @var{n}=1 the vectorizer reports each loop that got vectorized,
4972 and the total number of loops that got vectorized.
4973 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4974 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
4975 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
4976 level that @option{-fdump-tree-vect-stats} uses.
4977 Higher verbosity levels mean either more information dumped for each
4978 reported loop, or same amount of information reported for more loops:
4979 If @var{n}=3, alignment related information is added to the reports.
4980 If @var{n}=4, data-references related information (e.g.@: memory dependences,
4981 memory access-patterns) is added to the reports.
4982 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4983 that did not pass the first analysis phase (i.e., may not be countable, or
4984 may have complicated control-flow).
4985 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4986 For @var{n}=7, all the information the vectorizer generates during its
4987 analysis and transformation is reported.  This is the same verbosity level
4988 that @option{-fdump-tree-vect-details} uses.
4989
4990 @item -frandom-seed=@var{string}
4991 @opindex frandom-string
4992 This option provides a seed that GCC uses when it would otherwise use
4993 random numbers.  It is used to generate certain symbol names
4994 that have to be different in every compiled file.  It is also used to
4995 place unique stamps in coverage data files and the object files that
4996 produce them.  You can use the @option{-frandom-seed} option to produce
4997 reproducibly identical object files.
4998
4999 The @var{string} should be different for every file you compile.
5000
5001 @item -fsched-verbose=@var{n}
5002 @opindex fsched-verbose
5003 On targets that use instruction scheduling, this option controls the
5004 amount of debugging output the scheduler prints.  This information is
5005 written to standard error, unless @option{-fdump-rtl-sched1} or
5006 @option{-fdump-rtl-sched2} is specified, in which case it is output
5007 to the usual dump listing file, @file{.sched} or @file{.sched2}
5008 respectively.  However for @var{n} greater than nine, the output is
5009 always printed to standard error.
5010
5011 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5012 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5013 For @var{n} greater than one, it also output basic block probabilities,
5014 detailed ready list information and unit/insn info.  For @var{n} greater
5015 than two, it includes RTL at abort point, control-flow and regions info.
5016 And for @var{n} over four, @option{-fsched-verbose} also includes
5017 dependence info.
5018
5019 @item -save-temps
5020 @opindex save-temps
5021 Store the usual ``temporary'' intermediate files permanently; place them
5022 in the current directory and name them based on the source file.  Thus,
5023 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5024 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5025 preprocessed @file{foo.i} output file even though the compiler now
5026 normally uses an integrated preprocessor.
5027
5028 When used in combination with the @option{-x} command line option,
5029 @option{-save-temps} is sensible enough to avoid over writing an
5030 input source file with the same extension as an intermediate file.
5031 The corresponding intermediate file may be obtained by renaming the
5032 source file before using @option{-save-temps}.
5033
5034 @item -time
5035 @opindex time
5036 Report the CPU time taken by each subprocess in the compilation
5037 sequence.  For C source files, this is the compiler proper and assembler
5038 (plus the linker if linking is done).  The output looks like this:
5039
5040 @smallexample
5041 # cc1 0.12 0.01
5042 # as 0.00 0.01
5043 @end smallexample
5044
5045 The first number on each line is the ``user time'', that is time spent
5046 executing the program itself.  The second number is ``system time'',
5047 time spent executing operating system routines on behalf of the program.
5048 Both numbers are in seconds.
5049
5050 @item -fvar-tracking
5051 @opindex fvar-tracking
5052 Run variable tracking pass.  It computes where variables are stored at each
5053 position in code.  Better debugging information is then generated
5054 (if the debugging information format supports this information).
5055
5056 It is enabled by default when compiling with optimization (@option{-Os},
5057 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5058 the debug info format supports it.
5059
5060 @item -print-file-name=@var{library}
5061 @opindex print-file-name
5062 Print the full absolute name of the library file @var{library} that
5063 would be used when linking---and don't do anything else.  With this
5064 option, GCC does not compile or link anything; it just prints the
5065 file name.
5066
5067 @item -print-multi-directory
5068 @opindex print-multi-directory
5069 Print the directory name corresponding to the multilib selected by any
5070 other switches present in the command line.  This directory is supposed
5071 to exist in @env{GCC_EXEC_PREFIX}.
5072
5073 @item -print-multi-lib
5074 @opindex print-multi-lib
5075 Print the mapping from multilib directory names to compiler switches
5076 that enable them.  The directory name is separated from the switches by
5077 @samp{;}, and each switch starts with an @samp{@@} instead of the
5078 @samp{-}, without spaces between multiple switches.  This is supposed to
5079 ease shell-processing.
5080
5081 @item -print-prog-name=@var{program}
5082 @opindex print-prog-name
5083 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5084
5085 @item -print-libgcc-file-name
5086 @opindex print-libgcc-file-name
5087 Same as @option{-print-file-name=libgcc.a}.
5088
5089 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5090 but you do want to link with @file{libgcc.a}.  You can do
5091
5092 @smallexample
5093 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5094 @end smallexample
5095
5096 @item -print-search-dirs
5097 @opindex print-search-dirs
5098 Print the name of the configured installation directory and a list of
5099 program and library directories @command{gcc} will search---and don't do anything else.
5100
5101 This is useful when @command{gcc} prints the error message
5102 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5103 To resolve this you either need to put @file{cpp0} and the other compiler
5104 components where @command{gcc} expects to find them, or you can set the environment
5105 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5106 Don't forget the trailing @samp{/}.
5107 @xref{Environment Variables}.
5108
5109 @item -print-sysroot
5110 @opindex print-sysroot
5111 Print the target sysroot directory that will be used during
5112 compilation.  This is the target sysroot specified either at configure
5113 time or using the @option{--sysroot} option, possibly with an extra
5114 suffix that depends on compilation options.  If no target sysroot is
5115 specified, the option prints nothing.
5116
5117 @item -print-sysroot-headers-suffix
5118 @opindex print-sysroot-headers-suffix
5119 Print the suffix added to the target sysroot when searching for
5120 headers, or give an error if the compiler is not configured with such
5121 a suffix---and don't do anything else.
5122
5123 @item -dumpmachine
5124 @opindex dumpmachine
5125 Print the compiler's target machine (for example,
5126 @samp{i686-pc-linux-gnu})---and don't do anything else.
5127
5128 @item -dumpversion
5129 @opindex dumpversion
5130 Print the compiler version (for example, @samp{3.0})---and don't do
5131 anything else.
5132
5133 @item -dumpspecs
5134 @opindex dumpspecs
5135 Print the compiler's built-in specs---and don't do anything else.  (This
5136 is used when GCC itself is being built.)  @xref{Spec Files}.
5137
5138 @item -feliminate-unused-debug-types
5139 @opindex feliminate-unused-debug-types
5140 Normally, when producing DWARF2 output, GCC will emit debugging
5141 information for all types declared in a compilation
5142 unit, regardless of whether or not they are actually used
5143 in that compilation unit.  Sometimes this is useful, such as
5144 if, in the debugger, you want to cast a value to a type that is
5145 not actually used in your program (but is declared).  More often,
5146 however, this results in a significant amount of wasted space.
5147 With this option, GCC will avoid producing debug symbol output
5148 for types that are nowhere used in the source file being compiled.
5149 @end table
5150
5151 @node Optimize Options
5152 @section Options That Control Optimization
5153 @cindex optimize options
5154 @cindex options, optimization
5155
5156 These options control various sorts of optimizations.
5157
5158 Without any optimization option, the compiler's goal is to reduce the
5159 cost of compilation and to make debugging produce the expected
5160 results.  Statements are independent: if you stop the program with a
5161 breakpoint between statements, you can then assign a new value to any
5162 variable or change the program counter to any other statement in the
5163 function and get exactly the results you would expect from the source
5164 code.
5165
5166 Turning on optimization flags makes the compiler attempt to improve
5167 the performance and/or code size at the expense of compilation time
5168 and possibly the ability to debug the program.
5169
5170 The compiler performs optimization based on the knowledge it has of the
5171 program.  Compiling multiple files at once to a single output file mode allows
5172 the compiler to use information gained from all of the files when compiling
5173 each of them.
5174
5175 Not all optimizations are controlled directly by a flag.  Only
5176 optimizations that have a flag are listed.
5177
5178 @table @gcctabopt
5179 @item -O
5180 @itemx -O1
5181 @opindex O
5182 @opindex O1
5183 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5184 more memory for a large function.
5185
5186 With @option{-O}, the compiler tries to reduce code size and execution
5187 time, without performing any optimizations that take a great deal of
5188 compilation time.
5189
5190 @option{-O} turns on the following optimization flags:
5191 @gccoptlist{
5192 -fauto-inc-dec @gol
5193 -fcprop-registers @gol
5194 -fdce @gol
5195 -fdefer-pop @gol
5196 -fdelayed-branch @gol
5197 -fdse @gol
5198 -fguess-branch-probability @gol
5199 -fif-conversion2 @gol
5200 -fif-conversion @gol
5201 -finline-small-functions @gol
5202 -fipa-pure-const @gol
5203 -fipa-reference @gol
5204 -fmerge-constants
5205 -fsplit-wide-types @gol
5206 -ftree-builtin-call-dce @gol
5207 -ftree-ccp @gol
5208 -ftree-ch @gol
5209 -ftree-copyrename @gol
5210 -ftree-dce @gol
5211 -ftree-dominator-opts @gol
5212 -ftree-dse @gol
5213 -ftree-fre @gol
5214 -ftree-sra @gol
5215 -ftree-ter @gol
5216 -funit-at-a-time}
5217
5218 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5219 where doing so does not interfere with debugging.
5220
5221 @item -O2
5222 @opindex O2
5223 Optimize even more.  GCC performs nearly all supported optimizations
5224 that do not involve a space-speed tradeoff.  The compiler does not
5225 perform loop unrolling or function inlining when you specify @option{-O2}.
5226 As compared to @option{-O}, this option increases both compilation time
5227 and the performance of the generated code.
5228
5229 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5230 also turns on the following optimization flags:
5231 @gccoptlist{-fthread-jumps @gol
5232 -falign-functions  -falign-jumps @gol
5233 -falign-loops  -falign-labels @gol
5234 -fcaller-saves @gol
5235 -fcrossjumping @gol
5236 -fcse-follow-jumps  -fcse-skip-blocks @gol
5237 -fdelete-null-pointer-checks @gol
5238 -fexpensive-optimizations @gol
5239 -fgcse  -fgcse-lm  @gol
5240 -findirect-inlining @gol
5241 -foptimize-sibling-calls @gol
5242 -fpeephole2 @gol
5243 -fregmove @gol
5244 -freorder-blocks  -freorder-functions @gol
5245 -frerun-cse-after-loop  @gol
5246 -fsched-interblock  -fsched-spec @gol
5247 -fschedule-insns  -fschedule-insns2 @gol
5248 -fstrict-aliasing -fstrict-overflow @gol
5249 -ftree-switch-conversion @gol
5250 -ftree-pre @gol
5251 -ftree-vrp}
5252
5253 Please note the warning under @option{-fgcse} about
5254 invoking @option{-O2} on programs that use computed gotos.
5255
5256 @item -O3
5257 @opindex O3
5258 Optimize yet more.  @option{-O3} turns on all optimizations specified
5259 by @option{-O2} and also turns on the @option{-finline-functions},
5260 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5261 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5262
5263 @item -O0
5264 @opindex O0
5265 Reduce compilation time and make debugging produce the expected
5266 results.  This is the default.
5267
5268 @item -Os
5269 @opindex Os
5270 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5271 do not typically increase code size.  It also performs further
5272 optimizations designed to reduce code size.
5273
5274 @option{-Os} disables the following optimization flags:
5275 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5276 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5277 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5278
5279 If you use multiple @option{-O} options, with or without level numbers,
5280 the last such option is the one that is effective.
5281 @end table
5282
5283 Options of the form @option{-f@var{flag}} specify machine-independent
5284 flags.  Most flags have both positive and negative forms; the negative
5285 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5286 below, only one of the forms is listed---the one you typically will
5287 use.  You can figure out the other form by either removing @samp{no-}
5288 or adding it.
5289
5290 The following options control specific optimizations.  They are either
5291 activated by @option{-O} options or are related to ones that are.  You
5292 can use the following flags in the rare cases when ``fine-tuning'' of
5293 optimizations to be performed is desired.
5294
5295 @table @gcctabopt
5296 @item -fno-default-inline
5297 @opindex fno-default-inline
5298 Do not make member functions inline by default merely because they are
5299 defined inside the class scope (C++ only).  Otherwise, when you specify
5300 @w{@option{-O}}, member functions defined inside class scope are compiled
5301 inline by default; i.e., you don't need to add @samp{inline} in front of
5302 the member function name.
5303
5304 @item -fno-defer-pop
5305 @opindex fno-defer-pop
5306 Always pop the arguments to each function call as soon as that function
5307 returns.  For machines which must pop arguments after a function call,
5308 the compiler normally lets arguments accumulate on the stack for several
5309 function calls and pops them all at once.
5310
5311 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5312
5313 @item -fforward-propagate
5314 @opindex fforward-propagate
5315 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5316 instructions and checks if the result can be simplified.  If loop unrolling
5317 is active, two passes are performed and the second is scheduled after
5318 loop unrolling.
5319
5320 This option is enabled by default at optimization levels @option{-O2},
5321 @option{-O3}, @option{-Os}.
5322
5323 @item -fomit-frame-pointer
5324 @opindex fomit-frame-pointer
5325 Don't keep the frame pointer in a register for functions that
5326 don't need one.  This avoids the instructions to save, set up and
5327 restore frame pointers; it also makes an extra register available
5328 in many functions.  @strong{It also makes debugging impossible on
5329 some machines.}
5330
5331 On some machines, such as the VAX, this flag has no effect, because
5332 the standard calling sequence automatically handles the frame pointer
5333 and nothing is saved by pretending it doesn't exist.  The
5334 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5335 whether a target machine supports this flag.  @xref{Registers,,Register
5336 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5337
5338 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5339
5340 @item -foptimize-sibling-calls
5341 @opindex foptimize-sibling-calls
5342 Optimize sibling and tail recursive calls.
5343
5344 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5345
5346 @item -fno-inline
5347 @opindex fno-inline
5348 Don't pay attention to the @code{inline} keyword.  Normally this option
5349 is used to keep the compiler from expanding any functions inline.
5350 Note that if you are not optimizing, no functions can be expanded inline.
5351
5352 @item -finline-small-functions
5353 @opindex finline-small-functions
5354 Integrate functions into their callers when their body is smaller than expected
5355 function call code (so overall size of program gets smaller).  The compiler
5356 heuristically decides which functions are simple enough to be worth integrating
5357 in this way.
5358
5359 Enabled at level @option{-O2}.
5360
5361 @item -findirect-inlining
5362 @opindex findirect-inlining
5363 Inline also indirect calls that are discovered to be known at compile
5364 time thanks to previous inlining.  This option has any effect only
5365 when inlining itself is turned on by the @option{-finline-functions}
5366 or @option{-finline-small-functions} options.
5367
5368 Enabled at level @option{-O2}.
5369
5370 @item -finline-functions
5371 @opindex finline-functions
5372 Integrate all simple functions into their callers.  The compiler
5373 heuristically decides which functions are simple enough to be worth
5374 integrating in this way.
5375
5376 If all calls to a given function are integrated, and the function is
5377 declared @code{static}, then the function is normally not output as
5378 assembler code in its own right.
5379
5380 Enabled at level @option{-O3}.
5381
5382 @item -finline-functions-called-once
5383 @opindex finline-functions-called-once
5384 Consider all @code{static} functions called once for inlining into their
5385 caller even if they are not marked @code{inline}.  If a call to a given
5386 function is integrated, then the function is not output as assembler code
5387 in its own right.
5388
5389 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
5390
5391 @item -fearly-inlining
5392 @opindex fearly-inlining
5393 Inline functions marked by @code{always_inline} and functions whose body seems
5394 smaller than the function call overhead early before doing
5395 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5396 makes profiling significantly cheaper and usually inlining faster on programs
5397 having large chains of nested wrapper functions.
5398
5399 Enabled by default.
5400
5401 @item -finline-limit=@var{n}
5402 @opindex finline-limit
5403 By default, GCC limits the size of functions that can be inlined.  This flag
5404 allows coarse control of this limit.  @var{n} is the size of functions that
5405 can be inlined in number of pseudo instructions.
5406
5407 Inlining is actually controlled by a number of parameters, which may be
5408 specified individually by using @option{--param @var{name}=@var{value}}.
5409 The @option{-finline-limit=@var{n}} option sets some of these parameters
5410 as follows:
5411
5412 @table @gcctabopt
5413 @item max-inline-insns-single
5414 is set to @var{n}/2.
5415 @item max-inline-insns-auto
5416 is set to @var{n}/2.
5417 @end table
5418
5419 See below for a documentation of the individual
5420 parameters controlling inlining and for the defaults of these parameters.
5421
5422 @emph{Note:} there may be no value to @option{-finline-limit} that results
5423 in default behavior.
5424
5425 @emph{Note:} pseudo instruction represents, in this particular context, an
5426 abstract measurement of function's size.  In no way does it represent a count
5427 of assembly instructions and as such its exact meaning might change from one
5428 release to an another.
5429
5430 @item -fkeep-inline-functions
5431 @opindex fkeep-inline-functions
5432 In C, emit @code{static} functions that are declared @code{inline}
5433 into the object file, even if the function has been inlined into all
5434 of its callers.  This switch does not affect functions using the
5435 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5436 inline functions into the object file.
5437
5438 @item -fkeep-static-consts
5439 @opindex fkeep-static-consts
5440 Emit variables declared @code{static const} when optimization isn't turned
5441 on, even if the variables aren't referenced.
5442
5443 GCC enables this option by default.  If you want to force the compiler to
5444 check if the variable was referenced, regardless of whether or not
5445 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5446
5447 @item -fmerge-constants
5448 @opindex fmerge-constants
5449 Attempt to merge identical constants (string constants and floating point
5450 constants) across compilation units.
5451
5452 This option is the default for optimized compilation if the assembler and
5453 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5454 behavior.
5455
5456 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5457
5458 @item -fmerge-all-constants
5459 @opindex fmerge-all-constants
5460 Attempt to merge identical constants and identical variables.
5461
5462 This option implies @option{-fmerge-constants}.  In addition to
5463 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5464 arrays or initialized constant variables with integral or floating point
5465 types.  Languages like C or C++ require each non-automatic variable to
5466 have distinct location, so using this option will result in non-conforming
5467 behavior.
5468
5469 @item -fmodulo-sched
5470 @opindex fmodulo-sched
5471 Perform swing modulo scheduling immediately before the first scheduling
5472 pass.  This pass looks at innermost loops and reorders their
5473 instructions by overlapping different iterations.
5474
5475 @item -fmodulo-sched-allow-regmoves
5476 @opindex fmodulo-sched-allow-regmoves
5477 Perform more aggressive SMS based modulo scheduling with register moves
5478 allowed.  By setting this flag certain anti-dependences edges will be
5479 deleted which will trigger the generation of reg-moves based on the
5480 life-range analysis.  This option is effective only with
5481 @option{-fmodulo-sched} enabled.
5482
5483 @item -fno-branch-count-reg
5484 @opindex fno-branch-count-reg
5485 Do not use ``decrement and branch'' instructions on a count register,
5486 but instead generate a sequence of instructions that decrement a
5487 register, compare it against zero, then branch based upon the result.
5488 This option is only meaningful on architectures that support such
5489 instructions, which include x86, PowerPC, IA-64 and S/390.
5490
5491 The default is @option{-fbranch-count-reg}.
5492
5493 @item -fno-function-cse
5494 @opindex fno-function-cse
5495 Do not put function addresses in registers; make each instruction that
5496 calls a constant function contain the function's address explicitly.
5497
5498 This option results in less efficient code, but some strange hacks
5499 that alter the assembler output may be confused by the optimizations
5500 performed when this option is not used.
5501
5502 The default is @option{-ffunction-cse}
5503
5504 @item -fno-zero-initialized-in-bss
5505 @opindex fno-zero-initialized-in-bss
5506 If the target supports a BSS section, GCC by default puts variables that
5507 are initialized to zero into BSS@.  This can save space in the resulting
5508 code.
5509
5510 This option turns off this behavior because some programs explicitly
5511 rely on variables going to the data section.  E.g., so that the
5512 resulting executable can find the beginning of that section and/or make
5513 assumptions based on that.
5514
5515 The default is @option{-fzero-initialized-in-bss}.
5516
5517 @item -fmudflap -fmudflapth -fmudflapir
5518 @opindex fmudflap
5519 @opindex fmudflapth
5520 @opindex fmudflapir
5521 @cindex bounds checking
5522 @cindex mudflap
5523 For front-ends that support it (C and C++), instrument all risky
5524 pointer/array dereferencing operations, some standard library
5525 string/heap functions, and some other associated constructs with
5526 range/validity tests.  Modules so instrumented should be immune to
5527 buffer overflows, invalid heap use, and some other classes of C/C++
5528 programming errors.  The instrumentation relies on a separate runtime
5529 library (@file{libmudflap}), which will be linked into a program if
5530 @option{-fmudflap} is given at link time.  Run-time behavior of the
5531 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5532 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5533 for its options.
5534
5535 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5536 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5537 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5538 instrumentation should ignore pointer reads.  This produces less
5539 instrumentation (and therefore faster execution) and still provides
5540 some protection against outright memory corrupting writes, but allows
5541 erroneously read data to propagate within a program.
5542
5543 @item -fthread-jumps
5544 @opindex fthread-jumps
5545 Perform optimizations where we check to see if a jump branches to a
5546 location where another comparison subsumed by the first is found.  If
5547 so, the first branch is redirected to either the destination of the
5548 second branch or a point immediately following it, depending on whether
5549 the condition is known to be true or false.
5550
5551 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5552
5553 @item -fsplit-wide-types
5554 @opindex fsplit-wide-types
5555 When using a type that occupies multiple registers, such as @code{long
5556 long} on a 32-bit system, split the registers apart and allocate them
5557 independently.  This normally generates better code for those types,
5558 but may make debugging more difficult.
5559
5560 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5561 @option{-Os}.
5562
5563 @item -fcse-follow-jumps
5564 @opindex fcse-follow-jumps
5565 In common subexpression elimination (CSE), scan through jump instructions
5566 when the target of the jump is not reached by any other path.  For
5567 example, when CSE encounters an @code{if} statement with an
5568 @code{else} clause, CSE will follow the jump when the condition
5569 tested is false.
5570
5571 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5572
5573 @item -fcse-skip-blocks
5574 @opindex fcse-skip-blocks
5575 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5576 follow jumps which conditionally skip over blocks.  When CSE
5577 encounters a simple @code{if} statement with no else clause,
5578 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5579 body of the @code{if}.
5580
5581 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5582
5583 @item -frerun-cse-after-loop
5584 @opindex frerun-cse-after-loop
5585 Re-run common subexpression elimination after loop optimizations has been
5586 performed.
5587
5588 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5589
5590 @item -fgcse
5591 @opindex fgcse
5592 Perform a global common subexpression elimination pass.
5593 This pass also performs global constant and copy propagation.
5594
5595 @emph{Note:} When compiling a program using computed gotos, a GCC
5596 extension, you may get better runtime performance if you disable
5597 the global common subexpression elimination pass by adding
5598 @option{-fno-gcse} to the command line.
5599
5600 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5601
5602 @item -fgcse-lm
5603 @opindex fgcse-lm
5604 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5605 attempt to move loads which are only killed by stores into themselves.  This
5606 allows a loop containing a load/store sequence to be changed to a load outside
5607 the loop, and a copy/store within the loop.
5608
5609 Enabled by default when gcse is enabled.
5610
5611 @item -fgcse-sm
5612 @opindex fgcse-sm
5613 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5614 global common subexpression elimination.  This pass will attempt to move
5615 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5616 loops containing a load/store sequence can be changed to a load before
5617 the loop and a store after the loop.
5618
5619 Not enabled at any optimization level.
5620
5621 @item -fgcse-las
5622 @opindex fgcse-las
5623 When @option{-fgcse-las} is enabled, the global common subexpression
5624 elimination pass eliminates redundant loads that come after stores to the
5625 same memory location (both partial and full redundancies).
5626
5627 Not enabled at any optimization level.
5628
5629 @item -fgcse-after-reload
5630 @opindex fgcse-after-reload
5631 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5632 pass is performed after reload.  The purpose of this pass is to cleanup
5633 redundant spilling.
5634
5635 @item -funsafe-loop-optimizations
5636 @opindex funsafe-loop-optimizations
5637 If given, the loop optimizer will assume that loop indices do not
5638 overflow, and that the loops with nontrivial exit condition are not
5639 infinite.  This enables a wider range of loop optimizations even if
5640 the loop optimizer itself cannot prove that these assumptions are valid.
5641 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5642 if it finds this kind of loop.
5643
5644 @item -fcrossjumping
5645 @opindex fcrossjumping
5646 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5647 resulting code may or may not perform better than without cross-jumping.
5648
5649 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5650
5651 @item -fauto-inc-dec
5652 @opindex fauto-inc-dec
5653 Combine increments or decrements of addresses with memory accesses.
5654 This pass is always skipped on architectures that do not have
5655 instructions to support this.  Enabled by default at @option{-O} and
5656 higher on architectures that support this.
5657
5658 @item -fdce
5659 @opindex fdce
5660 Perform dead code elimination (DCE) on RTL@.
5661 Enabled by default at @option{-O} and higher.
5662
5663 @item -fdse
5664 @opindex fdse
5665 Perform dead store elimination (DSE) on RTL@.
5666 Enabled by default at @option{-O} and higher.
5667
5668 @item -fif-conversion
5669 @opindex fif-conversion
5670 Attempt to transform conditional jumps into branch-less equivalents.  This
5671 include use of conditional moves, min, max, set flags and abs instructions, and
5672 some tricks doable by standard arithmetics.  The use of conditional execution
5673 on chips where it is available is controlled by @code{if-conversion2}.
5674
5675 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5676
5677 @item -fif-conversion2
5678 @opindex fif-conversion2
5679 Use conditional execution (where available) to transform conditional jumps into
5680 branch-less equivalents.
5681
5682 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5683
5684 @item -fdelete-null-pointer-checks
5685 @opindex fdelete-null-pointer-checks
5686 Use global dataflow analysis to identify and eliminate useless checks
5687 for null pointers.  The compiler assumes that dereferencing a null
5688 pointer would have halted the program.  If a pointer is checked after
5689 it has already been dereferenced, it cannot be null.
5690
5691 In some environments, this assumption is not true, and programs can
5692 safely dereference null pointers.  Use
5693 @option{-fno-delete-null-pointer-checks} to disable this optimization
5694 for programs which depend on that behavior.
5695
5696 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5697
5698 @item -fexpensive-optimizations
5699 @opindex fexpensive-optimizations
5700 Perform a number of minor optimizations that are relatively expensive.
5701
5702 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5703
5704 @item -foptimize-register-move
5705 @itemx -fregmove
5706 @opindex foptimize-register-move
5707 @opindex fregmove
5708 Attempt to reassign register numbers in move instructions and as
5709 operands of other simple instructions in order to maximize the amount of
5710 register tying.  This is especially helpful on machines with two-operand
5711 instructions.
5712
5713 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5714 optimization.
5715
5716 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5717
5718 @item -fira
5719 @opindex fira
5720 Use the integrated register allocator (@acronym{IRA}) for register
5721 allocation.  It is a default if @acronym{IRA} has been ported for the
5722 target.
5723
5724 @item -fira-algorithm=@var{algorithm}
5725 Use specified algorithm for the integrated register allocator.  The
5726 @var{algorithm} argument should be one of @code{regional}, @code{CB},
5727 or @code{mixed}.  The second algorithm specifies Chaitin-Briggs
5728 coloring, the first one specifies regional coloring based on
5729 Chaitin-Briggs coloring, and the third one which is the default
5730 specifies a mix of Chaitin-Briggs and regional algorithms where loops
5731 with small register pressure are ignored.  The first algorithm can
5732 give best result for machines with small size and irregular register
5733 set, the second one is faster and generates decent code and the
5734 smallest size code, and the mixed algorithm usually give the best
5735 results in most cases and for most architectures.
5736
5737 @item -fira-coalesce
5738 @opindex fira-coalesce
5739 Do optimistic register coalescing.  This option might be profitable for
5740 architectures with big regular register files.
5741
5742 @item -fno-ira-share-save-slots
5743 @opindex fno-ira-share-save-slots
5744 Switch off sharing stack slots used for saving call used hard
5745 registers living through a call.  Each hard register will get a
5746 separate stack slot and as a result function stack frame will be
5747 bigger.
5748
5749 @item -fno-ira-share-spill-slots
5750 @opindex fno-ira-share-spill-slots
5751 Switch off sharing stack slots allocated for pseudo-registers.  Each
5752 pseudo-register which did not get a hard register will get a separate
5753 stack slot and as a result function stack frame will be bigger.
5754
5755 @item -fira-verbose=@var{n}
5756 @opindex fira-verbose
5757 Set up how verbose dump file for the integrated register allocator
5758 will be.  Default value is 5.  If the value is greater or equal to 10,
5759 the dump file will be stderr as if the value were @var{n} minus 10.
5760
5761 @item -fdelayed-branch
5762 @opindex fdelayed-branch
5763 If supported for the target machine, attempt to reorder instructions
5764 to exploit instruction slots available after delayed branch
5765 instructions.
5766
5767 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5768
5769 @item -fschedule-insns
5770 @opindex fschedule-insns
5771 If supported for the target machine, attempt to reorder instructions to
5772 eliminate execution stalls due to required data being unavailable.  This
5773 helps machines that have slow floating point or memory load instructions
5774 by allowing other instructions to be issued until the result of the load
5775 or floating point instruction is required.
5776
5777 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5778
5779 @item -fschedule-insns2
5780 @opindex fschedule-insns2
5781 Similar to @option{-fschedule-insns}, but requests an additional pass of
5782 instruction scheduling after register allocation has been done.  This is
5783 especially useful on machines with a relatively small number of
5784 registers and where memory load instructions take more than one cycle.
5785
5786 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5787
5788 @item -fno-sched-interblock
5789 @opindex fno-sched-interblock
5790 Don't schedule instructions across basic blocks.  This is normally
5791 enabled by default when scheduling before register allocation, i.e.@:
5792 with @option{-fschedule-insns} or at @option{-O2} or higher.
5793
5794 @item -fno-sched-spec
5795 @opindex fno-sched-spec
5796 Don't allow speculative motion of non-load instructions.  This is normally
5797 enabled by default when scheduling before register allocation, i.e.@:
5798 with @option{-fschedule-insns} or at @option{-O2} or higher.
5799
5800 @item -fsched-spec-load
5801 @opindex fsched-spec-load
5802 Allow speculative motion of some load instructions.  This only makes
5803 sense when scheduling before register allocation, i.e.@: with
5804 @option{-fschedule-insns} or at @option{-O2} or higher.
5805
5806 @item -fsched-spec-load-dangerous
5807 @opindex fsched-spec-load-dangerous
5808 Allow speculative motion of more load instructions.  This only makes
5809 sense when scheduling before register allocation, i.e.@: with
5810 @option{-fschedule-insns} or at @option{-O2} or higher.
5811
5812 @item -fsched-stalled-insns
5813 @itemx -fsched-stalled-insns=@var{n}
5814 @opindex fsched-stalled-insns
5815 Define how many insns (if any) can be moved prematurely from the queue
5816 of stalled insns into the ready list, during the second scheduling pass.
5817 @option{-fno-sched-stalled-insns} means that no insns will be moved
5818 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
5819 on how many queued insns can be moved prematurely.
5820 @option{-fsched-stalled-insns} without a value is equivalent to
5821 @option{-fsched-stalled-insns=1}.
5822
5823 @item -fsched-stalled-insns-dep
5824 @itemx -fsched-stalled-insns-dep=@var{n}
5825 @opindex fsched-stalled-insns-dep
5826 Define how many insn groups (cycles) will be examined for a dependency
5827 on a stalled insn that is candidate for premature removal from the queue
5828 of stalled insns.  This has an effect only during the second scheduling pass,
5829 and only if @option{-fsched-stalled-insns} is used.
5830 @option{-fno-sched-stalled-insns-dep} is equivalent to
5831 @option{-fsched-stalled-insns-dep=0}.
5832 @option{-fsched-stalled-insns-dep} without a value is equivalent to
5833 @option{-fsched-stalled-insns-dep=1}.
5834
5835 @item -fsched2-use-superblocks
5836 @opindex fsched2-use-superblocks
5837 When scheduling after register allocation, do use superblock scheduling
5838 algorithm.  Superblock scheduling allows motion across basic block boundaries
5839 resulting on faster schedules.  This option is experimental, as not all machine
5840 descriptions used by GCC model the CPU closely enough to avoid unreliable
5841 results from the algorithm.
5842
5843 This only makes sense when scheduling after register allocation, i.e.@: with
5844 @option{-fschedule-insns2} or at @option{-O2} or higher.
5845
5846 @item -fsched2-use-traces
5847 @opindex fsched2-use-traces
5848 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5849 allocation and additionally perform code duplication in order to increase the
5850 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5851 trace formation.
5852
5853 This mode should produce faster but significantly longer programs.  Also
5854 without @option{-fbranch-probabilities} the traces constructed may not
5855 match the reality and hurt the performance.  This only makes
5856 sense when scheduling after register allocation, i.e.@: with
5857 @option{-fschedule-insns2} or at @option{-O2} or higher.
5858
5859 @item -fsee
5860 @opindex fsee
5861 Eliminate redundant sign extension instructions and move the non-redundant
5862 ones to optimal placement using lazy code motion (LCM).
5863
5864 @item -freschedule-modulo-scheduled-loops
5865 @opindex freschedule-modulo-scheduled-loops
5866 The modulo scheduling comes before the traditional scheduling, if a loop
5867 was modulo scheduled we may want to prevent the later scheduling passes
5868 from changing its schedule, we use this option to control that.
5869
5870 @item -fselective-scheduling
5871 @opindex fselective-scheduling
5872 Schedule instructions using selective scheduling algorithm.  Selective
5873 scheduling runs instead of the first scheduler pass.
5874
5875 @item -fselective-scheduling2
5876 @opindex fselective-scheduling2
5877 Schedule instructions using selective scheduling algorithm.  Selective
5878 scheduling runs instead of the second scheduler pass.
5879
5880 @item -fsel-sched-pipelining
5881 @opindex fsel-sched-pipelining
5882 Enable software pipelining of innermost loops during selective scheduling.  
5883 This option has no effect until one of @option{-fselective-scheduling} or 
5884 @option{-fselective-scheduling2} is turned on.
5885
5886 @item -fsel-sched-pipelining-outer-loops
5887 @opindex fsel-sched-pipelining-outer-loops
5888 When pipelining loops during selective scheduling, also pipeline outer loops.
5889 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
5890
5891 @item -fcaller-saves
5892 @opindex fcaller-saves
5893 Enable values to be allocated in registers that will be clobbered by
5894 function calls, by emitting extra instructions to save and restore the
5895 registers around such calls.  Such allocation is done only when it
5896 seems to result in better code than would otherwise be produced.
5897
5898 This option is always enabled by default on certain machines, usually
5899 those which have no call-preserved registers to use instead.
5900
5901 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5902
5903 @item -fconserve-stack
5904 @opindex fconserve-stack
5905 Attempt to minimize stack usage.  The compiler will attempt to use less
5906 stack space, even if that makes the program slower.  This option
5907 implies setting the @option{large-stack-frame} parameter to 100
5908 and the @option{large-stack-frame-growth} parameter to 400.
5909
5910 @item -ftree-reassoc
5911 @opindex ftree-reassoc
5912 Perform reassociation on trees.  This flag is enabled by default
5913 at @option{-O} and higher.
5914
5915 @item -ftree-pre
5916 @opindex ftree-pre
5917 Perform partial redundancy elimination (PRE) on trees.  This flag is
5918 enabled by default at @option{-O2} and @option{-O3}.
5919
5920 @item -ftree-fre
5921 @opindex ftree-fre
5922 Perform full redundancy elimination (FRE) on trees.  The difference
5923 between FRE and PRE is that FRE only considers expressions
5924 that are computed on all paths leading to the redundant computation.
5925 This analysis is faster than PRE, though it exposes fewer redundancies.
5926 This flag is enabled by default at @option{-O} and higher.
5927
5928 @item -ftree-copy-prop
5929 @opindex ftree-copy-prop
5930 Perform copy propagation on trees.  This pass eliminates unnecessary
5931 copy operations.  This flag is enabled by default at @option{-O} and
5932 higher.
5933
5934 @item -fipa-pure-const
5935 @opindex fipa-pure-const
5936 Discover which functions are pure or constant.
5937 Enabled by default at @option{-O} and higher.
5938
5939 @item -fipa-reference
5940 @opindex fipa-reference
5941 Discover which static variables do not escape cannot escape the
5942 compilation unit.
5943 Enabled by default at @option{-O} and higher.
5944
5945 @item -fipa-struct-reorg
5946 @opindex fipa-struct-reorg
5947 Perform structure reorganization optimization, that change C-like structures 
5948 layout in order to better utilize spatial locality.  This transformation is 
5949 affective for programs containing arrays of structures.  Available in two 
5950 compilation modes: profile-based (enabled with @option{-fprofile-generate})
5951 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
5952 to provide the safety of this transformation.  It works only in whole program
5953 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
5954 enabled.  Structures considered @samp{cold} by this transformation are not
5955 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
5956
5957 With this flag, the program debug info reflects a new structure layout.
5958
5959 @item -fipa-pta
5960 @opindex fipa-pta
5961 Perform interprocedural pointer analysis.  This option is experimental
5962 and does not affect generated code.
5963
5964 @item -fipa-cp
5965 @opindex fipa-cp
5966 Perform interprocedural constant propagation.
5967 This optimization analyzes the program to determine when values passed
5968 to functions are constants and then optimizes accordingly.  
5969 This optimization can substantially increase performance
5970 if the application has constants passed to functions.
5971 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
5972
5973 @item -fipa-cp-clone
5974 @opindex fipa-cp-clone
5975 Perform function cloning to make interprocedural constant propagation stronger.
5976 When enabled, interprocedural constant propagation will perform function cloning
5977 when externally visible function can be called with constant arguments.
5978 Because this optimization can create multiple copies of functions,
5979 it may significantly increase code size
5980 (see @option{--param ipcp-unit-growth=@var{value}}).
5981 This flag is enabled by default at @option{-O3}.
5982
5983 @item -fipa-matrix-reorg
5984 @opindex fipa-matrix-reorg
5985 Perform matrix flattening and transposing.
5986 Matrix flattening tries to replace a m-dimensional matrix 
5987 with its equivalent n-dimensional matrix, where n < m.
5988 This reduces the level of indirection needed for accessing the elements
5989 of the matrix. The second optimization is matrix transposing that
5990 attemps to change the order of the matrix's dimensions in order to 
5991 improve cache locality.
5992 Both optimizations need fwhole-program flag. 
5993 Transposing is enabled only if profiling information is avaliable.
5994
5995
5996 @item -ftree-sink
5997 @opindex ftree-sink
5998 Perform forward store motion  on trees.  This flag is
5999 enabled by default at @option{-O} and higher.
6000
6001 @item -ftree-ccp
6002 @opindex ftree-ccp
6003 Perform sparse conditional constant propagation (CCP) on trees.  This
6004 pass only operates on local scalar variables and is enabled by default
6005 at @option{-O} and higher.
6006
6007 @item -ftree-switch-conversion
6008 Perform conversion of simple initializations in a switch to
6009 initializations from a scalar array.  This flag is enabled by default
6010 at @option{-O2} and higher.
6011
6012 @item -ftree-dce
6013 @opindex ftree-dce
6014 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6015 default at @option{-O} and higher.
6016
6017 @item -ftree-builtin-call-dce
6018 @opindex ftree-builtin-call-dce
6019 Perform conditional dead code elimination (DCE) for calls to builtin functions 
6020 that may set @code{errno} but are otherwise side-effect free.  This flag is 
6021 enabled by default at @option{-O2} and higher if @option{-Os} is not also 
6022 specified.
6023
6024 @item -ftree-dominator-opts
6025 @opindex ftree-dominator-opts
6026 Perform a variety of simple scalar cleanups (constant/copy
6027 propagation, redundancy elimination, range propagation and expression
6028 simplification) based on a dominator tree traversal.  This also
6029 performs jump threading (to reduce jumps to jumps). This flag is
6030 enabled by default at @option{-O} and higher.
6031
6032 @item -ftree-dse
6033 @opindex ftree-dse
6034 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6035 a memory location which will later be overwritten by another store without
6036 any intervening loads.  In this case the earlier store can be deleted.  This
6037 flag is enabled by default at @option{-O} and higher.
6038
6039 @item -ftree-ch
6040 @opindex ftree-ch
6041 Perform loop header copying on trees.  This is beneficial since it increases
6042 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6043 is enabled by default at @option{-O} and higher.  It is not enabled
6044 for @option{-Os}, since it usually increases code size.
6045
6046 @item -ftree-loop-optimize
6047 @opindex ftree-loop-optimize
6048 Perform loop optimizations on trees.  This flag is enabled by default
6049 at @option{-O} and higher.
6050
6051 @item -ftree-loop-linear
6052 @opindex ftree-loop-linear
6053 Perform linear loop transformations on tree.  This flag can improve cache
6054 performance and allow further loop optimizations to take place.
6055
6056 @item -floop-interchange
6057 Perform loop interchange transformations on loops.  Interchanging two
6058 nested loops switches the inner and outer loops.  For example, given a
6059 loop like:
6060 @smallexample
6061 DO J = 1, M
6062   DO I = 1, N
6063     A(J, I) = A(J, I) * C
6064   ENDDO
6065 ENDDO
6066 @end smallexample
6067 loop interchange will transform the loop as if the user had written:
6068 @smallexample
6069 DO I = 1, N
6070   DO J = 1, M
6071     A(J, I) = A(J, I) * C
6072   ENDDO
6073 ENDDO
6074 @end smallexample
6075 which can be beneficial when @code{N} is larger than the caches,
6076 because in Fortran, the elements of an array are stored in memory
6077 contiguously by column, and the original loop iterates over rows,
6078 potentially creating at each access a cache miss.  This optimization
6079 applies to all the languages supported by GCC and is not limited to
6080 Fortran.
6081
6082 @item -floop-strip-mine
6083 Perform loop strip mining transformations on loops.  Strip mining
6084 splits a loop into two nested loops.  The outer loop has strides 
6085 equal to the strip size and the inner loop has strides of the 
6086 original loop within a strip.  For example, given a loop like:
6087 @smallexample
6088 DO I = 1, N
6089   A(I) = A(I) + C
6090 ENDDO
6091 @end smallexample
6092 loop strip mining will transform the loop as if the user had written:
6093 @smallexample
6094 DO II = 1, N, 4
6095   DO I = II, min (II + 3, N)
6096     A(I) = A(I) + C
6097   ENDDO
6098 ENDDO
6099 @end smallexample
6100 This optimization applies to all the languages supported by GCC and is
6101 not limited to Fortran.
6102
6103 @item -floop-block
6104 Perform loop blocking transformations on loops.  Blocking strip mines
6105 each loop in the loop nest such that the memory accesses of the
6106 element loops fit inside caches.  For example, given a loop like:
6107 @smallexample
6108 DO I = 1, N
6109   DO J = 1, M
6110     A(J, I) = B(I) + C(J)
6111   ENDDO
6112 ENDDO
6113 @end smallexample
6114 loop blocking will transform the loop as if the user had written:
6115 @smallexample
6116 DO II = 1, N, 64
6117   DO JJ = 1, M, 64
6118     DO I = II, min (II + 63, N)
6119       DO J = JJ, min (JJ + 63, M)
6120         A(J, I) = B(I) + C(J)
6121       ENDDO
6122     ENDDO
6123   ENDDO
6124 ENDDO
6125 @end smallexample
6126 which can be beneficial when @code{M} is larger than the caches,
6127 because the innermost loop will iterate over a smaller amount of data
6128 that can be kept in the caches.  This optimization applies to all the
6129 languages supported by GCC and is not limited to Fortran.
6130
6131 @item -fcheck-data-deps
6132 @opindex fcheck-data-deps
6133 Compare the results of several data dependence analyzers.  This option
6134 is used for debugging the data dependence analyzers.
6135
6136 @item -ftree-loop-distribution
6137 Perform loop distribution.  This flag can improve cache performance on
6138 big loop bodies and allow further loop optimizations, like
6139 parallelization or vectorization, to take place.  For example, the loop
6140 @smallexample
6141 DO I = 1, N
6142   A(I) = B(I) + C
6143   D(I) = E(I) * F
6144 ENDDO
6145 @end smallexample
6146 is transformed to
6147 @smallexample
6148 DO I = 1, N
6149    A(I) = B(I) + C
6150 ENDDO
6151 DO I = 1, N
6152    D(I) = E(I) * F
6153 ENDDO
6154 @end smallexample
6155
6156 @item -ftree-loop-im
6157 @opindex ftree-loop-im
6158 Perform loop invariant motion on trees.  This pass moves only invariants that
6159 would be hard to handle at RTL level (function calls, operations that expand to
6160 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6161 operands of conditions that are invariant out of the loop, so that we can use
6162 just trivial invariantness analysis in loop unswitching.  The pass also includes
6163 store motion.
6164
6165 @item -ftree-loop-ivcanon
6166 @opindex ftree-loop-ivcanon
6167 Create a canonical counter for number of iterations in the loop for that
6168 determining number of iterations requires complicated analysis.  Later
6169 optimizations then may determine the number easily.  Useful especially
6170 in connection with unrolling.
6171
6172 @item -fivopts
6173 @opindex fivopts
6174 Perform induction variable optimizations (strength reduction, induction
6175 variable merging and induction variable elimination) on trees.
6176
6177 @item -ftree-parallelize-loops=n
6178 @opindex ftree-parallelize-loops
6179 Parallelize loops, i.e., split their iteration space to run in n threads.
6180 This is only possible for loops whose iterations are independent
6181 and can be arbitrarily reordered.  The optimization is only
6182 profitable on multiprocessor machines, for loops that are CPU-intensive,
6183 rather than constrained e.g.@: by memory bandwidth.  This option
6184 implies @option{-pthread}, and thus is only supported on targets
6185 that have support for @option{-pthread}.
6186
6187 @item -ftree-sra
6188 @opindex ftree-sra
6189 Perform scalar replacement of aggregates.  This pass replaces structure
6190 references with scalars to prevent committing structures to memory too
6191 early.  This flag is enabled by default at @option{-O} and higher.
6192
6193 @item -ftree-copyrename
6194 @opindex ftree-copyrename
6195 Perform copy renaming on trees.  This pass attempts to rename compiler
6196 temporaries to other variables at copy locations, usually resulting in
6197 variable names which more closely resemble the original variables.  This flag
6198 is enabled by default at @option{-O} and higher.
6199
6200 @item -ftree-ter
6201 @opindex ftree-ter
6202 Perform temporary expression replacement during the SSA->normal phase.  Single
6203 use/single def temporaries are replaced at their use location with their
6204 defining expression.  This results in non-GIMPLE code, but gives the expanders
6205 much more complex trees to work on resulting in better RTL generation.  This is
6206 enabled by default at @option{-O} and higher.
6207
6208 @item -ftree-vectorize
6209 @opindex ftree-vectorize
6210 Perform loop vectorization on trees. This flag is enabled by default at
6211 @option{-O3}.
6212
6213 @item -ftree-vect-loop-version
6214 @opindex ftree-vect-loop-version
6215 Perform loop versioning when doing loop vectorization on trees.  When a loop
6216 appears to be vectorizable except that data alignment or data dependence cannot
6217 be determined at compile time then vectorized and non-vectorized versions of
6218 the loop are generated along with runtime checks for alignment or dependence
6219 to control which version is executed.  This option is enabled by default
6220 except at level @option{-Os} where it is disabled.
6221
6222 @item -fvect-cost-model
6223 @opindex fvect-cost-model
6224 Enable cost model for vectorization.
6225
6226 @item -ftree-vrp
6227 @opindex ftree-vrp
6228 Perform Value Range Propagation on trees.  This is similar to the
6229 constant propagation pass, but instead of values, ranges of values are
6230 propagated.  This allows the optimizers to remove unnecessary range
6231 checks like array bound checks and null pointer checks.  This is
6232 enabled by default at @option{-O2} and higher.  Null pointer check
6233 elimination is only done if @option{-fdelete-null-pointer-checks} is
6234 enabled.
6235
6236 @item -ftracer
6237 @opindex ftracer
6238 Perform tail duplication to enlarge superblock size.  This transformation
6239 simplifies the control flow of the function allowing other optimizations to do
6240 better job.
6241
6242 @item -funroll-loops
6243 @opindex funroll-loops
6244 Unroll loops whose number of iterations can be determined at compile
6245 time or upon entry to the loop.  @option{-funroll-loops} implies
6246 @option{-frerun-cse-after-loop}.  This option makes code larger,
6247 and may or may not make it run faster.
6248
6249 @item -funroll-all-loops
6250 @opindex funroll-all-loops
6251 Unroll all loops, even if their number of iterations is uncertain when
6252 the loop is entered.  This usually makes programs run more slowly.
6253 @option{-funroll-all-loops} implies the same options as
6254 @option{-funroll-loops},
6255
6256 @item -fsplit-ivs-in-unroller
6257 @opindex fsplit-ivs-in-unroller
6258 Enables expressing of values of induction variables in later iterations
6259 of the unrolled loop using the value in the first iteration.  This breaks
6260 long dependency chains, thus improving efficiency of the scheduling passes.
6261
6262 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6263 same effect.  However in cases the loop body is more complicated than
6264 a single basic block, this is not reliable.  It also does not work at all
6265 on some of the architectures due to restrictions in the CSE pass.
6266
6267 This optimization is enabled by default.
6268
6269 @item -fvariable-expansion-in-unroller
6270 @opindex fvariable-expansion-in-unroller
6271 With this option, the compiler will create multiple copies of some
6272 local variables when unrolling a loop which can result in superior code.
6273
6274 @item -fpredictive-commoning
6275 @opindex fpredictive-commoning
6276 Perform predictive commoning optimization, i.e., reusing computations
6277 (especially memory loads and stores) performed in previous
6278 iterations of loops.
6279
6280 This option is enabled at level @option{-O3}.
6281
6282 @item -fprefetch-loop-arrays
6283 @opindex fprefetch-loop-arrays
6284 If supported by the target machine, generate instructions to prefetch
6285 memory to improve the performance of loops that access large arrays.
6286
6287 This option may generate better or worse code; results are highly
6288 dependent on the structure of loops within the source code.
6289
6290 Disabled at level @option{-Os}.
6291
6292 @item -fno-peephole
6293 @itemx -fno-peephole2
6294 @opindex fno-peephole
6295 @opindex fno-peephole2
6296 Disable any machine-specific peephole optimizations.  The difference
6297 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6298 are implemented in the compiler; some targets use one, some use the
6299 other, a few use both.
6300
6301 @option{-fpeephole} is enabled by default.
6302 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6303
6304 @item -fno-guess-branch-probability
6305 @opindex fno-guess-branch-probability
6306 Do not guess branch probabilities using heuristics.
6307
6308 GCC will use heuristics to guess branch probabilities if they are
6309 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6310 heuristics are based on the control flow graph.  If some branch probabilities
6311 are specified by @samp{__builtin_expect}, then the heuristics will be
6312 used to guess branch probabilities for the rest of the control flow graph,
6313 taking the @samp{__builtin_expect} info into account.  The interactions
6314 between the heuristics and @samp{__builtin_expect} can be complex, and in
6315 some cases, it may be useful to disable the heuristics so that the effects
6316 of @samp{__builtin_expect} are easier to understand.
6317
6318 The default is @option{-fguess-branch-probability} at levels
6319 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6320
6321 @item -freorder-blocks
6322 @opindex freorder-blocks
6323 Reorder basic blocks in the compiled function in order to reduce number of
6324 taken branches and improve code locality.
6325
6326 Enabled at levels @option{-O2}, @option{-O3}.
6327
6328 @item -freorder-blocks-and-partition
6329 @opindex freorder-blocks-and-partition
6330 In addition to reordering basic blocks in the compiled function, in order
6331 to reduce number of taken branches, partitions hot and cold basic blocks
6332 into separate sections of the assembly and .o files, to improve
6333 paging and cache locality performance.
6334
6335 This optimization is automatically turned off in the presence of
6336 exception handling, for linkonce sections, for functions with a user-defined
6337 section attribute and on any architecture that does not support named
6338 sections.
6339
6340 @item -freorder-functions
6341 @opindex freorder-functions
6342 Reorder functions in the object file in order to
6343 improve code locality.  This is implemented by using special
6344 subsections @code{.text.hot} for most frequently executed functions and
6345 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6346 the linker so object file format must support named sections and linker must
6347 place them in a reasonable way.
6348
6349 Also profile feedback must be available in to make this option effective.  See
6350 @option{-fprofile-arcs} for details.
6351
6352 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6353
6354 @item -fstrict-aliasing
6355 @opindex fstrict-aliasing
6356 Allows the compiler to assume the strictest aliasing rules applicable to
6357 the language being compiled.  For C (and C++), this activates
6358 optimizations based on the type of expressions.  In particular, an
6359 object of one type is assumed never to reside at the same address as an
6360 object of a different type, unless the types are almost the same.  For
6361 example, an @code{unsigned int} can alias an @code{int}, but not a
6362 @code{void*} or a @code{double}.  A character type may alias any other
6363 type.
6364
6365 @anchor{Type-punning}Pay special attention to code like this:
6366 @smallexample
6367 union a_union @{
6368   int i;
6369   double d;
6370 @};
6371
6372 int f() @{
6373   a_union t;
6374   t.d = 3.0;
6375   return t.i;
6376 @}
6377 @end smallexample
6378 The practice of reading from a different union member than the one most
6379 recently written to (called ``type-punning'') is common.  Even with
6380 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6381 is accessed through the union type.  So, the code above will work as
6382 expected.  @xref{Structures unions enumerations and bit-fields
6383 implementation}.  However, this code might not:
6384 @smallexample
6385 int f() @{
6386   a_union t;
6387   int* ip;
6388   t.d = 3.0;
6389   ip = &t.i;
6390   return *ip;
6391 @}
6392 @end smallexample
6393
6394 Similarly, access by taking the address, casting the resulting pointer
6395 and dereferencing the result has undefined behavior, even if the cast
6396 uses a union type, e.g.:
6397 @smallexample
6398 int f() @{
6399   double d = 3.0;
6400   return ((union a_union *) &d)->i;
6401 @}
6402 @end smallexample
6403
6404 The @option{-fstrict-aliasing} option is enabled at levels
6405 @option{-O2}, @option{-O3}, @option{-Os}.
6406
6407 @item -fstrict-overflow
6408 @opindex fstrict-overflow
6409 Allow the compiler to assume strict signed overflow rules, depending
6410 on the language being compiled.  For C (and C++) this means that
6411 overflow when doing arithmetic with signed numbers is undefined, which
6412 means that the compiler may assume that it will not happen.  This
6413 permits various optimizations.  For example, the compiler will assume
6414 that an expression like @code{i + 10 > i} will always be true for
6415 signed @code{i}.  This assumption is only valid if signed overflow is
6416 undefined, as the expression is false if @code{i + 10} overflows when
6417 using twos complement arithmetic.  When this option is in effect any
6418 attempt to determine whether an operation on signed numbers will
6419 overflow must be written carefully to not actually involve overflow.
6420
6421 This option also allows the compiler to assume strict pointer
6422 semantics: given a pointer to an object, if adding an offset to that
6423 pointer does not produce a pointer to the same object, the addition is
6424 undefined.  This permits the compiler to conclude that @code{p + u >
6425 p} is always true for a pointer @code{p} and unsigned integer
6426 @code{u}.  This assumption is only valid because pointer wraparound is
6427 undefined, as the expression is false if @code{p + u} overflows using
6428 twos complement arithmetic.
6429
6430 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6431 that integer signed overflow is fully defined: it wraps.  When
6432 @option{-fwrapv} is used, there is no difference between
6433 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
6434 integers.  With @option{-fwrapv} certain types of overflow are
6435 permitted.  For example, if the compiler gets an overflow when doing
6436 arithmetic on constants, the overflowed value can still be used with
6437 @option{-fwrapv}, but not otherwise.
6438
6439 The @option{-fstrict-overflow} option is enabled at levels
6440 @option{-O2}, @option{-O3}, @option{-Os}.
6441
6442 @item -falign-functions
6443 @itemx -falign-functions=@var{n}
6444 @opindex falign-functions
6445 Align the start of functions to the next power-of-two greater than
6446 @var{n}, skipping up to @var{n} bytes.  For instance,
6447 @option{-falign-functions=32} aligns functions to the next 32-byte
6448 boundary, but @option{-falign-functions=24} would align to the next
6449 32-byte boundary only if this can be done by skipping 23 bytes or less.
6450
6451 @option{-fno-align-functions} and @option{-falign-functions=1} are
6452 equivalent and mean that functions will not be aligned.
6453
6454 Some assemblers only support this flag when @var{n} is a power of two;
6455 in that case, it is rounded up.
6456
6457 If @var{n} is not specified or is zero, use a machine-dependent default.
6458
6459 Enabled at levels @option{-O2}, @option{-O3}.
6460
6461 @item -falign-labels
6462 @itemx -falign-labels=@var{n}
6463 @opindex falign-labels
6464 Align all branch targets to a power-of-two boundary, skipping up to
6465 @var{n} bytes like @option{-falign-functions}.  This option can easily
6466 make code slower, because it must insert dummy operations for when the
6467 branch target is reached in the usual flow of the code.
6468
6469 @option{-fno-align-labels} and @option{-falign-labels=1} are
6470 equivalent and mean that labels will not be aligned.
6471
6472 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6473 are greater than this value, then their values are used instead.
6474
6475 If @var{n} is not specified or is zero, use a machine-dependent default
6476 which is very likely to be @samp{1}, meaning no alignment.
6477
6478 Enabled at levels @option{-O2}, @option{-O3}.
6479
6480 @item -falign-loops
6481 @itemx -falign-loops=@var{n}
6482 @opindex falign-loops
6483 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6484 like @option{-falign-functions}.  The hope is that the loop will be
6485 executed many times, which will make up for any execution of the dummy
6486 operations.
6487
6488 @option{-fno-align-loops} and @option{-falign-loops=1} are
6489 equivalent and mean that loops will not be aligned.
6490
6491 If @var{n} is not specified or is zero, use a machine-dependent default.
6492
6493 Enabled at levels @option{-O2}, @option{-O3}.
6494
6495 @item -falign-jumps
6496 @itemx -falign-jumps=@var{n}
6497 @opindex falign-jumps
6498 Align branch targets to a power-of-two boundary, for branch targets
6499 where the targets can only be reached by jumping, skipping up to @var{n}
6500 bytes like @option{-falign-functions}.  In this case, no dummy operations
6501 need be executed.
6502
6503 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6504 equivalent and mean that loops will not be aligned.
6505
6506 If @var{n} is not specified or is zero, use a machine-dependent default.
6507
6508 Enabled at levels @option{-O2}, @option{-O3}.
6509
6510 @item -funit-at-a-time
6511 @opindex funit-at-a-time
6512 This option is left for compatibility reasons. @option{-funit-at-a-time}
6513 has no effect, while @option{-fno-unit-at-a-time} implies
6514 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
6515
6516 Enabled by default.
6517
6518 @item -fno-toplevel-reorder
6519 @opindex fno-toplevel-reorder
6520 Do not reorder top-level functions, variables, and @code{asm}
6521 statements.  Output them in the same order that they appear in the
6522 input file.  When this option is used, unreferenced static variables
6523 will not be removed.  This option is intended to support existing code
6524 which relies on a particular ordering.  For new code, it is better to
6525 use attributes.
6526
6527 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
6528 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
6529 targets.
6530
6531 @item -fweb
6532 @opindex fweb
6533 Constructs webs as commonly used for register allocation purposes and assign
6534 each web individual pseudo register.  This allows the register allocation pass
6535 to operate on pseudos directly, but also strengthens several other optimization
6536 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6537 however, make debugging impossible, since variables will no longer stay in a
6538 ``home register''.
6539
6540 Enabled by default with @option{-funroll-loops}.
6541
6542 @item -fwhole-program
6543 @opindex fwhole-program
6544 Assume that the current compilation unit represents whole program being
6545 compiled.  All public functions and variables with the exception of @code{main}
6546 and those merged by attribute @code{externally_visible} become static functions
6547 and in a affect gets more aggressively optimized by interprocedural optimizers.
6548 While this option is equivalent to proper use of @code{static} keyword for
6549 programs consisting of single file, in combination with option
6550 @option{--combine} this flag can be used to compile most of smaller scale C
6551 programs since the functions and variables become local for the whole combined
6552 compilation unit, not for the single source file itself.
6553
6554 This option is not supported for Fortran programs.
6555
6556 @item -fcprop-registers
6557 @opindex fcprop-registers
6558 After register allocation and post-register allocation instruction splitting,
6559 we perform a copy-propagation pass to try to reduce scheduling dependencies
6560 and occasionally eliminate the copy.
6561
6562 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6563
6564 @item -fprofile-correction
6565 @opindex fprofile-correction
6566 Profiles collected using an instrumented binary for multi-threaded programs may
6567 be inconsistent due to missed counter updates. When this option is specified,
6568 GCC will use heuristics to correct or smooth out such inconsistencies. By
6569 default, GCC will emit an error message when an inconsistent profile is detected.
6570
6571 @item -fprofile-dir=@var{path}
6572 @opindex fprofile-dir
6573
6574 Set the directory to search the profile data files in to @var{path}.
6575 This option affects only the profile data generated by
6576 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
6577 and used by @option{-fprofile-use} and @option{-fbranch-probabilities} 
6578 and its related options.
6579 By default, GCC will use the current directory as @var{path}
6580 thus the profile data file will appear in the same directory as the object file.
6581
6582 @item -fprofile-generate
6583 @itemx -fprofile-generate=@var{path}
6584 @opindex fprofile-generate
6585
6586 Enable options usually used for instrumenting application to produce
6587 profile useful for later recompilation with profile feedback based
6588 optimization.  You must use @option{-fprofile-generate} both when
6589 compiling and when linking your program.
6590
6591 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6592
6593 If @var{path} is specified, GCC will look at the @var{path} to find
6594 the profile feeedback data files. See @option{-fprofile-dir}.
6595
6596 @item -fprofile-use
6597 @itemx -fprofile-use=@var{path}
6598 @opindex fprofile-use
6599 Enable profile feedback directed optimizations, and optimizations
6600 generally profitable only with profile feedback available.
6601
6602 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6603 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6604
6605 By default, GCC emits an error message if the feedback profiles do not
6606 match the source code.  This error can be turned into a warning by using
6607 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6608 code.
6609
6610 If @var{path} is specified, GCC will look at the @var{path} to find
6611 the profile feedback data files. See @option{-fprofile-dir}.
6612 @end table
6613
6614 The following options control compiler behavior regarding floating
6615 point arithmetic.  These options trade off between speed and
6616 correctness.  All must be specifically enabled.
6617
6618 @table @gcctabopt
6619 @item -ffloat-store
6620 @opindex ffloat-store
6621 Do not store floating point variables in registers, and inhibit other
6622 options that might change whether a floating point value is taken from a
6623 register or memory.
6624
6625 @cindex floating point precision
6626 This option prevents undesirable excess precision on machines such as
6627 the 68000 where the floating registers (of the 68881) keep more
6628 precision than a @code{double} is supposed to have.  Similarly for the
6629 x86 architecture.  For most programs, the excess precision does only
6630 good, but a few programs rely on the precise definition of IEEE floating
6631 point.  Use @option{-ffloat-store} for such programs, after modifying
6632 them to store all pertinent intermediate computations into variables.
6633
6634 @item -ffast-math
6635 @opindex ffast-math
6636 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
6637 @option{-ffinite-math-only}, @option{-fno-rounding-math},
6638 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
6639
6640 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6641
6642 This option is not turned on by any @option{-O} option since
6643 it can result in incorrect output for programs which depend on
6644 an exact implementation of IEEE or ISO rules/specifications for
6645 math functions. It may, however, yield faster code for programs
6646 that do not require the guarantees of these specifications.
6647
6648 @item -fno-math-errno
6649 @opindex fno-math-errno
6650 Do not set ERRNO after calling math functions that are executed
6651 with a single instruction, e.g., sqrt.  A program that relies on
6652 IEEE exceptions for math error handling may want to use this flag
6653 for speed while maintaining IEEE arithmetic compatibility.
6654
6655 This option is not turned on by any @option{-O} option since
6656 it can result in incorrect output for programs which depend on
6657 an exact implementation of IEEE or ISO rules/specifications for
6658 math functions. It may, however, yield faster code for programs
6659 that do not require the guarantees of these specifications.
6660
6661 The default is @option{-fmath-errno}.
6662
6663 On Darwin systems, the math library never sets @code{errno}.  There is
6664 therefore no reason for the compiler to consider the possibility that
6665 it might, and @option{-fno-math-errno} is the default.
6666
6667 @item -funsafe-math-optimizations
6668 @opindex funsafe-math-optimizations
6669
6670 Allow optimizations for floating-point arithmetic that (a) assume
6671 that arguments and results are valid and (b) may violate IEEE or
6672 ANSI standards.  When used at link-time, it may include libraries
6673 or startup files that change the default FPU control word or other
6674 similar optimizations.
6675
6676 This option is not turned on by any @option{-O} option since
6677 it can result in incorrect output for programs which depend on
6678 an exact implementation of IEEE or ISO rules/specifications for
6679 math functions. It may, however, yield faster code for programs
6680 that do not require the guarantees of these specifications.
6681 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
6682 @option{-fassociative-math} and @option{-freciprocal-math}.
6683
6684 The default is @option{-fno-unsafe-math-optimizations}.
6685
6686 @item -fassociative-math
6687 @opindex fassociative-math
6688
6689 Allow re-association of operands in series of floating-point operations.
6690 This violates the ISO C and C++ language standard by possibly changing
6691 computation result.  NOTE: re-ordering may change the sign of zero as
6692 well as ignore NaNs and inhibit or create underflow or overflow (and
6693 thus cannot be used on a code which relies on rounding behavior like
6694 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
6695 and thus may not be used when ordered comparisons are required.
6696 This option requires that both @option{-fno-signed-zeros} and
6697 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
6698 much sense with @option{-frounding-math}.
6699
6700 The default is @option{-fno-associative-math}.
6701
6702 @item -freciprocal-math
6703 @opindex freciprocal-math
6704
6705 Allow the reciprocal of a value to be used instead of dividing by
6706 the value if this enables optimizations.  For example @code{x / y}
6707 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
6708 is subject to common subexpression elimination.  Note that this loses
6709 precision and increases the number of flops operating on the value.
6710
6711 The default is @option{-fno-reciprocal-math}.
6712
6713 @item -ffinite-math-only
6714 @opindex ffinite-math-only
6715 Allow optimizations for floating-point arithmetic that assume
6716 that arguments and results are not NaNs or +-Infs.
6717
6718 This option is not turned on by any @option{-O} option since
6719 it can result in incorrect output for programs which depend on
6720 an exact implementation of IEEE or ISO rules/specifications for
6721 math functions. It may, however, yield faster code for programs
6722 that do not require the guarantees of these specifications.
6723
6724 The default is @option{-fno-finite-math-only}.
6725
6726 @item -fno-signed-zeros
6727 @opindex fno-signed-zeros
6728 Allow optimizations for floating point arithmetic that ignore the
6729 signedness of zero.  IEEE arithmetic specifies the behavior of
6730 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6731 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6732 This option implies that the sign of a zero result isn't significant.
6733
6734 The default is @option{-fsigned-zeros}.
6735
6736 @item -fno-trapping-math
6737 @opindex fno-trapping-math
6738 Compile code assuming that floating-point operations cannot generate
6739 user-visible traps.  These traps include division by zero, overflow,
6740 underflow, inexact result and invalid operation.  This option requires
6741 that @option{-fno-signaling-nans} be in effect.  Setting this option may
6742 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
6743
6744 This option should never be turned on by any @option{-O} option since
6745 it can result in incorrect output for programs which depend on
6746 an exact implementation of IEEE or ISO rules/specifications for
6747 math functions.
6748
6749 The default is @option{-ftrapping-math}.
6750
6751 @item -frounding-math
6752 @opindex frounding-math
6753 Disable transformations and optimizations that assume default floating
6754 point rounding behavior.  This is round-to-zero for all floating point
6755 to integer conversions, and round-to-nearest for all other arithmetic
6756 truncations.  This option should be specified for programs that change
6757 the FP rounding mode dynamically, or that may be executed with a
6758 non-default rounding mode.  This option disables constant folding of
6759 floating point expressions at compile-time (which may be affected by
6760 rounding mode) and arithmetic transformations that are unsafe in the
6761 presence of sign-dependent rounding modes.
6762
6763 The default is @option{-fno-rounding-math}.
6764
6765 This option is experimental and does not currently guarantee to
6766 disable all GCC optimizations that are affected by rounding mode.
6767 Future versions of GCC may provide finer control of this setting
6768 using C99's @code{FENV_ACCESS} pragma.  This command line option
6769 will be used to specify the default state for @code{FENV_ACCESS}.
6770
6771 @item -frtl-abstract-sequences
6772 @opindex frtl-abstract-sequences
6773 It is a size optimization method. This option is to find identical
6774 sequences of code, which can be turned into pseudo-procedures  and
6775 then  replace  all  occurrences with  calls to  the  newly created
6776 subroutine. It is kind of an opposite of @option{-finline-functions}.
6777 This optimization runs at RTL level.
6778
6779 @item -fsignaling-nans
6780 @opindex fsignaling-nans
6781 Compile code assuming that IEEE signaling NaNs may generate user-visible
6782 traps during floating-point operations.  Setting this option disables
6783 optimizations that may change the number of exceptions visible with
6784 signaling NaNs.  This option implies @option{-ftrapping-math}.
6785
6786 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6787 be defined.
6788
6789 The default is @option{-fno-signaling-nans}.
6790
6791 This option is experimental and does not currently guarantee to
6792 disable all GCC optimizations that affect signaling NaN behavior.
6793
6794 @item -fsingle-precision-constant
6795 @opindex fsingle-precision-constant
6796 Treat floating point constant as single precision constant instead of
6797 implicitly converting it to double precision constant.
6798
6799 @item -fcx-limited-range
6800 @opindex fcx-limited-range
6801 When enabled, this option states that a range reduction step is not
6802 needed when performing complex division.  Also, there is no checking
6803 whether the result of a complex multiplication or division is @code{NaN
6804 + I*NaN}, with an attempt to rescue the situation in that case.  The
6805 default is @option{-fno-cx-limited-range}, but is enabled by
6806 @option{-ffast-math}.
6807
6808 This option controls the default setting of the ISO C99
6809 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6810 all languages.
6811
6812 @item -fcx-fortran-rules
6813 @opindex fcx-fortran-rules
6814 Complex multiplication and division follow Fortran rules.  Range
6815 reduction is done as part of complex division, but there is no checking
6816 whether the result of a complex multiplication or division is @code{NaN
6817 + I*NaN}, with an attempt to rescue the situation in that case.
6818
6819 The default is @option{-fno-cx-fortran-rules}.
6820
6821 @end table
6822
6823 The following options control optimizations that may improve
6824 performance, but are not enabled by any @option{-O} options.  This
6825 section includes experimental options that may produce broken code.
6826
6827 @table @gcctabopt
6828 @item -fbranch-probabilities
6829 @opindex fbranch-probabilities
6830 After running a program compiled with @option{-fprofile-arcs}
6831 (@pxref{Debugging Options,, Options for Debugging Your Program or
6832 @command{gcc}}), you can compile it a second time using
6833 @option{-fbranch-probabilities}, to improve optimizations based on
6834 the number of times each branch was taken.  When the program
6835 compiled with @option{-fprofile-arcs} exits it saves arc execution
6836 counts to a file called @file{@var{sourcename}.gcda} for each source
6837 file.  The information in this data file is very dependent on the
6838 structure of the generated code, so you must use the same source code
6839 and the same optimization options for both compilations.
6840
6841 With @option{-fbranch-probabilities}, GCC puts a
6842 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6843 These can be used to improve optimization.  Currently, they are only
6844 used in one place: in @file{reorg.c}, instead of guessing which path a
6845 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6846 exactly determine which path is taken more often.
6847
6848 @item -fprofile-values
6849 @opindex fprofile-values
6850 If combined with @option{-fprofile-arcs}, it adds code so that some
6851 data about values of expressions in the program is gathered.
6852
6853 With @option{-fbranch-probabilities}, it reads back the data gathered
6854 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6855 notes to instructions for their later usage in optimizations.
6856
6857 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6858
6859 @item -fvpt
6860 @opindex fvpt
6861 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
6862 a code to gather information about values of expressions.
6863
6864 With @option{-fbranch-probabilities}, it reads back the data gathered
6865 and actually performs the optimizations based on them.
6866 Currently the optimizations include specialization of division operation
6867 using the knowledge about the value of the denominator.
6868
6869 @item -frename-registers
6870 @opindex frename-registers
6871 Attempt to avoid false dependencies in scheduled code by making use
6872 of registers left over after register allocation.  This optimization
6873 will most benefit processors with lots of registers.  Depending on the
6874 debug information format adopted by the target, however, it can
6875 make debugging impossible, since variables will no longer stay in
6876 a ``home register''.
6877
6878 Enabled by default with @option{-funroll-loops}.
6879
6880 @item -ftracer
6881 @opindex ftracer
6882 Perform tail duplication to enlarge superblock size.  This transformation
6883 simplifies the control flow of the function allowing other optimizations to do
6884 better job.
6885
6886 Enabled with @option{-fprofile-use}.
6887
6888 @item -funroll-loops
6889 @opindex funroll-loops
6890 Unroll loops whose number of iterations can be determined at compile time or
6891 upon entry to the loop.  @option{-funroll-loops} implies
6892 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
6893 It also turns on complete loop peeling (i.e.@: complete removal of loops with
6894 small constant number of iterations).  This option makes code larger, and may
6895 or may not make it run faster.
6896
6897 Enabled with @option{-fprofile-use}.
6898
6899 @item -funroll-all-loops
6900 @opindex funroll-all-loops
6901 Unroll all loops, even if their number of iterations is uncertain when
6902 the loop is entered.  This usually makes programs run more slowly.
6903 @option{-funroll-all-loops} implies the same options as
6904 @option{-funroll-loops}.
6905
6906 @item -fpeel-loops
6907 @opindex fpeel-loops
6908 Peels the loops for that there is enough information that they do not
6909 roll much (from profile feedback).  It also turns on complete loop peeling
6910 (i.e.@: complete removal of loops with small constant number of iterations).
6911
6912 Enabled with @option{-fprofile-use}.
6913
6914 @item -fmove-loop-invariants
6915 @opindex fmove-loop-invariants
6916 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
6917 at level @option{-O1}
6918
6919 @item -funswitch-loops
6920 @opindex funswitch-loops
6921 Move branches with loop invariant conditions out of the loop, with duplicates
6922 of the loop on both branches (modified according to result of the condition).
6923
6924 @item -ffunction-sections
6925 @itemx -fdata-sections
6926 @opindex ffunction-sections
6927 @opindex fdata-sections
6928 Place each function or data item into its own section in the output
6929 file if the target supports arbitrary sections.  The name of the
6930 function or the name of the data item determines the section's name
6931 in the output file.
6932
6933 Use these options on systems where the linker can perform optimizations
6934 to improve locality of reference in the instruction space.  Most systems
6935 using the ELF object format and SPARC processors running Solaris 2 have
6936 linkers with such optimizations.  AIX may have these optimizations in
6937 the future.
6938
6939 Only use these options when there are significant benefits from doing
6940 so.  When you specify these options, the assembler and linker will
6941 create larger object and executable files and will also be slower.
6942 You will not be able to use @code{gprof} on all systems if you
6943 specify this option and you may have problems with debugging if
6944 you specify both this option and @option{-g}.
6945
6946 @item -fbranch-target-load-optimize
6947 @opindex fbranch-target-load-optimize
6948 Perform branch target register load optimization before prologue / epilogue
6949 threading.
6950 The use of target registers can typically be exposed only during reload,
6951 thus hoisting loads out of loops and doing inter-block scheduling needs
6952 a separate optimization pass.
6953
6954 @item -fbranch-target-load-optimize2
6955 @opindex fbranch-target-load-optimize2
6956 Perform branch target register load optimization after prologue / epilogue
6957 threading.
6958
6959 @item -fbtr-bb-exclusive
6960 @opindex fbtr-bb-exclusive
6961 When performing branch target register load optimization, don't reuse
6962 branch target registers in within any basic block.
6963
6964 @item -fstack-protector
6965 @opindex fstack-protector
6966 Emit extra code to check for buffer overflows, such as stack smashing
6967 attacks.  This is done by adding a guard variable to functions with
6968 vulnerable objects.  This includes functions that call alloca, and
6969 functions with buffers larger than 8 bytes.  The guards are initialized
6970 when a function is entered and then checked when the function exits.
6971 If a guard check fails, an error message is printed and the program exits.
6972
6973 @item -fstack-protector-all
6974 @opindex fstack-protector-all
6975 Like @option{-fstack-protector} except that all functions are protected.
6976
6977 @item -fsection-anchors
6978 @opindex fsection-anchors
6979 Try to reduce the number of symbolic address calculations by using
6980 shared ``anchor'' symbols to address nearby objects.  This transformation
6981 can help to reduce the number of GOT entries and GOT accesses on some
6982 targets.
6983
6984 For example, the implementation of the following function @code{foo}:
6985
6986 @smallexample
6987 static int a, b, c;
6988 int foo (void) @{ return a + b + c; @}
6989 @end smallexample
6990
6991 would usually calculate the addresses of all three variables, but if you
6992 compile it with @option{-fsection-anchors}, it will access the variables
6993 from a common anchor point instead.  The effect is similar to the
6994 following pseudocode (which isn't valid C):
6995
6996 @smallexample
6997 int foo (void)
6998 @{
6999   register int *xr = &x;
7000   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
7001 @}
7002 @end smallexample
7003
7004 Not all targets support this option.
7005
7006 @item --param @var{name}=@var{value}
7007 @opindex param
7008 In some places, GCC uses various constants to control the amount of
7009 optimization that is done.  For example, GCC will not inline functions
7010 that contain more that a certain number of instructions.  You can
7011 control some of these constants on the command-line using the
7012 @option{--param} option.
7013
7014 The names of specific parameters, and the meaning of the values, are
7015 tied to the internals of the compiler, and are subject to change
7016 without notice in future releases.
7017
7018 In each case, the @var{value} is an integer.  The allowable choices for
7019 @var{name} are given in the following table:
7020
7021 @table @gcctabopt
7022 @item sra-max-structure-size
7023 The maximum structure size, in bytes, at which the scalar replacement
7024 of aggregates (SRA) optimization will perform block copies.  The
7025 default value, 0, implies that GCC will select the most appropriate
7026 size itself.
7027
7028 @item sra-field-structure-ratio
7029 The threshold ratio (as a percentage) between instantiated fields and
7030 the complete structure size.  We say that if the ratio of the number
7031 of bytes in instantiated fields to the number of bytes in the complete
7032 structure exceeds this parameter, then block copies are not used.  The
7033 default is 75.
7034
7035 @item struct-reorg-cold-struct-ratio
7036 The threshold ratio (as a percentage) between a structure frequency
7037 and the frequency of the hottest structure in the program.  This parameter
7038 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
7039 We say that if the ratio of a structure frequency, calculated by profiling, 
7040 to the hottest structure frequency in the program is less than this 
7041 parameter, then structure reorganization is not applied to this structure.
7042 The default is 10.
7043
7044 @item predictable-branch-cost-outcome
7045 When branch is predicted to be taken with probability lower than this threshold
7046 (in percent), then it is considered well predictable. The default is 10.
7047
7048 @item max-crossjump-edges
7049 The maximum number of incoming edges to consider for crossjumping.
7050 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
7051 the number of edges incoming to each block.  Increasing values mean
7052 more aggressive optimization, making the compile time increase with
7053 probably small improvement in executable size.
7054
7055 @item min-crossjump-insns
7056 The minimum number of instructions which must be matched at the end
7057 of two blocks before crossjumping will be performed on them.  This
7058 value is ignored in the case where all instructions in the block being
7059 crossjumped from are matched.  The default value is 5.
7060
7061 @item max-grow-copy-bb-insns
7062 The maximum code size expansion factor when copying basic blocks
7063 instead of jumping.  The expansion is relative to a jump instruction.
7064 The default value is 8.
7065
7066 @item max-goto-duplication-insns
7067 The maximum number of instructions to duplicate to a block that jumps
7068 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
7069 passes, GCC factors computed gotos early in the compilation process,
7070 and unfactors them as late as possible.  Only computed jumps at the
7071 end of a basic blocks with no more than max-goto-duplication-insns are
7072 unfactored.  The default value is 8.
7073
7074 @item max-delay-slot-insn-search
7075 The maximum number of instructions to consider when looking for an
7076 instruction to fill a delay slot.  If more than this arbitrary number of
7077 instructions is searched, the time savings from filling the delay slot
7078 will be minimal so stop searching.  Increasing values mean more
7079 aggressive optimization, making the compile time increase with probably
7080 small improvement in executable run time.
7081
7082 @item max-delay-slot-live-search
7083 When trying to fill delay slots, the maximum number of instructions to
7084 consider when searching for a block with valid live register
7085 information.  Increasing this arbitrarily chosen value means more
7086 aggressive optimization, increasing the compile time.  This parameter
7087 should be removed when the delay slot code is rewritten to maintain the
7088 control-flow graph.
7089
7090 @item max-gcse-memory
7091 The approximate maximum amount of memory that will be allocated in
7092 order to perform the global common subexpression elimination
7093 optimization.  If more memory than specified is required, the
7094 optimization will not be done.
7095
7096 @item max-gcse-passes
7097 The maximum number of passes of GCSE to run.  The default is 1.
7098
7099 @item max-pending-list-length
7100 The maximum number of pending dependencies scheduling will allow
7101 before flushing the current state and starting over.  Large functions
7102 with few branches or calls can create excessively large lists which
7103 needlessly consume memory and resources.
7104
7105 @item max-inline-insns-single
7106 Several parameters control the tree inliner used in gcc.
7107 This number sets the maximum number of instructions (counted in GCC's
7108 internal representation) in a single function that the tree inliner
7109 will consider for inlining.  This only affects functions declared
7110 inline and methods implemented in a class declaration (C++).
7111 The default value is 450.
7112
7113 @item max-inline-insns-auto
7114 When you use @option{-finline-functions} (included in @option{-O3}),
7115 a lot of functions that would otherwise not be considered for inlining
7116 by the compiler will be investigated.  To those functions, a different
7117 (more restrictive) limit compared to functions declared inline can
7118 be applied.
7119 The default value is 90.
7120
7121 @item large-function-insns
7122 The limit specifying really large functions.  For functions larger than this
7123 limit after inlining, inlining is constrained by
7124 @option{--param large-function-growth}.  This parameter is useful primarily
7125 to avoid extreme compilation time caused by non-linear algorithms used by the
7126 backend.
7127 The default value is 2700.
7128
7129 @item large-function-growth
7130 Specifies maximal growth of large function caused by inlining in percents.
7131 The default value is 100 which limits large function growth to 2.0 times
7132 the original size.
7133
7134 @item large-unit-insns
7135 The limit specifying large translation unit.  Growth caused by inlining of
7136 units larger than this limit is limited by @option{--param inline-unit-growth}.
7137 For small units this might be too tight (consider unit consisting of function A
7138 that is inline and B that just calls A three time.  If B is small relative to
7139 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
7140 large units consisting of small inlineable functions however the overall unit
7141 growth limit is needed to avoid exponential explosion of code size.  Thus for
7142 smaller units, the size is increased to @option{--param large-unit-insns}
7143 before applying @option{--param inline-unit-growth}.  The default is 10000
7144
7145 @item inline-unit-growth
7146 Specifies maximal overall growth of the compilation unit caused by inlining.
7147 The default value is 30 which limits unit growth to 1.3 times the original
7148 size.
7149
7150 @item ipcp-unit-growth
7151 Specifies maximal overall growth of the compilation unit caused by
7152 interprocedural constant propagation.  The default value is 10 which limits
7153 unit growth to 1.1 times the original size.
7154
7155 @item large-stack-frame
7156 The limit specifying large stack frames.  While inlining the algorithm is trying
7157 to not grow past this limit too much.  Default value is 256 bytes.
7158
7159 @item large-stack-frame-growth
7160 Specifies maximal growth of large stack frames caused by inlining in percents.
7161 The default value is 1000 which limits large stack frame growth to 11 times
7162 the original size.
7163
7164 @item max-inline-insns-recursive
7165 @itemx max-inline-insns-recursive-auto
7166 Specifies maximum number of instructions out-of-line copy of self recursive inline
7167 function can grow into by performing recursive inlining.
7168
7169 For functions declared inline @option{--param max-inline-insns-recursive} is
7170 taken into account.  For function not declared inline, recursive inlining
7171 happens only when @option{-finline-functions} (included in @option{-O3}) is
7172 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
7173 default value is 450.
7174
7175 @item max-inline-recursive-depth
7176 @itemx max-inline-recursive-depth-auto
7177 Specifies maximum recursion depth used by the recursive inlining.
7178
7179 For functions declared inline @option{--param max-inline-recursive-depth} is
7180 taken into account.  For function not declared inline, recursive inlining
7181 happens only when @option{-finline-functions} (included in @option{-O3}) is
7182 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
7183 default value is 8.
7184
7185 @item min-inline-recursive-probability
7186 Recursive inlining is profitable only for function having deep recursion
7187 in average and can hurt for function having little recursion depth by
7188 increasing the prologue size or complexity of function body to other
7189 optimizers.
7190
7191 When profile feedback is available (see @option{-fprofile-generate}) the actual
7192 recursion depth can be guessed from probability that function will recurse via
7193 given call expression.  This parameter limits inlining only to call expression
7194 whose probability exceeds given threshold (in percents).  The default value is
7195 10.
7196
7197 @item inline-call-cost
7198 Specify cost of call instruction relative to simple arithmetics operations
7199 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
7200 functions and at the same time increases size of leaf function that is believed to
7201 reduce function size by being inlined.  In effect it increases amount of
7202 inlining for code having large abstraction penalty (many functions that just
7203 pass the arguments to other functions) and decrease inlining for code with low
7204 abstraction penalty.  The default value is 12.
7205
7206 @item min-vect-loop-bound
7207 The minimum number of iterations under which a loop will not get vectorized
7208 when @option{-ftree-vectorize} is used.  The number of iterations after
7209 vectorization needs to be greater than the value specified by this option
7210 to allow vectorization.  The default value is 0.
7211
7212 @item max-unrolled-insns
7213 The maximum number of instructions that a loop should have if that loop
7214 is unrolled, and if the loop is unrolled, it determines how many times
7215 the loop code is unrolled.
7216
7217 @item max-average-unrolled-insns
7218 The maximum number of instructions biased by probabilities of their execution
7219 that a loop should have if that loop is unrolled, and if the loop is unrolled,
7220 it determines how many times the loop code is unrolled.
7221
7222 @item max-unroll-times
7223 The maximum number of unrollings of a single loop.
7224
7225 @item max-peeled-insns
7226 The maximum number of instructions that a loop should have if that loop
7227 is peeled, and if the loop is peeled, it determines how many times
7228 the loop code is peeled.
7229
7230 @item max-peel-times
7231 The maximum number of peelings of a single loop.
7232
7233 @item max-completely-peeled-insns
7234 The maximum number of insns of a completely peeled loop.
7235
7236 @item max-completely-peel-times
7237 The maximum number of iterations of a loop to be suitable for complete peeling.
7238
7239 @item max-unswitch-insns
7240 The maximum number of insns of an unswitched loop.
7241
7242 @item max-unswitch-level
7243 The maximum number of branches unswitched in a single loop.
7244
7245 @item lim-expensive
7246 The minimum cost of an expensive expression in the loop invariant motion.
7247
7248 @item iv-consider-all-candidates-bound
7249 Bound on number of candidates for induction variables below that
7250 all candidates are considered for each use in induction variable
7251 optimizations.  Only the most relevant candidates are considered
7252 if there are more candidates, to avoid quadratic time complexity.
7253
7254 @item iv-max-considered-uses
7255 The induction variable optimizations give up on loops that contain more
7256 induction variable uses.
7257
7258 @item iv-always-prune-cand-set-bound
7259 If number of candidates in the set is smaller than this value,
7260 we always try to remove unnecessary ivs from the set during its
7261 optimization when a new iv is added to the set.
7262
7263 @item scev-max-expr-size
7264 Bound on size of expressions used in the scalar evolutions analyzer.
7265 Large expressions slow the analyzer.
7266
7267 @item omega-max-vars
7268 The maximum number of variables in an Omega constraint system.
7269 The default value is 128.
7270
7271 @item omega-max-geqs
7272 The maximum number of inequalities in an Omega constraint system.
7273 The default value is 256.
7274
7275 @item omega-max-eqs
7276 The maximum number of equalities in an Omega constraint system.
7277 The default value is 128.
7278
7279 @item omega-max-wild-cards
7280 The maximum number of wildcard variables that the Omega solver will
7281 be able to insert.  The default value is 18.
7282
7283 @item omega-hash-table-size
7284 The size of the hash table in the Omega solver.  The default value is
7285 550.
7286
7287 @item omega-max-keys
7288 The maximal number of keys used by the Omega solver.  The default
7289 value is 500.
7290
7291 @item omega-eliminate-redundant-constraints
7292 When set to 1, use expensive methods to eliminate all redundant
7293 constraints.  The default value is 0.
7294
7295 @item vect-max-version-for-alignment-checks
7296 The maximum number of runtime checks that can be performed when
7297 doing loop versioning for alignment in the vectorizer.  See option
7298 ftree-vect-loop-version for more information.
7299
7300 @item vect-max-version-for-alias-checks
7301 The maximum number of runtime checks that can be performed when
7302 doing loop versioning for alias in the vectorizer.  See option
7303 ftree-vect-loop-version for more information.
7304
7305 @item max-iterations-to-track
7306
7307 The maximum number of iterations of a loop the brute force algorithm
7308 for analysis of # of iterations of the loop tries to evaluate.
7309
7310 @item hot-bb-count-fraction
7311 Select fraction of the maximal count of repetitions of basic block in program
7312 given basic block needs to have to be considered hot.
7313
7314 @item hot-bb-frequency-fraction
7315 Select fraction of the maximal frequency of executions of basic block in
7316 function given basic block needs to have to be considered hot
7317
7318 @item max-predicted-iterations
7319 The maximum number of loop iterations we predict statically.  This is useful
7320 in cases where function contain single loop with known bound and other loop
7321 with unknown.  We predict the known number of iterations correctly, while
7322 the unknown number of iterations average to roughly 10.  This means that the
7323 loop without bounds would appear artificially cold relative to the other one.
7324
7325 @item align-threshold
7326
7327 Select fraction of the maximal frequency of executions of basic block in
7328 function given basic block will get aligned.
7329
7330 @item align-loop-iterations
7331
7332 A loop expected to iterate at lest the selected number of iterations will get
7333 aligned.
7334
7335 @item tracer-dynamic-coverage
7336 @itemx tracer-dynamic-coverage-feedback
7337
7338 This value is used to limit superblock formation once the given percentage of
7339 executed instructions is covered.  This limits unnecessary code size
7340 expansion.
7341
7342 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7343 feedback is available.  The real profiles (as opposed to statically estimated
7344 ones) are much less balanced allowing the threshold to be larger value.
7345
7346 @item tracer-max-code-growth
7347 Stop tail duplication once code growth has reached given percentage.  This is
7348 rather hokey argument, as most of the duplicates will be eliminated later in
7349 cross jumping, so it may be set to much higher values than is the desired code
7350 growth.
7351
7352 @item tracer-min-branch-ratio
7353
7354 Stop reverse growth when the reverse probability of best edge is less than this
7355 threshold (in percent).
7356
7357 @item tracer-min-branch-ratio
7358 @itemx tracer-min-branch-ratio-feedback
7359
7360 Stop forward growth if the best edge do have probability lower than this
7361 threshold.
7362
7363 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7364 compilation for profile feedback and one for compilation without.  The value
7365 for compilation with profile feedback needs to be more conservative (higher) in
7366 order to make tracer effective.
7367
7368 @item max-cse-path-length
7369
7370 Maximum number of basic blocks on path that cse considers.  The default is 10.
7371
7372 @item max-cse-insns
7373 The maximum instructions CSE process before flushing. The default is 1000.
7374
7375 @item max-aliased-vops
7376
7377 Maximum number of virtual operands per function allowed to represent
7378 aliases before triggering the alias partitioning heuristic.  Alias
7379 partitioning reduces compile times and memory consumption needed for
7380 aliasing at the expense of precision loss in alias information.  The
7381 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
7382 for -O3.
7383
7384 Notice that if a function contains more memory statements than the
7385 value of this parameter, it is not really possible to achieve this
7386 reduction.  In this case, the compiler will use the number of memory
7387 statements as the value for @option{max-aliased-vops}.
7388
7389 @item avg-aliased-vops
7390
7391 Average number of virtual operands per statement allowed to represent
7392 aliases before triggering the alias partitioning heuristic.  This
7393 works in conjunction with @option{max-aliased-vops}.  If a function
7394 contains more than @option{max-aliased-vops} virtual operators, then
7395 memory symbols will be grouped into memory partitions until either the
7396 total number of virtual operators is below @option{max-aliased-vops}
7397 or the average number of virtual operators per memory statement is
7398 below @option{avg-aliased-vops}.  The default value for this parameter
7399 is 1 for -O1 and -O2, and 3 for -O3.
7400
7401 @item ggc-min-expand
7402
7403 GCC uses a garbage collector to manage its own memory allocation.  This
7404 parameter specifies the minimum percentage by which the garbage
7405 collector's heap should be allowed to expand between collections.
7406 Tuning this may improve compilation speed; it has no effect on code
7407 generation.
7408
7409 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7410 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7411 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7412 GCC is not able to calculate RAM on a particular platform, the lower
7413 bound of 30% is used.  Setting this parameter and
7414 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7415 every opportunity.  This is extremely slow, but can be useful for
7416 debugging.
7417
7418 @item ggc-min-heapsize
7419
7420 Minimum size of the garbage collector's heap before it begins bothering
7421 to collect garbage.  The first collection occurs after the heap expands
7422 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7423 tuning this may improve compilation speed, and has no effect on code
7424 generation.
7425
7426 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7427 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7428 with a lower bound of 4096 (four megabytes) and an upper bound of
7429 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7430 particular platform, the lower bound is used.  Setting this parameter
7431 very large effectively disables garbage collection.  Setting this
7432 parameter and @option{ggc-min-expand} to zero causes a full collection
7433 to occur at every opportunity.
7434
7435 @item max-reload-search-insns
7436 The maximum number of instruction reload should look backward for equivalent
7437 register.  Increasing values mean more aggressive optimization, making the
7438 compile time increase with probably slightly better performance.  The default
7439 value is 100.
7440
7441 @item max-cselib-memory-locations
7442 The maximum number of memory locations cselib should take into account.
7443 Increasing values mean more aggressive optimization, making the compile time
7444 increase with probably slightly better performance.  The default value is 500.
7445
7446 @item reorder-blocks-duplicate
7447 @itemx reorder-blocks-duplicate-feedback
7448
7449 Used by basic block reordering pass to decide whether to use unconditional
7450 branch or duplicate the code on its destination.  Code is duplicated when its
7451 estimated size is smaller than this value multiplied by the estimated size of
7452 unconditional jump in the hot spots of the program.
7453
7454 The @option{reorder-block-duplicate-feedback} is used only when profile
7455 feedback is available and may be set to higher values than
7456 @option{reorder-block-duplicate} since information about the hot spots is more
7457 accurate.
7458
7459 @item max-sched-ready-insns
7460 The maximum number of instructions ready to be issued the scheduler should
7461 consider at any given time during the first scheduling pass.  Increasing
7462 values mean more thorough searches, making the compilation time increase
7463 with probably little benefit.  The default value is 100.
7464
7465 @item max-sched-region-blocks
7466 The maximum number of blocks in a region to be considered for
7467 interblock scheduling.  The default value is 10.
7468
7469 @item max-pipeline-region-blocks
7470 The maximum number of blocks in a region to be considered for
7471 pipelining in the selective scheduler.  The default value is 15.
7472
7473 @item max-sched-region-insns
7474 The maximum number of insns in a region to be considered for
7475 interblock scheduling.  The default value is 100.
7476
7477 @item max-pipeline-region-insns
7478 The maximum number of insns in a region to be considered for
7479 pipelining in the selective scheduler.  The default value is 200.
7480
7481 @item min-spec-prob
7482 The minimum probability (in percents) of reaching a source block
7483 for interblock speculative scheduling.  The default value is 40.
7484
7485 @item max-sched-extend-regions-iters
7486 The maximum number of iterations through CFG to extend regions.
7487 0 - disable region extension,
7488 N - do at most N iterations.
7489 The default value is 0.
7490
7491 @item max-sched-insn-conflict-delay
7492 The maximum conflict delay for an insn to be considered for speculative motion.
7493 The default value is 3.
7494
7495 @item sched-spec-prob-cutoff
7496 The minimal probability of speculation success (in percents), so that
7497 speculative insn will be scheduled.
7498 The default value is 40.
7499
7500 @item sched-mem-true-dep-cost
7501 Minimal distance (in CPU cycles) between store and load targeting same
7502 memory locations.  The default value is 1.
7503
7504 @item selsched-max-lookahead
7505 The maximum size of the lookahead window of selective scheduling.  It is a
7506 depth of search for available instructions.
7507 The default value is 50.
7508
7509 @item selsched-max-sched-times
7510 The maximum number of times that an instruction will be scheduled during 
7511 selective scheduling.  This is the limit on the number of iterations 
7512 through which the instruction may be pipelined.  The default value is 2.
7513
7514 @item selsched-max-insns-to-rename
7515 The maximum number of best instructions in the ready list that are considered
7516 for renaming in the selective scheduler.  The default value is 2.
7517
7518 @item max-last-value-rtl
7519 The maximum size measured as number of RTLs that can be recorded in an expression
7520 in combiner for a pseudo register as last known value of that register.  The default
7521 is 10000.
7522
7523 @item integer-share-limit
7524 Small integer constants can use a shared data structure, reducing the
7525 compiler's memory usage and increasing its speed.  This sets the maximum
7526 value of a shared integer constant.  The default value is 256.
7527
7528 @item min-virtual-mappings
7529 Specifies the minimum number of virtual mappings in the incremental
7530 SSA updater that should be registered to trigger the virtual mappings
7531 heuristic defined by virtual-mappings-ratio.  The default value is
7532 100.
7533
7534 @item virtual-mappings-ratio
7535 If the number of virtual mappings is virtual-mappings-ratio bigger
7536 than the number of virtual symbols to be updated, then the incremental
7537 SSA updater switches to a full update for those symbols.  The default
7538 ratio is 3.
7539
7540 @item ssp-buffer-size
7541 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
7542 protection when @option{-fstack-protection} is used.
7543
7544 @item max-jump-thread-duplication-stmts
7545 Maximum number of statements allowed in a block that needs to be
7546 duplicated when threading jumps.
7547
7548 @item max-fields-for-field-sensitive
7549 Maximum number of fields in a structure we will treat in
7550 a field sensitive manner during pointer analysis.  The default is zero
7551 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
7552
7553 @item prefetch-latency
7554 Estimate on average number of instructions that are executed before
7555 prefetch finishes.  The distance we prefetch ahead is proportional
7556 to this constant.  Increasing this number may also lead to less
7557 streams being prefetched (see @option{simultaneous-prefetches}).
7558
7559 @item simultaneous-prefetches
7560 Maximum number of prefetches that can run at the same time.
7561
7562 @item l1-cache-line-size
7563 The size of cache line in L1 cache, in bytes.
7564
7565 @item l1-cache-size
7566 The size of L1 cache, in kilobytes.
7567
7568 @item l2-cache-size
7569 The size of L2 cache, in kilobytes.
7570
7571 @item use-canonical-types
7572 Whether the compiler should use the ``canonical'' type system.  By
7573 default, this should always be 1, which uses a more efficient internal
7574 mechanism for comparing types in C++ and Objective-C++.  However, if
7575 bugs in the canonical type system are causing compilation failures,
7576 set this value to 0 to disable canonical types.
7577
7578 @item switch-conversion-max-branch-ratio
7579 Switch initialization conversion will refuse to create arrays that are
7580 bigger than @option{switch-conversion-max-branch-ratio} times the number of
7581 branches in the switch.
7582
7583 @item max-partial-antic-length
7584 Maximum length of the partial antic set computed during the tree
7585 partial redundancy elimination optimization (@option{-ftree-pre}) when
7586 optimizing at @option{-O3} and above.  For some sorts of source code
7587 the enhanced partial redundancy elimination optimization can run away,
7588 consuming all of the memory available on the host machine.  This
7589 parameter sets a limit on the length of the sets that are computed,
7590 which prevents the runaway behaviour.  Setting a value of 0 for
7591 this paramter will allow an unlimited set length.
7592
7593 @item sccvn-max-scc-size
7594 Maximum size of a strongly connected component (SCC) during SCCVN
7595 processing.  If this limit is hit, SCCVN processing for the whole
7596 function will not be done and optimizations depending on it will
7597 be disabled.  The default maximum SCC size is 10000.
7598
7599 @item ira-max-loops-num
7600 IRA uses a regional register allocation by default.  If a function
7601 contains loops more than number given by the parameter, non-regional
7602 register allocator will be used even when option
7603 @option{-fira-algorithm} is given.  The default value of the parameter
7604 is 20.
7605
7606 @end table
7607 @end table
7608
7609 @node Preprocessor Options
7610 @section Options Controlling the Preprocessor
7611 @cindex preprocessor options
7612 @cindex options, preprocessor
7613
7614 These options control the C preprocessor, which is run on each C source
7615 file before actual compilation.
7616
7617 If you use the @option{-E} option, nothing is done except preprocessing.
7618 Some of these options make sense only together with @option{-E} because
7619 they cause the preprocessor output to be unsuitable for actual
7620 compilation.
7621
7622 @table @gcctabopt
7623 @opindex Wp
7624 You can use @option{-Wp,@var{option}} to bypass the compiler driver
7625 and pass @var{option} directly through to the preprocessor.  If
7626 @var{option} contains commas, it is split into multiple options at the
7627 commas.  However, many options are modified, translated or interpreted
7628 by the compiler driver before being passed to the preprocessor, and
7629 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
7630 interface is undocumented and subject to change, so whenever possible
7631 you should avoid using @option{-Wp} and let the driver handle the
7632 options instead.
7633
7634 @item -Xpreprocessor @var{option}
7635 @opindex preprocessor
7636 Pass @var{option} as an option to the preprocessor.  You can use this to
7637 supply system-specific preprocessor options which GCC does not know how to
7638 recognize.
7639
7640 If you want to pass an option that takes an argument, you must use
7641 @option{-Xpreprocessor} twice, once for the option and once for the argument.
7642 @end table
7643
7644 @include cppopts.texi
7645
7646 @node Assembler Options
7647 @section Passing Options to the Assembler
7648
7649 @c prevent bad page break with this line
7650 You can pass options to the assembler.
7651
7652 @table @gcctabopt
7653 @item -Wa,@var{option}
7654 @opindex Wa
7655 Pass @var{option} as an option to the assembler.  If @var{option}
7656 contains commas, it is split into multiple options at the commas.
7657
7658 @item -Xassembler @var{option}
7659 @opindex Xassembler
7660 Pass @var{option} as an option to the assembler.  You can use this to
7661 supply system-specific assembler options which GCC does not know how to
7662 recognize.
7663
7664 If you want to pass an option that takes an argument, you must use
7665 @option{-Xassembler} twice, once for the option and once for the argument.
7666
7667 @end table
7668
7669 @node Link Options
7670 @section Options for Linking
7671 @cindex link options
7672 @cindex options, linking
7673
7674 These options come into play when the compiler links object files into
7675 an executable output file.  They are meaningless if the compiler is
7676 not doing a link step.
7677
7678 @table @gcctabopt
7679 @cindex file names
7680 @item @var{object-file-name}
7681 A file name that does not end in a special recognized suffix is
7682 considered to name an object file or library.  (Object files are
7683 distinguished from libraries by the linker according to the file
7684 contents.)  If linking is done, these object files are used as input
7685 to the linker.
7686
7687 @item -c
7688 @itemx -S
7689 @itemx -E
7690 @opindex c
7691 @opindex S
7692 @opindex E
7693 If any of these options is used, then the linker is not run, and
7694 object file names should not be used as arguments.  @xref{Overall
7695 Options}.
7696
7697 @cindex Libraries
7698 @item -l@var{library}
7699 @itemx -l @var{library}
7700 @opindex l
7701 Search the library named @var{library} when linking.  (The second
7702 alternative with the library as a separate argument is only for
7703 POSIX compliance and is not recommended.)
7704
7705 It makes a difference where in the command you write this option; the
7706 linker searches and processes libraries and object files in the order they
7707 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7708 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7709 to functions in @samp{z}, those functions may not be loaded.
7710
7711 The linker searches a standard list of directories for the library,
7712 which is actually a file named @file{lib@var{library}.a}.  The linker
7713 then uses this file as if it had been specified precisely by name.
7714
7715 The directories searched include several standard system directories
7716 plus any that you specify with @option{-L}.
7717
7718 Normally the files found this way are library files---archive files
7719 whose members are object files.  The linker handles an archive file by
7720 scanning through it for members which define symbols that have so far
7721 been referenced but not defined.  But if the file that is found is an
7722 ordinary object file, it is linked in the usual fashion.  The only
7723 difference between using an @option{-l} option and specifying a file name
7724 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7725 and searches several directories.
7726
7727 @item -lobjc
7728 @opindex lobjc
7729 You need this special case of the @option{-l} option in order to
7730 link an Objective-C or Objective-C++ program.
7731
7732 @item -nostartfiles
7733 @opindex nostartfiles
7734 Do not use the standard system startup files when linking.
7735 The standard system libraries are used normally, unless @option{-nostdlib}
7736 or @option{-nodefaultlibs} is used.
7737
7738 @item -nodefaultlibs
7739 @opindex nodefaultlibs
7740 Do not use the standard system libraries when linking.
7741 Only the libraries you specify will be passed to the linker.
7742 The standard startup files are used normally, unless @option{-nostartfiles}
7743 is used.  The compiler may generate calls to @code{memcmp},
7744 @code{memset}, @code{memcpy} and @code{memmove}.
7745 These entries are usually resolved by entries in
7746 libc.  These entry points should be supplied through some other
7747 mechanism when this option is specified.
7748
7749 @item -nostdlib
7750 @opindex nostdlib
7751 Do not use the standard system startup files or libraries when linking.
7752 No startup files and only the libraries you specify will be passed to
7753 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7754 @code{memcpy} and @code{memmove}.
7755 These entries are usually resolved by entries in
7756 libc.  These entry points should be supplied through some other
7757 mechanism when this option is specified.
7758
7759 @cindex @option{-lgcc}, use with @option{-nostdlib}
7760 @cindex @option{-nostdlib} and unresolved references
7761 @cindex unresolved references and @option{-nostdlib}
7762 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7763 @cindex @option{-nodefaultlibs} and unresolved references
7764 @cindex unresolved references and @option{-nodefaultlibs}
7765 One of the standard libraries bypassed by @option{-nostdlib} and
7766 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7767 that GCC uses to overcome shortcomings of particular machines, or special
7768 needs for some languages.
7769 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7770 Collection (GCC) Internals},
7771 for more discussion of @file{libgcc.a}.)
7772 In most cases, you need @file{libgcc.a} even when you want to avoid
7773 other standard libraries.  In other words, when you specify @option{-nostdlib}
7774 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7775 This ensures that you have no unresolved references to internal GCC
7776 library subroutines.  (For example, @samp{__main}, used to ensure C++
7777 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7778 GNU Compiler Collection (GCC) Internals}.)
7779
7780 @item -pie
7781 @opindex pie
7782 Produce a position independent executable on targets which support it.
7783 For predictable results, you must also specify the same set of options
7784 that were used to generate code (@option{-fpie}, @option{-fPIE},
7785 or model suboptions) when you specify this option.
7786
7787 @item -rdynamic
7788 @opindex rdynamic
7789 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7790 that support it. This instructs the linker to add all symbols, not
7791 only used ones, to the dynamic symbol table. This option is needed
7792 for some uses of @code{dlopen} or to allow obtaining backtraces
7793 from within a program.
7794
7795 @item -s
7796 @opindex s
7797 Remove all symbol table and relocation information from the executable.
7798
7799 @item -static
7800 @opindex static
7801 On systems that support dynamic linking, this prevents linking with the shared
7802 libraries.  On other systems, this option has no effect.
7803
7804 @item -shared
7805 @opindex shared
7806 Produce a shared object which can then be linked with other objects to
7807 form an executable.  Not all systems support this option.  For predictable
7808 results, you must also specify the same set of options that were used to
7809 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7810 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7811 needs to build supplementary stub code for constructors to work.  On
7812 multi-libbed systems, @samp{gcc -shared} must select the correct support
7813 libraries to link against.  Failing to supply the correct flags may lead
7814 to subtle defects.  Supplying them in cases where they are not necessary
7815 is innocuous.}
7816
7817 @item -shared-libgcc
7818 @itemx -static-libgcc
7819 @opindex shared-libgcc
7820 @opindex static-libgcc
7821 On systems that provide @file{libgcc} as a shared library, these options
7822 force the use of either the shared or static version respectively.
7823 If no shared version of @file{libgcc} was built when the compiler was
7824 configured, these options have no effect.
7825
7826 There are several situations in which an application should use the
7827 shared @file{libgcc} instead of the static version.  The most common
7828 of these is when the application wishes to throw and catch exceptions
7829 across different shared libraries.  In that case, each of the libraries
7830 as well as the application itself should use the shared @file{libgcc}.
7831
7832 Therefore, the G++ and GCJ drivers automatically add
7833 @option{-shared-libgcc} whenever you build a shared library or a main
7834 executable, because C++ and Java programs typically use exceptions, so
7835 this is the right thing to do.
7836
7837 If, instead, you use the GCC driver to create shared libraries, you may
7838 find that they will not always be linked with the shared @file{libgcc}.
7839 If GCC finds, at its configuration time, that you have a non-GNU linker
7840 or a GNU linker that does not support option @option{--eh-frame-hdr},
7841 it will link the shared version of @file{libgcc} into shared libraries
7842 by default.  Otherwise, it will take advantage of the linker and optimize
7843 away the linking with the shared version of @file{libgcc}, linking with
7844 the static version of libgcc by default.  This allows exceptions to
7845 propagate through such shared libraries, without incurring relocation
7846 costs at library load time.
7847
7848 However, if a library or main executable is supposed to throw or catch
7849 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7850 for the languages used in the program, or using the option
7851 @option{-shared-libgcc}, such that it is linked with the shared
7852 @file{libgcc}.
7853
7854 @item -symbolic
7855 @opindex symbolic
7856 Bind references to global symbols when building a shared object.  Warn
7857 about any unresolved references (unless overridden by the link editor
7858 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
7859 this option.
7860
7861 @item -T @var{script}
7862 @opindex T
7863 @cindex linker script
7864 Use @var{script} as the linker script.  This option is supported by most
7865 systems using the GNU linker.  On some targets, such as bare-board
7866 targets without an operating system, the @option{-T} option may be required 
7867 when linking to avoid references to undefined symbols.
7868
7869 @item -Xlinker @var{option}
7870 @opindex Xlinker
7871 Pass @var{option} as an option to the linker.  You can use this to
7872 supply system-specific linker options which GCC does not know how to
7873 recognize.
7874
7875 If you want to pass an option that takes an argument, you must use
7876 @option{-Xlinker} twice, once for the option and once for the argument.
7877 For example, to pass @option{-assert definitions}, you must write
7878 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
7879 @option{-Xlinker "-assert definitions"}, because this passes the entire
7880 string as a single argument, which is not what the linker expects.
7881
7882 @item -Wl,@var{option}
7883 @opindex Wl
7884 Pass @var{option} as an option to the linker.  If @var{option} contains
7885 commas, it is split into multiple options at the commas.
7886
7887 @item -u @var{symbol}
7888 @opindex u
7889 Pretend the symbol @var{symbol} is undefined, to force linking of
7890 library modules to define it.  You can use @option{-u} multiple times with
7891 different symbols to force loading of additional library modules.
7892 @end table
7893
7894 @node Directory Options
7895 @section Options for Directory Search
7896 @cindex directory options
7897 @cindex options, directory search
7898 @cindex search path
7899
7900 These options specify directories to search for header files, for
7901 libraries and for parts of the compiler:
7902
7903 @table @gcctabopt
7904 @item -I@var{dir}
7905 @opindex I
7906 Add the directory @var{dir} to the head of the list of directories to be
7907 searched for header files.  This can be used to override a system header
7908 file, substituting your own version, since these directories are
7909 searched before the system header file directories.  However, you should
7910 not use this option to add directories that contain vendor-supplied
7911 system header files (use @option{-isystem} for that).  If you use more than
7912 one @option{-I} option, the directories are scanned in left-to-right
7913 order; the standard system directories come after.
7914
7915 If a standard system include directory, or a directory specified with
7916 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
7917 option will be ignored.  The directory will still be searched but as a
7918 system directory at its normal position in the system include chain.
7919 This is to ensure that GCC's procedure to fix buggy system headers and
7920 the ordering for the include_next directive are not inadvertently changed.
7921 If you really need to change the search order for system directories,
7922 use the @option{-nostdinc} and/or @option{-isystem} options.
7923
7924 @item -iquote@var{dir}
7925 @opindex iquote
7926 Add the directory @var{dir} to the head of the list of directories to
7927 be searched for header files only for the case of @samp{#include
7928 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
7929 otherwise just like @option{-I}.
7930
7931 @item -L@var{dir}
7932 @opindex L
7933 Add directory @var{dir} to the list of directories to be searched
7934 for @option{-l}.
7935
7936 @item -B@var{prefix}
7937 @opindex B
7938 This option specifies where to find the executables, libraries,
7939 include files, and data files of the compiler itself.
7940
7941 The compiler driver program runs one or more of the subprograms
7942 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
7943 @var{prefix} as a prefix for each program it tries to run, both with and
7944 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
7945
7946 For each subprogram to be run, the compiler driver first tries the
7947 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
7948 was not specified, the driver tries two standard prefixes, which are
7949 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
7950 those results in a file name that is found, the unmodified program
7951 name is searched for using the directories specified in your
7952 @env{PATH} environment variable.
7953
7954 The compiler will check to see if the path provided by the @option{-B}
7955 refers to a directory, and if necessary it will add a directory
7956 separator character at the end of the path.
7957
7958 @option{-B} prefixes that effectively specify directory names also apply
7959 to libraries in the linker, because the compiler translates these
7960 options into @option{-L} options for the linker.  They also apply to
7961 includes files in the preprocessor, because the compiler translates these
7962 options into @option{-isystem} options for the preprocessor.  In this case,
7963 the compiler appends @samp{include} to the prefix.
7964
7965 The run-time support file @file{libgcc.a} can also be searched for using
7966 the @option{-B} prefix, if needed.  If it is not found there, the two
7967 standard prefixes above are tried, and that is all.  The file is left
7968 out of the link if it is not found by those means.
7969
7970 Another way to specify a prefix much like the @option{-B} prefix is to use
7971 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
7972 Variables}.
7973
7974 As a special kludge, if the path provided by @option{-B} is
7975 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
7976 9, then it will be replaced by @file{[dir/]include}.  This is to help
7977 with boot-strapping the compiler.
7978
7979 @item -specs=@var{file}
7980 @opindex specs
7981 Process @var{file} after the compiler reads in the standard @file{specs}
7982 file, in order to override the defaults that the @file{gcc} driver
7983 program uses when determining what switches to pass to @file{cc1},
7984 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
7985 @option{-specs=@var{file}} can be specified on the command line, and they
7986 are processed in order, from left to right.
7987
7988 @item --sysroot=@var{dir}
7989 @opindex sysroot
7990 Use @var{dir} as the logical root directory for headers and libraries.
7991 For example, if the compiler would normally search for headers in
7992 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
7993 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
7994
7995 If you use both this option and the @option{-isysroot} option, then
7996 the @option{--sysroot} option will apply to libraries, but the
7997 @option{-isysroot} option will apply to header files.
7998
7999 The GNU linker (beginning with version 2.16) has the necessary support
8000 for this option.  If your linker does not support this option, the
8001 header file aspect of @option{--sysroot} will still work, but the
8002 library aspect will not.
8003
8004 @item -I-
8005 @opindex I-
8006 This option has been deprecated.  Please use @option{-iquote} instead for
8007 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
8008 Any directories you specify with @option{-I} options before the @option{-I-}
8009 option are searched only for the case of @samp{#include "@var{file}"};
8010 they are not searched for @samp{#include <@var{file}>}.
8011
8012 If additional directories are specified with @option{-I} options after
8013 the @option{-I-}, these directories are searched for all @samp{#include}
8014 directives.  (Ordinarily @emph{all} @option{-I} directories are used
8015 this way.)
8016
8017 In addition, the @option{-I-} option inhibits the use of the current
8018 directory (where the current input file came from) as the first search
8019 directory for @samp{#include "@var{file}"}.  There is no way to
8020 override this effect of @option{-I-}.  With @option{-I.} you can specify
8021 searching the directory which was current when the compiler was
8022 invoked.  That is not exactly the same as what the preprocessor does
8023 by default, but it is often satisfactory.
8024
8025 @option{-I-} does not inhibit the use of the standard system directories
8026 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
8027 independent.
8028 @end table
8029
8030 @c man end
8031
8032 @node Spec Files
8033 @section Specifying subprocesses and the switches to pass to them
8034 @cindex Spec Files
8035
8036 @command{gcc} is a driver program.  It performs its job by invoking a
8037 sequence of other programs to do the work of compiling, assembling and
8038 linking.  GCC interprets its command-line parameters and uses these to
8039 deduce which programs it should invoke, and which command-line options
8040 it ought to place on their command lines.  This behavior is controlled
8041 by @dfn{spec strings}.  In most cases there is one spec string for each
8042 program that GCC can invoke, but a few programs have multiple spec
8043 strings to control their behavior.  The spec strings built into GCC can
8044 be overridden by using the @option{-specs=} command-line switch to specify
8045 a spec file.
8046
8047 @dfn{Spec files} are plaintext files that are used to construct spec
8048 strings.  They consist of a sequence of directives separated by blank
8049 lines.  The type of directive is determined by the first non-whitespace
8050 character on the line and it can be one of the following:
8051
8052 @table @code
8053 @item %@var{command}
8054 Issues a @var{command} to the spec file processor.  The commands that can
8055 appear here are:
8056
8057 @table @code
8058 @item %include <@var{file}>
8059 @cindex %include
8060 Search for @var{file} and insert its text at the current point in the
8061 specs file.
8062
8063 @item %include_noerr <@var{file}>
8064 @cindex %include_noerr
8065 Just like @samp{%include}, but do not generate an error message if the include
8066 file cannot be found.
8067
8068 @item %rename @var{old_name} @var{new_name}
8069 @cindex %rename
8070 Rename the spec string @var{old_name} to @var{new_name}.
8071
8072 @end table
8073
8074 @item *[@var{spec_name}]:
8075 This tells the compiler to create, override or delete the named spec
8076 string.  All lines after this directive up to the next directive or
8077 blank line are considered to be the text for the spec string.  If this
8078 results in an empty string then the spec will be deleted.  (Or, if the
8079 spec did not exist, then nothing will happened.)  Otherwise, if the spec
8080 does not currently exist a new spec will be created.  If the spec does
8081 exist then its contents will be overridden by the text of this
8082 directive, unless the first character of that text is the @samp{+}
8083 character, in which case the text will be appended to the spec.
8084
8085 @item [@var{suffix}]:
8086 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
8087 and up to the next directive or blank line are considered to make up the
8088 spec string for the indicated suffix.  When the compiler encounters an
8089 input file with the named suffix, it will processes the spec string in
8090 order to work out how to compile that file.  For example:
8091
8092 @smallexample
8093 .ZZ:
8094 z-compile -input %i
8095 @end smallexample
8096
8097 This says that any input file whose name ends in @samp{.ZZ} should be
8098 passed to the program @samp{z-compile}, which should be invoked with the
8099 command-line switch @option{-input} and with the result of performing the
8100 @samp{%i} substitution.  (See below.)
8101
8102 As an alternative to providing a spec string, the text that follows a
8103 suffix directive can be one of the following:
8104
8105 @table @code
8106 @item @@@var{language}
8107 This says that the suffix is an alias for a known @var{language}.  This is
8108 similar to using the @option{-x} command-line switch to GCC to specify a
8109 language explicitly.  For example:
8110
8111 @smallexample
8112 .ZZ:
8113 @@c++
8114 @end smallexample
8115
8116 Says that .ZZ files are, in fact, C++ source files.
8117
8118 @item #@var{name}
8119 This causes an error messages saying:
8120
8121 @smallexample
8122 @var{name} compiler not installed on this system.
8123 @end smallexample
8124 @end table
8125
8126 GCC already has an extensive list of suffixes built into it.
8127 This directive will add an entry to the end of the list of suffixes, but
8128 since the list is searched from the end backwards, it is effectively
8129 possible to override earlier entries using this technique.
8130
8131 @end table
8132
8133 GCC has the following spec strings built into it.  Spec files can
8134 override these strings or create their own.  Note that individual
8135 targets can also add their own spec strings to this list.
8136
8137 @smallexample
8138 asm          Options to pass to the assembler
8139 asm_final    Options to pass to the assembler post-processor
8140 cpp          Options to pass to the C preprocessor
8141 cc1          Options to pass to the C compiler
8142 cc1plus      Options to pass to the C++ compiler
8143 endfile      Object files to include at the end of the link
8144 link         Options to pass to the linker
8145 lib          Libraries to include on the command line to the linker
8146 libgcc       Decides which GCC support library to pass to the linker
8147 linker       Sets the name of the linker
8148 predefines   Defines to be passed to the C preprocessor
8149 signed_char  Defines to pass to CPP to say whether @code{char} is signed
8150              by default
8151 startfile    Object files to include at the start of the link
8152 @end smallexample
8153
8154 Here is a small example of a spec file:
8155
8156 @smallexample
8157 %rename lib                 old_lib
8158
8159 *lib:
8160 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
8161 @end smallexample
8162
8163 This example renames the spec called @samp{lib} to @samp{old_lib} and
8164 then overrides the previous definition of @samp{lib} with a new one.
8165 The new definition adds in some extra command-line options before
8166 including the text of the old definition.
8167
8168 @dfn{Spec strings} are a list of command-line options to be passed to their
8169 corresponding program.  In addition, the spec strings can contain
8170 @samp{%}-prefixed sequences to substitute variable text or to
8171 conditionally insert text into the command line.  Using these constructs
8172 it is possible to generate quite complex command lines.
8173
8174 Here is a table of all defined @samp{%}-sequences for spec
8175 strings.  Note that spaces are not generated automatically around the
8176 results of expanding these sequences.  Therefore you can concatenate them
8177 together or combine them with constant text in a single argument.
8178
8179 @table @code
8180 @item %%
8181 Substitute one @samp{%} into the program name or argument.
8182
8183 @item %i
8184 Substitute the name of the input file being processed.
8185
8186 @item %b
8187 Substitute the basename of the input file being processed.
8188 This is the substring up to (and not including) the last period
8189 and not including the directory.
8190
8191 @item %B
8192 This is the same as @samp{%b}, but include the file suffix (text after
8193 the last period).
8194
8195 @item %d
8196 Marks the argument containing or following the @samp{%d} as a
8197 temporary file name, so that that file will be deleted if GCC exits
8198 successfully.  Unlike @samp{%g}, this contributes no text to the
8199 argument.
8200
8201 @item %g@var{suffix}
8202 Substitute a file name that has suffix @var{suffix} and is chosen
8203 once per compilation, and mark the argument in the same way as
8204 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
8205 name is now chosen in a way that is hard to predict even when previously
8206 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
8207 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
8208 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
8209 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
8210 was simply substituted with a file name chosen once per compilation,
8211 without regard to any appended suffix (which was therefore treated
8212 just like ordinary text), making such attacks more likely to succeed.
8213
8214 @item %u@var{suffix}
8215 Like @samp{%g}, but generates a new temporary file name even if
8216 @samp{%u@var{suffix}} was already seen.
8217
8218 @item %U@var{suffix}
8219 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
8220 new one if there is no such last file name.  In the absence of any
8221 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
8222 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
8223 would involve the generation of two distinct file names, one
8224 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
8225 simply substituted with a file name chosen for the previous @samp{%u},
8226 without regard to any appended suffix.
8227
8228 @item %j@var{suffix}
8229 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
8230 writable, and if save-temps is off; otherwise, substitute the name
8231 of a temporary file, just like @samp{%u}.  This temporary file is not
8232 meant for communication between processes, but rather as a junk
8233 disposal mechanism.
8234
8235 @item %|@var{suffix}
8236 @itemx %m@var{suffix}
8237 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
8238 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
8239 all.  These are the two most common ways to instruct a program that it
8240 should read from standard input or write to standard output.  If you
8241 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
8242 construct: see for example @file{f/lang-specs.h}.
8243
8244 @item %.@var{SUFFIX}
8245 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
8246 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
8247 terminated by the next space or %.
8248
8249 @item %w
8250 Marks the argument containing or following the @samp{%w} as the
8251 designated output file of this compilation.  This puts the argument
8252 into the sequence of arguments that @samp{%o} will substitute later.
8253
8254 @item %o
8255 Substitutes the names of all the output files, with spaces
8256 automatically placed around them.  You should write spaces
8257 around the @samp{%o} as well or the results are undefined.
8258 @samp{%o} is for use in the specs for running the linker.
8259 Input files whose names have no recognized suffix are not compiled
8260 at all, but they are included among the output files, so they will
8261 be linked.
8262
8263 @item %O
8264 Substitutes the suffix for object files.  Note that this is
8265 handled specially when it immediately follows @samp{%g, %u, or %U},
8266 because of the need for those to form complete file names.  The
8267 handling is such that @samp{%O} is treated exactly as if it had already
8268 been substituted, except that @samp{%g, %u, and %U} do not currently
8269 support additional @var{suffix} characters following @samp{%O} as they would
8270 following, for example, @samp{.o}.
8271
8272 @item %p
8273 Substitutes the standard macro predefinitions for the
8274 current target machine.  Use this when running @code{cpp}.
8275
8276 @item %P
8277 Like @samp{%p}, but puts @samp{__} before and after the name of each
8278 predefined macro, except for macros that start with @samp{__} or with
8279 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8280 C@.
8281
8282 @item %I
8283 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8284 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8285 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8286 and @option{-imultilib} as necessary.
8287
8288 @item %s
8289 Current argument is the name of a library or startup file of some sort.
8290 Search for that file in a standard list of directories and substitute
8291 the full name found.
8292
8293 @item %e@var{str}
8294 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8295 Use this when inconsistent options are detected.
8296
8297 @item %(@var{name})
8298 Substitute the contents of spec string @var{name} at this point.
8299
8300 @item %[@var{name}]
8301 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8302
8303 @item %x@{@var{option}@}
8304 Accumulate an option for @samp{%X}.
8305
8306 @item %X
8307 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8308 spec string.
8309
8310 @item %Y
8311 Output the accumulated assembler options specified by @option{-Wa}.
8312
8313 @item %Z
8314 Output the accumulated preprocessor options specified by @option{-Wp}.
8315
8316 @item %a
8317 Process the @code{asm} spec.  This is used to compute the
8318 switches to be passed to the assembler.
8319
8320 @item %A
8321 Process the @code{asm_final} spec.  This is a spec string for
8322 passing switches to an assembler post-processor, if such a program is
8323 needed.
8324
8325 @item %l
8326 Process the @code{link} spec.  This is the spec for computing the
8327 command line passed to the linker.  Typically it will make use of the
8328 @samp{%L %G %S %D and %E} sequences.
8329
8330 @item %D
8331 Dump out a @option{-L} option for each directory that GCC believes might
8332 contain startup files.  If the target supports multilibs then the
8333 current multilib directory will be prepended to each of these paths.
8334
8335 @item %L
8336 Process the @code{lib} spec.  This is a spec string for deciding which
8337 libraries should be included on the command line to the linker.
8338
8339 @item %G
8340 Process the @code{libgcc} spec.  This is a spec string for deciding
8341 which GCC support library should be included on the command line to the linker.
8342
8343 @item %S
8344 Process the @code{startfile} spec.  This is a spec for deciding which
8345 object files should be the first ones passed to the linker.  Typically
8346 this might be a file named @file{crt0.o}.
8347
8348 @item %E
8349 Process the @code{endfile} spec.  This is a spec string that specifies
8350 the last object files that will be passed to the linker.
8351
8352 @item %C
8353 Process the @code{cpp} spec.  This is used to construct the arguments
8354 to be passed to the C preprocessor.
8355
8356 @item %1
8357 Process the @code{cc1} spec.  This is used to construct the options to be
8358 passed to the actual C compiler (@samp{cc1}).
8359
8360 @item %2
8361 Process the @code{cc1plus} spec.  This is used to construct the options to be
8362 passed to the actual C++ compiler (@samp{cc1plus}).
8363
8364 @item %*
8365 Substitute the variable part of a matched option.  See below.
8366 Note that each comma in the substituted string is replaced by
8367 a single space.
8368
8369 @item %<@code{S}
8370 Remove all occurrences of @code{-S} from the command line.  Note---this
8371 command is position dependent.  @samp{%} commands in the spec string
8372 before this one will see @code{-S}, @samp{%} commands in the spec string
8373 after this one will not.
8374
8375 @item %:@var{function}(@var{args})
8376 Call the named function @var{function}, passing it @var{args}.
8377 @var{args} is first processed as a nested spec string, then split
8378 into an argument vector in the usual fashion.  The function returns
8379 a string which is processed as if it had appeared literally as part
8380 of the current spec.
8381
8382 The following built-in spec functions are provided:
8383
8384 @table @code
8385 @item @code{getenv}
8386 The @code{getenv} spec function takes two arguments: an environment
8387 variable name and a string.  If the environment variable is not
8388 defined, a fatal error is issued.  Otherwise, the return value is the
8389 value of the environment variable concatenated with the string.  For
8390 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
8391
8392 @smallexample
8393 %:getenv(TOPDIR /include)
8394 @end smallexample
8395
8396 expands to @file{/path/to/top/include}.
8397
8398 @item @code{if-exists}
8399 The @code{if-exists} spec function takes one argument, an absolute
8400 pathname to a file.  If the file exists, @code{if-exists} returns the
8401 pathname.  Here is a small example of its usage:
8402
8403 @smallexample
8404 *startfile:
8405 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
8406 @end smallexample
8407
8408 @item @code{if-exists-else}
8409 The @code{if-exists-else} spec function is similar to the @code{if-exists}
8410 spec function, except that it takes two arguments.  The first argument is
8411 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
8412 returns the pathname.  If it does not exist, it returns the second argument.
8413 This way, @code{if-exists-else} can be used to select one file or another,
8414 based on the existence of the first.  Here is a small example of its usage:
8415
8416 @smallexample
8417 *startfile:
8418 crt0%O%s %:if-exists(crti%O%s) \
8419 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
8420 @end smallexample
8421
8422 @item @code{replace-outfile}
8423 The @code{replace-outfile} spec function takes two arguments.  It looks for the
8424 first argument in the outfiles array and replaces it with the second argument.  Here
8425 is a small example of its usage:
8426
8427 @smallexample
8428 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
8429 @end smallexample
8430
8431 @item @code{print-asm-header}
8432 The @code{print-asm-header} function takes no arguments and simply
8433 prints a banner like:
8434
8435 @smallexample
8436 Assembler options
8437 =================
8438
8439 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
8440 @end smallexample
8441
8442 It is used to separate compiler options from assembler options
8443 in the @option{--target-help} output.
8444 @end table
8445
8446 @item %@{@code{S}@}
8447 Substitutes the @code{-S} switch, if that switch was given to GCC@.
8448 If that switch was not specified, this substitutes nothing.  Note that
8449 the leading dash is omitted when specifying this option, and it is
8450 automatically inserted if the substitution is performed.  Thus the spec
8451 string @samp{%@{foo@}} would match the command-line option @option{-foo}
8452 and would output the command line option @option{-foo}.
8453
8454 @item %W@{@code{S}@}
8455 Like %@{@code{S}@} but mark last argument supplied within as a file to be
8456 deleted on failure.
8457
8458 @item %@{@code{S}*@}
8459 Substitutes all the switches specified to GCC whose names start
8460 with @code{-S}, but which also take an argument.  This is used for
8461 switches like @option{-o}, @option{-D}, @option{-I}, etc.
8462 GCC considers @option{-o foo} as being
8463 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
8464 text, including the space.  Thus two arguments would be generated.
8465
8466 @item %@{@code{S}*&@code{T}*@}
8467 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
8468 (the order of @code{S} and @code{T} in the spec is not significant).
8469 There can be any number of ampersand-separated variables; for each the
8470 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
8471
8472 @item %@{@code{S}:@code{X}@}
8473 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
8474
8475 @item %@{!@code{S}:@code{X}@}
8476 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
8477
8478 @item %@{@code{S}*:@code{X}@}
8479 Substitutes @code{X} if one or more switches whose names start with
8480 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
8481 once, no matter how many such switches appeared.  However, if @code{%*}
8482 appears somewhere in @code{X}, then @code{X} will be substituted once
8483 for each matching switch, with the @code{%*} replaced by the part of
8484 that switch that matched the @code{*}.
8485
8486 @item %@{.@code{S}:@code{X}@}
8487 Substitutes @code{X}, if processing a file with suffix @code{S}.
8488
8489 @item %@{!.@code{S}:@code{X}@}
8490 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
8491
8492 @item %@{,@code{S}:@code{X}@}
8493 Substitutes @code{X}, if processing a file for language @code{S}.
8494
8495 @item %@{!,@code{S}:@code{X}@}
8496 Substitutes @code{X}, if not processing a file for language @code{S}.
8497
8498 @item %@{@code{S}|@code{P}:@code{X}@}
8499 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
8500 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
8501 @code{*} sequences as well, although they have a stronger binding than
8502 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
8503 alternatives must be starred, and only the first matching alternative
8504 is substituted.
8505
8506 For example, a spec string like this:
8507
8508 @smallexample
8509 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
8510 @end smallexample
8511
8512 will output the following command-line options from the following input
8513 command-line options:
8514
8515 @smallexample
8516 fred.c        -foo -baz
8517 jim.d         -bar -boggle
8518 -d fred.c     -foo -baz -boggle
8519 -d jim.d      -bar -baz -boggle
8520 @end smallexample
8521
8522 @item %@{S:X; T:Y; :D@}
8523
8524 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
8525 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
8526 be as many clauses as you need.  This may be combined with @code{.},
8527 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
8528
8529
8530 @end table
8531
8532 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
8533 construct may contain other nested @samp{%} constructs or spaces, or
8534 even newlines.  They are processed as usual, as described above.
8535 Trailing white space in @code{X} is ignored.  White space may also
8536 appear anywhere on the left side of the colon in these constructs,
8537 except between @code{.} or @code{*} and the corresponding word.
8538
8539 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
8540 handled specifically in these constructs.  If another value of
8541 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
8542 @option{-W} switch is found later in the command line, the earlier
8543 switch value is ignored, except with @{@code{S}*@} where @code{S} is
8544 just one letter, which passes all matching options.
8545
8546 The character @samp{|} at the beginning of the predicate text is used to
8547 indicate that a command should be piped to the following command, but
8548 only if @option{-pipe} is specified.
8549
8550 It is built into GCC which switches take arguments and which do not.
8551 (You might think it would be useful to generalize this to allow each
8552 compiler's spec to say which switches take arguments.  But this cannot
8553 be done in a consistent fashion.  GCC cannot even decide which input
8554 files have been specified without knowing which switches take arguments,
8555 and it must know which input files to compile in order to tell which
8556 compilers to run).
8557
8558 GCC also knows implicitly that arguments starting in @option{-l} are to be
8559 treated as compiler output files, and passed to the linker in their
8560 proper position among the other output files.
8561
8562 @c man begin OPTIONS
8563
8564 @node Target Options
8565 @section Specifying Target Machine and Compiler Version
8566 @cindex target options
8567 @cindex cross compiling
8568 @cindex specifying machine version
8569 @cindex specifying compiler version and target machine
8570 @cindex compiler version, specifying
8571 @cindex target machine, specifying
8572
8573 The usual way to run GCC is to run the executable called @file{gcc}, or
8574 @file{<machine>-gcc} when cross-compiling, or
8575 @file{<machine>-gcc-<version>} to run a version other than the one that
8576 was installed last.  Sometimes this is inconvenient, so GCC provides
8577 options that will switch to another cross-compiler or version.
8578
8579 @table @gcctabopt
8580 @item -b @var{machine}
8581 @opindex b
8582 The argument @var{machine} specifies the target machine for compilation.
8583
8584 The value to use for @var{machine} is the same as was specified as the
8585 machine type when configuring GCC as a cross-compiler.  For
8586 example, if a cross-compiler was configured with @samp{configure
8587 arm-elf}, meaning to compile for an arm processor with elf binaries,
8588 then you would specify @option{-b arm-elf} to run that cross compiler.
8589 Because there are other options beginning with @option{-b}, the
8590 configuration must contain a hyphen.
8591
8592 @item -V @var{version}
8593 @opindex V
8594 The argument @var{version} specifies which version of GCC to run.
8595 This is useful when multiple versions are installed.  For example,
8596 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
8597 @end table
8598
8599 The @option{-V} and @option{-b} options work by running the
8600 @file{<machine>-gcc-<version>} executable, so there's no real reason to
8601 use them if you can just run that directly.
8602
8603 @node Submodel Options
8604 @section Hardware Models and Configurations
8605 @cindex submodel options
8606 @cindex specifying hardware config
8607 @cindex hardware models and configurations, specifying
8608 @cindex machine dependent options
8609
8610 Earlier we discussed the standard option @option{-b} which chooses among
8611 different installed compilers for completely different target
8612 machines, such as VAX vs.@: 68000 vs.@: 80386.
8613
8614 In addition, each of these target machine types can have its own
8615 special options, starting with @samp{-m}, to choose among various
8616 hardware models or configurations---for example, 68010 vs 68020,
8617 floating coprocessor or none.  A single installed version of the
8618 compiler can compile for any model or configuration, according to the
8619 options specified.
8620
8621 Some configurations of the compiler also support additional special
8622 options, usually for compatibility with other compilers on the same
8623 platform.
8624
8625 @c This list is ordered alphanumerically by subsection name.
8626 @c It should be the same order and spelling as these options are listed
8627 @c in Machine Dependent Options
8628
8629 @menu
8630 * ARC Options::
8631 * ARM Options::
8632 * AVR Options::
8633 * Blackfin Options::
8634 * CRIS Options::
8635 * CRX Options::
8636 * Darwin Options::
8637 * DEC Alpha Options::
8638 * DEC Alpha/VMS Options::
8639 * FRV Options::
8640 * GNU/Linux Options::
8641 * H8/300 Options::
8642 * HPPA Options::
8643 * i386 and x86-64 Options::
8644 * IA-64 Options::
8645 * M32C Options::
8646 * M32R/D Options::
8647 * M680x0 Options::
8648 * M68hc1x Options::
8649 * MCore Options::
8650 * MIPS Options::
8651 * MMIX Options::
8652 * MN10300 Options::
8653 * PDP-11 Options::
8654 * picoChip Options::
8655 * PowerPC Options::
8656 * RS/6000 and PowerPC Options::
8657 * S/390 and zSeries Options::
8658 * Score Options::
8659 * SH Options::
8660 * SPARC Options::
8661 * SPU Options::
8662 * System V Options::
8663 * V850 Options::
8664 * VAX Options::
8665 * VxWorks Options::
8666 * x86-64 Options::
8667 * Xstormy16 Options::
8668 * Xtensa Options::
8669 * zSeries Options::
8670 @end menu
8671
8672 @node ARC Options
8673 @subsection ARC Options
8674 @cindex ARC Options
8675
8676 These options are defined for ARC implementations:
8677
8678 @table @gcctabopt
8679 @item -EL
8680 @opindex EL
8681 Compile code for little endian mode.  This is the default.
8682
8683 @item -EB
8684 @opindex EB
8685 Compile code for big endian mode.
8686
8687 @item -mmangle-cpu
8688 @opindex mmangle-cpu
8689 Prepend the name of the cpu to all public symbol names.
8690 In multiple-processor systems, there are many ARC variants with different
8691 instruction and register set characteristics.  This flag prevents code
8692 compiled for one cpu to be linked with code compiled for another.
8693 No facility exists for handling variants that are ``almost identical''.
8694 This is an all or nothing option.
8695
8696 @item -mcpu=@var{cpu}
8697 @opindex mcpu
8698 Compile code for ARC variant @var{cpu}.
8699 Which variants are supported depend on the configuration.
8700 All variants support @option{-mcpu=base}, this is the default.
8701
8702 @item -mtext=@var{text-section}
8703 @itemx -mdata=@var{data-section}
8704 @itemx -mrodata=@var{readonly-data-section}
8705 @opindex mtext
8706 @opindex mdata
8707 @opindex mrodata
8708 Put functions, data, and readonly data in @var{text-section},
8709 @var{data-section}, and @var{readonly-data-section} respectively
8710 by default.  This can be overridden with the @code{section} attribute.
8711 @xref{Variable Attributes}.
8712
8713 @end table
8714
8715 @node ARM Options
8716 @subsection ARM Options
8717 @cindex ARM options
8718
8719 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8720 architectures:
8721
8722 @table @gcctabopt
8723 @item -mabi=@var{name}
8724 @opindex mabi
8725 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8726 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8727
8728 @item -mapcs-frame
8729 @opindex mapcs-frame
8730 Generate a stack frame that is compliant with the ARM Procedure Call
8731 Standard for all functions, even if this is not strictly necessary for
8732 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8733 with this option will cause the stack frames not to be generated for
8734 leaf functions.  The default is @option{-mno-apcs-frame}.
8735
8736 @item -mapcs
8737 @opindex mapcs
8738 This is a synonym for @option{-mapcs-frame}.
8739
8740 @ignore
8741 @c not currently implemented
8742 @item -mapcs-stack-check
8743 @opindex mapcs-stack-check
8744 Generate code to check the amount of stack space available upon entry to
8745 every function (that actually uses some stack space).  If there is
8746 insufficient space available then either the function
8747 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8748 called, depending upon the amount of stack space required.  The run time
8749 system is required to provide these functions.  The default is
8750 @option{-mno-apcs-stack-check}, since this produces smaller code.
8751
8752 @c not currently implemented
8753 @item -mapcs-float
8754 @opindex mapcs-float
8755 Pass floating point arguments using the float point registers.  This is
8756 one of the variants of the APCS@.  This option is recommended if the
8757 target hardware has a floating point unit or if a lot of floating point
8758 arithmetic is going to be performed by the code.  The default is
8759 @option{-mno-apcs-float}, since integer only code is slightly increased in
8760 size if @option{-mapcs-float} is used.
8761
8762 @c not currently implemented
8763 @item -mapcs-reentrant
8764 @opindex mapcs-reentrant
8765 Generate reentrant, position independent code.  The default is
8766 @option{-mno-apcs-reentrant}.
8767 @end ignore
8768
8769 @item -mthumb-interwork
8770 @opindex mthumb-interwork
8771 Generate code which supports calling between the ARM and Thumb
8772 instruction sets.  Without this option the two instruction sets cannot
8773 be reliably used inside one program.  The default is
8774 @option{-mno-thumb-interwork}, since slightly larger code is generated
8775 when @option{-mthumb-interwork} is specified.
8776
8777 @item -mno-sched-prolog
8778 @opindex mno-sched-prolog
8779 Prevent the reordering of instructions in the function prolog, or the
8780 merging of those instruction with the instructions in the function's
8781 body.  This means that all functions will start with a recognizable set
8782 of instructions (or in fact one of a choice from a small set of
8783 different function prologues), and this information can be used to
8784 locate the start if functions inside an executable piece of code.  The
8785 default is @option{-msched-prolog}.
8786
8787 @item -mfloat-abi=@var{name}
8788 @opindex mfloat-abi
8789 Specifies which floating-point ABI to use.  Permissible values
8790 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8791
8792 Specifying @samp{soft} causes GCC to generate output containing 
8793 library calls for floating-point operations.
8794 @samp{softfp} allows the generation of code using hardware floating-point 
8795 instructions, but still uses the soft-float calling conventions.  
8796 @samp{hard} allows generation of floating-point instructions 
8797 and uses FPU-specific calling conventions.
8798
8799 Using @option{-mfloat-abi=hard} with VFP coprocessors is not supported.
8800 Use @option{-mfloat-abi=softfp} with the appropriate @option{-mfpu} option
8801 to allow the compiler to generate code that makes use of the hardware
8802 floating-point capabilities for these CPUs.
8803
8804 The default depends on the specific target configuration.  Note that
8805 the hard-float and soft-float ABIs are not link-compatible; you must
8806 compile your entire program with the same ABI, and link with a
8807 compatible set of libraries.
8808
8809 @item -mhard-float
8810 @opindex mhard-float
8811 Equivalent to @option{-mfloat-abi=hard}.
8812
8813 @item -msoft-float
8814 @opindex msoft-float
8815 Equivalent to @option{-mfloat-abi=soft}.
8816
8817 @item -mlittle-endian
8818 @opindex mlittle-endian
8819 Generate code for a processor running in little-endian mode.  This is
8820 the default for all standard configurations.
8821
8822 @item -mbig-endian
8823 @opindex mbig-endian
8824 Generate code for a processor running in big-endian mode; the default is
8825 to compile code for a little-endian processor.
8826
8827 @item -mwords-little-endian
8828 @opindex mwords-little-endian
8829 This option only applies when generating code for big-endian processors.
8830 Generate code for a little-endian word order but a big-endian byte
8831 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8832 option should only be used if you require compatibility with code for
8833 big-endian ARM processors generated by versions of the compiler prior to
8834 2.8.
8835
8836 @item -mcpu=@var{name}
8837 @opindex mcpu
8838 This specifies the name of the target ARM processor.  GCC uses this name
8839 to determine what kind of instructions it can emit when generating
8840 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8841 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8842 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8843 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
8844 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
8845 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
8846 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
8847 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
8848 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
8849 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
8850 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
8851 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
8852 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
8853 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
8854 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
8855 @samp{cortex-m1},
8856 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
8857
8858 @item -mtune=@var{name}
8859 @opindex mtune
8860 This option is very similar to the @option{-mcpu=} option, except that
8861 instead of specifying the actual target processor type, and hence
8862 restricting which instructions can be used, it specifies that GCC should
8863 tune the performance of the code as if the target were of the type
8864 specified in this option, but still choosing the instructions that it
8865 will generate based on the cpu specified by a @option{-mcpu=} option.
8866 For some ARM implementations better performance can be obtained by using
8867 this option.
8868
8869 @item -march=@var{name}
8870 @opindex march
8871 This specifies the name of the target ARM architecture.  GCC uses this
8872 name to determine what kind of instructions it can emit when generating
8873 assembly code.  This option can be used in conjunction with or instead
8874 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
8875 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
8876 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
8877 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
8878 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
8879 @samp{iwmmxt}, @samp{ep9312}.
8880
8881 @item -mfpu=@var{name}
8882 @itemx -mfpe=@var{number}
8883 @itemx -mfp=@var{number}
8884 @opindex mfpu
8885 @opindex mfpe
8886 @opindex mfp
8887 This specifies what floating point hardware (or hardware emulation) is
8888 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
8889 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-d16} and
8890 @samp{neon}.  @option{-mfp} and @option{-mfpe}
8891 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
8892 with older versions of GCC@.
8893
8894 If @option{-msoft-float} is specified this specifies the format of
8895 floating point values.
8896
8897 @item -mstructure-size-boundary=@var{n}
8898 @opindex mstructure-size-boundary
8899 The size of all structures and unions will be rounded up to a multiple
8900 of the number of bits set by this option.  Permissible values are 8, 32
8901 and 64.  The default value varies for different toolchains.  For the COFF
8902 targeted toolchain the default value is 8.  A value of 64 is only allowed
8903 if the underlying ABI supports it.
8904
8905 Specifying the larger number can produce faster, more efficient code, but
8906 can also increase the size of the program.  Different values are potentially
8907 incompatible.  Code compiled with one value cannot necessarily expect to
8908 work with code or libraries compiled with another value, if they exchange
8909 information using structures or unions.
8910
8911 @item -mabort-on-noreturn
8912 @opindex mabort-on-noreturn
8913 Generate a call to the function @code{abort} at the end of a
8914 @code{noreturn} function.  It will be executed if the function tries to
8915 return.
8916
8917 @item -mlong-calls
8918 @itemx -mno-long-calls
8919 @opindex mlong-calls
8920 @opindex mno-long-calls
8921 Tells the compiler to perform function calls by first loading the
8922 address of the function into a register and then performing a subroutine
8923 call on this register.  This switch is needed if the target function
8924 will lie outside of the 64 megabyte addressing range of the offset based
8925 version of subroutine call instruction.
8926
8927 Even if this switch is enabled, not all function calls will be turned
8928 into long calls.  The heuristic is that static functions, functions
8929 which have the @samp{short-call} attribute, functions that are inside
8930 the scope of a @samp{#pragma no_long_calls} directive and functions whose
8931 definitions have already been compiled within the current compilation
8932 unit, will not be turned into long calls.  The exception to this rule is
8933 that weak function definitions, functions with the @samp{long-call}
8934 attribute or the @samp{section} attribute, and functions that are within
8935 the scope of a @samp{#pragma long_calls} directive, will always be
8936 turned into long calls.
8937
8938 This feature is not enabled by default.  Specifying
8939 @option{-mno-long-calls} will restore the default behavior, as will
8940 placing the function calls within the scope of a @samp{#pragma
8941 long_calls_off} directive.  Note these switches have no effect on how
8942 the compiler generates code to handle function calls via function
8943 pointers.
8944
8945 @item -mnop-fun-dllimport
8946 @opindex mnop-fun-dllimport
8947 Disable support for the @code{dllimport} attribute.
8948
8949 @item -msingle-pic-base
8950 @opindex msingle-pic-base
8951 Treat the register used for PIC addressing as read-only, rather than
8952 loading it in the prologue for each function.  The run-time system is
8953 responsible for initializing this register with an appropriate value
8954 before execution begins.
8955
8956 @item -mpic-register=@var{reg}
8957 @opindex mpic-register
8958 Specify the register to be used for PIC addressing.  The default is R10
8959 unless stack-checking is enabled, when R9 is used.
8960
8961 @item -mcirrus-fix-invalid-insns
8962 @opindex mcirrus-fix-invalid-insns
8963 @opindex mno-cirrus-fix-invalid-insns
8964 Insert NOPs into the instruction stream to in order to work around
8965 problems with invalid Maverick instruction combinations.  This option
8966 is only valid if the @option{-mcpu=ep9312} option has been used to
8967 enable generation of instructions for the Cirrus Maverick floating
8968 point co-processor.  This option is not enabled by default, since the
8969 problem is only present in older Maverick implementations.  The default
8970 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
8971 switch.
8972
8973 @item -mpoke-function-name
8974 @opindex mpoke-function-name
8975 Write the name of each function into the text section, directly
8976 preceding the function prologue.  The generated code is similar to this:
8977
8978 @smallexample
8979      t0
8980          .ascii "arm_poke_function_name", 0
8981          .align
8982      t1
8983          .word 0xff000000 + (t1 - t0)
8984      arm_poke_function_name
8985          mov     ip, sp
8986          stmfd   sp!, @{fp, ip, lr, pc@}
8987          sub     fp, ip, #4
8988 @end smallexample
8989
8990 When performing a stack backtrace, code can inspect the value of
8991 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
8992 location @code{pc - 12} and the top 8 bits are set, then we know that
8993 there is a function name embedded immediately preceding this location
8994 and has length @code{((pc[-3]) & 0xff000000)}.
8995
8996 @item -mthumb
8997 @opindex mthumb
8998 Generate code for the Thumb instruction set.  The default is to
8999 use the 32-bit ARM instruction set.
9000 This option automatically enables either 16-bit Thumb-1 or
9001 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
9002 and @option{-march=@var{name}} options.
9003
9004 @item -mtpcs-frame
9005 @opindex mtpcs-frame
9006 Generate a stack frame that is compliant with the Thumb Procedure Call
9007 Standard for all non-leaf functions.  (A leaf function is one that does
9008 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
9009
9010 @item -mtpcs-leaf-frame
9011 @opindex mtpcs-leaf-frame
9012 Generate a stack frame that is compliant with the Thumb Procedure Call
9013 Standard for all leaf functions.  (A leaf function is one that does
9014 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
9015
9016 @item -mcallee-super-interworking
9017 @opindex mcallee-super-interworking
9018 Gives all externally visible functions in the file being compiled an ARM
9019 instruction set header which switches to Thumb mode before executing the
9020 rest of the function.  This allows these functions to be called from
9021 non-interworking code.
9022
9023 @item -mcaller-super-interworking
9024 @opindex mcaller-super-interworking
9025 Allows calls via function pointers (including virtual functions) to
9026 execute correctly regardless of whether the target code has been
9027 compiled for interworking or not.  There is a small overhead in the cost
9028 of executing a function pointer if this option is enabled.
9029
9030 @item -mtp=@var{name}
9031 @opindex mtp
9032 Specify the access model for the thread local storage pointer.  The valid
9033 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
9034 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
9035 (supported in the arm6k architecture), and @option{auto}, which uses the
9036 best available method for the selected processor.  The default setting is
9037 @option{auto}.
9038
9039 @item -mword-relocations
9040 @opindex mword-relocations
9041 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
9042 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
9043 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
9044 is speficied.
9045
9046 @end table
9047
9048 @node AVR Options
9049 @subsection AVR Options
9050 @cindex AVR Options
9051
9052 These options are defined for AVR implementations:
9053
9054 @table @gcctabopt
9055 @item -mmcu=@var{mcu}
9056 @opindex mmcu
9057 Specify ATMEL AVR instruction set or MCU type.
9058
9059 Instruction set avr1 is for the minimal AVR core, not supported by the C
9060 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9061 attiny11, attiny12, attiny15, attiny28).
9062
9063 Instruction set avr2 (default) is for the classic AVR core with up to
9064 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9065 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9066 at90c8534, at90s8535).
9067
9068 Instruction set avr3 is for the classic AVR core with up to 128K program
9069 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9070
9071 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9072 memory space (MCU types: atmega8, atmega83, atmega85).
9073
9074 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9075 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9076 atmega64, atmega128, at43usb355, at94k).
9077
9078 @item -msize
9079 @opindex msize
9080 Output instruction sizes to the asm file.
9081
9082 @item -minit-stack=@var{N}
9083 @opindex minit-stack
9084 Specify the initial stack address, which may be a symbol or numeric value,
9085 @samp{__stack} is the default.
9086
9087 @item -mno-interrupts
9088 @opindex mno-interrupts
9089 Generated code is not compatible with hardware interrupts.
9090 Code size will be smaller.
9091
9092 @item -mcall-prologues
9093 @opindex mcall-prologues
9094 Functions prologues/epilogues expanded as call to appropriate
9095 subroutines.  Code size will be smaller.
9096
9097 @item -mno-tablejump
9098 @opindex mno-tablejump
9099 Do not generate tablejump insns which sometimes increase code size.
9100
9101 @item -mtiny-stack
9102 @opindex mtiny-stack
9103 Change only the low 8 bits of the stack pointer.
9104
9105 @item -mint8
9106 @opindex mint8
9107 Assume int to be 8 bit integer.  This affects the sizes of all types: A
9108 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
9109 and long long will be 4 bytes.  Please note that this option does not
9110 comply to the C standards, but it will provide you with smaller code
9111 size.
9112 @end table
9113
9114 @node Blackfin Options
9115 @subsection Blackfin Options
9116 @cindex Blackfin Options
9117
9118 @table @gcctabopt
9119 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
9120 @opindex mcpu=
9121 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
9122 can be one of @samp{bf522}, @samp{bf523}, @samp{bf524},
9123 @samp{bf525}, @samp{bf526}, @samp{bf527},
9124 @samp{bf531}, @samp{bf532}, @samp{bf533}, @samp{bf534},
9125 @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
9126 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
9127 @samp{bf561}.
9128 The optional @var{sirevision} specifies the silicon revision of the target
9129 Blackfin processor.  Any workarounds available for the targeted silicon revision
9130 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
9131 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
9132 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
9133 hexadecimal digits representing the major and minor numbers in the silicon
9134 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
9135 is not defined.  If @var{sirevision} is @samp{any}, the
9136 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
9137 If this optional @var{sirevision} is not used, GCC assumes the latest known
9138 silicon revision of the targeted Blackfin processor.
9139
9140 Support for @samp{bf561} is incomplete.  For @samp{bf561},
9141 Only the processor macro is defined.
9142 Without this option, @samp{bf532} is used as the processor by default.
9143 The corresponding predefined processor macros for @var{cpu} is to
9144 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
9145 provided by libgloss to be linked in if @option{-msim} is not given.
9146
9147 @item -msim
9148 @opindex msim
9149 Specifies that the program will be run on the simulator.  This causes
9150 the simulator BSP provided by libgloss to be linked in.  This option
9151 has effect only for @samp{bfin-elf} toolchain.
9152 Certain other options, such as @option{-mid-shared-library} and
9153 @option{-mfdpic}, imply @option{-msim}.
9154
9155 @item -momit-leaf-frame-pointer
9156 @opindex momit-leaf-frame-pointer
9157 Don't keep the frame pointer in a register for leaf functions.  This
9158 avoids the instructions to save, set up and restore frame pointers and
9159 makes an extra register available in leaf functions.  The option
9160 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9161 which might make debugging harder.
9162
9163 @item -mspecld-anomaly
9164 @opindex mspecld-anomaly
9165 When enabled, the compiler will ensure that the generated code does not
9166 contain speculative loads after jump instructions. If this option is used,
9167 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
9168
9169 @item -mno-specld-anomaly
9170 @opindex mno-specld-anomaly
9171 Don't generate extra code to prevent speculative loads from occurring.
9172
9173 @item -mcsync-anomaly
9174 @opindex mcsync-anomaly
9175 When enabled, the compiler will ensure that the generated code does not
9176 contain CSYNC or SSYNC instructions too soon after conditional branches.
9177 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
9178
9179 @item -mno-csync-anomaly
9180 @opindex mno-csync-anomaly
9181 Don't generate extra code to prevent CSYNC or SSYNC instructions from
9182 occurring too soon after a conditional branch.
9183
9184 @item -mlow-64k
9185 @opindex mlow-64k
9186 When enabled, the compiler is free to take advantage of the knowledge that
9187 the entire program fits into the low 64k of memory.
9188
9189 @item -mno-low-64k
9190 @opindex mno-low-64k
9191 Assume that the program is arbitrarily large.  This is the default.
9192
9193 @item -mstack-check-l1
9194 @opindex mstack-check-l1
9195 Do stack checking using information placed into L1 scratchpad memory by the
9196 uClinux kernel.
9197
9198 @item -mid-shared-library
9199 @opindex mid-shared-library
9200 Generate code that supports shared libraries via the library ID method.
9201 This allows for execute in place and shared libraries in an environment
9202 without virtual memory management.  This option implies @option{-fPIC}.
9203 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9204
9205 @item -mno-id-shared-library
9206 @opindex mno-id-shared-library
9207 Generate code that doesn't assume ID based shared libraries are being used.
9208 This is the default.
9209
9210 @item -mleaf-id-shared-library
9211 @opindex mleaf-id-shared-library
9212 Generate code that supports shared libraries via the library ID method,
9213 but assumes that this library or executable won't link against any other
9214 ID shared libraries.  That allows the compiler to use faster code for jumps
9215 and calls.
9216
9217 @item -mno-leaf-id-shared-library
9218 @opindex mno-leaf-id-shared-library
9219 Do not assume that the code being compiled won't link against any ID shared
9220 libraries.  Slower code will be generated for jump and call insns.
9221
9222 @item -mshared-library-id=n
9223 @opindex mshared-library-id
9224 Specified the identification number of the ID based shared library being
9225 compiled.  Specifying a value of 0 will generate more compact code, specifying
9226 other values will force the allocation of that number to the current
9227 library but is no more space or time efficient than omitting this option.
9228
9229 @item -msep-data
9230 @opindex msep-data
9231 Generate code that allows the data segment to be located in a different
9232 area of memory from the text segment.  This allows for execute in place in
9233 an environment without virtual memory management by eliminating relocations
9234 against the text section.
9235
9236 @item -mno-sep-data
9237 @opindex mno-sep-data
9238 Generate code that assumes that the data segment follows the text segment.
9239 This is the default.
9240
9241 @item -mlong-calls
9242 @itemx -mno-long-calls
9243 @opindex mlong-calls
9244 @opindex mno-long-calls
9245 Tells the compiler to perform function calls by first loading the
9246 address of the function into a register and then performing a subroutine
9247 call on this register.  This switch is needed if the target function
9248 will lie outside of the 24 bit addressing range of the offset based
9249 version of subroutine call instruction.
9250
9251 This feature is not enabled by default.  Specifying
9252 @option{-mno-long-calls} will restore the default behavior.  Note these
9253 switches have no effect on how the compiler generates code to handle
9254 function calls via function pointers.
9255
9256 @item -mfast-fp
9257 @opindex mfast-fp
9258 Link with the fast floating-point library. This library relaxes some of
9259 the IEEE floating-point standard's rules for checking inputs against
9260 Not-a-Number (NAN), in the interest of performance.
9261
9262 @item -minline-plt
9263 @opindex minline-plt
9264 Enable inlining of PLT entries in function calls to functions that are
9265 not known to bind locally.  It has no effect without @option{-mfdpic}.
9266
9267 @item -mmulticore
9268 @opindex mmulticore
9269 Build standalone application for multicore Blackfin processor. Proper
9270 start files and link scripts will be used to support multicore.
9271 This option defines @code{__BFIN_MULTICORE}. It can only be used with
9272 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
9273 @option{-mcorea} or @option{-mcoreb}. If it's used without
9274 @option{-mcorea} or @option{-mcoreb}, single application/dual core
9275 programming model is used. In this model, the main function of Core B
9276 should be named as coreb_main. If it's used with @option{-mcorea} or
9277 @option{-mcoreb}, one application per core programming model is used.
9278 If this option is not used, single core application programming
9279 model is used.
9280
9281 @item -mcorea
9282 @opindex mcorea
9283 Build standalone application for Core A of BF561 when using
9284 one application per core programming model. Proper start files
9285 and link scripts will be used to support Core A. This option
9286 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
9287
9288 @item -mcoreb
9289 @opindex mcoreb
9290 Build standalone application for Core B of BF561 when using
9291 one application per core programming model. Proper start files
9292 and link scripts will be used to support Core B. This option
9293 defines @code{__BFIN_COREB}. When this option is used, coreb_main
9294 should be used instead of main. It must be used with
9295 @option{-mmulticore}. 
9296
9297 @item -msdram
9298 @opindex msdram
9299 Build standalone application for SDRAM. Proper start files and
9300 link scripts will be used to put the application into SDRAM.
9301 Loader should initialize SDRAM before loading the application
9302 into SDRAM. This option defines @code{__BFIN_SDRAM}.
9303 @end table
9304
9305 @node CRIS Options
9306 @subsection CRIS Options
9307 @cindex CRIS Options
9308
9309 These options are defined specifically for the CRIS ports.
9310
9311 @table @gcctabopt
9312 @item -march=@var{architecture-type}
9313 @itemx -mcpu=@var{architecture-type}
9314 @opindex march
9315 @opindex mcpu
9316 Generate code for the specified architecture.  The choices for
9317 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9318 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9319 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9320 @samp{v10}.
9321
9322 @item -mtune=@var{architecture-type}
9323 @opindex mtune
9324 Tune to @var{architecture-type} everything applicable about the generated
9325 code, except for the ABI and the set of available instructions.  The
9326 choices for @var{architecture-type} are the same as for
9327 @option{-march=@var{architecture-type}}.
9328
9329 @item -mmax-stack-frame=@var{n}
9330 @opindex mmax-stack-frame
9331 Warn when the stack frame of a function exceeds @var{n} bytes.
9332
9333 @item -metrax4
9334 @itemx -metrax100
9335 @opindex metrax4
9336 @opindex metrax100
9337 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9338 @option{-march=v3} and @option{-march=v8} respectively.
9339
9340 @item -mmul-bug-workaround
9341 @itemx -mno-mul-bug-workaround
9342 @opindex mmul-bug-workaround
9343 @opindex mno-mul-bug-workaround
9344 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
9345 models where it applies.  This option is active by default.
9346
9347 @item -mpdebug
9348 @opindex mpdebug
9349 Enable CRIS-specific verbose debug-related information in the assembly
9350 code.  This option also has the effect to turn off the @samp{#NO_APP}
9351 formatted-code indicator to the assembler at the beginning of the
9352 assembly file.
9353
9354 @item -mcc-init
9355 @opindex mcc-init
9356 Do not use condition-code results from previous instruction; always emit
9357 compare and test instructions before use of condition codes.
9358
9359 @item -mno-side-effects
9360 @opindex mno-side-effects
9361 Do not emit instructions with side-effects in addressing modes other than
9362 post-increment.
9363
9364 @item -mstack-align
9365 @itemx -mno-stack-align
9366 @itemx -mdata-align
9367 @itemx -mno-data-align
9368 @itemx -mconst-align
9369 @itemx -mno-const-align
9370 @opindex mstack-align
9371 @opindex mno-stack-align
9372 @opindex mdata-align
9373 @opindex mno-data-align
9374 @opindex mconst-align
9375 @opindex mno-const-align
9376 These options (no-options) arranges (eliminate arrangements) for the
9377 stack-frame, individual data and constants to be aligned for the maximum
9378 single data access size for the chosen CPU model.  The default is to
9379 arrange for 32-bit alignment.  ABI details such as structure layout are
9380 not affected by these options.
9381
9382 @item -m32-bit
9383 @itemx -m16-bit
9384 @itemx -m8-bit
9385 @opindex m32-bit
9386 @opindex m16-bit
9387 @opindex m8-bit
9388 Similar to the stack- data- and const-align options above, these options
9389 arrange for stack-frame, writable data and constants to all be 32-bit,
9390 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9391
9392 @item -mno-prologue-epilogue
9393 @itemx -mprologue-epilogue
9394 @opindex mno-prologue-epilogue
9395 @opindex mprologue-epilogue
9396 With @option{-mno-prologue-epilogue}, the normal function prologue and
9397 epilogue that sets up the stack-frame are omitted and no return
9398 instructions or return sequences are generated in the code.  Use this
9399 option only together with visual inspection of the compiled code: no
9400 warnings or errors are generated when call-saved registers must be saved,
9401 or storage for local variable needs to be allocated.
9402
9403 @item -mno-gotplt
9404 @itemx -mgotplt
9405 @opindex mno-gotplt
9406 @opindex mgotplt
9407 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9408 instruction sequences that load addresses for functions from the PLT part
9409 of the GOT rather than (traditional on other architectures) calls to the
9410 PLT@.  The default is @option{-mgotplt}.
9411
9412 @item -melf
9413 @opindex melf
9414 Legacy no-op option only recognized with the cris-axis-elf and
9415 cris-axis-linux-gnu targets.
9416
9417 @item -mlinux
9418 @opindex mlinux
9419 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9420
9421 @item -sim
9422 @opindex sim
9423 This option, recognized for the cris-axis-elf arranges
9424 to link with input-output functions from a simulator library.  Code,
9425 initialized data and zero-initialized data are allocated consecutively.
9426
9427 @item -sim2
9428 @opindex sim2
9429 Like @option{-sim}, but pass linker options to locate initialized data at
9430 0x40000000 and zero-initialized data at 0x80000000.
9431 @end table
9432
9433 @node CRX Options
9434 @subsection CRX Options
9435 @cindex CRX Options
9436
9437 These options are defined specifically for the CRX ports.
9438
9439 @table @gcctabopt
9440
9441 @item -mmac
9442 @opindex mmac
9443 Enable the use of multiply-accumulate instructions. Disabled by default.
9444
9445 @item -mpush-args
9446 @opindex mpush-args
9447 Push instructions will be used to pass outgoing arguments when functions
9448 are called. Enabled by default.
9449 @end table
9450
9451 @node Darwin Options
9452 @subsection Darwin Options
9453 @cindex Darwin options
9454
9455 These options are defined for all architectures running the Darwin operating
9456 system.
9457
9458 FSF GCC on Darwin does not create ``fat'' object files; it will create
9459 an object file for the single architecture that it was built to
9460 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
9461 @option{-arch} options are used; it does so by running the compiler or
9462 linker multiple times and joining the results together with
9463 @file{lipo}.
9464
9465 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
9466 @samp{i686}) is determined by the flags that specify the ISA
9467 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
9468 @option{-force_cpusubtype_ALL} option can be used to override this.
9469
9470 The Darwin tools vary in their behavior when presented with an ISA
9471 mismatch.  The assembler, @file{as}, will only permit instructions to
9472 be used that are valid for the subtype of the file it is generating,
9473 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
9474 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
9475 and print an error if asked to create a shared library with a less
9476 restrictive subtype than its input files (for instance, trying to put
9477 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
9478 for executables, @file{ld}, will quietly give the executable the most
9479 restrictive subtype of any of its input files.
9480
9481 @table @gcctabopt
9482 @item -F@var{dir}
9483 @opindex F
9484 Add the framework directory @var{dir} to the head of the list of
9485 directories to be searched for header files.  These directories are
9486 interleaved with those specified by @option{-I} options and are
9487 scanned in a left-to-right order.
9488
9489 A framework directory is a directory with frameworks in it.  A
9490 framework is a directory with a @samp{"Headers"} and/or
9491 @samp{"PrivateHeaders"} directory contained directly in it that ends
9492 in @samp{".framework"}.  The name of a framework is the name of this
9493 directory excluding the @samp{".framework"}.  Headers associated with
9494 the framework are found in one of those two directories, with
9495 @samp{"Headers"} being searched first.  A subframework is a framework
9496 directory that is in a framework's @samp{"Frameworks"} directory.
9497 Includes of subframework headers can only appear in a header of a
9498 framework that contains the subframework, or in a sibling subframework
9499 header.  Two subframeworks are siblings if they occur in the same
9500 framework.  A subframework should not have the same name as a
9501 framework, a warning will be issued if this is violated.  Currently a
9502 subframework cannot have subframeworks, in the future, the mechanism
9503 may be extended to support this.  The standard frameworks can be found
9504 in @samp{"/System/Library/Frameworks"} and
9505 @samp{"/Library/Frameworks"}.  An example include looks like
9506 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
9507 the name of the framework and header.h is found in the
9508 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
9509
9510 @item -iframework@var{dir}
9511 @opindex iframework
9512 Like @option{-F} except the directory is a treated as a system
9513 directory.  The main difference between this @option{-iframework} and
9514 @option{-F} is that with @option{-iframework} the compiler does not
9515 warn about constructs contained within header files found via
9516 @var{dir}.  This option is valid only for the C family of languages.
9517
9518 @item -gused
9519 @opindex gused
9520 Emit debugging information for symbols that are used.  For STABS
9521 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
9522 This is by default ON@.
9523
9524 @item -gfull
9525 @opindex gfull
9526 Emit debugging information for all symbols and types.
9527
9528 @item -mmacosx-version-min=@var{version}
9529 The earliest version of MacOS X that this executable will run on
9530 is @var{version}.  Typical values of @var{version} include @code{10.1},
9531 @code{10.2}, and @code{10.3.9}.
9532
9533 If the compiler was built to use the system's headers by default,
9534 then the default for this option is the system version on which the
9535 compiler is running, otherwise the default is to make choices which
9536 are compatible with as many systems and code bases as possible.
9537
9538 @item -mkernel
9539 @opindex mkernel
9540 Enable kernel development mode.  The @option{-mkernel} option sets
9541 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
9542 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
9543 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
9544 applicable.  This mode also sets @option{-mno-altivec},
9545 @option{-msoft-float}, @option{-fno-builtin} and
9546 @option{-mlong-branch} for PowerPC targets.
9547
9548 @item -mone-byte-bool
9549 @opindex mone-byte-bool
9550 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
9551 By default @samp{sizeof(bool)} is @samp{4} when compiling for
9552 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
9553 option has no effect on x86.
9554
9555 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
9556 to generate code that is not binary compatible with code generated
9557 without that switch.  Using this switch may require recompiling all
9558 other modules in a program, including system libraries.  Use this
9559 switch to conform to a non-default data model.
9560
9561 @item -mfix-and-continue
9562 @itemx -ffix-and-continue
9563 @itemx -findirect-data
9564 @opindex mfix-and-continue
9565 @opindex ffix-and-continue
9566 @opindex findirect-data
9567 Generate code suitable for fast turn around development.  Needed to
9568 enable gdb to dynamically load @code{.o} files into already running
9569 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
9570 are provided for backwards compatibility.
9571
9572 @item -all_load
9573 @opindex all_load
9574 Loads all members of static archive libraries.
9575 See man ld(1) for more information.
9576
9577 @item -arch_errors_fatal
9578 @opindex arch_errors_fatal
9579 Cause the errors having to do with files that have the wrong architecture
9580 to be fatal.
9581
9582 @item -bind_at_load
9583 @opindex bind_at_load
9584 Causes the output file to be marked such that the dynamic linker will
9585 bind all undefined references when the file is loaded or launched.
9586
9587 @item -bundle
9588 @opindex bundle
9589 Produce a Mach-o bundle format file.
9590 See man ld(1) for more information.
9591
9592 @item -bundle_loader @var{executable}
9593 @opindex bundle_loader
9594 This option specifies the @var{executable} that will be loading the build
9595 output file being linked.  See man ld(1) for more information.
9596
9597 @item -dynamiclib
9598 @opindex dynamiclib
9599 When passed this option, GCC will produce a dynamic library instead of
9600 an executable when linking, using the Darwin @file{libtool} command.
9601
9602 @item -force_cpusubtype_ALL
9603 @opindex force_cpusubtype_ALL
9604 This causes GCC's output file to have the @var{ALL} subtype, instead of
9605 one controlled by the @option{-mcpu} or @option{-march} option.
9606
9607 @item -allowable_client  @var{client_name}
9608 @itemx -client_name
9609 @itemx -compatibility_version
9610 @itemx -current_version
9611 @itemx -dead_strip
9612 @itemx -dependency-file
9613 @itemx -dylib_file
9614 @itemx -dylinker_install_name
9615 @itemx -dynamic
9616 @itemx -exported_symbols_list
9617 @itemx -filelist
9618 @itemx -flat_namespace
9619 @itemx -force_flat_namespace
9620 @itemx -headerpad_max_install_names
9621 @itemx -image_base
9622 @itemx -init
9623 @itemx -install_name
9624 @itemx -keep_private_externs
9625 @itemx -multi_module
9626 @itemx -multiply_defined
9627 @itemx -multiply_defined_unused
9628 @itemx -noall_load
9629 @itemx -no_dead_strip_inits_and_terms
9630 @itemx -nofixprebinding
9631 @itemx -nomultidefs
9632 @itemx -noprebind
9633 @itemx -noseglinkedit
9634 @itemx -pagezero_size
9635 @itemx -prebind
9636 @itemx -prebind_all_twolevel_modules
9637 @itemx -private_bundle
9638 @itemx -read_only_relocs
9639 @itemx -sectalign
9640 @itemx -sectobjectsymbols
9641 @itemx -whyload
9642 @itemx -seg1addr
9643 @itemx -sectcreate
9644 @itemx -sectobjectsymbols
9645 @itemx -sectorder
9646 @itemx -segaddr
9647 @itemx -segs_read_only_addr
9648 @itemx -segs_read_write_addr
9649 @itemx -seg_addr_table
9650 @itemx -seg_addr_table_filename
9651 @itemx -seglinkedit
9652 @itemx -segprot
9653 @itemx -segs_read_only_addr
9654 @itemx -segs_read_write_addr
9655 @itemx -single_module
9656 @itemx -static
9657 @itemx -sub_library
9658 @itemx -sub_umbrella
9659 @itemx -twolevel_namespace
9660 @itemx -umbrella
9661 @itemx -undefined
9662 @itemx -unexported_symbols_list
9663 @itemx -weak_reference_mismatches
9664 @itemx -whatsloaded
9665 @opindex allowable_client
9666 @opindex client_name
9667 @opindex compatibility_version
9668 @opindex current_version
9669 @opindex dead_strip
9670 @opindex dependency-file
9671 @opindex dylib_file
9672 @opindex dylinker_install_name
9673 @opindex dynamic
9674 @opindex exported_symbols_list
9675 @opindex filelist
9676 @opindex flat_namespace
9677 @opindex force_flat_namespace
9678 @opindex headerpad_max_install_names
9679 @opindex image_base
9680 @opindex init
9681 @opindex install_name
9682 @opindex keep_private_externs
9683 @opindex multi_module
9684 @opindex multiply_defined
9685 @opindex multiply_defined_unused
9686 @opindex noall_load
9687 @opindex no_dead_strip_inits_and_terms
9688 @opindex nofixprebinding
9689 @opindex nomultidefs
9690 @opindex noprebind
9691 @opindex noseglinkedit
9692 @opindex pagezero_size
9693 @opindex prebind
9694 @opindex prebind_all_twolevel_modules
9695 @opindex private_bundle
9696 @opindex read_only_relocs
9697 @opindex sectalign
9698 @opindex sectobjectsymbols
9699 @opindex whyload
9700 @opindex seg1addr
9701 @opindex sectcreate
9702 @opindex sectobjectsymbols
9703 @opindex sectorder
9704 @opindex segaddr
9705 @opindex segs_read_only_addr
9706 @opindex segs_read_write_addr
9707 @opindex seg_addr_table
9708 @opindex seg_addr_table_filename
9709 @opindex seglinkedit
9710 @opindex segprot
9711 @opindex segs_read_only_addr
9712 @opindex segs_read_write_addr
9713 @opindex single_module
9714 @opindex static
9715 @opindex sub_library
9716 @opindex sub_umbrella
9717 @opindex twolevel_namespace
9718 @opindex umbrella
9719 @opindex undefined
9720 @opindex unexported_symbols_list
9721 @opindex weak_reference_mismatches
9722 @opindex whatsloaded
9723 These options are passed to the Darwin linker.  The Darwin linker man page
9724 describes them in detail.
9725 @end table
9726
9727 @node DEC Alpha Options
9728 @subsection DEC Alpha Options
9729
9730 These @samp{-m} options are defined for the DEC Alpha implementations:
9731
9732 @table @gcctabopt
9733 @item -mno-soft-float
9734 @itemx -msoft-float
9735 @opindex mno-soft-float
9736 @opindex msoft-float
9737 Use (do not use) the hardware floating-point instructions for
9738 floating-point operations.  When @option{-msoft-float} is specified,
9739 functions in @file{libgcc.a} will be used to perform floating-point
9740 operations.  Unless they are replaced by routines that emulate the
9741 floating-point operations, or compiled in such a way as to call such
9742 emulations routines, these routines will issue floating-point
9743 operations.   If you are compiling for an Alpha without floating-point
9744 operations, you must ensure that the library is built so as not to call
9745 them.
9746
9747 Note that Alpha implementations without floating-point operations are
9748 required to have floating-point registers.
9749
9750 @item -mfp-reg
9751 @itemx -mno-fp-regs
9752 @opindex mfp-reg
9753 @opindex mno-fp-regs
9754 Generate code that uses (does not use) the floating-point register set.
9755 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9756 register set is not used, floating point operands are passed in integer
9757 registers as if they were integers and floating-point results are passed
9758 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9759 so any function with a floating-point argument or return value called by code
9760 compiled with @option{-mno-fp-regs} must also be compiled with that
9761 option.
9762
9763 A typical use of this option is building a kernel that does not use,
9764 and hence need not save and restore, any floating-point registers.
9765
9766 @item -mieee
9767 @opindex mieee
9768 The Alpha architecture implements floating-point hardware optimized for
9769 maximum performance.  It is mostly compliant with the IEEE floating
9770 point standard.  However, for full compliance, software assistance is
9771 required.  This option generates code fully IEEE compliant code
9772 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9773 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9774 defined during compilation.  The resulting code is less efficient but is
9775 able to correctly support denormalized numbers and exceptional IEEE
9776 values such as not-a-number and plus/minus infinity.  Other Alpha
9777 compilers call this option @option{-ieee_with_no_inexact}.
9778
9779 @item -mieee-with-inexact
9780 @opindex mieee-with-inexact
9781 This is like @option{-mieee} except the generated code also maintains
9782 the IEEE @var{inexact-flag}.  Turning on this option causes the
9783 generated code to implement fully-compliant IEEE math.  In addition to
9784 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9785 macro.  On some Alpha implementations the resulting code may execute
9786 significantly slower than the code generated by default.  Since there is
9787 very little code that depends on the @var{inexact-flag}, you should
9788 normally not specify this option.  Other Alpha compilers call this
9789 option @option{-ieee_with_inexact}.
9790
9791 @item -mfp-trap-mode=@var{trap-mode}
9792 @opindex mfp-trap-mode
9793 This option controls what floating-point related traps are enabled.
9794 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9795 The trap mode can be set to one of four values:
9796
9797 @table @samp
9798 @item n
9799 This is the default (normal) setting.  The only traps that are enabled
9800 are the ones that cannot be disabled in software (e.g., division by zero
9801 trap).
9802
9803 @item u
9804 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9805 as well.
9806
9807 @item su
9808 Like @samp{u}, but the instructions are marked to be safe for software
9809 completion (see Alpha architecture manual for details).
9810
9811 @item sui
9812 Like @samp{su}, but inexact traps are enabled as well.
9813 @end table
9814
9815 @item -mfp-rounding-mode=@var{rounding-mode}
9816 @opindex mfp-rounding-mode
9817 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9818 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9819 of:
9820
9821 @table @samp
9822 @item n
9823 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9824 the nearest machine number or towards the even machine number in case
9825 of a tie.
9826
9827 @item m
9828 Round towards minus infinity.
9829
9830 @item c
9831 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9832
9833 @item d
9834 Dynamic rounding mode.  A field in the floating point control register
9835 (@var{fpcr}, see Alpha architecture reference manual) controls the
9836 rounding mode in effect.  The C library initializes this register for
9837 rounding towards plus infinity.  Thus, unless your program modifies the
9838 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9839 @end table
9840
9841 @item -mtrap-precision=@var{trap-precision}
9842 @opindex mtrap-precision
9843 In the Alpha architecture, floating point traps are imprecise.  This
9844 means without software assistance it is impossible to recover from a
9845 floating trap and program execution normally needs to be terminated.
9846 GCC can generate code that can assist operating system trap handlers
9847 in determining the exact location that caused a floating point trap.
9848 Depending on the requirements of an application, different levels of
9849 precisions can be selected:
9850
9851 @table @samp
9852 @item p
9853 Program precision.  This option is the default and means a trap handler
9854 can only identify which program caused a floating point exception.
9855
9856 @item f
9857 Function precision.  The trap handler can determine the function that
9858 caused a floating point exception.
9859
9860 @item i
9861 Instruction precision.  The trap handler can determine the exact
9862 instruction that caused a floating point exception.
9863 @end table
9864
9865 Other Alpha compilers provide the equivalent options called
9866 @option{-scope_safe} and @option{-resumption_safe}.
9867
9868 @item -mieee-conformant
9869 @opindex mieee-conformant
9870 This option marks the generated code as IEEE conformant.  You must not
9871 use this option unless you also specify @option{-mtrap-precision=i} and either
9872 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9873 is to emit the line @samp{.eflag 48} in the function prologue of the
9874 generated assembly file.  Under DEC Unix, this has the effect that
9875 IEEE-conformant math library routines will be linked in.
9876
9877 @item -mbuild-constants
9878 @opindex mbuild-constants
9879 Normally GCC examines a 32- or 64-bit integer constant to
9880 see if it can construct it from smaller constants in two or three
9881 instructions.  If it cannot, it will output the constant as a literal and
9882 generate code to load it from the data segment at runtime.
9883
9884 Use this option to require GCC to construct @emph{all} integer constants
9885 using code, even if it takes more instructions (the maximum is six).
9886
9887 You would typically use this option to build a shared library dynamic
9888 loader.  Itself a shared library, it must relocate itself in memory
9889 before it can find the variables and constants in its own data segment.
9890
9891 @item -malpha-as
9892 @itemx -mgas
9893 @opindex malpha-as
9894 @opindex mgas
9895 Select whether to generate code to be assembled by the vendor-supplied
9896 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9897
9898 @item -mbwx
9899 @itemx -mno-bwx
9900 @itemx -mcix
9901 @itemx -mno-cix
9902 @itemx -mfix
9903 @itemx -mno-fix
9904 @itemx -mmax
9905 @itemx -mno-max
9906 @opindex mbwx
9907 @opindex mno-bwx
9908 @opindex mcix
9909 @opindex mno-cix
9910 @opindex mfix
9911 @opindex mno-fix
9912 @opindex mmax
9913 @opindex mno-max
9914 Indicate whether GCC should generate code to use the optional BWX,
9915 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9916 sets supported by the CPU type specified via @option{-mcpu=} option or that
9917 of the CPU on which GCC was built if none was specified.
9918
9919 @item -mfloat-vax
9920 @itemx -mfloat-ieee
9921 @opindex mfloat-vax
9922 @opindex mfloat-ieee
9923 Generate code that uses (does not use) VAX F and G floating point
9924 arithmetic instead of IEEE single and double precision.
9925
9926 @item -mexplicit-relocs
9927 @itemx -mno-explicit-relocs
9928 @opindex mexplicit-relocs
9929 @opindex mno-explicit-relocs
9930 Older Alpha assemblers provided no way to generate symbol relocations
9931 except via assembler macros.  Use of these macros does not allow
9932 optimal instruction scheduling.  GNU binutils as of version 2.12
9933 supports a new syntax that allows the compiler to explicitly mark
9934 which relocations should apply to which instructions.  This option
9935 is mostly useful for debugging, as GCC detects the capabilities of
9936 the assembler when it is built and sets the default accordingly.
9937
9938 @item -msmall-data
9939 @itemx -mlarge-data
9940 @opindex msmall-data
9941 @opindex mlarge-data
9942 When @option{-mexplicit-relocs} is in effect, static data is
9943 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9944 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9945 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9946 16-bit relocations off of the @code{$gp} register.  This limits the
9947 size of the small data area to 64KB, but allows the variables to be
9948 directly accessed via a single instruction.
9949
9950 The default is @option{-mlarge-data}.  With this option the data area
9951 is limited to just below 2GB@.  Programs that require more than 2GB of
9952 data must use @code{malloc} or @code{mmap} to allocate the data in the
9953 heap instead of in the program's data segment.
9954
9955 When generating code for shared libraries, @option{-fpic} implies
9956 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9957
9958 @item -msmall-text
9959 @itemx -mlarge-text
9960 @opindex msmall-text
9961 @opindex mlarge-text
9962 When @option{-msmall-text} is used, the compiler assumes that the
9963 code of the entire program (or shared library) fits in 4MB, and is
9964 thus reachable with a branch instruction.  When @option{-msmall-data}
9965 is used, the compiler can assume that all local symbols share the
9966 same @code{$gp} value, and thus reduce the number of instructions
9967 required for a function call from 4 to 1.
9968
9969 The default is @option{-mlarge-text}.
9970
9971 @item -mcpu=@var{cpu_type}
9972 @opindex mcpu
9973 Set the instruction set and instruction scheduling parameters for
9974 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9975 style name or the corresponding chip number.  GCC supports scheduling
9976 parameters for the EV4, EV5 and EV6 family of processors and will
9977 choose the default values for the instruction set from the processor
9978 you specify.  If you do not specify a processor type, GCC will default
9979 to the processor on which the compiler was built.
9980
9981 Supported values for @var{cpu_type} are
9982
9983 @table @samp
9984 @item ev4
9985 @itemx ev45
9986 @itemx 21064
9987 Schedules as an EV4 and has no instruction set extensions.
9988
9989 @item ev5
9990 @itemx 21164
9991 Schedules as an EV5 and has no instruction set extensions.
9992
9993 @item ev56
9994 @itemx 21164a
9995 Schedules as an EV5 and supports the BWX extension.
9996
9997 @item pca56
9998 @itemx 21164pc
9999 @itemx 21164PC
10000 Schedules as an EV5 and supports the BWX and MAX extensions.
10001
10002 @item ev6
10003 @itemx 21264
10004 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
10005
10006 @item ev67
10007 @itemx 21264a
10008 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
10009 @end table
10010
10011 @item -mtune=@var{cpu_type}
10012 @opindex mtune
10013 Set only the instruction scheduling parameters for machine type
10014 @var{cpu_type}.  The instruction set is not changed.
10015
10016 @item -mmemory-latency=@var{time}
10017 @opindex mmemory-latency
10018 Sets the latency the scheduler should assume for typical memory
10019 references as seen by the application.  This number is highly
10020 dependent on the memory access patterns used by the application
10021 and the size of the external cache on the machine.
10022
10023 Valid options for @var{time} are
10024
10025 @table @samp
10026 @item @var{number}
10027 A decimal number representing clock cycles.
10028
10029 @item L1
10030 @itemx L2
10031 @itemx L3
10032 @itemx main
10033 The compiler contains estimates of the number of clock cycles for
10034 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
10035 (also called Dcache, Scache, and Bcache), as well as to main memory.
10036 Note that L3 is only valid for EV5.
10037
10038 @end table
10039 @end table
10040
10041 @node DEC Alpha/VMS Options
10042 @subsection DEC Alpha/VMS Options
10043
10044 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
10045
10046 @table @gcctabopt
10047 @item -mvms-return-codes
10048 @opindex mvms-return-codes
10049 Return VMS condition codes from main.  The default is to return POSIX
10050 style condition (e.g.@: error) codes.
10051 @end table
10052
10053 @node FRV Options
10054 @subsection FRV Options
10055 @cindex FRV Options
10056
10057 @table @gcctabopt
10058 @item -mgpr-32
10059 @opindex mgpr-32
10060
10061 Only use the first 32 general purpose registers.
10062
10063 @item -mgpr-64
10064 @opindex mgpr-64
10065
10066 Use all 64 general purpose registers.
10067
10068 @item -mfpr-32
10069 @opindex mfpr-32
10070
10071 Use only the first 32 floating point registers.
10072
10073 @item -mfpr-64
10074 @opindex mfpr-64
10075
10076 Use all 64 floating point registers
10077
10078 @item -mhard-float
10079 @opindex mhard-float
10080
10081 Use hardware instructions for floating point operations.
10082
10083 @item -msoft-float
10084 @opindex msoft-float
10085
10086 Use library routines for floating point operations.
10087
10088 @item -malloc-cc
10089 @opindex malloc-cc
10090
10091 Dynamically allocate condition code registers.
10092
10093 @item -mfixed-cc
10094 @opindex mfixed-cc
10095
10096 Do not try to dynamically allocate condition code registers, only
10097 use @code{icc0} and @code{fcc0}.
10098
10099 @item -mdword
10100 @opindex mdword
10101
10102 Change ABI to use double word insns.
10103
10104 @item -mno-dword
10105 @opindex mno-dword
10106
10107 Do not use double word instructions.
10108
10109 @item -mdouble
10110 @opindex mdouble
10111
10112 Use floating point double instructions.
10113
10114 @item -mno-double
10115 @opindex mno-double
10116
10117 Do not use floating point double instructions.
10118
10119 @item -mmedia
10120 @opindex mmedia
10121
10122 Use media instructions.
10123
10124 @item -mno-media
10125 @opindex mno-media
10126
10127 Do not use media instructions.
10128
10129 @item -mmuladd
10130 @opindex mmuladd
10131
10132 Use multiply and add/subtract instructions.
10133
10134 @item -mno-muladd
10135 @opindex mno-muladd
10136
10137 Do not use multiply and add/subtract instructions.
10138
10139 @item -mfdpic
10140 @opindex mfdpic
10141
10142 Select the FDPIC ABI, that uses function descriptors to represent
10143 pointers to functions.  Without any PIC/PIE-related options, it
10144 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
10145 assumes GOT entries and small data are within a 12-bit range from the
10146 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
10147 are computed with 32 bits.
10148 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10149
10150 @item -minline-plt
10151 @opindex minline-plt
10152
10153 Enable inlining of PLT entries in function calls to functions that are
10154 not known to bind locally.  It has no effect without @option{-mfdpic}.
10155 It's enabled by default if optimizing for speed and compiling for
10156 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
10157 optimization option such as @option{-O3} or above is present in the
10158 command line.
10159
10160 @item -mTLS
10161 @opindex TLS
10162
10163 Assume a large TLS segment when generating thread-local code.
10164
10165 @item -mtls
10166 @opindex tls
10167
10168 Do not assume a large TLS segment when generating thread-local code.
10169
10170 @item -mgprel-ro
10171 @opindex mgprel-ro
10172
10173 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
10174 that is known to be in read-only sections.  It's enabled by default,
10175 except for @option{-fpic} or @option{-fpie}: even though it may help
10176 make the global offset table smaller, it trades 1 instruction for 4.
10177 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
10178 one of which may be shared by multiple symbols, and it avoids the need
10179 for a GOT entry for the referenced symbol, so it's more likely to be a
10180 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
10181
10182 @item -multilib-library-pic
10183 @opindex multilib-library-pic
10184
10185 Link with the (library, not FD) pic libraries.  It's implied by
10186 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
10187 @option{-fpic} without @option{-mfdpic}.  You should never have to use
10188 it explicitly.
10189
10190 @item -mlinked-fp
10191 @opindex mlinked-fp
10192
10193 Follow the EABI requirement of always creating a frame pointer whenever
10194 a stack frame is allocated.  This option is enabled by default and can
10195 be disabled with @option{-mno-linked-fp}.
10196
10197 @item -mlong-calls
10198 @opindex mlong-calls
10199
10200 Use indirect addressing to call functions outside the current
10201 compilation unit.  This allows the functions to be placed anywhere
10202 within the 32-bit address space.
10203
10204 @item -malign-labels
10205 @opindex malign-labels
10206
10207 Try to align labels to an 8-byte boundary by inserting nops into the
10208 previous packet.  This option only has an effect when VLIW packing
10209 is enabled.  It doesn't create new packets; it merely adds nops to
10210 existing ones.
10211
10212 @item -mlibrary-pic
10213 @opindex mlibrary-pic
10214
10215 Generate position-independent EABI code.
10216
10217 @item -macc-4
10218 @opindex macc-4
10219
10220 Use only the first four media accumulator registers.
10221
10222 @item -macc-8
10223 @opindex macc-8
10224
10225 Use all eight media accumulator registers.
10226
10227 @item -mpack
10228 @opindex mpack
10229
10230 Pack VLIW instructions.
10231
10232 @item -mno-pack
10233 @opindex mno-pack
10234
10235 Do not pack VLIW instructions.
10236
10237 @item -mno-eflags
10238 @opindex mno-eflags
10239
10240 Do not mark ABI switches in e_flags.
10241
10242 @item -mcond-move
10243 @opindex mcond-move
10244
10245 Enable the use of conditional-move instructions (default).
10246
10247 This switch is mainly for debugging the compiler and will likely be removed
10248 in a future version.
10249
10250 @item -mno-cond-move
10251 @opindex mno-cond-move
10252
10253 Disable the use of conditional-move instructions.
10254
10255 This switch is mainly for debugging the compiler and will likely be removed
10256 in a future version.
10257
10258 @item -mscc
10259 @opindex mscc
10260
10261 Enable the use of conditional set instructions (default).
10262
10263 This switch is mainly for debugging the compiler and will likely be removed
10264 in a future version.
10265
10266 @item -mno-scc
10267 @opindex mno-scc
10268
10269 Disable the use of conditional set instructions.
10270
10271 This switch is mainly for debugging the compiler and will likely be removed
10272 in a future version.
10273
10274 @item -mcond-exec
10275 @opindex mcond-exec
10276
10277 Enable the use of conditional execution (default).
10278
10279 This switch is mainly for debugging the compiler and will likely be removed
10280 in a future version.
10281
10282 @item -mno-cond-exec
10283 @opindex mno-cond-exec
10284
10285 Disable the use of conditional execution.
10286
10287 This switch is mainly for debugging the compiler and will likely be removed
10288 in a future version.
10289
10290 @item -mvliw-branch
10291 @opindex mvliw-branch
10292
10293 Run a pass to pack branches into VLIW instructions (default).
10294
10295 This switch is mainly for debugging the compiler and will likely be removed
10296 in a future version.
10297
10298 @item -mno-vliw-branch
10299 @opindex mno-vliw-branch
10300
10301 Do not run a pass to pack branches into VLIW instructions.
10302
10303 This switch is mainly for debugging the compiler and will likely be removed
10304 in a future version.
10305
10306 @item -mmulti-cond-exec
10307 @opindex mmulti-cond-exec
10308
10309 Enable optimization of @code{&&} and @code{||} in conditional execution
10310 (default).
10311
10312 This switch is mainly for debugging the compiler and will likely be removed
10313 in a future version.
10314
10315 @item -mno-multi-cond-exec
10316 @opindex mno-multi-cond-exec
10317
10318 Disable optimization of @code{&&} and @code{||} in conditional execution.
10319
10320 This switch is mainly for debugging the compiler and will likely be removed
10321 in a future version.
10322
10323 @item -mnested-cond-exec
10324 @opindex mnested-cond-exec
10325
10326 Enable nested conditional execution optimizations (default).
10327
10328 This switch is mainly for debugging the compiler and will likely be removed
10329 in a future version.
10330
10331 @item -mno-nested-cond-exec
10332 @opindex mno-nested-cond-exec
10333
10334 Disable nested conditional execution optimizations.
10335
10336 This switch is mainly for debugging the compiler and will likely be removed
10337 in a future version.
10338
10339 @item -moptimize-membar
10340 @opindex moptimize-membar
10341
10342 This switch removes redundant @code{membar} instructions from the
10343 compiler generated code.  It is enabled by default.
10344
10345 @item -mno-optimize-membar
10346 @opindex mno-optimize-membar
10347
10348 This switch disables the automatic removal of redundant @code{membar}
10349 instructions from the generated code.
10350
10351 @item -mtomcat-stats
10352 @opindex mtomcat-stats
10353
10354 Cause gas to print out tomcat statistics.
10355
10356 @item -mcpu=@var{cpu}
10357 @opindex mcpu
10358
10359 Select the processor type for which to generate code.  Possible values are
10360 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
10361 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
10362
10363 @end table
10364
10365 @node GNU/Linux Options
10366 @subsection GNU/Linux Options
10367
10368 These @samp{-m} options are defined for GNU/Linux targets:
10369
10370 @table @gcctabopt
10371 @item -mglibc
10372 @opindex mglibc
10373 Use the GNU C library instead of uClibc.  This is the default except
10374 on @samp{*-*-linux-*uclibc*} targets.
10375
10376 @item -muclibc
10377 @opindex muclibc
10378 Use uClibc instead of the GNU C library.  This is the default on
10379 @samp{*-*-linux-*uclibc*} targets.
10380 @end table
10381
10382 @node H8/300 Options
10383 @subsection H8/300 Options
10384
10385 These @samp{-m} options are defined for the H8/300 implementations:
10386
10387 @table @gcctabopt
10388 @item -mrelax
10389 @opindex mrelax
10390 Shorten some address references at link time, when possible; uses the
10391 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
10392 ld, Using ld}, for a fuller description.
10393
10394 @item -mh
10395 @opindex mh
10396 Generate code for the H8/300H@.
10397
10398 @item -ms
10399 @opindex ms
10400 Generate code for the H8S@.
10401
10402 @item -mn
10403 @opindex mn
10404 Generate code for the H8S and H8/300H in the normal mode.  This switch
10405 must be used either with @option{-mh} or @option{-ms}.
10406
10407 @item -ms2600
10408 @opindex ms2600
10409 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
10410
10411 @item -mint32
10412 @opindex mint32
10413 Make @code{int} data 32 bits by default.
10414
10415 @item -malign-300
10416 @opindex malign-300
10417 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
10418 The default for the H8/300H and H8S is to align longs and floats on 4
10419 byte boundaries.
10420 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
10421 This option has no effect on the H8/300.
10422 @end table
10423
10424 @node HPPA Options
10425 @subsection HPPA Options
10426 @cindex HPPA Options
10427
10428 These @samp{-m} options are defined for the HPPA family of computers:
10429
10430 @table @gcctabopt
10431 @item -march=@var{architecture-type}
10432 @opindex march
10433 Generate code for the specified architecture.  The choices for
10434 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
10435 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
10436 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
10437 architecture option for your machine.  Code compiled for lower numbered
10438 architectures will run on higher numbered architectures, but not the
10439 other way around.
10440
10441 @item -mpa-risc-1-0
10442 @itemx -mpa-risc-1-1
10443 @itemx -mpa-risc-2-0
10444 @opindex mpa-risc-1-0
10445 @opindex mpa-risc-1-1
10446 @opindex mpa-risc-2-0
10447 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
10448
10449 @item -mbig-switch
10450 @opindex mbig-switch
10451 Generate code suitable for big switch tables.  Use this option only if
10452 the assembler/linker complain about out of range branches within a switch
10453 table.
10454
10455 @item -mjump-in-delay
10456 @opindex mjump-in-delay
10457 Fill delay slots of function calls with unconditional jump instructions
10458 by modifying the return pointer for the function call to be the target
10459 of the conditional jump.
10460
10461 @item -mdisable-fpregs
10462 @opindex mdisable-fpregs
10463 Prevent floating point registers from being used in any manner.  This is
10464 necessary for compiling kernels which perform lazy context switching of
10465 floating point registers.  If you use this option and attempt to perform
10466 floating point operations, the compiler will abort.
10467
10468 @item -mdisable-indexing
10469 @opindex mdisable-indexing
10470 Prevent the compiler from using indexing address modes.  This avoids some
10471 rather obscure problems when compiling MIG generated code under MACH@.
10472
10473 @item -mno-space-regs
10474 @opindex mno-space-regs
10475 Generate code that assumes the target has no space registers.  This allows
10476 GCC to generate faster indirect calls and use unscaled index address modes.
10477
10478 Such code is suitable for level 0 PA systems and kernels.
10479
10480 @item -mfast-indirect-calls
10481 @opindex mfast-indirect-calls
10482 Generate code that assumes calls never cross space boundaries.  This
10483 allows GCC to emit code which performs faster indirect calls.
10484
10485 This option will not work in the presence of shared libraries or nested
10486 functions.
10487
10488 @item -mfixed-range=@var{register-range}
10489 @opindex mfixed-range
10490 Generate code treating the given register range as fixed registers.
10491 A fixed register is one that the register allocator can not use.  This is
10492 useful when compiling kernel code.  A register range is specified as
10493 two registers separated by a dash.  Multiple register ranges can be
10494 specified separated by a comma.
10495
10496 @item -mlong-load-store
10497 @opindex mlong-load-store
10498 Generate 3-instruction load and store sequences as sometimes required by
10499 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
10500 the HP compilers.
10501
10502 @item -mportable-runtime
10503 @opindex mportable-runtime
10504 Use the portable calling conventions proposed by HP for ELF systems.
10505
10506 @item -mgas
10507 @opindex mgas
10508 Enable the use of assembler directives only GAS understands.
10509
10510 @item -mschedule=@var{cpu-type}
10511 @opindex mschedule
10512 Schedule code according to the constraints for the machine type
10513 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
10514 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
10515 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
10516 proper scheduling option for your machine.  The default scheduling is
10517 @samp{8000}.
10518
10519 @item -mlinker-opt
10520 @opindex mlinker-opt
10521 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
10522 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
10523 linkers in which they give bogus error messages when linking some programs.
10524
10525 @item -msoft-float
10526 @opindex msoft-float
10527 Generate output containing library calls for floating point.
10528 @strong{Warning:} the requisite libraries are not available for all HPPA
10529 targets.  Normally the facilities of the machine's usual C compiler are
10530 used, but this cannot be done directly in cross-compilation.  You must make
10531 your own arrangements to provide suitable library functions for
10532 cross-compilation.
10533
10534 @option{-msoft-float} changes the calling convention in the output file;
10535 therefore, it is only useful if you compile @emph{all} of a program with
10536 this option.  In particular, you need to compile @file{libgcc.a}, the
10537 library that comes with GCC, with @option{-msoft-float} in order for
10538 this to work.
10539
10540 @item -msio
10541 @opindex msio
10542 Generate the predefine, @code{_SIO}, for server IO@.  The default is
10543 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
10544 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
10545 options are available under HP-UX and HI-UX@.
10546
10547 @item -mgnu-ld
10548 @opindex gnu-ld
10549 Use GNU ld specific options.  This passes @option{-shared} to ld when
10550 building a shared library.  It is the default when GCC is configured,
10551 explicitly or implicitly, with the GNU linker.  This option does not
10552 have any affect on which ld is called, it only changes what parameters
10553 are passed to that ld.  The ld that is called is determined by the
10554 @option{--with-ld} configure option, GCC's program search path, and
10555 finally by the user's @env{PATH}.  The linker used by GCC can be printed
10556 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
10557 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10558
10559 @item -mhp-ld
10560 @opindex hp-ld
10561 Use HP ld specific options.  This passes @option{-b} to ld when building
10562 a shared library and passes @option{+Accept TypeMismatch} to ld on all
10563 links.  It is the default when GCC is configured, explicitly or
10564 implicitly, with the HP linker.  This option does not have any affect on
10565 which ld is called, it only changes what parameters are passed to that
10566 ld.  The ld that is called is determined by the @option{--with-ld}
10567 configure option, GCC's program search path, and finally by the user's
10568 @env{PATH}.  The linker used by GCC can be printed using @samp{which
10569 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
10570 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10571
10572 @item -mlong-calls
10573 @opindex mno-long-calls
10574 Generate code that uses long call sequences.  This ensures that a call
10575 is always able to reach linker generated stubs.  The default is to generate
10576 long calls only when the distance from the call site to the beginning
10577 of the function or translation unit, as the case may be, exceeds a
10578 predefined limit set by the branch type being used.  The limits for
10579 normal calls are 7,600,000 and 240,000 bytes, respectively for the
10580 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
10581 240,000 bytes.
10582
10583 Distances are measured from the beginning of functions when using the
10584 @option{-ffunction-sections} option, or when using the @option{-mgas}
10585 and @option{-mno-portable-runtime} options together under HP-UX with
10586 the SOM linker.
10587
10588 It is normally not desirable to use this option as it will degrade
10589 performance.  However, it may be useful in large applications,
10590 particularly when partial linking is used to build the application.
10591
10592 The types of long calls used depends on the capabilities of the
10593 assembler and linker, and the type of code being generated.  The
10594 impact on systems that support long absolute calls, and long pic
10595 symbol-difference or pc-relative calls should be relatively small.
10596 However, an indirect call is used on 32-bit ELF systems in pic code
10597 and it is quite long.
10598
10599 @item -munix=@var{unix-std}
10600 @opindex march
10601 Generate compiler predefines and select a startfile for the specified
10602 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
10603 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
10604 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
10605 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
10606 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
10607 and later.
10608
10609 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
10610 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
10611 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
10612 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
10613 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
10614 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
10615
10616 It is @emph{important} to note that this option changes the interfaces
10617 for various library routines.  It also affects the operational behavior
10618 of the C library.  Thus, @emph{extreme} care is needed in using this
10619 option.
10620
10621 Library code that is intended to operate with more than one UNIX
10622 standard must test, set and restore the variable @var{__xpg4_extended_mask}
10623 as appropriate.  Most GNU software doesn't provide this capability.
10624
10625 @item -nolibdld
10626 @opindex nolibdld
10627 Suppress the generation of link options to search libdld.sl when the
10628 @option{-static} option is specified on HP-UX 10 and later.
10629
10630 @item -static
10631 @opindex static
10632 The HP-UX implementation of setlocale in libc has a dependency on
10633 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
10634 when the @option{-static} option is specified, special link options
10635 are needed to resolve this dependency.
10636
10637 On HP-UX 10 and later, the GCC driver adds the necessary options to
10638 link with libdld.sl when the @option{-static} option is specified.
10639 This causes the resulting binary to be dynamic.  On the 64-bit port,
10640 the linkers generate dynamic binaries by default in any case.  The
10641 @option{-nolibdld} option can be used to prevent the GCC driver from
10642 adding these link options.
10643
10644 @item -threads
10645 @opindex threads
10646 Add support for multithreading with the @dfn{dce thread} library
10647 under HP-UX@.  This option sets flags for both the preprocessor and
10648 linker.
10649 @end table
10650
10651 @node i386 and x86-64 Options
10652 @subsection Intel 386 and AMD x86-64 Options
10653 @cindex i386 Options
10654 @cindex x86-64 Options
10655 @cindex Intel 386 Options
10656 @cindex AMD x86-64 Options
10657
10658 These @samp{-m} options are defined for the i386 and x86-64 family of
10659 computers:
10660
10661 @table @gcctabopt
10662 @item -mtune=@var{cpu-type}
10663 @opindex mtune
10664 Tune to @var{cpu-type} everything applicable about the generated code, except
10665 for the ABI and the set of available instructions.  The choices for
10666 @var{cpu-type} are:
10667 @table @emph
10668 @item generic
10669 Produce code optimized for the most common IA32/AMD64/EM64T processors.
10670 If you know the CPU on which your code will run, then you should use
10671 the corresponding @option{-mtune} option instead of
10672 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
10673 of your application will have, then you should use this option.
10674
10675 As new processors are deployed in the marketplace, the behavior of this
10676 option will change.  Therefore, if you upgrade to a newer version of
10677 GCC, the code generated option will change to reflect the processors
10678 that were most common when that version of GCC was released.
10679
10680 There is no @option{-march=generic} option because @option{-march}
10681 indicates the instruction set the compiler can use, and there is no
10682 generic instruction set applicable to all processors.  In contrast,
10683 @option{-mtune} indicates the processor (or, in this case, collection of
10684 processors) for which the code is optimized.
10685 @item native
10686 This selects the CPU to tune for at compilation time by determining
10687 the processor type of the compiling machine.  Using @option{-mtune=native}
10688 will produce code optimized for the local machine under the constraints
10689 of the selected instruction set.  Using @option{-march=native} will
10690 enable all instruction subsets supported by the local machine (hence
10691 the result might not run on different machines).
10692 @item i386
10693 Original Intel's i386 CPU@.
10694 @item i486
10695 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
10696 @item i586, pentium
10697 Intel Pentium CPU with no MMX support.
10698 @item pentium-mmx
10699 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
10700 @item pentiumpro
10701 Intel PentiumPro CPU@.
10702 @item i686
10703 Same as @code{generic}, but when used as @code{march} option, PentiumPro
10704 instruction set will be used, so the code will run on all i686 family chips.
10705 @item pentium2
10706 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
10707 @item pentium3, pentium3m
10708 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
10709 support.
10710 @item pentium-m
10711 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10712 support.  Used by Centrino notebooks.
10713 @item pentium4, pentium4m
10714 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10715 @item prescott
10716 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10717 set support.
10718 @item nocona
10719 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10720 SSE2 and SSE3 instruction set support.
10721 @item core2
10722 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10723 instruction set support.
10724 @item k6
10725 AMD K6 CPU with MMX instruction set support.
10726 @item k6-2, k6-3
10727 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
10728 @item athlon, athlon-tbird
10729 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
10730 support.
10731 @item athlon-4, athlon-xp, athlon-mp
10732 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
10733 instruction set support.
10734 @item k8, opteron, athlon64, athlon-fx
10735 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10736 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
10737 @item k8-sse3, opteron-sse3, athlon64-sse3
10738 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10739 @item amdfam10, barcelona
10740 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10741 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10742 instruction set extensions.)
10743 @item winchip-c6
10744 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10745 set support.
10746 @item winchip2
10747 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
10748 instruction set support.
10749 @item c3
10750 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
10751 implemented for this chip.)
10752 @item c3-2
10753 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10754 implemented for this chip.)
10755 @item geode
10756 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10757 @end table
10758
10759 While picking a specific @var{cpu-type} will schedule things appropriately
10760 for that particular chip, the compiler will not generate any code that
10761 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10762 being used.
10763
10764 @item -march=@var{cpu-type}
10765 @opindex march
10766 Generate instructions for the machine type @var{cpu-type}.  The choices
10767 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10768 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10769
10770 @item -mcpu=@var{cpu-type}
10771 @opindex mcpu
10772 A deprecated synonym for @option{-mtune}.
10773
10774 @item -mfpmath=@var{unit}
10775 @opindex march
10776 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10777 for @var{unit} are:
10778
10779 @table @samp
10780 @item 387
10781 Use the standard 387 floating point coprocessor present majority of chips and
10782 emulated otherwise.  Code compiled with this option will run almost everywhere.
10783 The temporary results are computed in 80bit precision instead of precision
10784 specified by the type resulting in slightly different results compared to most
10785 of other chips.  See @option{-ffloat-store} for more detailed description.
10786
10787 This is the default choice for i386 compiler.
10788
10789 @item sse
10790 Use scalar floating point instructions present in the SSE instruction set.
10791 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10792 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10793 instruction set supports only single precision arithmetics, thus the double and
10794 extended precision arithmetics is still done using 387.  Later version, present
10795 only in Pentium4 and the future AMD x86-64 chips supports double precision
10796 arithmetics too.
10797
10798 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10799 or @option{-msse2} switches to enable SSE extensions and make this option
10800 effective.  For the x86-64 compiler, these extensions are enabled by default.
10801
10802 The resulting code should be considerably faster in the majority of cases and avoid
10803 the numerical instability problems of 387 code, but may break some existing
10804 code that expects temporaries to be 80bit.
10805
10806 This is the default choice for the x86-64 compiler.
10807
10808 @item sse,387
10809 @itemx sse+387
10810 @itemx both
10811 Attempt to utilize both instruction sets at once.  This effectively double the
10812 amount of available registers and on chips with separate execution units for
10813 387 and SSE the execution resources too.  Use this option with care, as it is
10814 still experimental, because the GCC register allocator does not model separate
10815 functional units well resulting in instable performance.
10816 @end table
10817
10818 @item -masm=@var{dialect}
10819 @opindex masm=@var{dialect}
10820 Output asm instructions using selected @var{dialect}.  Supported
10821 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10822 not support @samp{intel}.
10823
10824 @item -mieee-fp
10825 @itemx -mno-ieee-fp
10826 @opindex mieee-fp
10827 @opindex mno-ieee-fp
10828 Control whether or not the compiler uses IEEE floating point
10829 comparisons.  These handle correctly the case where the result of a
10830 comparison is unordered.
10831
10832 @item -msoft-float
10833 @opindex msoft-float
10834 Generate output containing library calls for floating point.
10835 @strong{Warning:} the requisite libraries are not part of GCC@.
10836 Normally the facilities of the machine's usual C compiler are used, but
10837 this can't be done directly in cross-compilation.  You must make your
10838 own arrangements to provide suitable library functions for
10839 cross-compilation.
10840
10841 On machines where a function returns floating point results in the 80387
10842 register stack, some floating point opcodes may be emitted even if
10843 @option{-msoft-float} is used.
10844
10845 @item -mno-fp-ret-in-387
10846 @opindex mno-fp-ret-in-387
10847 Do not use the FPU registers for return values of functions.
10848
10849 The usual calling convention has functions return values of types
10850 @code{float} and @code{double} in an FPU register, even if there
10851 is no FPU@.  The idea is that the operating system should emulate
10852 an FPU@.
10853
10854 The option @option{-mno-fp-ret-in-387} causes such values to be returned
10855 in ordinary CPU registers instead.
10856
10857 @item -mno-fancy-math-387
10858 @opindex mno-fancy-math-387
10859 Some 387 emulators do not support the @code{sin}, @code{cos} and
10860 @code{sqrt} instructions for the 387.  Specify this option to avoid
10861 generating those instructions.  This option is the default on FreeBSD,
10862 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
10863 indicates that the target cpu will always have an FPU and so the
10864 instruction will not need emulation.  As of revision 2.6.1, these
10865 instructions are not generated unless you also use the
10866 @option{-funsafe-math-optimizations} switch.
10867
10868 @item -malign-double
10869 @itemx -mno-align-double
10870 @opindex malign-double
10871 @opindex mno-align-double
10872 Control whether GCC aligns @code{double}, @code{long double}, and
10873 @code{long long} variables on a two word boundary or a one word
10874 boundary.  Aligning @code{double} variables on a two word boundary will
10875 produce code that runs somewhat faster on a @samp{Pentium} at the
10876 expense of more memory.
10877
10878 On x86-64, @option{-malign-double} is enabled by default.
10879
10880 @strong{Warning:} if you use the @option{-malign-double} switch,
10881 structures containing the above types will be aligned differently than
10882 the published application binary interface specifications for the 386
10883 and will not be binary compatible with structures in code compiled
10884 without that switch.
10885
10886 @item -m96bit-long-double
10887 @itemx -m128bit-long-double
10888 @opindex m96bit-long-double
10889 @opindex m128bit-long-double
10890 These switches control the size of @code{long double} type.  The i386
10891 application binary interface specifies the size to be 96 bits,
10892 so @option{-m96bit-long-double} is the default in 32 bit mode.
10893
10894 Modern architectures (Pentium and newer) would prefer @code{long double}
10895 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
10896 conforming to the ABI, this would not be possible.  So specifying a
10897 @option{-m128bit-long-double} will align @code{long double}
10898 to a 16 byte boundary by padding the @code{long double} with an additional
10899 32 bit zero.
10900
10901 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
10902 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
10903
10904 Notice that neither of these options enable any extra precision over the x87
10905 standard of 80 bits for a @code{long double}.
10906
10907 @strong{Warning:} if you override the default value for your target ABI, the
10908 structures and arrays containing @code{long double} variables will change
10909 their size as well as function calling convention for function taking
10910 @code{long double} will be modified.  Hence they will not be binary
10911 compatible with arrays or structures in code compiled without that switch.
10912
10913 @item -mmlarge-data-threshold=@var{number}
10914 @opindex mlarge-data-threshold=@var{number}
10915 When @option{-mcmodel=medium} is specified, the data greater than
10916 @var{threshold} are placed in large data section.  This value must be the
10917 same across all object linked into the binary and defaults to 65535.
10918
10919 @item -mrtd
10920 @opindex mrtd
10921 Use a different function-calling convention, in which functions that
10922 take a fixed number of arguments return with the @code{ret} @var{num}
10923 instruction, which pops their arguments while returning.  This saves one
10924 instruction in the caller since there is no need to pop the arguments
10925 there.
10926
10927 You can specify that an individual function is called with this calling
10928 sequence with the function attribute @samp{stdcall}.  You can also
10929 override the @option{-mrtd} option by using the function attribute
10930 @samp{cdecl}.  @xref{Function Attributes}.
10931
10932 @strong{Warning:} this calling convention is incompatible with the one
10933 normally used on Unix, so you cannot use it if you need to call
10934 libraries compiled with the Unix compiler.
10935
10936 Also, you must provide function prototypes for all functions that
10937 take variable numbers of arguments (including @code{printf});
10938 otherwise incorrect code will be generated for calls to those
10939 functions.
10940
10941 In addition, seriously incorrect code will result if you call a
10942 function with too many arguments.  (Normally, extra arguments are
10943 harmlessly ignored.)
10944
10945 @item -mregparm=@var{num}
10946 @opindex mregparm
10947 Control how many registers are used to pass integer arguments.  By
10948 default, no registers are used to pass arguments, and at most 3
10949 registers can be used.  You can control this behavior for a specific
10950 function by using the function attribute @samp{regparm}.
10951 @xref{Function Attributes}.
10952
10953 @strong{Warning:} if you use this switch, and
10954 @var{num} is nonzero, then you must build all modules with the same
10955 value, including any libraries.  This includes the system libraries and
10956 startup modules.
10957
10958 @item -msseregparm
10959 @opindex msseregparm
10960 Use SSE register passing conventions for float and double arguments
10961 and return values.  You can control this behavior for a specific
10962 function by using the function attribute @samp{sseregparm}.
10963 @xref{Function Attributes}.
10964
10965 @strong{Warning:} if you use this switch then you must build all
10966 modules with the same value, including any libraries.  This includes
10967 the system libraries and startup modules.
10968
10969 @item -mpc32
10970 @itemx -mpc64
10971 @itemx -mpc80
10972 @opindex mpc32
10973 @opindex mpc64
10974 @opindex mpc80
10975
10976 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
10977 is specified, the significands of results of floating-point operations are
10978 rounded to 24 bits (single precision); @option{-mpc64} rounds the
10979 significands of results of floating-point operations to 53 bits (double
10980 precision) and @option{-mpc80} rounds the significands of results of
10981 floating-point operations to 64 bits (extended double precision), which is
10982 the default.  When this option is used, floating-point operations in higher
10983 precisions are not available to the programmer without setting the FPU
10984 control word explicitly.
10985
10986 Setting the rounding of floating-point operations to less than the default
10987 80 bits can speed some programs by 2% or more.  Note that some mathematical
10988 libraries assume that extended precision (80 bit) floating-point operations
10989 are enabled by default; routines in such libraries could suffer significant
10990 loss of accuracy, typically through so-called "catastrophic cancellation",
10991 when this option is used to set the precision to less than extended precision. 
10992
10993 @item -mstackrealign
10994 @opindex mstackrealign
10995 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
10996 option will generate an alternate prologue and epilogue that realigns the
10997 runtime stack if necessary.  This supports mixing legacy codes that keep
10998 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
10999 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
11000 applicable to individual functions.
11001
11002 @item -mpreferred-stack-boundary=@var{num}
11003 @opindex mpreferred-stack-boundary
11004 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
11005 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
11006 the default is 4 (16 bytes or 128 bits).
11007
11008 @item -mincoming-stack-boundary=@var{num}
11009 @opindex mincoming-stack-boundary
11010 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
11011 boundary.  If @option{-mincoming-stack-boundary} is not specified,
11012 the one specified by @option{-mpreferred-stack-boundary} will be used.
11013
11014 On Pentium and PentiumPro, @code{double} and @code{long double} values
11015 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
11016 suffer significant run time performance penalties.  On Pentium III, the
11017 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
11018 properly if it is not 16 byte aligned.
11019
11020 To ensure proper alignment of this values on the stack, the stack boundary
11021 must be as aligned as that required by any value stored on the stack.
11022 Further, every function must be generated such that it keeps the stack
11023 aligned.  Thus calling a function compiled with a higher preferred
11024 stack boundary from a function compiled with a lower preferred stack
11025 boundary will most likely misalign the stack.  It is recommended that
11026 libraries that use callbacks always use the default setting.
11027
11028 This extra alignment does consume extra stack space, and generally
11029 increases code size.  Code that is sensitive to stack space usage, such
11030 as embedded systems and operating system kernels, may want to reduce the
11031 preferred alignment to @option{-mpreferred-stack-boundary=2}.
11032
11033 @item -mmmx
11034 @itemx -mno-mmx
11035 @itemx -msse
11036 @itemx -mno-sse
11037 @itemx -msse2
11038 @itemx -mno-sse2
11039 @itemx -msse3
11040 @itemx -mno-sse3
11041 @itemx -mssse3
11042 @itemx -mno-ssse3
11043 @itemx -msse4.1
11044 @itemx -mno-sse4.1
11045 @itemx -msse4.2
11046 @itemx -mno-sse4.2
11047 @itemx -msse4
11048 @itemx -mno-sse4
11049 @itemx -mavx
11050 @itemx -mno-avx
11051 @itemx -maes
11052 @itemx -mno-aes
11053 @itemx -mpclmul
11054 @itemx -mno-pclmul
11055 @itemx -msse4a
11056 @itemx -mno-sse4a
11057 @itemx -msse5
11058 @itemx -mno-sse5
11059 @itemx -m3dnow
11060 @itemx -mno-3dnow
11061 @itemx -mpopcnt
11062 @itemx -mno-popcnt
11063 @itemx -mabm
11064 @itemx -mno-abm
11065 @opindex mmmx
11066 @opindex mno-mmx
11067 @opindex msse
11068 @opindex mno-sse
11069 @opindex m3dnow
11070 @opindex mno-3dnow
11071 These switches enable or disable the use of instructions in the MMX,
11072 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, SSE5, ABM or
11073 3DNow!@: extended instruction sets.
11074 These extensions are also available as built-in functions: see
11075 @ref{X86 Built-in Functions}, for details of the functions enabled and
11076 disabled by these switches.
11077
11078 To have SSE/SSE2 instructions generated automatically from floating-point
11079 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
11080
11081 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
11082 generates new AVX instructions or AVX equivalence for all SSEx instructions
11083 when needed.
11084
11085 These options will enable GCC to use these extended instructions in
11086 generated code, even without @option{-mfpmath=sse}.  Applications which
11087 perform runtime CPU detection must compile separate files for each
11088 supported architecture, using the appropriate flags.  In particular,
11089 the file containing the CPU detection code should be compiled without
11090 these options.
11091
11092 @item -mcld
11093 @opindex mcld
11094 This option instructs GCC to emit a @code{cld} instruction in the prologue
11095 of functions that use string instructions.  String instructions depend on
11096 the DF flag to select between autoincrement or autodecrement mode.  While the
11097 ABI specifies the DF flag to be cleared on function entry, some operating
11098 systems violate this specification by not clearing the DF flag in their
11099 exception dispatchers.  The exception handler can be invoked with the DF flag
11100 set which leads to wrong direction mode, when string instructions are used.
11101 This option can be enabled by default on 32-bit x86 targets by configuring
11102 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
11103 instructions can be suppressed with the @option{-mno-cld} compiler option
11104 in this case.
11105
11106 @item -mcx16
11107 @opindex mcx16
11108 This option will enable GCC to use CMPXCHG16B instruction in generated code.
11109 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
11110 data types.  This is useful for high resolution counters that could be updated
11111 by multiple processors (or cores).  This instruction is generated as part of
11112 atomic built-in functions: see @ref{Atomic Builtins} for details.
11113
11114 @item -msahf
11115 @opindex msahf
11116 This option will enable GCC to use SAHF instruction in generated 64-bit code.
11117 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
11118 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
11119 SAHF are load and store instructions, respectively, for certain status flags.
11120 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
11121 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
11122
11123 @item -mrecip
11124 @opindex mrecip
11125 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
11126 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Rhapson step
11127 to increase precision instead of DIVSS and SQRTSS (and their vectorized
11128 variants) for single precision floating point arguments.  These instructions
11129 are generated only when @option{-funsafe-math-optimizations} is enabled
11130 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
11131 Note that while the throughput of the sequence is higher than the throughput
11132 of the non-reciprocal instruction, the precision of the sequence can be
11133 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
11134
11135 @item -mveclibabi=@var{type}
11136 @opindex mveclibabi
11137 Specifies the ABI type to use for vectorizing intrinsics using an
11138 external library.  Supported types are @code{svml} for the Intel short
11139 vector math library and @code{acml} for the AMD math core library style
11140 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
11141 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
11142 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
11143 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
11144 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
11145 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
11146 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
11147 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
11148 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
11149 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
11150 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
11151 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
11152 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
11153 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
11154 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
11155 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
11156 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
11157 compatible library will have to be specified at link time.
11158
11159 @item -mpush-args
11160 @itemx -mno-push-args
11161 @opindex mpush-args
11162 @opindex mno-push-args
11163 Use PUSH operations to store outgoing parameters.  This method is shorter
11164 and usually equally fast as method using SUB/MOV operations and is enabled
11165 by default.  In some cases disabling it may improve performance because of
11166 improved scheduling and reduced dependencies.
11167
11168 @item -maccumulate-outgoing-args
11169 @opindex maccumulate-outgoing-args
11170 If enabled, the maximum amount of space required for outgoing arguments will be
11171 computed in the function prologue.  This is faster on most modern CPUs
11172 because of reduced dependencies, improved scheduling and reduced stack usage
11173 when preferred stack boundary is not equal to 2.  The drawback is a notable
11174 increase in code size.  This switch implies @option{-mno-push-args}.
11175
11176 @item -mthreads
11177 @opindex mthreads
11178 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
11179 on thread-safe exception handling must compile and link all code with the
11180 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
11181 @option{-D_MT}; when linking, it links in a special thread helper library
11182 @option{-lmingwthrd} which cleans up per thread exception handling data.
11183
11184 @item -mno-align-stringops
11185 @opindex mno-align-stringops
11186 Do not align destination of inlined string operations.  This switch reduces
11187 code size and improves performance in case the destination is already aligned,
11188 but GCC doesn't know about it.
11189
11190 @item -minline-all-stringops
11191 @opindex minline-all-stringops
11192 By default GCC inlines string operations only when destination is known to be
11193 aligned at least to 4 byte boundary.  This enables more inlining, increase code
11194 size, but may improve performance of code that depends on fast memcpy, strlen
11195 and memset for short lengths.
11196
11197 @item -minline-stringops-dynamically
11198 @opindex minline-stringops-dynamically
11199 For string operation of unknown size, inline runtime checks so for small
11200 blocks inline code is used, while for large blocks library call is used.
11201
11202 @item -mstringop-strategy=@var{alg}
11203 @opindex mstringop-strategy=@var{alg}
11204 Overwrite internal decision heuristic about particular algorithm to inline
11205 string operation with.  The allowed values are @code{rep_byte},
11206 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
11207 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
11208 expanding inline loop, @code{libcall} for always expanding library call.
11209
11210 @item -momit-leaf-frame-pointer
11211 @opindex momit-leaf-frame-pointer
11212 Don't keep the frame pointer in a register for leaf functions.  This
11213 avoids the instructions to save, set up and restore frame pointers and
11214 makes an extra register available in leaf functions.  The option
11215 @option{-fomit-frame-pointer} removes the frame pointer for all functions
11216 which might make debugging harder.
11217
11218 @item -mtls-direct-seg-refs
11219 @itemx -mno-tls-direct-seg-refs
11220 @opindex mtls-direct-seg-refs
11221 Controls whether TLS variables may be accessed with offsets from the
11222 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
11223 or whether the thread base pointer must be added.  Whether or not this
11224 is legal depends on the operating system, and whether it maps the
11225 segment to cover the entire TLS area.
11226
11227 For systems that use GNU libc, the default is on.
11228
11229 @item -mfused-madd
11230 @itemx -mno-fused-madd
11231 @opindex mfused-madd
11232 Enable automatic generation of fused floating point multiply-add instructions
11233 if the ISA supports such instructions.  The -mfused-madd option is on by
11234 default.  The fused multiply-add instructions have a different
11235 rounding behavior compared to executing a multiply followed by an add.
11236
11237 @item -msse2avx
11238 @itemx -mno-sse2avx
11239 @opindex msse2avx
11240 Specify that the assembler should encode SSE instructions with VEX
11241 prefix.  The option @option{-mavx} turns this on by default.
11242 @end table
11243
11244 These @samp{-m} switches are supported in addition to the above
11245 on AMD x86-64 processors in 64-bit environments.
11246
11247 @table @gcctabopt
11248 @item -m32
11249 @itemx -m64
11250 @opindex m32
11251 @opindex m64
11252 Generate code for a 32-bit or 64-bit environment.
11253 The 32-bit environment sets int, long and pointer to 32 bits and
11254 generates code that runs on any i386 system.
11255 The 64-bit environment sets int to 32 bits and long and pointer
11256 to 64 bits and generates code for AMD's x86-64 architecture. For
11257 darwin only the -m64 option turns off the @option{-fno-pic} and
11258 @option{-mdynamic-no-pic} options.
11259
11260 @item -mno-red-zone
11261 @opindex no-red-zone
11262 Do not use a so called red zone for x86-64 code.  The red zone is mandated
11263 by the x86-64 ABI, it is a 128-byte area beyond the location of the
11264 stack pointer that will not be modified by signal or interrupt handlers
11265 and therefore can be used for temporary data without adjusting the stack
11266 pointer.  The flag @option{-mno-red-zone} disables this red zone.
11267
11268 @item -mcmodel=small
11269 @opindex mcmodel=small
11270 Generate code for the small code model: the program and its symbols must
11271 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
11272 Programs can be statically or dynamically linked.  This is the default
11273 code model.
11274
11275 @item -mcmodel=kernel
11276 @opindex mcmodel=kernel
11277 Generate code for the kernel code model.  The kernel runs in the
11278 negative 2 GB of the address space.
11279 This model has to be used for Linux kernel code.
11280
11281 @item -mcmodel=medium
11282 @opindex mcmodel=medium
11283 Generate code for the medium model: The program is linked in the lower 2
11284 GB of the address space but symbols can be located anywhere in the
11285 address space.  Programs can be statically or dynamically linked, but
11286 building of shared libraries are not supported with the medium model.
11287
11288 @item -mcmodel=large
11289 @opindex mcmodel=large
11290 Generate code for the large model: This model makes no assumptions
11291 about addresses and sizes of sections.
11292 @end table
11293
11294 @node IA-64 Options
11295 @subsection IA-64 Options
11296 @cindex IA-64 Options
11297
11298 These are the @samp{-m} options defined for the Intel IA-64 architecture.
11299
11300 @table @gcctabopt
11301 @item -mbig-endian
11302 @opindex mbig-endian
11303 Generate code for a big endian target.  This is the default for HP-UX@.
11304
11305 @item -mlittle-endian
11306 @opindex mlittle-endian
11307 Generate code for a little endian target.  This is the default for AIX5
11308 and GNU/Linux.
11309
11310 @item -mgnu-as
11311 @itemx -mno-gnu-as
11312 @opindex mgnu-as
11313 @opindex mno-gnu-as
11314 Generate (or don't) code for the GNU assembler.  This is the default.
11315 @c Also, this is the default if the configure option @option{--with-gnu-as}
11316 @c is used.
11317
11318 @item -mgnu-ld
11319 @itemx -mno-gnu-ld
11320 @opindex mgnu-ld
11321 @opindex mno-gnu-ld
11322 Generate (or don't) code for the GNU linker.  This is the default.
11323 @c Also, this is the default if the configure option @option{--with-gnu-ld}
11324 @c is used.
11325
11326 @item -mno-pic
11327 @opindex mno-pic
11328 Generate code that does not use a global pointer register.  The result
11329 is not position independent code, and violates the IA-64 ABI@.
11330
11331 @item -mvolatile-asm-stop
11332 @itemx -mno-volatile-asm-stop
11333 @opindex mvolatile-asm-stop
11334 @opindex mno-volatile-asm-stop
11335 Generate (or don't) a stop bit immediately before and after volatile asm
11336 statements.
11337
11338 @item -mregister-names
11339 @itemx -mno-register-names
11340 @opindex mregister-names
11341 @opindex mno-register-names
11342 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
11343 the stacked registers.  This may make assembler output more readable.
11344
11345 @item -mno-sdata
11346 @itemx -msdata
11347 @opindex mno-sdata
11348 @opindex msdata
11349 Disable (or enable) optimizations that use the small data section.  This may
11350 be useful for working around optimizer bugs.
11351
11352 @item -mconstant-gp
11353 @opindex mconstant-gp
11354 Generate code that uses a single constant global pointer value.  This is
11355 useful when compiling kernel code.
11356
11357 @item -mauto-pic
11358 @opindex mauto-pic
11359 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
11360 This is useful when compiling firmware code.
11361
11362 @item -minline-float-divide-min-latency
11363 @opindex minline-float-divide-min-latency
11364 Generate code for inline divides of floating point values
11365 using the minimum latency algorithm.
11366
11367 @item -minline-float-divide-max-throughput
11368 @opindex minline-float-divide-max-throughput
11369 Generate code for inline divides of floating point values
11370 using the maximum throughput algorithm.
11371
11372 @item -minline-int-divide-min-latency
11373 @opindex minline-int-divide-min-latency
11374 Generate code for inline divides of integer values
11375 using the minimum latency algorithm.
11376
11377 @item -minline-int-divide-max-throughput
11378 @opindex minline-int-divide-max-throughput
11379 Generate code for inline divides of integer values
11380 using the maximum throughput algorithm.
11381
11382 @item -minline-sqrt-min-latency
11383 @opindex minline-sqrt-min-latency
11384 Generate code for inline square roots
11385 using the minimum latency algorithm.
11386
11387 @item -minline-sqrt-max-throughput
11388 @opindex minline-sqrt-max-throughput
11389 Generate code for inline square roots
11390 using the maximum throughput algorithm.
11391
11392 @item -mno-dwarf2-asm
11393 @itemx -mdwarf2-asm
11394 @opindex mno-dwarf2-asm
11395 @opindex mdwarf2-asm
11396 Don't (or do) generate assembler code for the DWARF2 line number debugging
11397 info.  This may be useful when not using the GNU assembler.
11398
11399 @item -mearly-stop-bits
11400 @itemx -mno-early-stop-bits
11401 @opindex mearly-stop-bits
11402 @opindex mno-early-stop-bits
11403 Allow stop bits to be placed earlier than immediately preceding the
11404 instruction that triggered the stop bit.  This can improve instruction
11405 scheduling, but does not always do so.
11406
11407 @item -mfixed-range=@var{register-range}
11408 @opindex mfixed-range
11409 Generate code treating the given register range as fixed registers.
11410 A fixed register is one that the register allocator can not use.  This is
11411 useful when compiling kernel code.  A register range is specified as
11412 two registers separated by a dash.  Multiple register ranges can be
11413 specified separated by a comma.
11414
11415 @item -mtls-size=@var{tls-size}
11416 @opindex mtls-size
11417 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
11418 64.
11419
11420 @item -mtune=@var{cpu-type}
11421 @opindex mtune
11422 Tune the instruction scheduling for a particular CPU, Valid values are
11423 itanium, itanium1, merced, itanium2, and mckinley.
11424
11425 @item -mt
11426 @itemx -pthread
11427 @opindex mt
11428 @opindex pthread
11429 Add support for multithreading using the POSIX threads library.  This
11430 option sets flags for both the preprocessor and linker.  It does
11431 not affect the thread safety of object code produced by the compiler or
11432 that of libraries supplied with it.  These are HP-UX specific flags.
11433
11434 @item -milp32
11435 @itemx -mlp64
11436 @opindex milp32
11437 @opindex mlp64
11438 Generate code for a 32-bit or 64-bit environment.
11439 The 32-bit environment sets int, long and pointer to 32 bits.
11440 The 64-bit environment sets int to 32 bits and long and pointer
11441 to 64 bits.  These are HP-UX specific flags.
11442
11443 @item -mno-sched-br-data-spec
11444 @itemx -msched-br-data-spec
11445 @opindex mno-sched-br-data-spec
11446 @opindex msched-br-data-spec
11447 (Dis/En)able data speculative scheduling before reload.
11448 This will result in generation of the ld.a instructions and
11449 the corresponding check instructions (ld.c / chk.a).
11450 The default is 'disable'.
11451
11452 @item -msched-ar-data-spec
11453 @itemx -mno-sched-ar-data-spec
11454 @opindex msched-ar-data-spec
11455 @opindex mno-sched-ar-data-spec
11456 (En/Dis)able data speculative scheduling after reload.
11457 This will result in generation of the ld.a instructions and
11458 the corresponding check instructions (ld.c / chk.a).
11459 The default is 'enable'.
11460
11461 @item -mno-sched-control-spec
11462 @itemx -msched-control-spec
11463 @opindex mno-sched-control-spec
11464 @opindex msched-control-spec
11465 (Dis/En)able control speculative scheduling.  This feature is
11466 available only during region scheduling (i.e.@: before reload).
11467 This will result in generation of the ld.s instructions and
11468 the corresponding check instructions chk.s .
11469 The default is 'disable'.
11470
11471 @item -msched-br-in-data-spec
11472 @itemx -mno-sched-br-in-data-spec
11473 @opindex msched-br-in-data-spec
11474 @opindex mno-sched-br-in-data-spec
11475 (En/Dis)able speculative scheduling of the instructions that
11476 are dependent on the data speculative loads before reload.
11477 This is effective only with @option{-msched-br-data-spec} enabled.
11478 The default is 'enable'.
11479
11480 @item -msched-ar-in-data-spec
11481 @itemx -mno-sched-ar-in-data-spec
11482 @opindex msched-ar-in-data-spec
11483 @opindex mno-sched-ar-in-data-spec
11484 (En/Dis)able speculative scheduling of the instructions that
11485 are dependent on the data speculative loads after reload.
11486 This is effective only with @option{-msched-ar-data-spec} enabled.
11487 The default is 'enable'.
11488
11489 @item -msched-in-control-spec
11490 @itemx -mno-sched-in-control-spec
11491 @opindex msched-in-control-spec
11492 @opindex mno-sched-in-control-spec
11493 (En/Dis)able speculative scheduling of the instructions that
11494 are dependent on the control speculative loads.
11495 This is effective only with @option{-msched-control-spec} enabled.
11496 The default is 'enable'.
11497
11498 @item -msched-ldc
11499 @itemx -mno-sched-ldc
11500 @opindex msched-ldc
11501 @opindex mno-sched-ldc
11502 (En/Dis)able use of simple data speculation checks ld.c .
11503 If disabled, only chk.a instructions will be emitted to check
11504 data speculative loads.
11505 The default is 'enable'.
11506
11507 @item -mno-sched-control-ldc
11508 @itemx -msched-control-ldc
11509 @opindex mno-sched-control-ldc
11510 @opindex msched-control-ldc
11511 (Dis/En)able use of ld.c instructions to check control speculative loads.
11512 If enabled, in case of control speculative load with no speculatively
11513 scheduled dependent instructions this load will be emitted as ld.sa and
11514 ld.c will be used to check it.
11515 The default is 'disable'.
11516
11517 @item -mno-sched-spec-verbose
11518 @itemx -msched-spec-verbose
11519 @opindex mno-sched-spec-verbose
11520 @opindex msched-spec-verbose
11521 (Dis/En)able printing of the information about speculative motions.
11522
11523 @item -mno-sched-prefer-non-data-spec-insns
11524 @itemx -msched-prefer-non-data-spec-insns
11525 @opindex mno-sched-prefer-non-data-spec-insns
11526 @opindex msched-prefer-non-data-spec-insns
11527 If enabled, data speculative instructions will be chosen for schedule
11528 only if there are no other choices at the moment.  This will make
11529 the use of the data speculation much more conservative.
11530 The default is 'disable'.
11531
11532 @item -mno-sched-prefer-non-control-spec-insns
11533 @itemx -msched-prefer-non-control-spec-insns
11534 @opindex mno-sched-prefer-non-control-spec-insns
11535 @opindex msched-prefer-non-control-spec-insns
11536 If enabled, control speculative instructions will be chosen for schedule
11537 only if there are no other choices at the moment.  This will make
11538 the use of the control speculation much more conservative.
11539 The default is 'disable'.
11540
11541 @item -mno-sched-count-spec-in-critical-path
11542 @itemx -msched-count-spec-in-critical-path
11543 @opindex mno-sched-count-spec-in-critical-path
11544 @opindex msched-count-spec-in-critical-path
11545 If enabled, speculative dependencies will be considered during
11546 computation of the instructions priorities.  This will make the use of the
11547 speculation a bit more conservative.
11548 The default is 'disable'.
11549
11550 @end table
11551
11552 @node M32C Options
11553 @subsection M32C Options
11554 @cindex M32C options
11555
11556 @table @gcctabopt
11557 @item -mcpu=@var{name}
11558 @opindex mcpu=
11559 Select the CPU for which code is generated.  @var{name} may be one of
11560 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
11561 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
11562 the M32C/80 series.
11563
11564 @item -msim
11565 @opindex msim
11566 Specifies that the program will be run on the simulator.  This causes
11567 an alternate runtime library to be linked in which supports, for
11568 example, file I/O@.  You must not use this option when generating
11569 programs that will run on real hardware; you must provide your own
11570 runtime library for whatever I/O functions are needed.
11571
11572 @item -memregs=@var{number}
11573 @opindex memregs=
11574 Specifies the number of memory-based pseudo-registers GCC will use
11575 during code generation.  These pseudo-registers will be used like real
11576 registers, so there is a tradeoff between GCC's ability to fit the
11577 code into available registers, and the performance penalty of using
11578 memory instead of registers.  Note that all modules in a program must
11579 be compiled with the same value for this option.  Because of that, you
11580 must not use this option with the default runtime libraries gcc
11581 builds.
11582
11583 @end table
11584
11585 @node M32R/D Options
11586 @subsection M32R/D Options
11587 @cindex M32R/D options
11588
11589 These @option{-m} options are defined for Renesas M32R/D architectures:
11590
11591 @table @gcctabopt
11592 @item -m32r2
11593 @opindex m32r2
11594 Generate code for the M32R/2@.
11595
11596 @item -m32rx
11597 @opindex m32rx
11598 Generate code for the M32R/X@.
11599
11600 @item -m32r
11601 @opindex m32r
11602 Generate code for the M32R@.  This is the default.
11603
11604 @item -mmodel=small
11605 @opindex mmodel=small
11606 Assume all objects live in the lower 16MB of memory (so that their addresses
11607 can be loaded with the @code{ld24} instruction), and assume all subroutines
11608 are reachable with the @code{bl} instruction.
11609 This is the default.
11610
11611 The addressability of a particular object can be set with the
11612 @code{model} attribute.
11613
11614 @item -mmodel=medium
11615 @opindex mmodel=medium
11616 Assume objects may be anywhere in the 32-bit address space (the compiler
11617 will generate @code{seth/add3} instructions to load their addresses), and
11618 assume all subroutines are reachable with the @code{bl} instruction.
11619
11620 @item -mmodel=large
11621 @opindex mmodel=large
11622 Assume objects may be anywhere in the 32-bit address space (the compiler
11623 will generate @code{seth/add3} instructions to load their addresses), and
11624 assume subroutines may not be reachable with the @code{bl} instruction
11625 (the compiler will generate the much slower @code{seth/add3/jl}
11626 instruction sequence).
11627
11628 @item -msdata=none
11629 @opindex msdata=none
11630 Disable use of the small data area.  Variables will be put into
11631 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
11632 @code{section} attribute has been specified).
11633 This is the default.
11634
11635 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
11636 Objects may be explicitly put in the small data area with the
11637 @code{section} attribute using one of these sections.
11638
11639 @item -msdata=sdata
11640 @opindex msdata=sdata
11641 Put small global and static data in the small data area, but do not
11642 generate special code to reference them.
11643
11644 @item -msdata=use
11645 @opindex msdata=use
11646 Put small global and static data in the small data area, and generate
11647 special instructions to reference them.
11648
11649 @item -G @var{num}
11650 @opindex G
11651 @cindex smaller data references
11652 Put global and static objects less than or equal to @var{num} bytes
11653 into the small data or bss sections instead of the normal data or bss
11654 sections.  The default value of @var{num} is 8.
11655 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
11656 for this option to have any effect.
11657
11658 All modules should be compiled with the same @option{-G @var{num}} value.
11659 Compiling with different values of @var{num} may or may not work; if it
11660 doesn't the linker will give an error message---incorrect code will not be
11661 generated.
11662
11663 @item -mdebug
11664 @opindex mdebug
11665 Makes the M32R specific code in the compiler display some statistics
11666 that might help in debugging programs.
11667
11668 @item -malign-loops
11669 @opindex malign-loops
11670 Align all loops to a 32-byte boundary.
11671
11672 @item -mno-align-loops
11673 @opindex mno-align-loops
11674 Do not enforce a 32-byte alignment for loops.  This is the default.
11675
11676 @item -missue-rate=@var{number}
11677 @opindex missue-rate=@var{number}
11678 Issue @var{number} instructions per cycle.  @var{number} can only be 1
11679 or 2.
11680
11681 @item -mbranch-cost=@var{number}
11682 @opindex mbranch-cost=@var{number}
11683 @var{number} can only be 1 or 2.  If it is 1 then branches will be
11684 preferred over conditional code, if it is 2, then the opposite will
11685 apply.
11686
11687 @item -mflush-trap=@var{number}
11688 @opindex mflush-trap=@var{number}
11689 Specifies the trap number to use to flush the cache.  The default is
11690 12.  Valid numbers are between 0 and 15 inclusive.
11691
11692 @item -mno-flush-trap
11693 @opindex mno-flush-trap
11694 Specifies that the cache cannot be flushed by using a trap.
11695
11696 @item -mflush-func=@var{name}
11697 @opindex mflush-func=@var{name}
11698 Specifies the name of the operating system function to call to flush
11699 the cache.  The default is @emph{_flush_cache}, but a function call
11700 will only be used if a trap is not available.
11701
11702 @item -mno-flush-func
11703 @opindex mno-flush-func
11704 Indicates that there is no OS function for flushing the cache.
11705
11706 @end table
11707
11708 @node M680x0 Options
11709 @subsection M680x0 Options
11710 @cindex M680x0 options
11711
11712 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
11713 The default settings depend on which architecture was selected when
11714 the compiler was configured; the defaults for the most common choices
11715 are given below.
11716
11717 @table @gcctabopt
11718 @item -march=@var{arch}
11719 @opindex march
11720 Generate code for a specific M680x0 or ColdFire instruction set
11721 architecture.  Permissible values of @var{arch} for M680x0
11722 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
11723 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
11724 architectures are selected according to Freescale's ISA classification
11725 and the permissible values are: @samp{isaa}, @samp{isaaplus},
11726 @samp{isab} and @samp{isac}.
11727
11728 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
11729 code for a ColdFire target.  The @var{arch} in this macro is one of the
11730 @option{-march} arguments given above.
11731
11732 When used together, @option{-march} and @option{-mtune} select code
11733 that runs on a family of similar processors but that is optimized
11734 for a particular microarchitecture.
11735
11736 @item -mcpu=@var{cpu}
11737 @opindex mcpu
11738 Generate code for a specific M680x0 or ColdFire processor.
11739 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
11740 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
11741 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
11742 below, which also classifies the CPUs into families:
11743
11744 @multitable @columnfractions 0.20 0.80
11745 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
11746 @item @samp{51qe} @tab @samp{51qe}
11747 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
11748 @item @samp{5206e} @tab @samp{5206e}
11749 @item @samp{5208} @tab @samp{5207} @samp{5208}
11750 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
11751 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
11752 @item @samp{5216} @tab @samp{5214} @samp{5216}
11753 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
11754 @item @samp{5225} @tab @samp{5224} @samp{5225}
11755 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
11756 @item @samp{5249} @tab @samp{5249}
11757 @item @samp{5250} @tab @samp{5250}
11758 @item @samp{5271} @tab @samp{5270} @samp{5271}
11759 @item @samp{5272} @tab @samp{5272}
11760 @item @samp{5275} @tab @samp{5274} @samp{5275}
11761 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
11762 @item @samp{5307} @tab @samp{5307}
11763 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
11764 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
11765 @item @samp{5407} @tab @samp{5407}
11766 @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}
11767 @end multitable
11768
11769 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
11770 @var{arch} is compatible with @var{cpu}.  Other combinations of
11771 @option{-mcpu} and @option{-march} are rejected.
11772
11773 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
11774 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
11775 where the value of @var{family} is given by the table above.
11776
11777 @item -mtune=@var{tune}
11778 @opindex mtune
11779 Tune the code for a particular microarchitecture, within the
11780 constraints set by @option{-march} and @option{-mcpu}.
11781 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
11782 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11783 and @samp{cpu32}.  The ColdFire microarchitectures
11784 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11785
11786 You can also use @option{-mtune=68020-40} for code that needs
11787 to run relatively well on 68020, 68030 and 68040 targets.
11788 @option{-mtune=68020-60} is similar but includes 68060 targets
11789 as well.  These two options select the same tuning decisions as
11790 @option{-m68020-40} and @option{-m68020-60} respectively.
11791
11792 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11793 when tuning for 680x0 architecture @var{arch}.  It also defines
11794 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11795 option is used.  If gcc is tuning for a range of architectures,
11796 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11797 it defines the macros for every architecture in the range.
11798
11799 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11800 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11801 of the arguments given above.
11802
11803 @item -m68000
11804 @itemx -mc68000
11805 @opindex m68000
11806 @opindex mc68000
11807 Generate output for a 68000.  This is the default
11808 when the compiler is configured for 68000-based systems.
11809 It is equivalent to @option{-march=68000}.
11810
11811 Use this option for microcontrollers with a 68000 or EC000 core,
11812 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11813
11814 @item -m68010
11815 @opindex m68010
11816 Generate output for a 68010.  This is the default
11817 when the compiler is configured for 68010-based systems.
11818 It is equivalent to @option{-march=68010}.
11819
11820 @item -m68020
11821 @itemx -mc68020
11822 @opindex m68020
11823 @opindex mc68020
11824 Generate output for a 68020.  This is the default
11825 when the compiler is configured for 68020-based systems.
11826 It is equivalent to @option{-march=68020}.
11827
11828 @item -m68030
11829 @opindex m68030
11830 Generate output for a 68030.  This is the default when the compiler is
11831 configured for 68030-based systems.  It is equivalent to
11832 @option{-march=68030}.
11833
11834 @item -m68040
11835 @opindex m68040
11836 Generate output for a 68040.  This is the default when the compiler is
11837 configured for 68040-based systems.  It is equivalent to
11838 @option{-march=68040}.
11839
11840 This option inhibits the use of 68881/68882 instructions that have to be
11841 emulated by software on the 68040.  Use this option if your 68040 does not
11842 have code to emulate those instructions.
11843
11844 @item -m68060
11845 @opindex m68060
11846 Generate output for a 68060.  This is the default when the compiler is
11847 configured for 68060-based systems.  It is equivalent to
11848 @option{-march=68060}.
11849
11850 This option inhibits the use of 68020 and 68881/68882 instructions that
11851 have to be emulated by software on the 68060.  Use this option if your 68060
11852 does not have code to emulate those instructions.
11853
11854 @item -mcpu32
11855 @opindex mcpu32
11856 Generate output for a CPU32.  This is the default
11857 when the compiler is configured for CPU32-based systems.
11858 It is equivalent to @option{-march=cpu32}.
11859
11860 Use this option for microcontrollers with a
11861 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
11862 68336, 68340, 68341, 68349 and 68360.
11863
11864 @item -m5200
11865 @opindex m5200
11866 Generate output for a 520X ColdFire CPU@.  This is the default
11867 when the compiler is configured for 520X-based systems.
11868 It is equivalent to @option{-mcpu=5206}, and is now deprecated
11869 in favor of that option.
11870
11871 Use this option for microcontroller with a 5200 core, including
11872 the MCF5202, MCF5203, MCF5204 and MCF5206.
11873
11874 @item -m5206e
11875 @opindex m5206e
11876 Generate output for a 5206e ColdFire CPU@.  The option is now
11877 deprecated in favor of the equivalent @option{-mcpu=5206e}.
11878
11879 @item -m528x
11880 @opindex m528x
11881 Generate output for a member of the ColdFire 528X family.
11882 The option is now deprecated in favor of the equivalent
11883 @option{-mcpu=528x}.
11884
11885 @item -m5307
11886 @opindex m5307
11887 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
11888 in favor of the equivalent @option{-mcpu=5307}.
11889
11890 @item -m5407
11891 @opindex m5407
11892 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
11893 in favor of the equivalent @option{-mcpu=5407}.
11894
11895 @item -mcfv4e
11896 @opindex mcfv4e
11897 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
11898 This includes use of hardware floating point instructions.
11899 The option is equivalent to @option{-mcpu=547x}, and is now
11900 deprecated in favor of that option.
11901
11902 @item -m68020-40
11903 @opindex m68020-40
11904 Generate output for a 68040, without using any of the new instructions.
11905 This results in code which can run relatively efficiently on either a
11906 68020/68881 or a 68030 or a 68040.  The generated code does use the
11907 68881 instructions that are emulated on the 68040.
11908
11909 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
11910
11911 @item -m68020-60
11912 @opindex m68020-60
11913 Generate output for a 68060, without using any of the new instructions.
11914 This results in code which can run relatively efficiently on either a
11915 68020/68881 or a 68030 or a 68040.  The generated code does use the
11916 68881 instructions that are emulated on the 68060.
11917
11918 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
11919
11920 @item -mhard-float
11921 @itemx -m68881
11922 @opindex mhard-float
11923 @opindex m68881
11924 Generate floating-point instructions.  This is the default for 68020
11925 and above, and for ColdFire devices that have an FPU@.  It defines the
11926 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
11927 on ColdFire targets.
11928
11929 @item -msoft-float
11930 @opindex msoft-float
11931 Do not generate floating-point instructions; use library calls instead.
11932 This is the default for 68000, 68010, and 68832 targets.  It is also
11933 the default for ColdFire devices that have no FPU.
11934
11935 @item -mdiv
11936 @itemx -mno-div
11937 @opindex mdiv
11938 @opindex mno-div
11939 Generate (do not generate) ColdFire hardware divide and remainder
11940 instructions.  If @option{-march} is used without @option{-mcpu},
11941 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
11942 architectures.  Otherwise, the default is taken from the target CPU
11943 (either the default CPU, or the one specified by @option{-mcpu}).  For
11944 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
11945 @option{-mcpu=5206e}.
11946
11947 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
11948
11949 @item -mshort
11950 @opindex mshort
11951 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11952 Additionally, parameters passed on the stack are also aligned to a
11953 16-bit boundary even on targets whose API mandates promotion to 32-bit.
11954
11955 @item -mno-short
11956 @opindex mno-short
11957 Do not consider type @code{int} to be 16 bits wide.  This is the default.
11958
11959 @item -mnobitfield
11960 @itemx -mno-bitfield
11961 @opindex mnobitfield
11962 @opindex mno-bitfield
11963 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
11964 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
11965
11966 @item -mbitfield
11967 @opindex mbitfield
11968 Do use the bit-field instructions.  The @option{-m68020} option implies
11969 @option{-mbitfield}.  This is the default if you use a configuration
11970 designed for a 68020.
11971
11972 @item -mrtd
11973 @opindex mrtd
11974 Use a different function-calling convention, in which functions
11975 that take a fixed number of arguments return with the @code{rtd}
11976 instruction, which pops their arguments while returning.  This
11977 saves one instruction in the caller since there is no need to pop
11978 the arguments there.
11979
11980 This calling convention is incompatible with the one normally
11981 used on Unix, so you cannot use it if you need to call libraries
11982 compiled with the Unix compiler.
11983
11984 Also, you must provide function prototypes for all functions that
11985 take variable numbers of arguments (including @code{printf});
11986 otherwise incorrect code will be generated for calls to those
11987 functions.
11988
11989 In addition, seriously incorrect code will result if you call a
11990 function with too many arguments.  (Normally, extra arguments are
11991 harmlessly ignored.)
11992
11993 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
11994 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
11995
11996 @item -mno-rtd
11997 @opindex mno-rtd
11998 Do not use the calling conventions selected by @option{-mrtd}.
11999 This is the default.
12000
12001 @item -malign-int
12002 @itemx -mno-align-int
12003 @opindex malign-int
12004 @opindex mno-align-int
12005 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
12006 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
12007 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
12008 Aligning variables on 32-bit boundaries produces code that runs somewhat
12009 faster on processors with 32-bit busses at the expense of more memory.
12010
12011 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
12012 align structures containing the above types  differently than
12013 most published application binary interface specifications for the m68k.
12014
12015 @item -mpcrel
12016 @opindex mpcrel
12017 Use the pc-relative addressing mode of the 68000 directly, instead of
12018 using a global offset table.  At present, this option implies @option{-fpic},
12019 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
12020 not presently supported with @option{-mpcrel}, though this could be supported for
12021 68020 and higher processors.
12022
12023 @item -mno-strict-align
12024 @itemx -mstrict-align
12025 @opindex mno-strict-align
12026 @opindex mstrict-align
12027 Do not (do) assume that unaligned memory references will be handled by
12028 the system.
12029
12030 @item -msep-data
12031 Generate code that allows the data segment to be located in a different
12032 area of memory from the text segment.  This allows for execute in place in
12033 an environment without virtual memory management.  This option implies
12034 @option{-fPIC}.
12035
12036 @item -mno-sep-data
12037 Generate code that assumes that the data segment follows the text segment.
12038 This is the default.
12039
12040 @item -mid-shared-library
12041 Generate code that supports shared libraries via the library ID method.
12042 This allows for execute in place and shared libraries in an environment
12043 without virtual memory management.  This option implies @option{-fPIC}.
12044
12045 @item -mno-id-shared-library
12046 Generate code that doesn't assume ID based shared libraries are being used.
12047 This is the default.
12048
12049 @item -mshared-library-id=n
12050 Specified the identification number of the ID based shared library being
12051 compiled.  Specifying a value of 0 will generate more compact code, specifying
12052 other values will force the allocation of that number to the current
12053 library but is no more space or time efficient than omitting this option.
12054
12055 @item -mxgot
12056 @itemx -mno-xgot
12057 @opindex mxgot
12058 @opindex mno-xgot
12059 When generating position-independent code for ColdFire, generate code
12060 that works if the GOT has more than 8192 entries.  This code is
12061 larger and slower than code generated without this option.  On M680x0
12062 processors, this option is not needed; @option{-fPIC} suffices.
12063
12064 GCC normally uses a single instruction to load values from the GOT@.
12065 While this is relatively efficient, it only works if the GOT
12066 is smaller than about 64k.  Anything larger causes the linker
12067 to report an error such as:
12068
12069 @cindex relocation truncated to fit (ColdFire)
12070 @smallexample
12071 relocation truncated to fit: R_68K_GOT16O foobar
12072 @end smallexample
12073
12074 If this happens, you should recompile your code with @option{-mxgot}.
12075 It should then work with very large GOTs.  However, code generated with
12076 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
12077 the value of a global symbol.
12078
12079 Note that some linkers, including newer versions of the GNU linker,
12080 can create multiple GOTs and sort GOT entries.  If you have such a linker,
12081 you should only need to use @option{-mxgot} when compiling a single
12082 object file that accesses more than 8192 GOT entries.  Very few do.
12083
12084 These options have no effect unless GCC is generating
12085 position-independent code.
12086
12087 @end table
12088
12089 @node M68hc1x Options
12090 @subsection M68hc1x Options
12091 @cindex M68hc1x options
12092
12093 These are the @samp{-m} options defined for the 68hc11 and 68hc12
12094 microcontrollers.  The default values for these options depends on
12095 which style of microcontroller was selected when the compiler was configured;
12096 the defaults for the most common choices are given below.
12097
12098 @table @gcctabopt
12099 @item -m6811
12100 @itemx -m68hc11
12101 @opindex m6811
12102 @opindex m68hc11
12103 Generate output for a 68HC11.  This is the default
12104 when the compiler is configured for 68HC11-based systems.
12105
12106 @item -m6812
12107 @itemx -m68hc12
12108 @opindex m6812
12109 @opindex m68hc12
12110 Generate output for a 68HC12.  This is the default
12111 when the compiler is configured for 68HC12-based systems.
12112
12113 @item -m68S12
12114 @itemx -m68hcs12
12115 @opindex m68S12
12116 @opindex m68hcs12
12117 Generate output for a 68HCS12.
12118
12119 @item -mauto-incdec
12120 @opindex mauto-incdec
12121 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
12122 addressing modes.
12123
12124 @item -minmax
12125 @itemx -nominmax
12126 @opindex minmax
12127 @opindex mnominmax
12128 Enable the use of 68HC12 min and max instructions.
12129
12130 @item -mlong-calls
12131 @itemx -mno-long-calls
12132 @opindex mlong-calls
12133 @opindex mno-long-calls
12134 Treat all calls as being far away (near).  If calls are assumed to be
12135 far away, the compiler will use the @code{call} instruction to
12136 call a function and the @code{rtc} instruction for returning.
12137
12138 @item -mshort
12139 @opindex mshort
12140 Consider type @code{int} to be 16 bits wide, like @code{short int}.
12141
12142 @item -msoft-reg-count=@var{count}
12143 @opindex msoft-reg-count
12144 Specify the number of pseudo-soft registers which are used for the
12145 code generation.  The maximum number is 32.  Using more pseudo-soft
12146 register may or may not result in better code depending on the program.
12147 The default is 4 for 68HC11 and 2 for 68HC12.
12148
12149 @end table
12150
12151 @node MCore Options
12152 @subsection MCore Options
12153 @cindex MCore options
12154
12155 These are the @samp{-m} options defined for the Motorola M*Core
12156 processors.
12157
12158 @table @gcctabopt
12159
12160 @item -mhardlit
12161 @itemx -mno-hardlit
12162 @opindex mhardlit
12163 @opindex mno-hardlit
12164 Inline constants into the code stream if it can be done in two
12165 instructions or less.
12166
12167 @item -mdiv
12168 @itemx -mno-div
12169 @opindex mdiv
12170 @opindex mno-div
12171 Use the divide instruction.  (Enabled by default).
12172
12173 @item -mrelax-immediate
12174 @itemx -mno-relax-immediate
12175 @opindex mrelax-immediate
12176 @opindex mno-relax-immediate
12177 Allow arbitrary sized immediates in bit operations.
12178
12179 @item -mwide-bitfields
12180 @itemx -mno-wide-bitfields
12181 @opindex mwide-bitfields
12182 @opindex mno-wide-bitfields
12183 Always treat bit-fields as int-sized.
12184
12185 @item -m4byte-functions
12186 @itemx -mno-4byte-functions
12187 @opindex m4byte-functions
12188 @opindex mno-4byte-functions
12189 Force all functions to be aligned to a four byte boundary.
12190
12191 @item -mcallgraph-data
12192 @itemx -mno-callgraph-data
12193 @opindex mcallgraph-data
12194 @opindex mno-callgraph-data
12195 Emit callgraph information.
12196
12197 @item -mslow-bytes
12198 @itemx -mno-slow-bytes
12199 @opindex mslow-bytes
12200 @opindex mno-slow-bytes
12201 Prefer word access when reading byte quantities.
12202
12203 @item -mlittle-endian
12204 @itemx -mbig-endian
12205 @opindex mlittle-endian
12206 @opindex mbig-endian
12207 Generate code for a little endian target.
12208
12209 @item -m210
12210 @itemx -m340
12211 @opindex m210
12212 @opindex m340
12213 Generate code for the 210 processor.
12214 @end table
12215
12216 @node MIPS Options
12217 @subsection MIPS Options
12218 @cindex MIPS options
12219
12220 @table @gcctabopt
12221
12222 @item -EB
12223 @opindex EB
12224 Generate big-endian code.
12225
12226 @item -EL
12227 @opindex EL
12228 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
12229 configurations.
12230
12231 @item -march=@var{arch}
12232 @opindex march
12233 Generate code that will run on @var{arch}, which can be the name of a
12234 generic MIPS ISA, or the name of a particular processor.
12235 The ISA names are:
12236 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
12237 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
12238 The processor names are:
12239 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
12240 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
12241 @samp{5kc}, @samp{5kf},
12242 @samp{20kc},
12243 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
12244 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
12245 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
12246 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
12247 @samp{loongson2e}, @samp{loongson2f},
12248 @samp{m4k},
12249 @samp{octeon},
12250 @samp{orion},
12251 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
12252 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
12253 @samp{rm7000}, @samp{rm9000},
12254 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
12255 @samp{sb1},
12256 @samp{sr71000},
12257 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
12258 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
12259 and @samp{xlr}.
12260 The special value @samp{from-abi} selects the
12261 most compatible architecture for the selected ABI (that is,
12262 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
12263
12264 Native Linux/GNU toolchains also support the value @samp{native},
12265 which selects the best architecture option for the host processor.
12266 @option{-march=native} has no effect if GCC does not recognize
12267 the processor.
12268
12269 In processor names, a final @samp{000} can be abbreviated as @samp{k}
12270 (for example, @samp{-march=r2k}).  Prefixes are optional, and
12271 @samp{vr} may be written @samp{r}.
12272
12273 Names of the form @samp{@var{n}f2_1} refer to processors with
12274 FPUs clocked at half the rate of the core, names of the form
12275 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
12276 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
12277 processors with FPUs clocked a ratio of 3:2 with respect to the core.
12278 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
12279 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
12280 accepted as synonyms for @samp{@var{n}f1_1}.
12281
12282 GCC defines two macros based on the value of this option.  The first
12283 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
12284 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
12285 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
12286 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
12287 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
12288
12289 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
12290 above.  In other words, it will have the full prefix and will not
12291 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
12292 the macro names the resolved architecture (either @samp{"mips1"} or
12293 @samp{"mips3"}).  It names the default architecture when no
12294 @option{-march} option is given.
12295
12296 @item -mtune=@var{arch}
12297 @opindex mtune
12298 Optimize for @var{arch}.  Among other things, this option controls
12299 the way instructions are scheduled, and the perceived cost of arithmetic
12300 operations.  The list of @var{arch} values is the same as for
12301 @option{-march}.
12302
12303 When this option is not used, GCC will optimize for the processor
12304 specified by @option{-march}.  By using @option{-march} and
12305 @option{-mtune} together, it is possible to generate code that will
12306 run on a family of processors, but optimize the code for one
12307 particular member of that family.
12308
12309 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
12310 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
12311 @samp{-march} ones described above.
12312
12313 @item -mips1
12314 @opindex mips1
12315 Equivalent to @samp{-march=mips1}.
12316
12317 @item -mips2
12318 @opindex mips2
12319 Equivalent to @samp{-march=mips2}.
12320
12321 @item -mips3
12322 @opindex mips3
12323 Equivalent to @samp{-march=mips3}.
12324
12325 @item -mips4
12326 @opindex mips4
12327 Equivalent to @samp{-march=mips4}.
12328
12329 @item -mips32
12330 @opindex mips32
12331 Equivalent to @samp{-march=mips32}.
12332
12333 @item -mips32r2
12334 @opindex mips32r2
12335 Equivalent to @samp{-march=mips32r2}.
12336
12337 @item -mips64
12338 @opindex mips64
12339 Equivalent to @samp{-march=mips64}.
12340
12341 @item -mips64r2
12342 @opindex mips64r2
12343 Equivalent to @samp{-march=mips64r2}.
12344
12345 @item -mips16
12346 @itemx -mno-mips16
12347 @opindex mips16
12348 @opindex mno-mips16
12349 Generate (do not generate) MIPS16 code.  If GCC is targetting a
12350 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
12351
12352 MIPS16 code generation can also be controlled on a per-function basis
12353 by means of @code{mips16} and @code{nomips16} attributes.  
12354 @xref{Function Attributes}, for more information.
12355
12356 @item -mflip-mips16
12357 @opindex mflip-mips16
12358 Generate MIPS16 code on alternating functions.  This option is provided
12359 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
12360 not intended for ordinary use in compiling user code.
12361
12362 @item -minterlink-mips16
12363 @itemx -mno-interlink-mips16
12364 @opindex minterlink-mips16
12365 @opindex mno-interlink-mips16
12366 Require (do not require) that non-MIPS16 code be link-compatible with
12367 MIPS16 code.
12368
12369 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
12370 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
12371 therefore disables direct jumps unless GCC knows that the target of the
12372 jump is not MIPS16.
12373
12374 @item -mabi=32
12375 @itemx -mabi=o64
12376 @itemx -mabi=n32
12377 @itemx -mabi=64
12378 @itemx -mabi=eabi
12379 @opindex mabi=32
12380 @opindex mabi=o64
12381 @opindex mabi=n32
12382 @opindex mabi=64
12383 @opindex mabi=eabi
12384 Generate code for the given ABI@.
12385
12386 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
12387 generates 64-bit code when you select a 64-bit architecture, but you
12388 can use @option{-mgp32} to get 32-bit code instead.
12389
12390 For information about the O64 ABI, see
12391 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
12392
12393 GCC supports a variant of the o32 ABI in which floating-point registers
12394 are 64 rather than 32 bits wide.  You can select this combination with
12395 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
12396 and @samp{mfhc1} instructions and is therefore only supported for
12397 MIPS32R2 processors.
12398
12399 The register assignments for arguments and return values remain the
12400 same, but each scalar value is passed in a single 64-bit register
12401 rather than a pair of 32-bit registers.  For example, scalar
12402 floating-point values are returned in @samp{$f0} only, not a
12403 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
12404 remains the same, but all 64 bits are saved.
12405
12406 @item -mabicalls
12407 @itemx -mno-abicalls
12408 @opindex mabicalls
12409 @opindex mno-abicalls
12410 Generate (do not generate) code that is suitable for SVR4-style
12411 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
12412 systems.
12413
12414 @item -mshared
12415 @itemx -mno-shared
12416 Generate (do not generate) code that is fully position-independent,
12417 and that can therefore be linked into shared libraries.  This option
12418 only affects @option{-mabicalls}.
12419
12420 All @option{-mabicalls} code has traditionally been position-independent,
12421 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
12422 as an extension, the GNU toolchain allows executables to use absolute
12423 accesses for locally-binding symbols.  It can also use shorter GP
12424 initialization sequences and generate direct calls to locally-defined
12425 functions.  This mode is selected by @option{-mno-shared}.
12426
12427 @option{-mno-shared} depends on binutils 2.16 or higher and generates
12428 objects that can only be linked by the GNU linker.  However, the option
12429 does not affect the ABI of the final executable; it only affects the ABI
12430 of relocatable objects.  Using @option{-mno-shared} will generally make
12431 executables both smaller and quicker.
12432
12433 @option{-mshared} is the default.
12434
12435 @item -mplt
12436 @itemx -mno-plt
12437 @opindex mplt
12438 @opindex mno-plt
12439 Assume (do not assume) that the static and dynamic linkers
12440 support PLTs and copy relocations.  This option only affects
12441 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
12442 has no effect without @samp{-msym32}.
12443
12444 You can make @option{-mplt} the default by configuring
12445 GCC with @option{--with-mips-plt}.  The default is
12446 @option{-mno-plt} otherwise.
12447
12448 @item -mxgot
12449 @itemx -mno-xgot
12450 @opindex mxgot
12451 @opindex mno-xgot
12452 Lift (do not lift) the usual restrictions on the size of the global
12453 offset table.
12454
12455 GCC normally uses a single instruction to load values from the GOT@.
12456 While this is relatively efficient, it will only work if the GOT
12457 is smaller than about 64k.  Anything larger will cause the linker
12458 to report an error such as:
12459
12460 @cindex relocation truncated to fit (MIPS)
12461 @smallexample
12462 relocation truncated to fit: R_MIPS_GOT16 foobar
12463 @end smallexample
12464
12465 If this happens, you should recompile your code with @option{-mxgot}.
12466 It should then work with very large GOTs, although it will also be
12467 less efficient, since it will take three instructions to fetch the
12468 value of a global symbol.
12469
12470 Note that some linkers can create multiple GOTs.  If you have such a
12471 linker, you should only need to use @option{-mxgot} when a single object
12472 file accesses more than 64k's worth of GOT entries.  Very few do.
12473
12474 These options have no effect unless GCC is generating position
12475 independent code.
12476
12477 @item -mgp32
12478 @opindex mgp32
12479 Assume that general-purpose registers are 32 bits wide.
12480
12481 @item -mgp64
12482 @opindex mgp64
12483 Assume that general-purpose registers are 64 bits wide.
12484
12485 @item -mfp32
12486 @opindex mfp32
12487 Assume that floating-point registers are 32 bits wide.
12488
12489 @item -mfp64
12490 @opindex mfp64
12491 Assume that floating-point registers are 64 bits wide.
12492
12493 @item -mhard-float
12494 @opindex mhard-float
12495 Use floating-point coprocessor instructions.
12496
12497 @item -msoft-float
12498 @opindex msoft-float
12499 Do not use floating-point coprocessor instructions.  Implement
12500 floating-point calculations using library calls instead.
12501
12502 @item -msingle-float
12503 @opindex msingle-float
12504 Assume that the floating-point coprocessor only supports single-precision
12505 operations.
12506
12507 @item -mdouble-float
12508 @opindex mdouble-float
12509 Assume that the floating-point coprocessor supports double-precision
12510 operations.  This is the default.
12511
12512 @item -mllsc
12513 @itemx -mno-llsc
12514 @opindex mllsc
12515 @opindex mno-llsc
12516 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
12517 implement atomic memory built-in functions.  When neither option is
12518 specified, GCC will use the instructions if the target architecture
12519 supports them.
12520
12521 @option{-mllsc} is useful if the runtime environment can emulate the
12522 instructions and @option{-mno-llsc} can be useful when compiling for
12523 nonstandard ISAs.  You can make either option the default by
12524 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
12525 respectively.  @option{--with-llsc} is the default for some
12526 configurations; see the installation documentation for details.
12527
12528 @item -mdsp
12529 @itemx -mno-dsp
12530 @opindex mdsp
12531 @opindex mno-dsp
12532 Use (do not use) revision 1 of the MIPS DSP ASE@.
12533 @xref{MIPS DSP Built-in Functions}.  This option defines the
12534 preprocessor macro @samp{__mips_dsp}.  It also defines
12535 @samp{__mips_dsp_rev} to 1.
12536
12537 @item -mdspr2
12538 @itemx -mno-dspr2
12539 @opindex mdspr2
12540 @opindex mno-dspr2
12541 Use (do not use) revision 2 of the MIPS DSP ASE@.
12542 @xref{MIPS DSP Built-in Functions}.  This option defines the
12543 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
12544 It also defines @samp{__mips_dsp_rev} to 2.
12545
12546 @item -msmartmips
12547 @itemx -mno-smartmips
12548 @opindex msmartmips
12549 @opindex mno-smartmips
12550 Use (do not use) the MIPS SmartMIPS ASE.
12551
12552 @item -mpaired-single
12553 @itemx -mno-paired-single
12554 @opindex mpaired-single
12555 @opindex mno-paired-single
12556 Use (do not use) paired-single floating-point instructions.
12557 @xref{MIPS Paired-Single Support}.  This option requires
12558 hardware floating-point support to be enabled.
12559
12560 @item -mdmx
12561 @itemx -mno-mdmx
12562 @opindex mdmx
12563 @opindex mno-mdmx
12564 Use (do not use) MIPS Digital Media Extension instructions.
12565 This option can only be used when generating 64-bit code and requires
12566 hardware floating-point support to be enabled.
12567
12568 @item -mips3d
12569 @itemx -mno-mips3d
12570 @opindex mips3d
12571 @opindex mno-mips3d
12572 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
12573 The option @option{-mips3d} implies @option{-mpaired-single}.
12574
12575 @item -mmt
12576 @itemx -mno-mt
12577 @opindex mmt
12578 @opindex mno-mt
12579 Use (do not use) MT Multithreading instructions.
12580
12581 @item -mlong64
12582 @opindex mlong64
12583 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
12584 an explanation of the default and the way that the pointer size is
12585 determined.
12586
12587 @item -mlong32
12588 @opindex mlong32
12589 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
12590
12591 The default size of @code{int}s, @code{long}s and pointers depends on
12592 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
12593 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
12594 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
12595 or the same size as integer registers, whichever is smaller.
12596
12597 @item -msym32
12598 @itemx -mno-sym32
12599 @opindex msym32
12600 @opindex mno-sym32
12601 Assume (do not assume) that all symbols have 32-bit values, regardless
12602 of the selected ABI@.  This option is useful in combination with
12603 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
12604 to generate shorter and faster references to symbolic addresses.
12605
12606 @item -G @var{num}
12607 @opindex G
12608 Put definitions of externally-visible data in a small data section
12609 if that data is no bigger than @var{num} bytes.  GCC can then access
12610 the data more efficiently; see @option{-mgpopt} for details.
12611
12612 The default @option{-G} option depends on the configuration.
12613
12614 @item -mlocal-sdata
12615 @itemx -mno-local-sdata
12616 @opindex mlocal-sdata
12617 @opindex mno-local-sdata
12618 Extend (do not extend) the @option{-G} behavior to local data too,
12619 such as to static variables in C@.  @option{-mlocal-sdata} is the
12620 default for all configurations.
12621
12622 If the linker complains that an application is using too much small data,
12623 you might want to try rebuilding the less performance-critical parts with
12624 @option{-mno-local-sdata}.  You might also want to build large
12625 libraries with @option{-mno-local-sdata}, so that the libraries leave
12626 more room for the main program.
12627
12628 @item -mextern-sdata
12629 @itemx -mno-extern-sdata
12630 @opindex mextern-sdata
12631 @opindex mno-extern-sdata
12632 Assume (do not assume) that externally-defined data will be in
12633 a small data section if that data is within the @option{-G} limit.
12634 @option{-mextern-sdata} is the default for all configurations.
12635
12636 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
12637 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
12638 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
12639 is placed in a small data section.  If @var{Var} is defined by another
12640 module, you must either compile that module with a high-enough
12641 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
12642 definition.  If @var{Var} is common, you must link the application
12643 with a high-enough @option{-G} setting.
12644
12645 The easiest way of satisfying these restrictions is to compile
12646 and link every module with the same @option{-G} option.  However,
12647 you may wish to build a library that supports several different
12648 small data limits.  You can do this by compiling the library with
12649 the highest supported @option{-G} setting and additionally using
12650 @option{-mno-extern-sdata} to stop the library from making assumptions
12651 about externally-defined data.
12652
12653 @item -mgpopt
12654 @itemx -mno-gpopt
12655 @opindex mgpopt
12656 @opindex mno-gpopt
12657 Use (do not use) GP-relative accesses for symbols that are known to be
12658 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
12659 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
12660 configurations.
12661
12662 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
12663 might not hold the value of @code{_gp}.  For example, if the code is
12664 part of a library that might be used in a boot monitor, programs that
12665 call boot monitor routines will pass an unknown value in @code{$gp}.
12666 (In such situations, the boot monitor itself would usually be compiled
12667 with @option{-G0}.)
12668
12669 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
12670 @option{-mno-extern-sdata}.
12671
12672 @item -membedded-data
12673 @itemx -mno-embedded-data
12674 @opindex membedded-data
12675 @opindex mno-embedded-data
12676 Allocate variables to the read-only data section first if possible, then
12677 next in the small data section if possible, otherwise in data.  This gives
12678 slightly slower code than the default, but reduces the amount of RAM required
12679 when executing, and thus may be preferred for some embedded systems.
12680
12681 @item -muninit-const-in-rodata
12682 @itemx -mno-uninit-const-in-rodata
12683 @opindex muninit-const-in-rodata
12684 @opindex mno-uninit-const-in-rodata
12685 Put uninitialized @code{const} variables in the read-only data section.
12686 This option is only meaningful in conjunction with @option{-membedded-data}.
12687
12688 @item -mcode-readable=@var{setting}
12689 @opindex mcode-readable
12690 Specify whether GCC may generate code that reads from executable sections.
12691 There are three possible settings:
12692
12693 @table @gcctabopt
12694 @item -mcode-readable=yes
12695 Instructions may freely access executable sections.  This is the
12696 default setting.
12697
12698 @item -mcode-readable=pcrel
12699 MIPS16 PC-relative load instructions can access executable sections,
12700 but other instructions must not do so.  This option is useful on 4KSc
12701 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
12702 It is also useful on processors that can be configured to have a dual
12703 instruction/data SRAM interface and that, like the M4K, automatically
12704 redirect PC-relative loads to the instruction RAM.
12705
12706 @item -mcode-readable=no
12707 Instructions must not access executable sections.  This option can be
12708 useful on targets that are configured to have a dual instruction/data
12709 SRAM interface but that (unlike the M4K) do not automatically redirect
12710 PC-relative loads to the instruction RAM.
12711 @end table
12712
12713 @item -msplit-addresses
12714 @itemx -mno-split-addresses
12715 @opindex msplit-addresses
12716 @opindex mno-split-addresses
12717 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
12718 relocation operators.  This option has been superseded by
12719 @option{-mexplicit-relocs} but is retained for backwards compatibility.
12720
12721 @item -mexplicit-relocs
12722 @itemx -mno-explicit-relocs
12723 @opindex mexplicit-relocs
12724 @opindex mno-explicit-relocs
12725 Use (do not use) assembler relocation operators when dealing with symbolic
12726 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
12727 is to use assembler macros instead.
12728
12729 @option{-mexplicit-relocs} is the default if GCC was configured
12730 to use an assembler that supports relocation operators.
12731
12732 @item -mcheck-zero-division
12733 @itemx -mno-check-zero-division
12734 @opindex mcheck-zero-division
12735 @opindex mno-check-zero-division
12736 Trap (do not trap) on integer division by zero.
12737
12738 The default is @option{-mcheck-zero-division}.
12739
12740 @item -mdivide-traps
12741 @itemx -mdivide-breaks
12742 @opindex mdivide-traps
12743 @opindex mdivide-breaks
12744 MIPS systems check for division by zero by generating either a
12745 conditional trap or a break instruction.  Using traps results in
12746 smaller code, but is only supported on MIPS II and later.  Also, some
12747 versions of the Linux kernel have a bug that prevents trap from
12748 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
12749 allow conditional traps on architectures that support them and
12750 @option{-mdivide-breaks} to force the use of breaks.
12751
12752 The default is usually @option{-mdivide-traps}, but this can be
12753 overridden at configure time using @option{--with-divide=breaks}.
12754 Divide-by-zero checks can be completely disabled using
12755 @option{-mno-check-zero-division}.
12756
12757 @item -mmemcpy
12758 @itemx -mno-memcpy
12759 @opindex mmemcpy
12760 @opindex mno-memcpy
12761 Force (do not force) the use of @code{memcpy()} for non-trivial block
12762 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
12763 most constant-sized copies.
12764
12765 @item -mlong-calls
12766 @itemx -mno-long-calls
12767 @opindex mlong-calls
12768 @opindex mno-long-calls
12769 Disable (do not disable) use of the @code{jal} instruction.  Calling
12770 functions using @code{jal} is more efficient but requires the caller
12771 and callee to be in the same 256 megabyte segment.
12772
12773 This option has no effect on abicalls code.  The default is
12774 @option{-mno-long-calls}.
12775
12776 @item -mmad
12777 @itemx -mno-mad
12778 @opindex mmad
12779 @opindex mno-mad
12780 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
12781 instructions, as provided by the R4650 ISA@.
12782
12783 @item -mfused-madd
12784 @itemx -mno-fused-madd
12785 @opindex mfused-madd
12786 @opindex mno-fused-madd
12787 Enable (disable) use of the floating point multiply-accumulate
12788 instructions, when they are available.  The default is
12789 @option{-mfused-madd}.
12790
12791 When multiply-accumulate instructions are used, the intermediate
12792 product is calculated to infinite precision and is not subject to
12793 the FCSR Flush to Zero bit.  This may be undesirable in some
12794 circumstances.
12795
12796 @item -nocpp
12797 @opindex nocpp
12798 Tell the MIPS assembler to not run its preprocessor over user
12799 assembler files (with a @samp{.s} suffix) when assembling them.
12800
12801 @item -mfix-r4000
12802 @itemx -mno-fix-r4000
12803 @opindex mfix-r4000
12804 @opindex mno-fix-r4000
12805 Work around certain R4000 CPU errata:
12806 @itemize @minus
12807 @item
12808 A double-word or a variable shift may give an incorrect result if executed
12809 immediately after starting an integer division.
12810 @item
12811 A double-word or a variable shift may give an incorrect result if executed
12812 while an integer multiplication is in progress.
12813 @item
12814 An integer division may give an incorrect result if started in a delay slot
12815 of a taken branch or a jump.
12816 @end itemize
12817
12818 @item -mfix-r4400
12819 @itemx -mno-fix-r4400
12820 @opindex mfix-r4400
12821 @opindex mno-fix-r4400
12822 Work around certain R4400 CPU errata:
12823 @itemize @minus
12824 @item
12825 A double-word or a variable shift may give an incorrect result if executed
12826 immediately after starting an integer division.
12827 @end itemize
12828
12829 @item -mfix-vr4120
12830 @itemx -mno-fix-vr4120
12831 @opindex mfix-vr4120
12832 Work around certain VR4120 errata:
12833 @itemize @minus
12834 @item
12835 @code{dmultu} does not always produce the correct result.
12836 @item
12837 @code{div} and @code{ddiv} do not always produce the correct result if one
12838 of the operands is negative.
12839 @end itemize
12840 The workarounds for the division errata rely on special functions in
12841 @file{libgcc.a}.  At present, these functions are only provided by
12842 the @code{mips64vr*-elf} configurations.
12843
12844 Other VR4120 errata require a nop to be inserted between certain pairs of
12845 instructions.  These errata are handled by the assembler, not by GCC itself.
12846
12847 @item -mfix-vr4130
12848 @opindex mfix-vr4130
12849 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
12850 workarounds are implemented by the assembler rather than by GCC,
12851 although GCC will avoid using @code{mflo} and @code{mfhi} if the
12852 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
12853 instructions are available instead.
12854
12855 @item -mfix-sb1
12856 @itemx -mno-fix-sb1
12857 @opindex mfix-sb1
12858 Work around certain SB-1 CPU core errata.
12859 (This flag currently works around the SB-1 revision 2
12860 ``F1'' and ``F2'' floating point errata.)
12861
12862 @item -mr10k-cache-barrier=@var{setting}
12863 @opindex mr10k-cache-barrier
12864 Specify whether GCC should insert cache barriers to avoid the
12865 side-effects of speculation on R10K processors.
12866
12867 In common with many processors, the R10K tries to predict the outcome
12868 of a conditional branch and speculatively executes instructions from
12869 the ``taken'' branch.  It later aborts these instructions if the
12870 predicted outcome was wrong.  However, on the R10K, even aborted
12871 instructions can have side effects.
12872
12873 This problem only affects kernel stores and, depending on the system,
12874 kernel loads.  As an example, a speculatively-executed store may load
12875 the target memory into cache and mark the cache line as dirty, even if
12876 the store itself is later aborted.  If a DMA operation writes to the
12877 same area of memory before the ``dirty'' line is flushed, the cached
12878 data will overwrite the DMA-ed data.  See the R10K processor manual
12879 for a full description, including other potential problems.
12880
12881 One workaround is to insert cache barrier instructions before every memory
12882 access that might be speculatively executed and that might have side
12883 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
12884 controls GCC's implementation of this workaround.  It assumes that
12885 aborted accesses to any byte in the following regions will not have
12886 side effects:
12887
12888 @enumerate
12889 @item
12890 the memory occupied by the current function's stack frame;
12891
12892 @item
12893 the memory occupied by an incoming stack argument;
12894
12895 @item
12896 the memory occupied by an object with a link-time-constant address.
12897 @end enumerate
12898
12899 It is the kernel's responsibility to ensure that speculative
12900 accesses to these regions are indeed safe.
12901
12902 If the input program contains a function declaration such as:
12903
12904 @smallexample
12905 void foo (void);
12906 @end smallexample
12907
12908 then the implementation of @code{foo} must allow @code{j foo} and
12909 @code{jal foo} to be executed speculatively.  GCC honors this
12910 restriction for functions it compiles itself.  It expects non-GCC
12911 functions (such as hand-written assembly code) to do the same.
12912
12913 The option has three forms:
12914
12915 @table @gcctabopt
12916 @item -mr10k-cache-barrier=load-store
12917 Insert a cache barrier before a load or store that might be
12918 speculatively executed and that might have side effects even
12919 if aborted.
12920
12921 @item -mr10k-cache-barrier=store
12922 Insert a cache barrier before a store that might be speculatively
12923 executed and that might have side effects even if aborted.
12924
12925 @item -mr10k-cache-barrier=none
12926 Disable the insertion of cache barriers.  This is the default setting.
12927 @end table
12928
12929 @item -mflush-func=@var{func}
12930 @itemx -mno-flush-func
12931 @opindex mflush-func
12932 Specifies the function to call to flush the I and D caches, or to not
12933 call any such function.  If called, the function must take the same
12934 arguments as the common @code{_flush_func()}, that is, the address of the
12935 memory range for which the cache is being flushed, the size of the
12936 memory range, and the number 3 (to flush both caches).  The default
12937 depends on the target GCC was configured for, but commonly is either
12938 @samp{_flush_func} or @samp{__cpu_flush}.
12939
12940 @item mbranch-cost=@var{num}
12941 @opindex mbranch-cost
12942 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12943 This cost is only a heuristic and is not guaranteed to produce
12944 consistent results across releases.  A zero cost redundantly selects
12945 the default, which is based on the @option{-mtune} setting.
12946
12947 @item -mbranch-likely
12948 @itemx -mno-branch-likely
12949 @opindex mbranch-likely
12950 @opindex mno-branch-likely
12951 Enable or disable use of Branch Likely instructions, regardless of the
12952 default for the selected architecture.  By default, Branch Likely
12953 instructions may be generated if they are supported by the selected
12954 architecture.  An exception is for the MIPS32 and MIPS64 architectures
12955 and processors which implement those architectures; for those, Branch
12956 Likely instructions will not be generated by default because the MIPS32
12957 and MIPS64 architectures specifically deprecate their use.
12958
12959 @item -mfp-exceptions
12960 @itemx -mno-fp-exceptions
12961 @opindex mfp-exceptions
12962 Specifies whether FP exceptions are enabled.  This affects how we schedule
12963 FP instructions for some processors.  The default is that FP exceptions are
12964 enabled.
12965
12966 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
12967 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
12968 FP pipe.
12969
12970 @item -mvr4130-align
12971 @itemx -mno-vr4130-align
12972 @opindex mvr4130-align
12973 The VR4130 pipeline is two-way superscalar, but can only issue two
12974 instructions together if the first one is 8-byte aligned.  When this
12975 option is enabled, GCC will align pairs of instructions that it
12976 thinks should execute in parallel.
12977
12978 This option only has an effect when optimizing for the VR4130.
12979 It normally makes code faster, but at the expense of making it bigger.
12980 It is enabled by default at optimization level @option{-O3}.
12981 @end table
12982
12983 @node MMIX Options
12984 @subsection MMIX Options
12985 @cindex MMIX Options
12986
12987 These options are defined for the MMIX:
12988
12989 @table @gcctabopt
12990 @item -mlibfuncs
12991 @itemx -mno-libfuncs
12992 @opindex mlibfuncs
12993 @opindex mno-libfuncs
12994 Specify that intrinsic library functions are being compiled, passing all
12995 values in registers, no matter the size.
12996
12997 @item -mepsilon
12998 @itemx -mno-epsilon
12999 @opindex mepsilon
13000 @opindex mno-epsilon
13001 Generate floating-point comparison instructions that compare with respect
13002 to the @code{rE} epsilon register.
13003
13004 @item -mabi=mmixware
13005 @itemx -mabi=gnu
13006 @opindex mabi-mmixware
13007 @opindex mabi=gnu
13008 Generate code that passes function parameters and return values that (in
13009 the called function) are seen as registers @code{$0} and up, as opposed to
13010 the GNU ABI which uses global registers @code{$231} and up.
13011
13012 @item -mzero-extend
13013 @itemx -mno-zero-extend
13014 @opindex mzero-extend
13015 @opindex mno-zero-extend
13016 When reading data from memory in sizes shorter than 64 bits, use (do not
13017 use) zero-extending load instructions by default, rather than
13018 sign-extending ones.
13019
13020 @item -mknuthdiv
13021 @itemx -mno-knuthdiv
13022 @opindex mknuthdiv
13023 @opindex mno-knuthdiv
13024 Make the result of a division yielding a remainder have the same sign as
13025 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
13026 remainder follows the sign of the dividend.  Both methods are
13027 arithmetically valid, the latter being almost exclusively used.
13028
13029 @item -mtoplevel-symbols
13030 @itemx -mno-toplevel-symbols
13031 @opindex mtoplevel-symbols
13032 @opindex mno-toplevel-symbols
13033 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
13034 code can be used with the @code{PREFIX} assembly directive.
13035
13036 @item -melf
13037 @opindex melf
13038 Generate an executable in the ELF format, rather than the default
13039 @samp{mmo} format used by the @command{mmix} simulator.
13040
13041 @item -mbranch-predict
13042 @itemx -mno-branch-predict
13043 @opindex mbranch-predict
13044 @opindex mno-branch-predict
13045 Use (do not use) the probable-branch instructions, when static branch
13046 prediction indicates a probable branch.
13047
13048 @item -mbase-addresses
13049 @itemx -mno-base-addresses
13050 @opindex mbase-addresses
13051 @opindex mno-base-addresses
13052 Generate (do not generate) code that uses @emph{base addresses}.  Using a
13053 base address automatically generates a request (handled by the assembler
13054 and the linker) for a constant to be set up in a global register.  The
13055 register is used for one or more base address requests within the range 0
13056 to 255 from the value held in the register.  The generally leads to short
13057 and fast code, but the number of different data items that can be
13058 addressed is limited.  This means that a program that uses lots of static
13059 data may require @option{-mno-base-addresses}.
13060
13061 @item -msingle-exit
13062 @itemx -mno-single-exit
13063 @opindex msingle-exit
13064 @opindex mno-single-exit
13065 Force (do not force) generated code to have a single exit point in each
13066 function.
13067 @end table
13068
13069 @node MN10300 Options
13070 @subsection MN10300 Options
13071 @cindex MN10300 options
13072
13073 These @option{-m} options are defined for Matsushita MN10300 architectures:
13074
13075 @table @gcctabopt
13076 @item -mmult-bug
13077 @opindex mmult-bug
13078 Generate code to avoid bugs in the multiply instructions for the MN10300
13079 processors.  This is the default.
13080
13081 @item -mno-mult-bug
13082 @opindex mno-mult-bug
13083 Do not generate code to avoid bugs in the multiply instructions for the
13084 MN10300 processors.
13085
13086 @item -mam33
13087 @opindex mam33
13088 Generate code which uses features specific to the AM33 processor.
13089
13090 @item -mno-am33
13091 @opindex mno-am33
13092 Do not generate code which uses features specific to the AM33 processor.  This
13093 is the default.
13094
13095 @item -mreturn-pointer-on-d0
13096 @opindex mreturn-pointer-on-d0
13097 When generating a function which returns a pointer, return the pointer
13098 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
13099 only in a0, and attempts to call such functions without a prototype
13100 would result in errors.  Note that this option is on by default; use
13101 @option{-mno-return-pointer-on-d0} to disable it.
13102
13103 @item -mno-crt0
13104 @opindex mno-crt0
13105 Do not link in the C run-time initialization object file.
13106
13107 @item -mrelax
13108 @opindex mrelax
13109 Indicate to the linker that it should perform a relaxation optimization pass
13110 to shorten branches, calls and absolute memory addresses.  This option only
13111 has an effect when used on the command line for the final link step.
13112
13113 This option makes symbolic debugging impossible.
13114 @end table
13115
13116 @node PDP-11 Options
13117 @subsection PDP-11 Options
13118 @cindex PDP-11 Options
13119
13120 These options are defined for the PDP-11:
13121
13122 @table @gcctabopt
13123 @item -mfpu
13124 @opindex mfpu
13125 Use hardware FPP floating point.  This is the default.  (FIS floating
13126 point on the PDP-11/40 is not supported.)
13127
13128 @item -msoft-float
13129 @opindex msoft-float
13130 Do not use hardware floating point.
13131
13132 @item -mac0
13133 @opindex mac0
13134 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
13135
13136 @item -mno-ac0
13137 @opindex mno-ac0
13138 Return floating-point results in memory.  This is the default.
13139
13140 @item -m40
13141 @opindex m40
13142 Generate code for a PDP-11/40.
13143
13144 @item -m45
13145 @opindex m45
13146 Generate code for a PDP-11/45.  This is the default.
13147
13148 @item -m10
13149 @opindex m10
13150 Generate code for a PDP-11/10.
13151
13152 @item -mbcopy-builtin
13153 @opindex bcopy-builtin
13154 Use inline @code{movmemhi} patterns for copying memory.  This is the
13155 default.
13156
13157 @item -mbcopy
13158 @opindex mbcopy
13159 Do not use inline @code{movmemhi} patterns for copying memory.
13160
13161 @item -mint16
13162 @itemx -mno-int32
13163 @opindex mint16
13164 @opindex mno-int32
13165 Use 16-bit @code{int}.  This is the default.
13166
13167 @item -mint32
13168 @itemx -mno-int16
13169 @opindex mint32
13170 @opindex mno-int16
13171 Use 32-bit @code{int}.
13172
13173 @item -mfloat64
13174 @itemx -mno-float32
13175 @opindex mfloat64
13176 @opindex mno-float32
13177 Use 64-bit @code{float}.  This is the default.
13178
13179 @item -mfloat32
13180 @itemx -mno-float64
13181 @opindex mfloat32
13182 @opindex mno-float64
13183 Use 32-bit @code{float}.
13184
13185 @item -mabshi
13186 @opindex mabshi
13187 Use @code{abshi2} pattern.  This is the default.
13188
13189 @item -mno-abshi
13190 @opindex mno-abshi
13191 Do not use @code{abshi2} pattern.
13192
13193 @item -mbranch-expensive
13194 @opindex mbranch-expensive
13195 Pretend that branches are expensive.  This is for experimenting with
13196 code generation only.
13197
13198 @item -mbranch-cheap
13199 @opindex mbranch-cheap
13200 Do not pretend that branches are expensive.  This is the default.
13201
13202 @item -msplit
13203 @opindex msplit
13204 Generate code for a system with split I&D@.
13205
13206 @item -mno-split
13207 @opindex mno-split
13208 Generate code for a system without split I&D@.  This is the default.
13209
13210 @item -munix-asm
13211 @opindex munix-asm
13212 Use Unix assembler syntax.  This is the default when configured for
13213 @samp{pdp11-*-bsd}.
13214
13215 @item -mdec-asm
13216 @opindex mdec-asm
13217 Use DEC assembler syntax.  This is the default when configured for any
13218 PDP-11 target other than @samp{pdp11-*-bsd}.
13219 @end table
13220
13221 @node picoChip Options
13222 @subsection picoChip Options
13223 @cindex picoChip options
13224
13225 These @samp{-m} options are defined for picoChip implementations:
13226
13227 @table @gcctabopt
13228
13229 @item -mae=@var{ae_type}
13230 @opindex mcpu
13231 Set the instruction set, register set, and instruction scheduling
13232 parameters for array element type @var{ae_type}.  Supported values
13233 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
13234
13235 @option{-mae=ANY} selects a completely generic AE type.  Code
13236 generated with this option will run on any of the other AE types.  The
13237 code will not be as efficient as it would be if compiled for a specific
13238 AE type, and some types of operation (e.g., multiplication) will not
13239 work properly on all types of AE.
13240
13241 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
13242 for compiled code, and is the default.
13243
13244 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
13245 option may suffer from poor performance of byte (char) manipulation,
13246 since the DSP AE does not provide hardware support for byte load/stores.
13247
13248 @item -msymbol-as-address
13249 Enable the compiler to directly use a symbol name as an address in a
13250 load/store instruction, without first loading it into a
13251 register.  Typically, the use of this option will generate larger
13252 programs, which run faster than when the option isn't used.  However, the
13253 results vary from program to program, so it is left as a user option,
13254 rather than being permanently enabled.
13255
13256 @item -mno-inefficient-warnings
13257 Disables warnings about the generation of inefficient code.  These
13258 warnings can be generated, for example, when compiling code which
13259 performs byte-level memory operations on the MAC AE type.  The MAC AE has
13260 no hardware support for byte-level memory operations, so all byte
13261 load/stores must be synthesised from word load/store operations.  This is
13262 inefficient and a warning will be generated indicating to the programmer
13263 that they should rewrite the code to avoid byte operations, or to target
13264 an AE type which has the necessary hardware support.  This option enables
13265 the warning to be turned off.
13266
13267 @end table
13268
13269 @node PowerPC Options
13270 @subsection PowerPC Options
13271 @cindex PowerPC options
13272
13273 These are listed under @xref{RS/6000 and PowerPC Options}.
13274
13275 @node RS/6000 and PowerPC Options
13276 @subsection IBM RS/6000 and PowerPC Options
13277 @cindex RS/6000 and PowerPC Options
13278 @cindex IBM RS/6000 and PowerPC Options
13279
13280 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
13281 @table @gcctabopt
13282 @item -mpower
13283 @itemx -mno-power
13284 @itemx -mpower2
13285 @itemx -mno-power2
13286 @itemx -mpowerpc
13287 @itemx -mno-powerpc
13288 @itemx -mpowerpc-gpopt
13289 @itemx -mno-powerpc-gpopt
13290 @itemx -mpowerpc-gfxopt
13291 @itemx -mno-powerpc-gfxopt
13292 @itemx -mpowerpc64
13293 @itemx -mno-powerpc64
13294 @itemx -mmfcrf
13295 @itemx -mno-mfcrf
13296 @itemx -mpopcntb
13297 @itemx -mno-popcntb
13298 @itemx -mfprnd
13299 @itemx -mno-fprnd
13300 @itemx -mcmpb
13301 @itemx -mno-cmpb
13302 @itemx -mmfpgpr
13303 @itemx -mno-mfpgpr
13304 @itemx -mhard-dfp
13305 @itemx -mno-hard-dfp
13306 @opindex mpower
13307 @opindex mno-power
13308 @opindex mpower2
13309 @opindex mno-power2
13310 @opindex mpowerpc
13311 @opindex mno-powerpc
13312 @opindex mpowerpc-gpopt
13313 @opindex mno-powerpc-gpopt
13314 @opindex mpowerpc-gfxopt
13315 @opindex mno-powerpc-gfxopt
13316 @opindex mpowerpc64
13317 @opindex mno-powerpc64
13318 @opindex mmfcrf
13319 @opindex mno-mfcrf
13320 @opindex mpopcntb
13321 @opindex mno-popcntb
13322 @opindex mfprnd
13323 @opindex mno-fprnd
13324 @opindex mcmpb
13325 @opindex mno-cmpb
13326 @opindex mmfpgpr
13327 @opindex mno-mfpgpr
13328 @opindex mhard-dfp
13329 @opindex mno-hard-dfp
13330 GCC supports two related instruction set architectures for the
13331 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
13332 instructions supported by the @samp{rios} chip set used in the original
13333 RS/6000 systems and the @dfn{PowerPC} instruction set is the
13334 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
13335 the IBM 4xx, 6xx, and follow-on microprocessors.
13336
13337 Neither architecture is a subset of the other.  However there is a
13338 large common subset of instructions supported by both.  An MQ
13339 register is included in processors supporting the POWER architecture.
13340
13341 You use these options to specify which instructions are available on the
13342 processor you are using.  The default value of these options is
13343 determined when configuring GCC@.  Specifying the
13344 @option{-mcpu=@var{cpu_type}} overrides the specification of these
13345 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
13346 rather than the options listed above.
13347
13348 The @option{-mpower} option allows GCC to generate instructions that
13349 are found only in the POWER architecture and to use the MQ register.
13350 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
13351 to generate instructions that are present in the POWER2 architecture but
13352 not the original POWER architecture.
13353
13354 The @option{-mpowerpc} option allows GCC to generate instructions that
13355 are found only in the 32-bit subset of the PowerPC architecture.
13356 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
13357 GCC to use the optional PowerPC architecture instructions in the
13358 General Purpose group, including floating-point square root.  Specifying
13359 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
13360 use the optional PowerPC architecture instructions in the Graphics
13361 group, including floating-point select.
13362
13363 The @option{-mmfcrf} option allows GCC to generate the move from
13364 condition register field instruction implemented on the POWER4
13365 processor and other processors that support the PowerPC V2.01
13366 architecture.
13367 The @option{-mpopcntb} option allows GCC to generate the popcount and
13368 double precision FP reciprocal estimate instruction implemented on the
13369 POWER5 processor and other processors that support the PowerPC V2.02
13370 architecture.
13371 The @option{-mfprnd} option allows GCC to generate the FP round to
13372 integer instructions implemented on the POWER5+ processor and other
13373 processors that support the PowerPC V2.03 architecture.
13374 The @option{-mcmpb} option allows GCC to generate the compare bytes
13375 instruction implemented on the POWER6 processor and other processors
13376 that support the PowerPC V2.05 architecture.
13377 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
13378 general purpose register instructions implemented on the POWER6X
13379 processor and other processors that support the extended PowerPC V2.05
13380 architecture.
13381 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
13382 point instructions implemented on some POWER processors.
13383
13384 The @option{-mpowerpc64} option allows GCC to generate the additional
13385 64-bit instructions that are found in the full PowerPC64 architecture
13386 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
13387 @option{-mno-powerpc64}.
13388
13389 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
13390 will use only the instructions in the common subset of both
13391 architectures plus some special AIX common-mode calls, and will not use
13392 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
13393 permits GCC to use any instruction from either architecture and to
13394 allow use of the MQ register; specify this for the Motorola MPC601.
13395
13396 @item -mnew-mnemonics
13397 @itemx -mold-mnemonics
13398 @opindex mnew-mnemonics
13399 @opindex mold-mnemonics
13400 Select which mnemonics to use in the generated assembler code.  With
13401 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
13402 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
13403 assembler mnemonics defined for the POWER architecture.  Instructions
13404 defined in only one architecture have only one mnemonic; GCC uses that
13405 mnemonic irrespective of which of these options is specified.
13406
13407 GCC defaults to the mnemonics appropriate for the architecture in
13408 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
13409 value of these option.  Unless you are building a cross-compiler, you
13410 should normally not specify either @option{-mnew-mnemonics} or
13411 @option{-mold-mnemonics}, but should instead accept the default.
13412
13413 @item -mcpu=@var{cpu_type}
13414 @opindex mcpu
13415 Set architecture type, register usage, choice of mnemonics, and
13416 instruction scheduling parameters for machine type @var{cpu_type}.
13417 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
13418 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
13419 @samp{505}, @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
13420 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
13421 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
13422 @samp{860}, @samp{970}, @samp{8540}, @samp{e300c2}, @samp{e300c3},
13423 @samp{e500mc}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
13424 @samp{power}, @samp{power2}, @samp{power3}, @samp{power4},
13425 @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x}, @samp{power7}
13426 @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
13427 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
13428
13429 @option{-mcpu=common} selects a completely generic processor.  Code
13430 generated under this option will run on any POWER or PowerPC processor.
13431 GCC will use only the instructions in the common subset of both
13432 architectures, and will not use the MQ register.  GCC assumes a generic
13433 processor model for scheduling purposes.
13434
13435 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
13436 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
13437 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
13438 types, with an appropriate, generic processor model assumed for
13439 scheduling purposes.
13440
13441 The other options specify a specific processor.  Code generated under
13442 those options will run best on that processor, and may not run at all on
13443 others.
13444
13445 The @option{-mcpu} options automatically enable or disable the
13446 following options:
13447
13448 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
13449 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
13450 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
13451 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
13452
13453 The particular options set for any particular CPU will vary between
13454 compiler versions, depending on what setting seems to produce optimal
13455 code for that CPU; it doesn't necessarily reflect the actual hardware's
13456 capabilities.  If you wish to set an individual option to a particular
13457 value, you may specify it after the @option{-mcpu} option, like
13458 @samp{-mcpu=970 -mno-altivec}.
13459
13460 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
13461 not enabled or disabled by the @option{-mcpu} option at present because
13462 AIX does not have full support for these options.  You may still
13463 enable or disable them individually if you're sure it'll work in your
13464 environment.
13465
13466 @item -mtune=@var{cpu_type}
13467 @opindex mtune
13468 Set the instruction scheduling parameters for machine type
13469 @var{cpu_type}, but do not set the architecture type, register usage, or
13470 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
13471 values for @var{cpu_type} are used for @option{-mtune} as for
13472 @option{-mcpu}.  If both are specified, the code generated will use the
13473 architecture, registers, and mnemonics set by @option{-mcpu}, but the
13474 scheduling parameters set by @option{-mtune}.
13475
13476 @item -mswdiv
13477 @itemx -mno-swdiv
13478 @opindex mswdiv
13479 @opindex mno-swdiv
13480 Generate code to compute division as reciprocal estimate and iterative
13481 refinement, creating opportunities for increased throughput.  This
13482 feature requires: optional PowerPC Graphics instruction set for single
13483 precision and FRE instruction for double precision, assuming divides
13484 cannot generate user-visible traps, and the domain values not include
13485 Infinities, denormals or zero denominator.
13486
13487 @item -maltivec
13488 @itemx -mno-altivec
13489 @opindex maltivec
13490 @opindex mno-altivec
13491 Generate code that uses (does not use) AltiVec instructions, and also
13492 enable the use of built-in functions that allow more direct access to
13493 the AltiVec instruction set.  You may also need to set
13494 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
13495 enhancements.
13496
13497 @item -mvrsave
13498 @itemx -mno-vrsave
13499 @opindex mvrsave
13500 @opindex mno-vrsave
13501 Generate VRSAVE instructions when generating AltiVec code.
13502
13503 @item -mgen-cell-microcode
13504 @opindex mgen-cell-microcode
13505 Generate Cell microcode instructions
13506
13507 @item -mwarn-cell-microcode
13508 @opindex mwarn-cell-microcode
13509 Warning when a Cell microcode instruction is going to emitted.  An example
13510 of a Cell microcode instruction is a variable shift.
13511
13512 @item -msecure-plt
13513 @opindex msecure-plt
13514 Generate code that allows ld and ld.so to build executables and shared
13515 libraries with non-exec .plt and .got sections.  This is a PowerPC
13516 32-bit SYSV ABI option.
13517
13518 @item -mbss-plt
13519 @opindex mbss-plt
13520 Generate code that uses a BSS .plt section that ld.so fills in, and
13521 requires .plt and .got sections that are both writable and executable.
13522 This is a PowerPC 32-bit SYSV ABI option.
13523
13524 @item -misel
13525 @itemx -mno-isel
13526 @opindex misel
13527 @opindex mno-isel
13528 This switch enables or disables the generation of ISEL instructions.
13529
13530 @item -misel=@var{yes/no}
13531 This switch has been deprecated.  Use @option{-misel} and
13532 @option{-mno-isel} instead.
13533
13534 @item -mspe
13535 @itemx -mno-spe
13536 @opindex mspe
13537 @opindex mno-spe
13538 This switch enables or disables the generation of SPE simd
13539 instructions.
13540
13541 @item -mpaired
13542 @itemx -mno-paired
13543 @opindex mpaired
13544 @opindex mno-paired
13545 This switch enables or disables the generation of PAIRED simd
13546 instructions.
13547
13548 @item -mspe=@var{yes/no}
13549 This option has been deprecated.  Use @option{-mspe} and
13550 @option{-mno-spe} instead.
13551
13552 @item -mfloat-gprs=@var{yes/single/double/no}
13553 @itemx -mfloat-gprs
13554 @opindex mfloat-gprs
13555 This switch enables or disables the generation of floating point
13556 operations on the general purpose registers for architectures that
13557 support it.
13558
13559 The argument @var{yes} or @var{single} enables the use of
13560 single-precision floating point operations.
13561
13562 The argument @var{double} enables the use of single and
13563 double-precision floating point operations.
13564
13565 The argument @var{no} disables floating point operations on the
13566 general purpose registers.
13567
13568 This option is currently only available on the MPC854x.
13569
13570 @item -m32
13571 @itemx -m64
13572 @opindex m32
13573 @opindex m64
13574 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
13575 targets (including GNU/Linux).  The 32-bit environment sets int, long
13576 and pointer to 32 bits and generates code that runs on any PowerPC
13577 variant.  The 64-bit environment sets int to 32 bits and long and
13578 pointer to 64 bits, and generates code for PowerPC64, as for
13579 @option{-mpowerpc64}.
13580
13581 @item -mfull-toc
13582 @itemx -mno-fp-in-toc
13583 @itemx -mno-sum-in-toc
13584 @itemx -mminimal-toc
13585 @opindex mfull-toc
13586 @opindex mno-fp-in-toc
13587 @opindex mno-sum-in-toc
13588 @opindex mminimal-toc
13589 Modify generation of the TOC (Table Of Contents), which is created for
13590 every executable file.  The @option{-mfull-toc} option is selected by
13591 default.  In that case, GCC will allocate at least one TOC entry for
13592 each unique non-automatic variable reference in your program.  GCC
13593 will also place floating-point constants in the TOC@.  However, only
13594 16,384 entries are available in the TOC@.
13595
13596 If you receive a linker error message that saying you have overflowed
13597 the available TOC space, you can reduce the amount of TOC space used
13598 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
13599 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
13600 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
13601 generate code to calculate the sum of an address and a constant at
13602 run-time instead of putting that sum into the TOC@.  You may specify one
13603 or both of these options.  Each causes GCC to produce very slightly
13604 slower and larger code at the expense of conserving TOC space.
13605
13606 If you still run out of space in the TOC even when you specify both of
13607 these options, specify @option{-mminimal-toc} instead.  This option causes
13608 GCC to make only one TOC entry for every file.  When you specify this
13609 option, GCC will produce code that is slower and larger but which
13610 uses extremely little TOC space.  You may wish to use this option
13611 only on files that contain less frequently executed code.
13612
13613 @item -maix64
13614 @itemx -maix32
13615 @opindex maix64
13616 @opindex maix32
13617 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
13618 @code{long} type, and the infrastructure needed to support them.
13619 Specifying @option{-maix64} implies @option{-mpowerpc64} and
13620 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
13621 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
13622
13623 @item -mxl-compat
13624 @itemx -mno-xl-compat
13625 @opindex mxl-compat
13626 @opindex mno-xl-compat
13627 Produce code that conforms more closely to IBM XL compiler semantics
13628 when using AIX-compatible ABI@.  Pass floating-point arguments to
13629 prototyped functions beyond the register save area (RSA) on the stack
13630 in addition to argument FPRs.  Do not assume that most significant
13631 double in 128-bit long double value is properly rounded when comparing
13632 values and converting to double.  Use XL symbol names for long double
13633 support routines.
13634
13635 The AIX calling convention was extended but not initially documented to
13636 handle an obscure K&R C case of calling a function that takes the
13637 address of its arguments with fewer arguments than declared.  IBM XL
13638 compilers access floating point arguments which do not fit in the
13639 RSA from the stack when a subroutine is compiled without
13640 optimization.  Because always storing floating-point arguments on the
13641 stack is inefficient and rarely needed, this option is not enabled by
13642 default and only is necessary when calling subroutines compiled by IBM
13643 XL compilers without optimization.
13644
13645 @item -mpe
13646 @opindex mpe
13647 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
13648 application written to use message passing with special startup code to
13649 enable the application to run.  The system must have PE installed in the
13650 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
13651 must be overridden with the @option{-specs=} option to specify the
13652 appropriate directory location.  The Parallel Environment does not
13653 support threads, so the @option{-mpe} option and the @option{-pthread}
13654 option are incompatible.
13655
13656 @item -malign-natural
13657 @itemx -malign-power
13658 @opindex malign-natural
13659 @opindex malign-power
13660 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
13661 @option{-malign-natural} overrides the ABI-defined alignment of larger
13662 types, such as floating-point doubles, on their natural size-based boundary.
13663 The option @option{-malign-power} instructs GCC to follow the ABI-specified
13664 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
13665
13666 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
13667 is not supported.
13668
13669 @item -msoft-float
13670 @itemx -mhard-float
13671 @opindex msoft-float
13672 @opindex mhard-float
13673 Generate code that does not use (uses) the floating-point register set.
13674 Software floating point emulation is provided if you use the
13675 @option{-msoft-float} option, and pass the option to GCC when linking.
13676
13677 @item -msingle-float
13678 @itemx -mdouble-float
13679 @opindex msingle-float
13680 @opindex mdouble-float
13681 Generate code for single or double-precision floating point operations. 
13682 @option{-mdouble-float} implies @option{-msingle-float}. 
13683
13684 @item -msimple-fpu
13685 @opindex msimple-fpu
13686 Do not generate sqrt and div instructions for hardware floating point unit.
13687
13688 @item -mfpu
13689 @opindex mfpu
13690 Specify type of floating point unit.  Valid values are @var{sp_lite} 
13691 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
13692 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
13693 and @var{dp_full} (equivalent to -mdouble-float).
13694
13695 @item -mxilinx-fpu
13696 @opindex mxilinx-fpu
13697 Perform optimizations for floating point unit on Xilinx PPC 405/440.
13698
13699 @item -mmultiple
13700 @itemx -mno-multiple
13701 @opindex mmultiple
13702 @opindex mno-multiple
13703 Generate code that uses (does not use) the load multiple word
13704 instructions and the store multiple word instructions.  These
13705 instructions are generated by default on POWER systems, and not
13706 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
13707 endian PowerPC systems, since those instructions do not work when the
13708 processor is in little endian mode.  The exceptions are PPC740 and
13709 PPC750 which permit the instructions usage in little endian mode.
13710
13711 @item -mstring
13712 @itemx -mno-string
13713 @opindex mstring
13714 @opindex mno-string
13715 Generate code that uses (does not use) the load string instructions
13716 and the store string word instructions to save multiple registers and
13717 do small block moves.  These instructions are generated by default on
13718 POWER systems, and not generated on PowerPC systems.  Do not use
13719 @option{-mstring} on little endian PowerPC systems, since those
13720 instructions do not work when the processor is in little endian mode.
13721 The exceptions are PPC740 and PPC750 which permit the instructions
13722 usage in little endian mode.
13723
13724 @item -mupdate
13725 @itemx -mno-update
13726 @opindex mupdate
13727 @opindex mno-update
13728 Generate code that uses (does not use) the load or store instructions
13729 that update the base register to the address of the calculated memory
13730 location.  These instructions are generated by default.  If you use
13731 @option{-mno-update}, there is a small window between the time that the
13732 stack pointer is updated and the address of the previous frame is
13733 stored, which means code that walks the stack frame across interrupts or
13734 signals may get corrupted data.
13735
13736 @item -mfused-madd
13737 @itemx -mno-fused-madd
13738 @opindex mfused-madd
13739 @opindex mno-fused-madd
13740 Generate code that uses (does not use) the floating point multiply and
13741 accumulate instructions.  These instructions are generated by default if
13742 hardware floating is used.
13743
13744 @item -mmulhw
13745 @itemx -mno-mulhw
13746 @opindex mmulhw
13747 @opindex mno-mulhw
13748 Generate code that uses (does not use) the half-word multiply and
13749 multiply-accumulate instructions on the IBM 405, 440 and 464 processors.
13750 These instructions are generated by default when targetting those
13751 processors.
13752
13753 @item -mdlmzb
13754 @itemx -mno-dlmzb
13755 @opindex mdlmzb
13756 @opindex mno-dlmzb
13757 Generate code that uses (does not use) the string-search @samp{dlmzb}
13758 instruction on the IBM 405, 440 and 464 processors.  This instruction is
13759 generated by default when targetting those processors.
13760
13761 @item -mno-bit-align
13762 @itemx -mbit-align
13763 @opindex mno-bit-align
13764 @opindex mbit-align
13765 On System V.4 and embedded PowerPC systems do not (do) force structures
13766 and unions that contain bit-fields to be aligned to the base type of the
13767 bit-field.
13768
13769 For example, by default a structure containing nothing but 8
13770 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
13771 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
13772 the structure would be aligned to a 1 byte boundary and be one byte in
13773 size.
13774
13775 @item -mno-strict-align
13776 @itemx -mstrict-align
13777 @opindex mno-strict-align
13778 @opindex mstrict-align
13779 On System V.4 and embedded PowerPC systems do not (do) assume that
13780 unaligned memory references will be handled by the system.
13781
13782 @item -mrelocatable
13783 @itemx -mno-relocatable
13784 @opindex mrelocatable
13785 @opindex mno-relocatable
13786 On embedded PowerPC systems generate code that allows (does not allow)
13787 the program to be relocated to a different address at runtime.  If you
13788 use @option{-mrelocatable} on any module, all objects linked together must
13789 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
13790
13791 @item -mrelocatable-lib
13792 @itemx -mno-relocatable-lib
13793 @opindex mrelocatable-lib
13794 @opindex mno-relocatable-lib
13795 On embedded PowerPC systems generate code that allows (does not allow)
13796 the program to be relocated to a different address at runtime.  Modules
13797 compiled with @option{-mrelocatable-lib} can be linked with either modules
13798 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
13799 with modules compiled with the @option{-mrelocatable} options.
13800
13801 @item -mno-toc
13802 @itemx -mtoc
13803 @opindex mno-toc
13804 @opindex mtoc
13805 On System V.4 and embedded PowerPC systems do not (do) assume that
13806 register 2 contains a pointer to a global area pointing to the addresses
13807 used in the program.
13808
13809 @item -mlittle
13810 @itemx -mlittle-endian
13811 @opindex mlittle
13812 @opindex mlittle-endian
13813 On System V.4 and embedded PowerPC systems compile code for the
13814 processor in little endian mode.  The @option{-mlittle-endian} option is
13815 the same as @option{-mlittle}.
13816
13817 @item -mbig
13818 @itemx -mbig-endian
13819 @opindex mbig
13820 @opindex mbig-endian
13821 On System V.4 and embedded PowerPC systems compile code for the
13822 processor in big endian mode.  The @option{-mbig-endian} option is
13823 the same as @option{-mbig}.
13824
13825 @item -mdynamic-no-pic
13826 @opindex mdynamic-no-pic
13827 On Darwin and Mac OS X systems, compile code so that it is not
13828 relocatable, but that its external references are relocatable.  The
13829 resulting code is suitable for applications, but not shared
13830 libraries.
13831
13832 @item -mprioritize-restricted-insns=@var{priority}
13833 @opindex mprioritize-restricted-insns
13834 This option controls the priority that is assigned to
13835 dispatch-slot restricted instructions during the second scheduling
13836 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
13837 @var{no/highest/second-highest} priority to dispatch slot restricted
13838 instructions.
13839
13840 @item -msched-costly-dep=@var{dependence_type}
13841 @opindex msched-costly-dep
13842 This option controls which dependences are considered costly
13843 by the target during instruction scheduling.  The argument
13844 @var{dependence_type} takes one of the following values:
13845 @var{no}: no dependence is costly,
13846 @var{all}: all dependences are costly,
13847 @var{true_store_to_load}: a true dependence from store to load is costly,
13848 @var{store_to_load}: any dependence from store to load is costly,
13849 @var{number}: any dependence which latency >= @var{number} is costly.
13850
13851 @item -minsert-sched-nops=@var{scheme}
13852 @opindex minsert-sched-nops
13853 This option controls which nop insertion scheme will be used during
13854 the second scheduling pass.  The argument @var{scheme} takes one of the
13855 following values:
13856 @var{no}: Don't insert nops.
13857 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
13858 according to the scheduler's grouping.
13859 @var{regroup_exact}: Insert nops to force costly dependent insns into
13860 separate groups.  Insert exactly as many nops as needed to force an insn
13861 to a new group, according to the estimated processor grouping.
13862 @var{number}: Insert nops to force costly dependent insns into
13863 separate groups.  Insert @var{number} nops to force an insn to a new group.
13864
13865 @item -mcall-sysv
13866 @opindex mcall-sysv
13867 On System V.4 and embedded PowerPC systems compile code using calling
13868 conventions that adheres to the March 1995 draft of the System V
13869 Application Binary Interface, PowerPC processor supplement.  This is the
13870 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
13871
13872 @item -mcall-sysv-eabi
13873 @opindex mcall-sysv-eabi
13874 Specify both @option{-mcall-sysv} and @option{-meabi} options.
13875
13876 @item -mcall-sysv-noeabi
13877 @opindex mcall-sysv-noeabi
13878 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
13879
13880 @item -mcall-solaris
13881 @opindex mcall-solaris
13882 On System V.4 and embedded PowerPC systems compile code for the Solaris
13883 operating system.
13884
13885 @item -mcall-linux
13886 @opindex mcall-linux
13887 On System V.4 and embedded PowerPC systems compile code for the
13888 Linux-based GNU system.
13889
13890 @item -mcall-gnu
13891 @opindex mcall-gnu
13892 On System V.4 and embedded PowerPC systems compile code for the
13893 Hurd-based GNU system.
13894
13895 @item -mcall-netbsd
13896 @opindex mcall-netbsd
13897 On System V.4 and embedded PowerPC systems compile code for the
13898 NetBSD operating system.
13899
13900 @item -maix-struct-return
13901 @opindex maix-struct-return
13902 Return all structures in memory (as specified by the AIX ABI)@.
13903
13904 @item -msvr4-struct-return
13905 @opindex msvr4-struct-return
13906 Return structures smaller than 8 bytes in registers (as specified by the
13907 SVR4 ABI)@.
13908
13909 @item -mabi=@var{abi-type}
13910 @opindex mabi
13911 Extend the current ABI with a particular extension, or remove such extension.
13912 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
13913 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
13914
13915 @item -mabi=spe
13916 @opindex mabi=spe
13917 Extend the current ABI with SPE ABI extensions.  This does not change
13918 the default ABI, instead it adds the SPE ABI extensions to the current
13919 ABI@.
13920
13921 @item -mabi=no-spe
13922 @opindex mabi=no-spe
13923 Disable Booke SPE ABI extensions for the current ABI@.
13924
13925 @item -mabi=ibmlongdouble
13926 @opindex mabi=ibmlongdouble
13927 Change the current ABI to use IBM extended precision long double.
13928 This is a PowerPC 32-bit SYSV ABI option.
13929
13930 @item -mabi=ieeelongdouble
13931 @opindex mabi=ieeelongdouble
13932 Change the current ABI to use IEEE extended precision long double.
13933 This is a PowerPC 32-bit Linux ABI option.
13934
13935 @item -mprototype
13936 @itemx -mno-prototype
13937 @opindex mprototype
13938 @opindex mno-prototype
13939 On System V.4 and embedded PowerPC systems assume that all calls to
13940 variable argument functions are properly prototyped.  Otherwise, the
13941 compiler must insert an instruction before every non prototyped call to
13942 set or clear bit 6 of the condition code register (@var{CR}) to
13943 indicate whether floating point values were passed in the floating point
13944 registers in case the function takes a variable arguments.  With
13945 @option{-mprototype}, only calls to prototyped variable argument functions
13946 will set or clear the bit.
13947
13948 @item -msim
13949 @opindex msim
13950 On embedded PowerPC systems, assume that the startup module is called
13951 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
13952 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
13953 configurations.
13954
13955 @item -mmvme
13956 @opindex mmvme
13957 On embedded PowerPC systems, assume that the startup module is called
13958 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
13959 @file{libc.a}.
13960
13961 @item -mads
13962 @opindex mads
13963 On embedded PowerPC systems, assume that the startup module is called
13964 @file{crt0.o} and the standard C libraries are @file{libads.a} and
13965 @file{libc.a}.
13966
13967 @item -myellowknife
13968 @opindex myellowknife
13969 On embedded PowerPC systems, assume that the startup module is called
13970 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
13971 @file{libc.a}.
13972
13973 @item -mvxworks
13974 @opindex mvxworks
13975 On System V.4 and embedded PowerPC systems, specify that you are
13976 compiling for a VxWorks system.
13977
13978 @item -memb
13979 @opindex memb
13980 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
13981 header to indicate that @samp{eabi} extended relocations are used.
13982
13983 @item -meabi
13984 @itemx -mno-eabi
13985 @opindex meabi
13986 @opindex mno-eabi
13987 On System V.4 and embedded PowerPC systems do (do not) adhere to the
13988 Embedded Applications Binary Interface (eabi) which is a set of
13989 modifications to the System V.4 specifications.  Selecting @option{-meabi}
13990 means that the stack is aligned to an 8 byte boundary, a function
13991 @code{__eabi} is called to from @code{main} to set up the eabi
13992 environment, and the @option{-msdata} option can use both @code{r2} and
13993 @code{r13} to point to two separate small data areas.  Selecting
13994 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
13995 do not call an initialization function from @code{main}, and the
13996 @option{-msdata} option will only use @code{r13} to point to a single
13997 small data area.  The @option{-meabi} option is on by default if you
13998 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
13999
14000 @item -msdata=eabi
14001 @opindex msdata=eabi
14002 On System V.4 and embedded PowerPC systems, put small initialized
14003 @code{const} global and static data in the @samp{.sdata2} section, which
14004 is pointed to by register @code{r2}.  Put small initialized
14005 non-@code{const} global and static data in the @samp{.sdata} section,
14006 which is pointed to by register @code{r13}.  Put small uninitialized
14007 global and static data in the @samp{.sbss} section, which is adjacent to
14008 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
14009 incompatible with the @option{-mrelocatable} option.  The
14010 @option{-msdata=eabi} option also sets the @option{-memb} option.
14011
14012 @item -msdata=sysv
14013 @opindex msdata=sysv
14014 On System V.4 and embedded PowerPC systems, put small global and static
14015 data in the @samp{.sdata} section, which is pointed to by register
14016 @code{r13}.  Put small uninitialized global and static data in the
14017 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
14018 The @option{-msdata=sysv} option is incompatible with the
14019 @option{-mrelocatable} option.
14020
14021 @item -msdata=default
14022 @itemx -msdata
14023 @opindex msdata=default
14024 @opindex msdata
14025 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
14026 compile code the same as @option{-msdata=eabi}, otherwise compile code the
14027 same as @option{-msdata=sysv}.
14028
14029 @item -msdata-data
14030 @opindex msdata-data
14031 On System V.4 and embedded PowerPC systems, put small global
14032 data in the @samp{.sdata} section.  Put small uninitialized global
14033 data in the @samp{.sbss} section.  Do not use register @code{r13}
14034 to address small data however.  This is the default behavior unless
14035 other @option{-msdata} options are used.
14036
14037 @item -msdata=none
14038 @itemx -mno-sdata
14039 @opindex msdata=none
14040 @opindex mno-sdata
14041 On embedded PowerPC systems, put all initialized global and static data
14042 in the @samp{.data} section, and all uninitialized data in the
14043 @samp{.bss} section.
14044
14045 @item -G @var{num}
14046 @opindex G
14047 @cindex smaller data references (PowerPC)
14048 @cindex .sdata/.sdata2 references (PowerPC)
14049 On embedded PowerPC systems, put global and static items less than or
14050 equal to @var{num} bytes into the small data or bss sections instead of
14051 the normal data or bss section.  By default, @var{num} is 8.  The
14052 @option{-G @var{num}} switch is also passed to the linker.
14053 All modules should be compiled with the same @option{-G @var{num}} value.
14054
14055 @item -mregnames
14056 @itemx -mno-regnames
14057 @opindex mregnames
14058 @opindex mno-regnames
14059 On System V.4 and embedded PowerPC systems do (do not) emit register
14060 names in the assembly language output using symbolic forms.
14061
14062 @item -mlongcall
14063 @itemx -mno-longcall
14064 @opindex mlongcall
14065 @opindex mno-longcall
14066 By default assume that all calls are far away so that a longer more
14067 expensive calling sequence is required.  This is required for calls
14068 further than 32 megabytes (33,554,432 bytes) from the current location.
14069 A short call will be generated if the compiler knows
14070 the call cannot be that far away.  This setting can be overridden by
14071 the @code{shortcall} function attribute, or by @code{#pragma
14072 longcall(0)}.
14073
14074 Some linkers are capable of detecting out-of-range calls and generating
14075 glue code on the fly.  On these systems, long calls are unnecessary and
14076 generate slower code.  As of this writing, the AIX linker can do this,
14077 as can the GNU linker for PowerPC/64.  It is planned to add this feature
14078 to the GNU linker for 32-bit PowerPC systems as well.
14079
14080 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
14081 callee, L42'', plus a ``branch island'' (glue code).  The two target
14082 addresses represent the callee and the ``branch island''.  The
14083 Darwin/PPC linker will prefer the first address and generate a ``bl
14084 callee'' if the PPC ``bl'' instruction will reach the callee directly;
14085 otherwise, the linker will generate ``bl L42'' to call the ``branch
14086 island''.  The ``branch island'' is appended to the body of the
14087 calling function; it computes the full 32-bit address of the callee
14088 and jumps to it.
14089
14090 On Mach-O (Darwin) systems, this option directs the compiler emit to
14091 the glue for every direct call, and the Darwin linker decides whether
14092 to use or discard it.
14093
14094 In the future, we may cause GCC to ignore all longcall specifications
14095 when the linker is known to generate glue.
14096
14097 @item -pthread
14098 @opindex pthread
14099 Adds support for multithreading with the @dfn{pthreads} library.
14100 This option sets flags for both the preprocessor and linker.
14101
14102 @end table
14103
14104 @node S/390 and zSeries Options
14105 @subsection S/390 and zSeries Options
14106 @cindex S/390 and zSeries Options
14107
14108 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
14109
14110 @table @gcctabopt
14111 @item -mhard-float
14112 @itemx -msoft-float
14113 @opindex mhard-float
14114 @opindex msoft-float
14115 Use (do not use) the hardware floating-point instructions and registers
14116 for floating-point operations.  When @option{-msoft-float} is specified,
14117 functions in @file{libgcc.a} will be used to perform floating-point
14118 operations.  When @option{-mhard-float} is specified, the compiler
14119 generates IEEE floating-point instructions.  This is the default.
14120
14121 @item -mhard-dfp
14122 @itemx -mno-hard-dfp
14123 @opindex mhard-dfp
14124 @opindex mno-hard-dfp
14125 Use (do not use) the hardware decimal-floating-point instructions for
14126 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
14127 specified, functions in @file{libgcc.a} will be used to perform
14128 decimal-floating-point operations.  When @option{-mhard-dfp} is
14129 specified, the compiler generates decimal-floating-point hardware
14130 instructions.  This is the default for @option{-march=z9-ec} or higher.
14131
14132 @item -mlong-double-64
14133 @itemx -mlong-double-128
14134 @opindex mlong-double-64
14135 @opindex mlong-double-128
14136 These switches control the size of @code{long double} type. A size
14137 of 64bit makes the @code{long double} type equivalent to the @code{double}
14138 type. This is the default.
14139
14140 @item -mbackchain
14141 @itemx -mno-backchain
14142 @opindex mbackchain
14143 @opindex mno-backchain
14144 Store (do not store) the address of the caller's frame as backchain pointer
14145 into the callee's stack frame.
14146 A backchain may be needed to allow debugging using tools that do not understand
14147 DWARF-2 call frame information.
14148 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
14149 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
14150 the backchain is placed into the topmost word of the 96/160 byte register
14151 save area.
14152
14153 In general, code compiled with @option{-mbackchain} is call-compatible with
14154 code compiled with @option{-mmo-backchain}; however, use of the backchain
14155 for debugging purposes usually requires that the whole binary is built with
14156 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
14157 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
14158 to build a linux kernel use @option{-msoft-float}.
14159
14160 The default is to not maintain the backchain.
14161
14162 @item -mpacked-stack
14163 @itemx -mno-packed-stack
14164 @opindex mpacked-stack
14165 @opindex mno-packed-stack
14166 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
14167 specified, the compiler uses the all fields of the 96/160 byte register save
14168 area only for their default purpose; unused fields still take up stack space.
14169 When @option{-mpacked-stack} is specified, register save slots are densely
14170 packed at the top of the register save area; unused space is reused for other
14171 purposes, allowing for more efficient use of the available stack space.
14172 However, when @option{-mbackchain} is also in effect, the topmost word of
14173 the save area is always used to store the backchain, and the return address
14174 register is always saved two words below the backchain.
14175
14176 As long as the stack frame backchain is not used, code generated with
14177 @option{-mpacked-stack} is call-compatible with code generated with
14178 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
14179 S/390 or zSeries generated code that uses the stack frame backchain at run
14180 time, not just for debugging purposes.  Such code is not call-compatible
14181 with code compiled with @option{-mpacked-stack}.  Also, note that the
14182 combination of @option{-mbackchain},
14183 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
14184 to build a linux kernel use @option{-msoft-float}.
14185
14186 The default is to not use the packed stack layout.
14187
14188 @item -msmall-exec
14189 @itemx -mno-small-exec
14190 @opindex msmall-exec
14191 @opindex mno-small-exec
14192 Generate (or do not generate) code using the @code{bras} instruction
14193 to do subroutine calls.
14194 This only works reliably if the total executable size does not
14195 exceed 64k.  The default is to use the @code{basr} instruction instead,
14196 which does not have this limitation.
14197
14198 @item -m64
14199 @itemx -m31
14200 @opindex m64
14201 @opindex m31
14202 When @option{-m31} is specified, generate code compliant to the
14203 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
14204 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
14205 particular to generate 64-bit instructions.  For the @samp{s390}
14206 targets, the default is @option{-m31}, while the @samp{s390x}
14207 targets default to @option{-m64}.
14208
14209 @item -mzarch
14210 @itemx -mesa
14211 @opindex mzarch
14212 @opindex mesa
14213 When @option{-mzarch} is specified, generate code using the
14214 instructions available on z/Architecture.
14215 When @option{-mesa} is specified, generate code using the
14216 instructions available on ESA/390.  Note that @option{-mesa} is
14217 not possible with @option{-m64}.
14218 When generating code compliant to the GNU/Linux for S/390 ABI,
14219 the default is @option{-mesa}.  When generating code compliant
14220 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
14221
14222 @item -mmvcle
14223 @itemx -mno-mvcle
14224 @opindex mmvcle
14225 @opindex mno-mvcle
14226 Generate (or do not generate) code using the @code{mvcle} instruction
14227 to perform block moves.  When @option{-mno-mvcle} is specified,
14228 use a @code{mvc} loop instead.  This is the default unless optimizing for
14229 size.
14230
14231 @item -mdebug
14232 @itemx -mno-debug
14233 @opindex mdebug
14234 @opindex mno-debug
14235 Print (or do not print) additional debug information when compiling.
14236 The default is to not print debug information.
14237
14238 @item -march=@var{cpu-type}
14239 @opindex march
14240 Generate code that will run on @var{cpu-type}, which is the name of a system
14241 representing a certain processor type.  Possible values for
14242 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
14243 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
14244 When generating code using the instructions available on z/Architecture,
14245 the default is @option{-march=z900}.  Otherwise, the default is
14246 @option{-march=g5}.
14247
14248 @item -mtune=@var{cpu-type}
14249 @opindex mtune
14250 Tune to @var{cpu-type} everything applicable about the generated code,
14251 except for the ABI and the set of available instructions.
14252 The list of @var{cpu-type} values is the same as for @option{-march}.
14253 The default is the value used for @option{-march}.
14254
14255 @item -mtpf-trace
14256 @itemx -mno-tpf-trace
14257 @opindex mtpf-trace
14258 @opindex mno-tpf-trace
14259 Generate code that adds (does not add) in TPF OS specific branches to trace
14260 routines in the operating system.  This option is off by default, even
14261 when compiling for the TPF OS@.
14262
14263 @item -mfused-madd
14264 @itemx -mno-fused-madd
14265 @opindex mfused-madd
14266 @opindex mno-fused-madd
14267 Generate code that uses (does not use) the floating point multiply and
14268 accumulate instructions.  These instructions are generated by default if
14269 hardware floating point is used.
14270
14271 @item -mwarn-framesize=@var{framesize}
14272 @opindex mwarn-framesize
14273 Emit a warning if the current function exceeds the given frame size.  Because
14274 this is a compile time check it doesn't need to be a real problem when the program
14275 runs.  It is intended to identify functions which most probably cause
14276 a stack overflow.  It is useful to be used in an environment with limited stack
14277 size e.g.@: the linux kernel.
14278
14279 @item -mwarn-dynamicstack
14280 @opindex mwarn-dynamicstack
14281 Emit a warning if the function calls alloca or uses dynamically
14282 sized arrays.  This is generally a bad idea with a limited stack size.
14283
14284 @item -mstack-guard=@var{stack-guard}
14285 @itemx -mstack-size=@var{stack-size}
14286 @opindex mstack-guard
14287 @opindex mstack-size
14288 If these options are provided the s390 back end emits additional instructions in
14289 the function prologue which trigger a trap if the stack size is @var{stack-guard}
14290 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
14291 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
14292 the frame size of the compiled function is chosen.
14293 These options are intended to be used to help debugging stack overflow problems.
14294 The additionally emitted code causes only little overhead and hence can also be
14295 used in production like systems without greater performance degradation.  The given
14296 values have to be exact powers of 2 and @var{stack-size} has to be greater than
14297 @var{stack-guard} without exceeding 64k.
14298 In order to be efficient the extra code makes the assumption that the stack starts
14299 at an address aligned to the value given by @var{stack-size}.
14300 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
14301 @end table
14302
14303 @node Score Options
14304 @subsection Score Options
14305 @cindex Score Options
14306
14307 These options are defined for Score implementations:
14308
14309 @table @gcctabopt
14310 @item -meb
14311 @opindex meb
14312 Compile code for big endian mode.  This is the default.
14313
14314 @item -mel
14315 @opindex mel
14316 Compile code for little endian mode. 
14317
14318 @item -mnhwloop
14319 @opindex mnhwloop
14320 Disable generate bcnz instruction.
14321
14322 @item -muls
14323 @opindex muls
14324 Enable generate unaligned load and store instruction.
14325
14326 @item -mmac
14327 @opindex mmac
14328 Enable the use of multiply-accumulate instructions. Disabled by default. 
14329
14330 @item -mscore5
14331 @opindex mscore5
14332 Specify the SCORE5 as the target architecture.
14333
14334 @item -mscore5u
14335 @opindex mscore5u
14336 Specify the SCORE5U of the target architecture.
14337
14338 @item -mscore7
14339 @opindex mscore7
14340 Specify the SCORE7 as the target architecture. This is the default.
14341
14342 @item -mscore7d
14343 @opindex mscore7d
14344 Specify the SCORE7D as the target architecture.
14345 @end table
14346
14347 @node SH Options
14348 @subsection SH Options
14349
14350 These @samp{-m} options are defined for the SH implementations:
14351
14352 @table @gcctabopt
14353 @item -m1
14354 @opindex m1
14355 Generate code for the SH1.
14356
14357 @item -m2
14358 @opindex m2
14359 Generate code for the SH2.
14360
14361 @item -m2e
14362 Generate code for the SH2e.
14363
14364 @item -m3
14365 @opindex m3
14366 Generate code for the SH3.
14367
14368 @item -m3e
14369 @opindex m3e
14370 Generate code for the SH3e.
14371
14372 @item -m4-nofpu
14373 @opindex m4-nofpu
14374 Generate code for the SH4 without a floating-point unit.
14375
14376 @item -m4-single-only
14377 @opindex m4-single-only
14378 Generate code for the SH4 with a floating-point unit that only
14379 supports single-precision arithmetic.
14380
14381 @item -m4-single
14382 @opindex m4-single
14383 Generate code for the SH4 assuming the floating-point unit is in
14384 single-precision mode by default.
14385
14386 @item -m4
14387 @opindex m4
14388 Generate code for the SH4.
14389
14390 @item -m4a-nofpu
14391 @opindex m4a-nofpu
14392 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
14393 floating-point unit is not used.
14394
14395 @item -m4a-single-only
14396 @opindex m4a-single-only
14397 Generate code for the SH4a, in such a way that no double-precision
14398 floating point operations are used.
14399
14400 @item -m4a-single
14401 @opindex m4a-single
14402 Generate code for the SH4a assuming the floating-point unit is in
14403 single-precision mode by default.
14404
14405 @item -m4a
14406 @opindex m4a
14407 Generate code for the SH4a.
14408
14409 @item -m4al
14410 @opindex m4al
14411 Same as @option{-m4a-nofpu}, except that it implicitly passes
14412 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
14413 instructions at the moment.
14414
14415 @item -mb
14416 @opindex mb
14417 Compile code for the processor in big endian mode.
14418
14419 @item -ml
14420 @opindex ml
14421 Compile code for the processor in little endian mode.
14422
14423 @item -mdalign
14424 @opindex mdalign
14425 Align doubles at 64-bit boundaries.  Note that this changes the calling
14426 conventions, and thus some functions from the standard C library will
14427 not work unless you recompile it first with @option{-mdalign}.
14428
14429 @item -mrelax
14430 @opindex mrelax
14431 Shorten some address references at link time, when possible; uses the
14432 linker option @option{-relax}.
14433
14434 @item -mbigtable
14435 @opindex mbigtable
14436 Use 32-bit offsets in @code{switch} tables.  The default is to use
14437 16-bit offsets.
14438
14439 @item -mbitops
14440 @opindex mbitops
14441 Enable the use of bit manipulation instructions on SH2A.
14442
14443 @item -mfmovd
14444 @opindex mfmovd
14445 Enable the use of the instruction @code{fmovd}.
14446
14447 @item -mhitachi
14448 @opindex mhitachi
14449 Comply with the calling conventions defined by Renesas.
14450
14451 @item -mrenesas
14452 @opindex mhitachi
14453 Comply with the calling conventions defined by Renesas.
14454
14455 @item -mno-renesas
14456 @opindex mhitachi
14457 Comply with the calling conventions defined for GCC before the Renesas
14458 conventions were available.  This option is the default for all
14459 targets of the SH toolchain except for @samp{sh-symbianelf}.
14460
14461 @item -mnomacsave
14462 @opindex mnomacsave
14463 Mark the @code{MAC} register as call-clobbered, even if
14464 @option{-mhitachi} is given.
14465
14466 @item -mieee
14467 @opindex mieee
14468 Increase IEEE-compliance of floating-point code.
14469 At the moment, this is equivalent to @option{-fno-finite-math-only}.
14470 When generating 16 bit SH opcodes, getting IEEE-conforming results for
14471 comparisons of NANs / infinities incurs extra overhead in every
14472 floating point comparison, therefore the default is set to
14473 @option{-ffinite-math-only}.
14474
14475 @item -minline-ic_invalidate
14476 @opindex minline-ic_invalidate
14477 Inline code to invalidate instruction cache entries after setting up
14478 nested function trampolines.
14479 This option has no effect if -musermode is in effect and the selected
14480 code generation option (e.g. -m4) does not allow the use of the icbi
14481 instruction.
14482 If the selected code generation option does not allow the use of the icbi
14483 instruction, and -musermode is not in effect, the inlined code will
14484 manipulate the instruction cache address array directly with an associative
14485 write.  This not only requires privileged mode, but it will also
14486 fail if the cache line had been mapped via the TLB and has become unmapped.
14487
14488 @item -misize
14489 @opindex misize
14490 Dump instruction size and location in the assembly code.
14491
14492 @item -mpadstruct
14493 @opindex mpadstruct
14494 This option is deprecated.  It pads structures to multiple of 4 bytes,
14495 which is incompatible with the SH ABI@.
14496
14497 @item -mspace
14498 @opindex mspace
14499 Optimize for space instead of speed.  Implied by @option{-Os}.
14500
14501 @item -mprefergot
14502 @opindex mprefergot
14503 When generating position-independent code, emit function calls using
14504 the Global Offset Table instead of the Procedure Linkage Table.
14505
14506 @item -musermode
14507 @opindex musermode
14508 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
14509 if the inlined code would not work in user mode.
14510 This is the default when the target is @code{sh-*-linux*}.
14511
14512 @item -multcost=@var{number}
14513 @opindex multcost=@var{number}
14514 Set the cost to assume for a multiply insn.
14515
14516 @item -mdiv=@var{strategy}
14517 @opindex mdiv=@var{strategy}
14518 Set the division strategy to use for SHmedia code.  @var{strategy} must be
14519 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
14520 inv:call2, inv:fp .
14521 "fp" performs the operation in floating point.  This has a very high latency,
14522 but needs only a few instructions, so it might be a good choice if
14523 your code has enough easily exploitable ILP to allow the compiler to
14524 schedule the floating point instructions together with other instructions.
14525 Division by zero causes a floating point exception.
14526 "inv" uses integer operations to calculate the inverse of the divisor,
14527 and then multiplies the dividend with the inverse.  This strategy allows
14528 cse and hoisting of the inverse calculation.  Division by zero calculates
14529 an unspecified result, but does not trap.
14530 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
14531 have been found, or if the entire operation has been hoisted to the same
14532 place, the last stages of the inverse calculation are intertwined with the
14533 final multiply to reduce the overall latency, at the expense of using a few
14534 more instructions, and thus offering fewer scheduling opportunities with
14535 other code.
14536 "call" calls a library function that usually implements the inv:minlat
14537 strategy.
14538 This gives high code density for m5-*media-nofpu compilations.
14539 "call2" uses a different entry point of the same library function, where it
14540 assumes that a pointer to a lookup table has already been set up, which
14541 exposes the pointer load to cse / code hoisting optimizations.
14542 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
14543 code generation, but if the code stays unoptimized, revert to the "call",
14544 "call2", or "fp" strategies, respectively.  Note that the
14545 potentially-trapping side effect of division by zero is carried by a
14546 separate instruction, so it is possible that all the integer instructions
14547 are hoisted out, but the marker for the side effect stays where it is.
14548 A recombination to fp operations or a call is not possible in that case.
14549 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
14550 that the inverse calculation was nor separated from the multiply, they speed
14551 up division where the dividend fits into 20 bits (plus sign where applicable),
14552 by inserting a test to skip a number of operations in this case; this test
14553 slows down the case of larger dividends.  inv20u assumes the case of a such
14554 a small dividend to be unlikely, and inv20l assumes it to be likely.
14555
14556 @item -mdivsi3_libfunc=@var{name}
14557 @opindex mdivsi3_libfunc=@var{name}
14558 Set the name of the library function used for 32 bit signed division to
14559 @var{name}.  This only affect the name used in the call and inv:call
14560 division strategies, and the compiler will still expect the same
14561 sets of input/output/clobbered registers as if this option was not present.
14562
14563 @item -mfixed-range=@var{register-range}
14564 @opindex mfixed-range
14565 Generate code treating the given register range as fixed registers.
14566 A fixed register is one that the register allocator can not use.  This is
14567 useful when compiling kernel code.  A register range is specified as
14568 two registers separated by a dash.  Multiple register ranges can be
14569 specified separated by a comma.
14570
14571 @item -madjust-unroll
14572 @opindex madjust-unroll
14573 Throttle unrolling to avoid thrashing target registers.
14574 This option only has an effect if the gcc code base supports the
14575 TARGET_ADJUST_UNROLL_MAX target hook.
14576
14577 @item -mindexed-addressing
14578 @opindex mindexed-addressing
14579 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
14580 This is only safe if the hardware and/or OS implement 32 bit wrap-around
14581 semantics for the indexed addressing mode.  The architecture allows the
14582 implementation of processors with 64 bit MMU, which the OS could use to
14583 get 32 bit addressing, but since no current hardware implementation supports
14584 this or any other way to make the indexed addressing mode safe to use in
14585 the 32 bit ABI, the default is -mno-indexed-addressing.
14586
14587 @item -mgettrcost=@var{number}
14588 @opindex mgettrcost=@var{number}
14589 Set the cost assumed for the gettr instruction to @var{number}.
14590 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
14591
14592 @item -mpt-fixed
14593 @opindex mpt-fixed
14594 Assume pt* instructions won't trap.  This will generally generate better
14595 scheduled code, but is unsafe on current hardware.  The current architecture
14596 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
14597 This has the unintentional effect of making it unsafe to schedule ptabs /
14598 ptrel before a branch, or hoist it out of a loop.  For example,
14599 __do_global_ctors, a part of libgcc that runs constructors at program
14600 startup, calls functions in a list which is delimited by @minus{}1.  With the
14601 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
14602 That means that all the constructors will be run a bit quicker, but when
14603 the loop comes to the end of the list, the program crashes because ptabs
14604 loads @minus{}1 into a target register.  Since this option is unsafe for any
14605 hardware implementing the current architecture specification, the default
14606 is -mno-pt-fixed.  Unless the user specifies a specific cost with
14607 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
14608 this deters register allocation using target registers for storing
14609 ordinary integers.
14610
14611 @item -minvalid-symbols
14612 @opindex minvalid-symbols
14613 Assume symbols might be invalid.  Ordinary function symbols generated by
14614 the compiler will always be valid to load with movi/shori/ptabs or
14615 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
14616 to generate symbols that will cause ptabs / ptrel to trap.
14617 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
14618 It will then prevent cross-basic-block cse, hoisting and most scheduling
14619 of symbol loads.  The default is @option{-mno-invalid-symbols}.
14620 @end table
14621
14622 @node SPARC Options
14623 @subsection SPARC Options
14624 @cindex SPARC options
14625
14626 These @samp{-m} options are supported on the SPARC:
14627
14628 @table @gcctabopt
14629 @item -mno-app-regs
14630 @itemx -mapp-regs
14631 @opindex mno-app-regs
14632 @opindex mapp-regs
14633 Specify @option{-mapp-regs} to generate output using the global registers
14634 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
14635 is the default.
14636
14637 To be fully SVR4 ABI compliant at the cost of some performance loss,
14638 specify @option{-mno-app-regs}.  You should compile libraries and system
14639 software with this option.
14640
14641 @item -mfpu
14642 @itemx -mhard-float
14643 @opindex mfpu
14644 @opindex mhard-float
14645 Generate output containing floating point instructions.  This is the
14646 default.
14647
14648 @item -mno-fpu
14649 @itemx -msoft-float
14650 @opindex mno-fpu
14651 @opindex msoft-float
14652 Generate output containing library calls for floating point.
14653 @strong{Warning:} the requisite libraries are not available for all SPARC
14654 targets.  Normally the facilities of the machine's usual C compiler are
14655 used, but this cannot be done directly in cross-compilation.  You must make
14656 your own arrangements to provide suitable library functions for
14657 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
14658 @samp{sparclite-*-*} do provide software floating point support.
14659
14660 @option{-msoft-float} changes the calling convention in the output file;
14661 therefore, it is only useful if you compile @emph{all} of a program with
14662 this option.  In particular, you need to compile @file{libgcc.a}, the
14663 library that comes with GCC, with @option{-msoft-float} in order for
14664 this to work.
14665
14666 @item -mhard-quad-float
14667 @opindex mhard-quad-float
14668 Generate output containing quad-word (long double) floating point
14669 instructions.
14670
14671 @item -msoft-quad-float
14672 @opindex msoft-quad-float
14673 Generate output containing library calls for quad-word (long double)
14674 floating point instructions.  The functions called are those specified
14675 in the SPARC ABI@.  This is the default.
14676
14677 As of this writing, there are no SPARC implementations that have hardware
14678 support for the quad-word floating point instructions.  They all invoke
14679 a trap handler for one of these instructions, and then the trap handler
14680 emulates the effect of the instruction.  Because of the trap handler overhead,
14681 this is much slower than calling the ABI library routines.  Thus the
14682 @option{-msoft-quad-float} option is the default.
14683
14684 @item -mno-unaligned-doubles
14685 @itemx -munaligned-doubles
14686 @opindex mno-unaligned-doubles
14687 @opindex munaligned-doubles
14688 Assume that doubles have 8 byte alignment.  This is the default.
14689
14690 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
14691 alignment only if they are contained in another type, or if they have an
14692 absolute address.  Otherwise, it assumes they have 4 byte alignment.
14693 Specifying this option avoids some rare compatibility problems with code
14694 generated by other compilers.  It is not the default because it results
14695 in a performance loss, especially for floating point code.
14696
14697 @item -mno-faster-structs
14698 @itemx -mfaster-structs
14699 @opindex mno-faster-structs
14700 @opindex mfaster-structs
14701 With @option{-mfaster-structs}, the compiler assumes that structures
14702 should have 8 byte alignment.  This enables the use of pairs of
14703 @code{ldd} and @code{std} instructions for copies in structure
14704 assignment, in place of twice as many @code{ld} and @code{st} pairs.
14705 However, the use of this changed alignment directly violates the SPARC
14706 ABI@.  Thus, it's intended only for use on targets where the developer
14707 acknowledges that their resulting code will not be directly in line with
14708 the rules of the ABI@.
14709
14710 @item -mimpure-text
14711 @opindex mimpure-text
14712 @option{-mimpure-text}, used in addition to @option{-shared}, tells
14713 the compiler to not pass @option{-z text} to the linker when linking a
14714 shared object.  Using this option, you can link position-dependent
14715 code into a shared object.
14716
14717 @option{-mimpure-text} suppresses the ``relocations remain against
14718 allocatable but non-writable sections'' linker error message.
14719 However, the necessary relocations will trigger copy-on-write, and the
14720 shared object is not actually shared across processes.  Instead of
14721 using @option{-mimpure-text}, you should compile all source code with
14722 @option{-fpic} or @option{-fPIC}.
14723
14724 This option is only available on SunOS and Solaris.
14725
14726 @item -mcpu=@var{cpu_type}
14727 @opindex mcpu
14728 Set the instruction set, register set, and instruction scheduling parameters
14729 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
14730 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
14731 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
14732 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
14733 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
14734
14735 Default instruction scheduling parameters are used for values that select
14736 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
14737 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
14738
14739 Here is a list of each supported architecture and their supported
14740 implementations.
14741
14742 @smallexample
14743     v7:             cypress
14744     v8:             supersparc, hypersparc
14745     sparclite:      f930, f934, sparclite86x
14746     sparclet:       tsc701
14747     v9:             ultrasparc, ultrasparc3, niagara, niagara2
14748 @end smallexample
14749
14750 By default (unless configured otherwise), GCC generates code for the V7
14751 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
14752 additionally optimizes it for the Cypress CY7C602 chip, as used in the
14753 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
14754 SPARCStation 1, 2, IPX etc.
14755
14756 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
14757 architecture.  The only difference from V7 code is that the compiler emits
14758 the integer multiply and integer divide instructions which exist in SPARC-V8
14759 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
14760 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
14761 2000 series.
14762
14763 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
14764 the SPARC architecture.  This adds the integer multiply, integer divide step
14765 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
14766 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
14767 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
14768 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
14769 MB86934 chip, which is the more recent SPARClite with FPU@.
14770
14771 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
14772 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
14773 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
14774 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
14775 optimizes it for the TEMIC SPARClet chip.
14776
14777 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
14778 architecture.  This adds 64-bit integer and floating-point move instructions,
14779 3 additional floating-point condition code registers and conditional move
14780 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
14781 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
14782 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
14783 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
14784 @option{-mcpu=niagara}, the compiler additionally optimizes it for
14785 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
14786 additionally optimizes it for Sun UltraSPARC T2 chips.
14787
14788 @item -mtune=@var{cpu_type}
14789 @opindex mtune
14790 Set the instruction scheduling parameters for machine type
14791 @var{cpu_type}, but do not set the instruction set or register set that the
14792 option @option{-mcpu=@var{cpu_type}} would.
14793
14794 The same values for @option{-mcpu=@var{cpu_type}} can be used for
14795 @option{-mtune=@var{cpu_type}}, but the only useful values are those
14796 that select a particular cpu implementation.  Those are @samp{cypress},
14797 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
14798 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
14799 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
14800
14801 @item -mv8plus
14802 @itemx -mno-v8plus
14803 @opindex mv8plus
14804 @opindex mno-v8plus
14805 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
14806 difference from the V8 ABI is that the global and out registers are
14807 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
14808 mode for all SPARC-V9 processors.
14809
14810 @item -mvis
14811 @itemx -mno-vis
14812 @opindex mvis
14813 @opindex mno-vis
14814 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
14815 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
14816 @end table
14817
14818 These @samp{-m} options are supported in addition to the above
14819 on SPARC-V9 processors in 64-bit environments:
14820
14821 @table @gcctabopt
14822 @item -mlittle-endian
14823 @opindex mlittle-endian
14824 Generate code for a processor running in little-endian mode.  It is only
14825 available for a few configurations and most notably not on Solaris and Linux.
14826
14827 @item -m32
14828 @itemx -m64
14829 @opindex m32
14830 @opindex m64
14831 Generate code for a 32-bit or 64-bit environment.
14832 The 32-bit environment sets int, long and pointer to 32 bits.
14833 The 64-bit environment sets int to 32 bits and long and pointer
14834 to 64 bits.
14835
14836 @item -mcmodel=medlow
14837 @opindex mcmodel=medlow
14838 Generate code for the Medium/Low code model: 64-bit addresses, programs
14839 must be linked in the low 32 bits of memory.  Programs can be statically
14840 or dynamically linked.
14841
14842 @item -mcmodel=medmid
14843 @opindex mcmodel=medmid
14844 Generate code for the Medium/Middle code model: 64-bit addresses, programs
14845 must be linked in the low 44 bits of memory, the text and data segments must
14846 be less than 2GB in size and the data segment must be located within 2GB of
14847 the text segment.
14848
14849 @item -mcmodel=medany
14850 @opindex mcmodel=medany
14851 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
14852 may be linked anywhere in memory, the text and data segments must be less
14853 than 2GB in size and the data segment must be located within 2GB of the
14854 text segment.
14855
14856 @item -mcmodel=embmedany
14857 @opindex mcmodel=embmedany
14858 Generate code for the Medium/Anywhere code model for embedded systems:
14859 64-bit addresses, the text and data segments must be less than 2GB in
14860 size, both starting anywhere in memory (determined at link time).  The
14861 global register %g4 points to the base of the data segment.  Programs
14862 are statically linked and PIC is not supported.
14863
14864 @item -mstack-bias
14865 @itemx -mno-stack-bias
14866 @opindex mstack-bias
14867 @opindex mno-stack-bias
14868 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
14869 frame pointer if present, are offset by @minus{}2047 which must be added back
14870 when making stack frame references.  This is the default in 64-bit mode.
14871 Otherwise, assume no such offset is present.
14872 @end table
14873
14874 These switches are supported in addition to the above on Solaris:
14875
14876 @table @gcctabopt
14877 @item -threads
14878 @opindex threads
14879 Add support for multithreading using the Solaris threads library.  This
14880 option sets flags for both the preprocessor and linker.  This option does
14881 not affect the thread safety of object code produced by the compiler or
14882 that of libraries supplied with it.
14883
14884 @item -pthreads
14885 @opindex pthreads
14886 Add support for multithreading using the POSIX threads library.  This
14887 option sets flags for both the preprocessor and linker.  This option does
14888 not affect the thread safety of object code produced  by the compiler or
14889 that of libraries supplied with it.
14890
14891 @item -pthread
14892 @opindex pthread
14893 This is a synonym for @option{-pthreads}.
14894 @end table
14895
14896 @node SPU Options
14897 @subsection SPU Options
14898 @cindex SPU options
14899
14900 These @samp{-m} options are supported on the SPU:
14901
14902 @table @gcctabopt
14903 @item -mwarn-reloc
14904 @itemx -merror-reloc
14905 @opindex mwarn-reloc
14906 @opindex merror-reloc
14907
14908 The loader for SPU does not handle dynamic relocations.  By default, GCC
14909 will give an error when it generates code that requires a dynamic
14910 relocation.  @option{-mno-error-reloc} disables the error,
14911 @option{-mwarn-reloc} will generate a warning instead.
14912
14913 @item -msafe-dma
14914 @itemx -munsafe-dma
14915 @opindex msafe-dma
14916 @opindex munsafe-dma
14917
14918 Instructions which initiate or test completion of DMA must not be
14919 reordered with respect to loads and stores of the memory which is being
14920 accessed.  Users typically address this problem using the volatile
14921 keyword, but that can lead to inefficient code in places where the
14922 memory is known to not change.  Rather than mark the memory as volatile
14923 we treat the DMA instructions as potentially effecting all memory.  With
14924 @option{-munsafe-dma} users must use the volatile keyword to protect
14925 memory accesses.
14926
14927 @item -mbranch-hints
14928 @opindex mbranch-hints
14929
14930 By default, GCC will generate a branch hint instruction to avoid
14931 pipeline stalls for always taken or probably taken branches.  A hint
14932 will not be generated closer than 8 instructions away from its branch.
14933 There is little reason to disable them, except for debugging purposes,
14934 or to make an object a little bit smaller.
14935
14936 @item -msmall-mem
14937 @itemx -mlarge-mem
14938 @opindex msmall-mem
14939 @opindex mlarge-mem
14940
14941 By default, GCC generates code assuming that addresses are never larger
14942 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
14943 a full 32 bit address.
14944
14945 @item -mstdmain
14946 @opindex mstdmain
14947
14948 By default, GCC links against startup code that assumes the SPU-style
14949 main function interface (which has an unconventional parameter list).
14950 With @option{-mstdmain}, GCC will link your program against startup
14951 code that assumes a C99-style interface to @code{main}, including a
14952 local copy of @code{argv} strings.
14953
14954 @item -mfixed-range=@var{register-range}
14955 @opindex mfixed-range
14956 Generate code treating the given register range as fixed registers.
14957 A fixed register is one that the register allocator can not use.  This is
14958 useful when compiling kernel code.  A register range is specified as
14959 two registers separated by a dash.  Multiple register ranges can be
14960 specified separated by a comma.
14961
14962 @item -mdual-nops
14963 @itemx -mdual-nops=@var{n}
14964 @opindex mdual-nops
14965 By default, GCC will insert nops to increase dual issue when it expects
14966 it to increase performance.  @var{n} can be a value from 0 to 10.  A
14967 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
14968 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
14969
14970 @item -mhint-max-nops=@var{n}
14971 @opindex mhint-max-nops
14972 Maximum number of nops to insert for a branch hint.  A branch hint must
14973 be at least 8 instructions away from the branch it is effecting.  GCC
14974 will insert up to @var{n} nops to enforce this, otherwise it will not
14975 generate the branch hint.
14976
14977 @item -mhint-max-distance=@var{n}
14978 @opindex mhint-max-distance
14979 The encoding of the branch hint instruction limits the hint to be within
14980 256 instructions of the branch it is effecting.  By default, GCC makes
14981 sure it is within 125. 
14982
14983 @item -msafe-hints
14984 @opindex msafe-hints
14985 Work around a hardware bug which causes the SPU to stall indefinitely.
14986 By default, GCC will insert the @code{hbrp} instruction to make sure
14987 this stall won't happen.
14988
14989 @end table
14990
14991 @node System V Options
14992 @subsection Options for System V
14993
14994 These additional options are available on System V Release 4 for
14995 compatibility with other compilers on those systems:
14996
14997 @table @gcctabopt
14998 @item -G
14999 @opindex G
15000 Create a shared object.
15001 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
15002
15003 @item -Qy
15004 @opindex Qy
15005 Identify the versions of each tool used by the compiler, in a
15006 @code{.ident} assembler directive in the output.
15007
15008 @item -Qn
15009 @opindex Qn
15010 Refrain from adding @code{.ident} directives to the output file (this is
15011 the default).
15012
15013 @item -YP,@var{dirs}
15014 @opindex YP
15015 Search the directories @var{dirs}, and no others, for libraries
15016 specified with @option{-l}.
15017
15018 @item -Ym,@var{dir}
15019 @opindex Ym
15020 Look in the directory @var{dir} to find the M4 preprocessor.
15021 The assembler uses this option.
15022 @c This is supposed to go with a -Yd for predefined M4 macro files, but
15023 @c the generic assembler that comes with Solaris takes just -Ym.
15024 @end table
15025
15026 @node V850 Options
15027 @subsection V850 Options
15028 @cindex V850 Options
15029
15030 These @samp{-m} options are defined for V850 implementations:
15031
15032 @table @gcctabopt
15033 @item -mlong-calls
15034 @itemx -mno-long-calls
15035 @opindex mlong-calls
15036 @opindex mno-long-calls
15037 Treat all calls as being far away (near).  If calls are assumed to be
15038 far away, the compiler will always load the functions address up into a
15039 register, and call indirect through the pointer.
15040
15041 @item -mno-ep
15042 @itemx -mep
15043 @opindex mno-ep
15044 @opindex mep
15045 Do not optimize (do optimize) basic blocks that use the same index
15046 pointer 4 or more times to copy pointer into the @code{ep} register, and
15047 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
15048 option is on by default if you optimize.
15049
15050 @item -mno-prolog-function
15051 @itemx -mprolog-function
15052 @opindex mno-prolog-function
15053 @opindex mprolog-function
15054 Do not use (do use) external functions to save and restore registers
15055 at the prologue and epilogue of a function.  The external functions
15056 are slower, but use less code space if more than one function saves
15057 the same number of registers.  The @option{-mprolog-function} option
15058 is on by default if you optimize.
15059
15060 @item -mspace
15061 @opindex mspace
15062 Try to make the code as small as possible.  At present, this just turns
15063 on the @option{-mep} and @option{-mprolog-function} options.
15064
15065 @item -mtda=@var{n}
15066 @opindex mtda
15067 Put static or global variables whose size is @var{n} bytes or less into
15068 the tiny data area that register @code{ep} points to.  The tiny data
15069 area can hold up to 256 bytes in total (128 bytes for byte references).
15070
15071 @item -msda=@var{n}
15072 @opindex msda
15073 Put static or global variables whose size is @var{n} bytes or less into
15074 the small data area that register @code{gp} points to.  The small data
15075 area can hold up to 64 kilobytes.
15076
15077 @item -mzda=@var{n}
15078 @opindex mzda
15079 Put static or global variables whose size is @var{n} bytes or less into
15080 the first 32 kilobytes of memory.
15081
15082 @item -mv850
15083 @opindex mv850
15084 Specify that the target processor is the V850.
15085
15086 @item -mbig-switch
15087 @opindex mbig-switch
15088 Generate code suitable for big switch tables.  Use this option only if
15089 the assembler/linker complain about out of range branches within a switch
15090 table.
15091
15092 @item -mapp-regs
15093 @opindex mapp-regs
15094 This option will cause r2 and r5 to be used in the code generated by
15095 the compiler.  This setting is the default.
15096
15097 @item -mno-app-regs
15098 @opindex mno-app-regs
15099 This option will cause r2 and r5 to be treated as fixed registers.
15100
15101 @item -mv850e1
15102 @opindex mv850e1
15103 Specify that the target processor is the V850E1.  The preprocessor
15104 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
15105 this option is used.
15106
15107 @item -mv850e
15108 @opindex mv850e
15109 Specify that the target processor is the V850E@.  The preprocessor
15110 constant @samp{__v850e__} will be defined if this option is used.
15111
15112 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
15113 are defined then a default target processor will be chosen and the
15114 relevant @samp{__v850*__} preprocessor constant will be defined.
15115
15116 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
15117 defined, regardless of which processor variant is the target.
15118
15119 @item -mdisable-callt
15120 @opindex mdisable-callt
15121 This option will suppress generation of the CALLT instruction for the
15122 v850e and v850e1 flavors of the v850 architecture.  The default is
15123 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
15124
15125 @end table
15126
15127 @node VAX Options
15128 @subsection VAX Options
15129 @cindex VAX options
15130
15131 These @samp{-m} options are defined for the VAX:
15132
15133 @table @gcctabopt
15134 @item -munix
15135 @opindex munix
15136 Do not output certain jump instructions (@code{aobleq} and so on)
15137 that the Unix assembler for the VAX cannot handle across long
15138 ranges.
15139
15140 @item -mgnu
15141 @opindex mgnu
15142 Do output those jump instructions, on the assumption that you
15143 will assemble with the GNU assembler.
15144
15145 @item -mg
15146 @opindex mg
15147 Output code for g-format floating point numbers instead of d-format.
15148 @end table
15149
15150 @node VxWorks Options
15151 @subsection VxWorks Options
15152 @cindex VxWorks Options
15153
15154 The options in this section are defined for all VxWorks targets.
15155 Options specific to the target hardware are listed with the other
15156 options for that target.
15157
15158 @table @gcctabopt
15159 @item -mrtp
15160 @opindex mrtp
15161 GCC can generate code for both VxWorks kernels and real time processes
15162 (RTPs).  This option switches from the former to the latter.  It also
15163 defines the preprocessor macro @code{__RTP__}.
15164
15165 @item -non-static
15166 @opindex non-static
15167 Link an RTP executable against shared libraries rather than static
15168 libraries.  The options @option{-static} and @option{-shared} can
15169 also be used for RTPs (@pxref{Link Options}); @option{-static}
15170 is the default.
15171
15172 @item -Bstatic
15173 @itemx -Bdynamic
15174 @opindex Bstatic
15175 @opindex Bdynamic
15176 These options are passed down to the linker.  They are defined for
15177 compatibility with Diab.
15178
15179 @item -Xbind-lazy
15180 @opindex Xbind-lazy
15181 Enable lazy binding of function calls.  This option is equivalent to
15182 @option{-Wl,-z,now} and is defined for compatibility with Diab.
15183
15184 @item -Xbind-now
15185 @opindex Xbind-now
15186 Disable lazy binding of function calls.  This option is the default and
15187 is defined for compatibility with Diab.
15188 @end table
15189
15190 @node x86-64 Options
15191 @subsection x86-64 Options
15192 @cindex x86-64 options
15193
15194 These are listed under @xref{i386 and x86-64 Options}.
15195
15196 @node Xstormy16 Options
15197 @subsection Xstormy16 Options
15198 @cindex Xstormy16 Options
15199
15200 These options are defined for Xstormy16:
15201
15202 @table @gcctabopt
15203 @item -msim
15204 @opindex msim
15205 Choose startup files and linker script suitable for the simulator.
15206 @end table
15207
15208 @node Xtensa Options
15209 @subsection Xtensa Options
15210 @cindex Xtensa Options
15211
15212 These options are supported for Xtensa targets:
15213
15214 @table @gcctabopt
15215 @item -mconst16
15216 @itemx -mno-const16
15217 @opindex mconst16
15218 @opindex mno-const16
15219 Enable or disable use of @code{CONST16} instructions for loading
15220 constant values.  The @code{CONST16} instruction is currently not a
15221 standard option from Tensilica.  When enabled, @code{CONST16}
15222 instructions are always used in place of the standard @code{L32R}
15223 instructions.  The use of @code{CONST16} is enabled by default only if
15224 the @code{L32R} instruction is not available.
15225
15226 @item -mfused-madd
15227 @itemx -mno-fused-madd
15228 @opindex mfused-madd
15229 @opindex mno-fused-madd
15230 Enable or disable use of fused multiply/add and multiply/subtract
15231 instructions in the floating-point option.  This has no effect if the
15232 floating-point option is not also enabled.  Disabling fused multiply/add
15233 and multiply/subtract instructions forces the compiler to use separate
15234 instructions for the multiply and add/subtract operations.  This may be
15235 desirable in some cases where strict IEEE 754-compliant results are
15236 required: the fused multiply add/subtract instructions do not round the
15237 intermediate result, thereby producing results with @emph{more} bits of
15238 precision than specified by the IEEE standard.  Disabling fused multiply
15239 add/subtract instructions also ensures that the program output is not
15240 sensitive to the compiler's ability to combine multiply and add/subtract
15241 operations.
15242
15243 @item -mserialize-volatile
15244 @itemx -mno-serialize-volatile
15245 @opindex mserialize-volatile
15246 @opindex mno-serialize-volatile
15247 When this option is enabled, GCC inserts @code{MEMW} instructions before
15248 @code{volatile} memory references to guarantee sequential consistency.
15249 The default is @option{-mserialize-volatile}.  Use
15250 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
15251
15252 @item -mtext-section-literals
15253 @itemx -mno-text-section-literals
15254 @opindex mtext-section-literals
15255 @opindex mno-text-section-literals
15256 Control the treatment of literal pools.  The default is
15257 @option{-mno-text-section-literals}, which places literals in a separate
15258 section in the output file.  This allows the literal pool to be placed
15259 in a data RAM/ROM, and it also allows the linker to combine literal
15260 pools from separate object files to remove redundant literals and
15261 improve code size.  With @option{-mtext-section-literals}, the literals
15262 are interspersed in the text section in order to keep them as close as
15263 possible to their references.  This may be necessary for large assembly
15264 files.
15265
15266 @item -mtarget-align
15267 @itemx -mno-target-align
15268 @opindex mtarget-align
15269 @opindex mno-target-align
15270 When this option is enabled, GCC instructs the assembler to
15271 automatically align instructions to reduce branch penalties at the
15272 expense of some code density.  The assembler attempts to widen density
15273 instructions to align branch targets and the instructions following call
15274 instructions.  If there are not enough preceding safe density
15275 instructions to align a target, no widening will be performed.  The
15276 default is @option{-mtarget-align}.  These options do not affect the
15277 treatment of auto-aligned instructions like @code{LOOP}, which the
15278 assembler will always align, either by widening density instructions or
15279 by inserting no-op instructions.
15280
15281 @item -mlongcalls
15282 @itemx -mno-longcalls
15283 @opindex mlongcalls
15284 @opindex mno-longcalls
15285 When this option is enabled, GCC instructs the assembler to translate
15286 direct calls to indirect calls unless it can determine that the target
15287 of a direct call is in the range allowed by the call instruction.  This
15288 translation typically occurs for calls to functions in other source
15289 files.  Specifically, the assembler translates a direct @code{CALL}
15290 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
15291 The default is @option{-mno-longcalls}.  This option should be used in
15292 programs where the call target can potentially be out of range.  This
15293 option is implemented in the assembler, not the compiler, so the
15294 assembly code generated by GCC will still show direct call
15295 instructions---look at the disassembled object code to see the actual
15296 instructions.  Note that the assembler will use an indirect call for
15297 every cross-file call, not just those that really will be out of range.
15298 @end table
15299
15300 @node zSeries Options
15301 @subsection zSeries Options
15302 @cindex zSeries options
15303
15304 These are listed under @xref{S/390 and zSeries Options}.
15305
15306 @node Code Gen Options
15307 @section Options for Code Generation Conventions
15308 @cindex code generation conventions
15309 @cindex options, code generation
15310 @cindex run-time options
15311
15312 These machine-independent options control the interface conventions
15313 used in code generation.
15314
15315 Most of them have both positive and negative forms; the negative form
15316 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
15317 one of the forms is listed---the one which is not the default.  You
15318 can figure out the other form by either removing @samp{no-} or adding
15319 it.
15320
15321 @table @gcctabopt
15322 @item -fbounds-check
15323 @opindex fbounds-check
15324 For front-ends that support it, generate additional code to check that
15325 indices used to access arrays are within the declared range.  This is
15326 currently only supported by the Java and Fortran front-ends, where
15327 this option defaults to true and false respectively.
15328
15329 @item -ftrapv
15330 @opindex ftrapv
15331 This option generates traps for signed overflow on addition, subtraction,
15332 multiplication operations.
15333
15334 @item -fwrapv
15335 @opindex fwrapv
15336 This option instructs the compiler to assume that signed arithmetic
15337 overflow of addition, subtraction and multiplication wraps around
15338 using twos-complement representation.  This flag enables some optimizations
15339 and disables others.  This option is enabled by default for the Java
15340 front-end, as required by the Java language specification.
15341
15342 @item -fexceptions
15343 @opindex fexceptions
15344 Enable exception handling.  Generates extra code needed to propagate
15345 exceptions.  For some targets, this implies GCC will generate frame
15346 unwind information for all functions, which can produce significant data
15347 size overhead, although it does not affect execution.  If you do not
15348 specify this option, GCC will enable it by default for languages like
15349 C++ which normally require exception handling, and disable it for
15350 languages like C that do not normally require it.  However, you may need
15351 to enable this option when compiling C code that needs to interoperate
15352 properly with exception handlers written in C++.  You may also wish to
15353 disable this option if you are compiling older C++ programs that don't
15354 use exception handling.
15355
15356 @item -fnon-call-exceptions
15357 @opindex fnon-call-exceptions
15358 Generate code that allows trapping instructions to throw exceptions.
15359 Note that this requires platform-specific runtime support that does
15360 not exist everywhere.  Moreover, it only allows @emph{trapping}
15361 instructions to throw exceptions, i.e.@: memory references or floating
15362 point instructions.  It does not allow exceptions to be thrown from
15363 arbitrary signal handlers such as @code{SIGALRM}.
15364
15365 @item -funwind-tables
15366 @opindex funwind-tables
15367 Similar to @option{-fexceptions}, except that it will just generate any needed
15368 static data, but will not affect the generated code in any other way.
15369 You will normally not enable this option; instead, a language processor
15370 that needs this handling would enable it on your behalf.
15371
15372 @item -fasynchronous-unwind-tables
15373 @opindex fasynchronous-unwind-tables
15374 Generate unwind table in dwarf2 format, if supported by target machine.  The
15375 table is exact at each instruction boundary, so it can be used for stack
15376 unwinding from asynchronous events (such as debugger or garbage collector).
15377
15378 @item -fpcc-struct-return
15379 @opindex fpcc-struct-return
15380 Return ``short'' @code{struct} and @code{union} values in memory like
15381 longer ones, rather than in registers.  This convention is less
15382 efficient, but it has the advantage of allowing intercallability between
15383 GCC-compiled files and files compiled with other compilers, particularly
15384 the Portable C Compiler (pcc).
15385
15386 The precise convention for returning structures in memory depends
15387 on the target configuration macros.
15388
15389 Short structures and unions are those whose size and alignment match
15390 that of some integer type.
15391
15392 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
15393 switch is not binary compatible with code compiled with the
15394 @option{-freg-struct-return} switch.
15395 Use it to conform to a non-default application binary interface.
15396
15397 @item -freg-struct-return
15398 @opindex freg-struct-return
15399 Return @code{struct} and @code{union} values in registers when possible.
15400 This is more efficient for small structures than
15401 @option{-fpcc-struct-return}.
15402
15403 If you specify neither @option{-fpcc-struct-return} nor
15404 @option{-freg-struct-return}, GCC defaults to whichever convention is
15405 standard for the target.  If there is no standard convention, GCC
15406 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
15407 the principal compiler.  In those cases, we can choose the standard, and
15408 we chose the more efficient register return alternative.
15409
15410 @strong{Warning:} code compiled with the @option{-freg-struct-return}
15411 switch is not binary compatible with code compiled with the
15412 @option{-fpcc-struct-return} switch.
15413 Use it to conform to a non-default application binary interface.
15414
15415 @item -fshort-enums
15416 @opindex fshort-enums
15417 Allocate to an @code{enum} type only as many bytes as it needs for the
15418 declared range of possible values.  Specifically, the @code{enum} type
15419 will be equivalent to the smallest integer type which has enough room.
15420
15421 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
15422 code that is not binary compatible with code generated without that switch.
15423 Use it to conform to a non-default application binary interface.
15424
15425 @item -fshort-double
15426 @opindex fshort-double
15427 Use the same size for @code{double} as for @code{float}.
15428
15429 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
15430 code that is not binary compatible with code generated without that switch.
15431 Use it to conform to a non-default application binary interface.
15432
15433 @item -fshort-wchar
15434 @opindex fshort-wchar
15435 Override the underlying type for @samp{wchar_t} to be @samp{short
15436 unsigned int} instead of the default for the target.  This option is
15437 useful for building programs to run under WINE@.
15438
15439 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
15440 code that is not binary compatible with code generated without that switch.
15441 Use it to conform to a non-default application binary interface.
15442
15443 @item -fno-common
15444 @opindex fno-common
15445 In C, allocate even uninitialized global variables in the data section of the
15446 object file, rather than generating them as common blocks.  This has the
15447 effect that if the same variable is declared (without @code{extern}) in
15448 two different compilations, you will get an error when you link them.
15449 The only reason this might be useful is if you wish to verify that the
15450 program will work on other systems which always work this way.
15451
15452 @item -fno-ident
15453 @opindex fno-ident
15454 Ignore the @samp{#ident} directive.
15455
15456 @item -finhibit-size-directive
15457 @opindex finhibit-size-directive
15458 Don't output a @code{.size} assembler directive, or anything else that
15459 would cause trouble if the function is split in the middle, and the
15460 two halves are placed at locations far apart in memory.  This option is
15461 used when compiling @file{crtstuff.c}; you should not need to use it
15462 for anything else.
15463
15464 @item -fverbose-asm
15465 @opindex fverbose-asm
15466 Put extra commentary information in the generated assembly code to
15467 make it more readable.  This option is generally only of use to those
15468 who actually need to read the generated assembly code (perhaps while
15469 debugging the compiler itself).
15470
15471 @option{-fno-verbose-asm}, the default, causes the
15472 extra information to be omitted and is useful when comparing two assembler
15473 files.
15474
15475 @item -frecord-gcc-switches
15476 @opindex frecord-gcc-switches
15477 This switch causes the command line that was used to invoke the
15478 compiler to be recorded into the object file that is being created.
15479 This switch is only implemented on some targets and the exact format
15480 of the recording is target and binary file format dependent, but it
15481 usually takes the form of a section containing ASCII text.  This
15482 switch is related to the @option{-fverbose-asm} switch, but that
15483 switch only records information in the assembler output file as
15484 comments, so it never reaches the object file.
15485
15486 @item -fpic
15487 @opindex fpic
15488 @cindex global offset table
15489 @cindex PIC
15490 Generate position-independent code (PIC) suitable for use in a shared
15491 library, if supported for the target machine.  Such code accesses all
15492 constant addresses through a global offset table (GOT)@.  The dynamic
15493 loader resolves the GOT entries when the program starts (the dynamic
15494 loader is not part of GCC; it is part of the operating system).  If
15495 the GOT size for the linked executable exceeds a machine-specific
15496 maximum size, you get an error message from the linker indicating that
15497 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
15498 instead.  (These maximums are 8k on the SPARC and 32k
15499 on the m68k and RS/6000.  The 386 has no such limit.)
15500
15501 Position-independent code requires special support, and therefore works
15502 only on certain machines.  For the 386, GCC supports PIC for System V
15503 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
15504 position-independent.
15505
15506 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15507 are defined to 1.
15508
15509 @item -fPIC
15510 @opindex fPIC
15511 If supported for the target machine, emit position-independent code,
15512 suitable for dynamic linking and avoiding any limit on the size of the
15513 global offset table.  This option makes a difference on the m68k,
15514 PowerPC and SPARC@.
15515
15516 Position-independent code requires special support, and therefore works
15517 only on certain machines.
15518
15519 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15520 are defined to 2.
15521
15522 @item -fpie
15523 @itemx -fPIE
15524 @opindex fpie
15525 @opindex fPIE
15526 These options are similar to @option{-fpic} and @option{-fPIC}, but
15527 generated position independent code can be only linked into executables.
15528 Usually these options are used when @option{-pie} GCC option will be
15529 used during linking.
15530
15531 @option{-fpie} and @option{-fPIE} both define the macros
15532 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
15533 for @option{-fpie} and 2 for @option{-fPIE}.
15534
15535 @item -fno-jump-tables
15536 @opindex fno-jump-tables
15537 Do not use jump tables for switch statements even where it would be
15538 more efficient than other code generation strategies.  This option is
15539 of use in conjunction with @option{-fpic} or @option{-fPIC} for
15540 building code which forms part of a dynamic linker and cannot
15541 reference the address of a jump table.  On some targets, jump tables
15542 do not require a GOT and this option is not needed.
15543
15544 @item -ffixed-@var{reg}
15545 @opindex ffixed
15546 Treat the register named @var{reg} as a fixed register; generated code
15547 should never refer to it (except perhaps as a stack pointer, frame
15548 pointer or in some other fixed role).
15549
15550 @var{reg} must be the name of a register.  The register names accepted
15551 are machine-specific and are defined in the @code{REGISTER_NAMES}
15552 macro in the machine description macro file.
15553
15554 This flag does not have a negative form, because it specifies a
15555 three-way choice.
15556
15557 @item -fcall-used-@var{reg}
15558 @opindex fcall-used
15559 Treat the register named @var{reg} as an allocable register that is
15560 clobbered by function calls.  It may be allocated for temporaries or
15561 variables that do not live across a call.  Functions compiled this way
15562 will not save and restore the register @var{reg}.
15563
15564 It is an error to used this flag with the frame pointer or stack pointer.
15565 Use of this flag for other registers that have fixed pervasive roles in
15566 the machine's execution model will produce disastrous results.
15567
15568 This flag does not have a negative form, because it specifies a
15569 three-way choice.
15570
15571 @item -fcall-saved-@var{reg}
15572 @opindex fcall-saved
15573 Treat the register named @var{reg} as an allocable register saved by
15574 functions.  It may be allocated even for temporaries or variables that
15575 live across a call.  Functions compiled this way will save and restore
15576 the register @var{reg} if they use it.
15577
15578 It is an error to used this flag with the frame pointer or stack pointer.
15579 Use of this flag for other registers that have fixed pervasive roles in
15580 the machine's execution model will produce disastrous results.
15581
15582 A different sort of disaster will result from the use of this flag for
15583 a register in which function values may be returned.
15584
15585 This flag does not have a negative form, because it specifies a
15586 three-way choice.
15587
15588 @item -fpack-struct[=@var{n}]
15589 @opindex fpack-struct
15590 Without a value specified, pack all structure members together without
15591 holes.  When a value is specified (which must be a small power of two), pack
15592 structure members according to this value, representing the maximum
15593 alignment (that is, objects with default alignment requirements larger than
15594 this will be output potentially unaligned at the next fitting location.
15595
15596 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
15597 code that is not binary compatible with code generated without that switch.
15598 Additionally, it makes the code suboptimal.
15599 Use it to conform to a non-default application binary interface.
15600
15601 @item -finstrument-functions
15602 @opindex finstrument-functions
15603 Generate instrumentation calls for entry and exit to functions.  Just
15604 after function entry and just before function exit, the following
15605 profiling functions will be called with the address of the current
15606 function and its call site.  (On some platforms,
15607 @code{__builtin_return_address} does not work beyond the current
15608 function, so the call site information may not be available to the
15609 profiling functions otherwise.)
15610
15611 @smallexample
15612 void __cyg_profile_func_enter (void *this_fn,
15613                                void *call_site);
15614 void __cyg_profile_func_exit  (void *this_fn,
15615                                void *call_site);
15616 @end smallexample
15617
15618 The first argument is the address of the start of the current function,
15619 which may be looked up exactly in the symbol table.
15620
15621 This instrumentation is also done for functions expanded inline in other
15622 functions.  The profiling calls will indicate where, conceptually, the
15623 inline function is entered and exited.  This means that addressable
15624 versions of such functions must be available.  If all your uses of a
15625 function are expanded inline, this may mean an additional expansion of
15626 code size.  If you use @samp{extern inline} in your C code, an
15627 addressable version of such functions must be provided.  (This is
15628 normally the case anyways, but if you get lucky and the optimizer always
15629 expands the functions inline, you might have gotten away without
15630 providing static copies.)
15631
15632 A function may be given the attribute @code{no_instrument_function}, in
15633 which case this instrumentation will not be done.  This can be used, for
15634 example, for the profiling functions listed above, high-priority
15635 interrupt routines, and any functions from which the profiling functions
15636 cannot safely be called (perhaps signal handlers, if the profiling
15637 routines generate output or allocate memory).
15638
15639 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
15640 @opindex finstrument-functions-exclude-file-list
15641
15642 Set the list of functions that are excluded from instrumentation (see
15643 the description of @code{-finstrument-functions}).  If the file that
15644 contains a function definition matches with one of @var{file}, then
15645 that function is not instrumented.  The match is done on substrings:
15646 if the @var{file} parameter is a substring of the file name, it is
15647 considered to be a match.
15648
15649 For example,
15650 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
15651 will exclude any inline function defined in files whose pathnames
15652 contain @code{/bits/stl} or @code{include/sys}.
15653
15654 If, for some reason, you want to include letter @code{','} in one of
15655 @var{sym}, write @code{'\,'}. For example,
15656 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
15657 (note the single quote surrounding the option).
15658
15659 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
15660 @opindex finstrument-functions-exclude-function-list
15661
15662 This is similar to @code{-finstrument-functions-exclude-file-list},
15663 but this option sets the list of function names to be excluded from
15664 instrumentation.  The function name to be matched is its user-visible
15665 name, such as @code{vector<int> blah(const vector<int> &)}, not the
15666 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
15667 match is done on substrings: if the @var{sym} parameter is a substring
15668 of the function name, it is considered to be a match.
15669
15670 @item -fstack-check
15671 @opindex fstack-check
15672 Generate code to verify that you do not go beyond the boundary of the
15673 stack.  You should specify this flag if you are running in an
15674 environment with multiple threads, but only rarely need to specify it in
15675 a single-threaded environment since stack overflow is automatically
15676 detected on nearly all systems if there is only one stack.
15677
15678 Note that this switch does not actually cause checking to be done; the
15679 operating system or the language runtime must do that.  The switch causes
15680 generation of code to ensure that they see the stack being extended.
15681
15682 You can additionally specify a string parameter: @code{no} means no
15683 checking, @code{generic} means force the use of old-style checking,
15684 @code{specific} means use the best checking method and is equivalent
15685 to bare @option{-fstack-check}.
15686
15687 Old-style checking is a generic mechanism that requires no specific
15688 target support in the compiler but comes with the following drawbacks:
15689
15690 @enumerate
15691 @item
15692 Modified allocation strategy for large objects: they will always be
15693 allocated dynamically if their size exceeds a fixed threshold.
15694
15695 @item
15696 Fixed limit on the size of the static frame of functions: when it is
15697 topped by a particular function, stack checking is not reliable and
15698 a warning is issued by the compiler.
15699
15700 @item
15701 Inefficiency: because of both the modified allocation strategy and the
15702 generic implementation, the performances of the code are hampered.
15703 @end enumerate
15704
15705 Note that old-style stack checking is also the fallback method for
15706 @code{specific} if no target support has been added in the compiler.
15707
15708 @item -fstack-limit-register=@var{reg}
15709 @itemx -fstack-limit-symbol=@var{sym}
15710 @itemx -fno-stack-limit
15711 @opindex fstack-limit-register
15712 @opindex fstack-limit-symbol
15713 @opindex fno-stack-limit
15714 Generate code to ensure that the stack does not grow beyond a certain value,
15715 either the value of a register or the address of a symbol.  If the stack
15716 would grow beyond the value, a signal is raised.  For most targets,
15717 the signal is raised before the stack overruns the boundary, so
15718 it is possible to catch the signal without taking special precautions.
15719
15720 For instance, if the stack starts at absolute address @samp{0x80000000}
15721 and grows downwards, you can use the flags
15722 @option{-fstack-limit-symbol=__stack_limit} and
15723 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
15724 of 128KB@.  Note that this may only work with the GNU linker.
15725
15726 @cindex aliasing of parameters
15727 @cindex parameters, aliased
15728 @item -fargument-alias
15729 @itemx -fargument-noalias
15730 @itemx -fargument-noalias-global
15731 @itemx -fargument-noalias-anything
15732 @opindex fargument-alias
15733 @opindex fargument-noalias
15734 @opindex fargument-noalias-global
15735 @opindex fargument-noalias-anything
15736 Specify the possible relationships among parameters and between
15737 parameters and global data.
15738
15739 @option{-fargument-alias} specifies that arguments (parameters) may
15740 alias each other and may alias global storage.@*
15741 @option{-fargument-noalias} specifies that arguments do not alias
15742 each other, but may alias global storage.@*
15743 @option{-fargument-noalias-global} specifies that arguments do not
15744 alias each other and do not alias global storage.
15745 @option{-fargument-noalias-anything} specifies that arguments do not
15746 alias any other storage.
15747
15748 Each language will automatically use whatever option is required by
15749 the language standard.  You should not need to use these options yourself.
15750
15751 @item -fleading-underscore
15752 @opindex fleading-underscore
15753 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
15754 change the way C symbols are represented in the object file.  One use
15755 is to help link with legacy assembly code.
15756
15757 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
15758 generate code that is not binary compatible with code generated without that
15759 switch.  Use it to conform to a non-default application binary interface.
15760 Not all targets provide complete support for this switch.
15761
15762 @item -ftls-model=@var{model}
15763 @opindex ftls-model
15764 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
15765 The @var{model} argument should be one of @code{global-dynamic},
15766 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
15767
15768 The default without @option{-fpic} is @code{initial-exec}; with
15769 @option{-fpic} the default is @code{global-dynamic}.
15770
15771 @item -fvisibility=@var{default|internal|hidden|protected}
15772 @opindex fvisibility
15773 Set the default ELF image symbol visibility to the specified option---all
15774 symbols will be marked with this unless overridden within the code.
15775 Using this feature can very substantially improve linking and
15776 load times of shared object libraries, produce more optimized
15777 code, provide near-perfect API export and prevent symbol clashes.
15778 It is @strong{strongly} recommended that you use this in any shared objects
15779 you distribute.
15780
15781 Despite the nomenclature, @code{default} always means public ie;
15782 available to be linked against from outside the shared object.
15783 @code{protected} and @code{internal} are pretty useless in real-world
15784 usage so the only other commonly used option will be @code{hidden}.
15785 The default if @option{-fvisibility} isn't specified is
15786 @code{default}, i.e., make every
15787 symbol public---this causes the same behavior as previous versions of
15788 GCC@.
15789
15790 A good explanation of the benefits offered by ensuring ELF
15791 symbols have the correct visibility is given by ``How To Write
15792 Shared Libraries'' by Ulrich Drepper (which can be found at
15793 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
15794 solution made possible by this option to marking things hidden when
15795 the default is public is to make the default hidden and mark things
15796 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
15797 and @code{__attribute__ ((visibility("default")))} instead of
15798 @code{__declspec(dllexport)} you get almost identical semantics with
15799 identical syntax.  This is a great boon to those working with
15800 cross-platform projects.
15801
15802 For those adding visibility support to existing code, you may find
15803 @samp{#pragma GCC visibility} of use.  This works by you enclosing
15804 the declarations you wish to set visibility for with (for example)
15805 @samp{#pragma GCC visibility push(hidden)} and
15806 @samp{#pragma GCC visibility pop}.
15807 Bear in mind that symbol visibility should be viewed @strong{as
15808 part of the API interface contract} and thus all new code should
15809 always specify visibility when it is not the default ie; declarations
15810 only for use within the local DSO should @strong{always} be marked explicitly
15811 as hidden as so to avoid PLT indirection overheads---making this
15812 abundantly clear also aids readability and self-documentation of the code.
15813 Note that due to ISO C++ specification requirements, operator new and
15814 operator delete must always be of default visibility.
15815
15816 Be aware that headers from outside your project, in particular system
15817 headers and headers from any other library you use, may not be
15818 expecting to be compiled with visibility other than the default.  You
15819 may need to explicitly say @samp{#pragma GCC visibility push(default)}
15820 before including any such headers.
15821
15822 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
15823 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
15824 no modifications.  However, this means that calls to @samp{extern}
15825 functions with no explicit visibility will use the PLT, so it is more
15826 effective to use @samp{__attribute ((visibility))} and/or
15827 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
15828 declarations should be treated as hidden.
15829
15830 Note that @samp{-fvisibility} does affect C++ vague linkage
15831 entities. This means that, for instance, an exception class that will
15832 be thrown between DSOs must be explicitly marked with default
15833 visibility so that the @samp{type_info} nodes will be unified between
15834 the DSOs.
15835
15836 An overview of these techniques, their benefits and how to use them
15837 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
15838
15839 @end table
15840
15841 @c man end
15842
15843 @node Environment Variables
15844 @section Environment Variables Affecting GCC
15845 @cindex environment variables
15846
15847 @c man begin ENVIRONMENT
15848 This section describes several environment variables that affect how GCC
15849 operates.  Some of them work by specifying directories or prefixes to use
15850 when searching for various kinds of files.  Some are used to specify other
15851 aspects of the compilation environment.
15852
15853 Note that you can also specify places to search using options such as
15854 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
15855 take precedence over places specified using environment variables, which
15856 in turn take precedence over those specified by the configuration of GCC@.
15857 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
15858 GNU Compiler Collection (GCC) Internals}.
15859
15860 @table @env
15861 @item LANG
15862 @itemx LC_CTYPE
15863 @c @itemx LC_COLLATE
15864 @itemx LC_MESSAGES
15865 @c @itemx LC_MONETARY
15866 @c @itemx LC_NUMERIC
15867 @c @itemx LC_TIME
15868 @itemx LC_ALL
15869 @findex LANG
15870 @findex LC_CTYPE
15871 @c @findex LC_COLLATE
15872 @findex LC_MESSAGES
15873 @c @findex LC_MONETARY
15874 @c @findex LC_NUMERIC
15875 @c @findex LC_TIME
15876 @findex LC_ALL
15877 @cindex locale
15878 These environment variables control the way that GCC uses
15879 localization information that allow GCC to work with different
15880 national conventions.  GCC inspects the locale categories
15881 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
15882 so.  These locale categories can be set to any value supported by your
15883 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
15884 Kingdom encoded in UTF-8.
15885
15886 The @env{LC_CTYPE} environment variable specifies character
15887 classification.  GCC uses it to determine the character boundaries in
15888 a string; this is needed for some multibyte encodings that contain quote
15889 and escape characters that would otherwise be interpreted as a string
15890 end or escape.
15891
15892 The @env{LC_MESSAGES} environment variable specifies the language to
15893 use in diagnostic messages.
15894
15895 If the @env{LC_ALL} environment variable is set, it overrides the value
15896 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
15897 and @env{LC_MESSAGES} default to the value of the @env{LANG}
15898 environment variable.  If none of these variables are set, GCC
15899 defaults to traditional C English behavior.
15900
15901 @item TMPDIR
15902 @findex TMPDIR
15903 If @env{TMPDIR} is set, it specifies the directory to use for temporary
15904 files.  GCC uses temporary files to hold the output of one stage of
15905 compilation which is to be used as input to the next stage: for example,
15906 the output of the preprocessor, which is the input to the compiler
15907 proper.
15908
15909 @item GCC_EXEC_PREFIX
15910 @findex GCC_EXEC_PREFIX
15911 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
15912 names of the subprograms executed by the compiler.  No slash is added
15913 when this prefix is combined with the name of a subprogram, but you can
15914 specify a prefix that ends with a slash if you wish.
15915
15916 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
15917 an appropriate prefix to use based on the pathname it was invoked with.
15918
15919 If GCC cannot find the subprogram using the specified prefix, it
15920 tries looking in the usual places for the subprogram.
15921
15922 The default value of @env{GCC_EXEC_PREFIX} is
15923 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
15924 the installed compiler. In many cases @var{prefix} is the value
15925 of @code{prefix} when you ran the @file{configure} script.
15926
15927 Other prefixes specified with @option{-B} take precedence over this prefix.
15928
15929 This prefix is also used for finding files such as @file{crt0.o} that are
15930 used for linking.
15931
15932 In addition, the prefix is used in an unusual way in finding the
15933 directories to search for header files.  For each of the standard
15934 directories whose name normally begins with @samp{/usr/local/lib/gcc}
15935 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
15936 replacing that beginning with the specified prefix to produce an
15937 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
15938 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
15939 These alternate directories are searched first; the standard directories
15940 come next. If a standard directory begins with the configured
15941 @var{prefix} then the value of @var{prefix} is replaced by
15942 @env{GCC_EXEC_PREFIX} when looking for header files.
15943
15944 @item COMPILER_PATH
15945 @findex COMPILER_PATH
15946 The value of @env{COMPILER_PATH} is a colon-separated list of
15947 directories, much like @env{PATH}.  GCC tries the directories thus
15948 specified when searching for subprograms, if it can't find the
15949 subprograms using @env{GCC_EXEC_PREFIX}.
15950
15951 @item LIBRARY_PATH
15952 @findex LIBRARY_PATH
15953 The value of @env{LIBRARY_PATH} is a colon-separated list of
15954 directories, much like @env{PATH}.  When configured as a native compiler,
15955 GCC tries the directories thus specified when searching for special
15956 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
15957 using GCC also uses these directories when searching for ordinary
15958 libraries for the @option{-l} option (but directories specified with
15959 @option{-L} come first).
15960
15961 @item LANG
15962 @findex LANG
15963 @cindex locale definition
15964 This variable is used to pass locale information to the compiler.  One way in
15965 which this information is used is to determine the character set to be used
15966 when character literals, string literals and comments are parsed in C and C++.
15967 When the compiler is configured to allow multibyte characters,
15968 the following values for @env{LANG} are recognized:
15969
15970 @table @samp
15971 @item C-JIS
15972 Recognize JIS characters.
15973 @item C-SJIS
15974 Recognize SJIS characters.
15975 @item C-EUCJP
15976 Recognize EUCJP characters.
15977 @end table
15978
15979 If @env{LANG} is not defined, or if it has some other value, then the
15980 compiler will use mblen and mbtowc as defined by the default locale to
15981 recognize and translate multibyte characters.
15982 @end table
15983
15984 @noindent
15985 Some additional environments variables affect the behavior of the
15986 preprocessor.
15987
15988 @include cppenv.texi
15989
15990 @c man end
15991
15992 @node Precompiled Headers
15993 @section Using Precompiled Headers
15994 @cindex precompiled headers
15995 @cindex speed of compilation
15996
15997 Often large projects have many header files that are included in every
15998 source file.  The time the compiler takes to process these header files
15999 over and over again can account for nearly all of the time required to
16000 build the project.  To make builds faster, GCC allows users to
16001 `precompile' a header file; then, if builds can use the precompiled
16002 header file they will be much faster.
16003
16004 To create a precompiled header file, simply compile it as you would any
16005 other file, if necessary using the @option{-x} option to make the driver
16006 treat it as a C or C++ header file.  You will probably want to use a
16007 tool like @command{make} to keep the precompiled header up-to-date when
16008 the headers it contains change.
16009
16010 A precompiled header file will be searched for when @code{#include} is
16011 seen in the compilation.  As it searches for the included file
16012 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
16013 compiler looks for a precompiled header in each directory just before it
16014 looks for the include file in that directory.  The name searched for is
16015 the name specified in the @code{#include} with @samp{.gch} appended.  If
16016 the precompiled header file can't be used, it is ignored.
16017
16018 For instance, if you have @code{#include "all.h"}, and you have
16019 @file{all.h.gch} in the same directory as @file{all.h}, then the
16020 precompiled header file will be used if possible, and the original
16021 header will be used otherwise.
16022
16023 Alternatively, you might decide to put the precompiled header file in a
16024 directory and use @option{-I} to ensure that directory is searched
16025 before (or instead of) the directory containing the original header.
16026 Then, if you want to check that the precompiled header file is always
16027 used, you can put a file of the same name as the original header in this
16028 directory containing an @code{#error} command.
16029
16030 This also works with @option{-include}.  So yet another way to use
16031 precompiled headers, good for projects not designed with precompiled
16032 header files in mind, is to simply take most of the header files used by
16033 a project, include them from another header file, precompile that header
16034 file, and @option{-include} the precompiled header.  If the header files
16035 have guards against multiple inclusion, they will be skipped because
16036 they've already been included (in the precompiled header).
16037
16038 If you need to precompile the same header file for different
16039 languages, targets, or compiler options, you can instead make a
16040 @emph{directory} named like @file{all.h.gch}, and put each precompiled
16041 header in the directory, perhaps using @option{-o}.  It doesn't matter
16042 what you call the files in the directory, every precompiled header in
16043 the directory will be considered.  The first precompiled header
16044 encountered in the directory that is valid for this compilation will
16045 be used; they're searched in no particular order.
16046
16047 There are many other possibilities, limited only by your imagination,
16048 good sense, and the constraints of your build system.
16049
16050 A precompiled header file can be used only when these conditions apply:
16051
16052 @itemize
16053 @item
16054 Only one precompiled header can be used in a particular compilation.
16055
16056 @item
16057 A precompiled header can't be used once the first C token is seen.  You
16058 can have preprocessor directives before a precompiled header; you can
16059 even include a precompiled header from inside another header, so long as
16060 there are no C tokens before the @code{#include}.
16061
16062 @item
16063 The precompiled header file must be produced for the same language as
16064 the current compilation.  You can't use a C precompiled header for a C++
16065 compilation.
16066
16067 @item
16068 The precompiled header file must have been produced by the same compiler
16069 binary as the current compilation is using.
16070
16071 @item
16072 Any macros defined before the precompiled header is included must
16073 either be defined in the same way as when the precompiled header was
16074 generated, or must not affect the precompiled header, which usually
16075 means that they don't appear in the precompiled header at all.
16076
16077 The @option{-D} option is one way to define a macro before a
16078 precompiled header is included; using a @code{#define} can also do it.
16079 There are also some options that define macros implicitly, like
16080 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
16081 defined this way.
16082
16083 @item If debugging information is output when using the precompiled
16084 header, using @option{-g} or similar, the same kind of debugging information
16085 must have been output when building the precompiled header.  However,
16086 a precompiled header built using @option{-g} can be used in a compilation
16087 when no debugging information is being output.
16088
16089 @item The same @option{-m} options must generally be used when building
16090 and using the precompiled header.  @xref{Submodel Options},
16091 for any cases where this rule is relaxed.
16092
16093 @item Each of the following options must be the same when building and using
16094 the precompiled header:
16095
16096 @gccoptlist{-fexceptions}
16097
16098 @item
16099 Some other command-line options starting with @option{-f},
16100 @option{-p}, or @option{-O} must be defined in the same way as when
16101 the precompiled header was generated.  At present, it's not clear
16102 which options are safe to change and which are not; the safest choice
16103 is to use exactly the same options when generating and using the
16104 precompiled header.  The following are known to be safe:
16105
16106 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
16107 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
16108 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
16109 -pedantic-errors}
16110
16111 @end itemize
16112
16113 For all of these except the last, the compiler will automatically
16114 ignore the precompiled header if the conditions aren't met.  If you
16115 find an option combination that doesn't work and doesn't cause the
16116 precompiled header to be ignored, please consider filing a bug report,
16117 see @ref{Bugs}.
16118
16119 If you do use differing options when generating and using the
16120 precompiled header, the actual behavior will be a mixture of the
16121 behavior for the options.  For instance, if you use @option{-g} to
16122 generate the precompiled header but not when using it, you may or may
16123 not get debugging information for routines in the precompiled header.
16124
16125 @node Running Protoize
16126 @section Running Protoize
16127
16128 The program @code{protoize} is an optional part of GCC@.  You can use
16129 it to add prototypes to a program, thus converting the program to ISO
16130 C in one respect.  The companion program @code{unprotoize} does the
16131 reverse: it removes argument types from any prototypes that are found.
16132
16133 When you run these programs, you must specify a set of source files as
16134 command line arguments.  The conversion programs start out by compiling
16135 these files to see what functions they define.  The information gathered
16136 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
16137
16138 After scanning comes actual conversion.  The specified files are all
16139 eligible to be converted; any files they include (whether sources or
16140 just headers) are eligible as well.
16141
16142 But not all the eligible files are converted.  By default,
16143 @code{protoize} and @code{unprotoize} convert only source and header
16144 files in the current directory.  You can specify additional directories
16145 whose files should be converted with the @option{-d @var{directory}}
16146 option.  You can also specify particular files to exclude with the
16147 @option{-x @var{file}} option.  A file is converted if it is eligible, its
16148 directory name matches one of the specified directory names, and its
16149 name within the directory has not been excluded.
16150
16151 Basic conversion with @code{protoize} consists of rewriting most
16152 function definitions and function declarations to specify the types of
16153 the arguments.  The only ones not rewritten are those for varargs
16154 functions.
16155
16156 @code{protoize} optionally inserts prototype declarations at the
16157 beginning of the source file, to make them available for any calls that
16158 precede the function's definition.  Or it can insert prototype
16159 declarations with block scope in the blocks where undeclared functions
16160 are called.
16161
16162 Basic conversion with @code{unprotoize} consists of rewriting most
16163 function declarations to remove any argument types, and rewriting
16164 function definitions to the old-style pre-ISO form.
16165
16166 Both conversion programs print a warning for any function declaration or
16167 definition that they can't convert.  You can suppress these warnings
16168 with @option{-q}.
16169
16170 The output from @code{protoize} or @code{unprotoize} replaces the
16171 original source file.  The original file is renamed to a name ending
16172 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
16173 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
16174 for DOS) file already exists, then the source file is simply discarded.
16175
16176 @code{protoize} and @code{unprotoize} both depend on GCC itself to
16177 scan the program and collect information about the functions it uses.
16178 So neither of these programs will work until GCC is installed.
16179
16180 Here is a table of the options you can use with @code{protoize} and
16181 @code{unprotoize}.  Each option works with both programs unless
16182 otherwise stated.
16183
16184 @table @code
16185 @item -B @var{directory}
16186 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
16187 usual directory (normally @file{/usr/local/lib}).  This file contains
16188 prototype information about standard system functions.  This option
16189 applies only to @code{protoize}.
16190
16191 @item -c @var{compilation-options}
16192 Use @var{compilation-options} as the options when running @command{gcc} to
16193 produce the @samp{.X} files.  The special option @option{-aux-info} is
16194 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
16195
16196 Note that the compilation options must be given as a single argument to
16197 @code{protoize} or @code{unprotoize}.  If you want to specify several
16198 @command{gcc} options, you must quote the entire set of compilation options
16199 to make them a single word in the shell.
16200
16201 There are certain @command{gcc} arguments that you cannot use, because they
16202 would produce the wrong kind of output.  These include @option{-g},
16203 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
16204 the @var{compilation-options}, they are ignored.
16205
16206 @item -C
16207 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
16208 systems) instead of @samp{.c}.  This is convenient if you are converting
16209 a C program to C++.  This option applies only to @code{protoize}.
16210
16211 @item -g
16212 Add explicit global declarations.  This means inserting explicit
16213 declarations at the beginning of each source file for each function
16214 that is called in the file and was not declared.  These declarations
16215 precede the first function definition that contains a call to an
16216 undeclared function.  This option applies only to @code{protoize}.
16217
16218 @item -i @var{string}
16219 Indent old-style parameter declarations with the string @var{string}.
16220 This option applies only to @code{protoize}.
16221
16222 @code{unprotoize} converts prototyped function definitions to old-style
16223 function definitions, where the arguments are declared between the
16224 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
16225 uses five spaces as the indentation.  If you want to indent with just
16226 one space instead, use @option{-i " "}.
16227
16228 @item -k
16229 Keep the @samp{.X} files.  Normally, they are deleted after conversion
16230 is finished.
16231
16232 @item -l
16233 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
16234 a prototype declaration for each function in each block which calls the
16235 function without any declaration.  This option applies only to
16236 @code{protoize}.
16237
16238 @item -n
16239 Make no real changes.  This mode just prints information about the conversions
16240 that would have been done without @option{-n}.
16241
16242 @item -N
16243 Make no @samp{.save} files.  The original files are simply deleted.
16244 Use this option with caution.
16245
16246 @item -p @var{program}
16247 Use the program @var{program} as the compiler.  Normally, the name
16248 @file{gcc} is used.
16249
16250 @item -q
16251 Work quietly.  Most warnings are suppressed.
16252
16253 @item -v
16254 Print the version number, just like @option{-v} for @command{gcc}.
16255 @end table
16256
16257 If you need special compiler options to compile one of your program's
16258 source files, then you should generate that file's @samp{.X} file
16259 specially, by running @command{gcc} on that source file with the
16260 appropriate options and the option @option{-aux-info}.  Then run
16261 @code{protoize} on the entire set of files.  @code{protoize} will use
16262 the existing @samp{.X} file because it is newer than the source file.
16263 For example:
16264
16265 @smallexample
16266 gcc -Dfoo=bar file1.c -aux-info file1.X
16267 protoize *.c
16268 @end smallexample
16269
16270 @noindent
16271 You need to include the special files along with the rest in the
16272 @code{protoize} command, even though their @samp{.X} files already
16273 exist, because otherwise they won't get converted.
16274
16275 @xref{Protoize Caveats}, for more information on how to use
16276 @code{protoize} successfully.