OSDN Git Service

2008-07-08 Raksit Ashok <raksit@google.com>
[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{-dr} is very different from @w{@samp{-d
101 -r}}.
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 -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
232 -Wchar-subscripts -Wclobbered  -Wcomment @gol
233 -Wconversion  -Wcoverage-mismatch  -Wno-deprecated  @gol
234 -Wno-deprecated-declarations -Wdisabled-optimization  -Wno-div-by-zero  @gol
235 -Wempty-body  -Wenum-compare -Wno-endif-labels @gol
236 -Werror  -Werror=* @gol
237 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
238 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
239 -Wformat-security  -Wformat-y2k @gol
240 -Wframe-larger-than=@var{len} -Wignored-qualifiers @gol
241 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
242 -Winit-self  -Winline @gol
243 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
244 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
245 -Wlogical-op -Wlong-long @gol
246 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
247 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
248 -Wmissing-noreturn  -Wno-mudflap @gol
249 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
250 -Woverlength-strings  -Wpacked  -Wpadded @gol
251 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
252 -Wredundant-decls @gol
253 -Wreturn-type  -Wsequence-point  -Wshadow @gol
254 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
255 -Wstrict-aliasing -Wstrict-aliasing=n @gol
256 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
257 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
258 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
259 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
260 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
261 -Wunused-value  -Wunused-variable @gol
262 -Wvariadic-macros -Wvla @gol
263 -Wvolatile-register-var  -Wwrite-strings}
264
265 @item C and Objective-C-only Warning Options
266 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
267 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
268 -Wold-style-declaration  -Wold-style-definition @gol
269 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
270 -Wdeclaration-after-statement -Wpointer-sign}
271
272 @item Debugging Options
273 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
274 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
275 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
276 -fdump-noaddr -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
277 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
278 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
279 -fdump-statistics @gol
280 -fdump-tree-all @gol
281 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
282 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
283 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
284 -fdump-tree-ch @gol
285 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
286 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
289 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-nrv -fdump-tree-vect @gol
294 -fdump-tree-sink @gol
295 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
298 -ftree-vectorizer-verbose=@var{n} @gol
299 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
300 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
301 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
302 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
303 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
304 -ftest-coverage  -ftime-report -fvar-tracking @gol
305 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
306 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
307 -fno-merge-debug-strings -fdebug-prefix-map=@var{old}=@var{new} @gol
308 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
309 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
310 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
311 -print-multi-directory  -print-multi-lib @gol
312 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
313 -print-sysroot -print-sysroot-headers-suffix @gol
314 -save-temps  -time}
315
316 @item Optimization Options
317 @xref{Optimize Options,,Options that Control Optimization}.
318 @gccoptlist{
319 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
320 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
321 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
322 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
323 -fcheck-data-deps -fcprop-registers -fcrossjumping -fcse-follow-jumps @gol
324 -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
325 -fdata-sections -fdce -fdce @gol
326 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
327 -fearly-inlining -fexpensive-optimizations -ffast-math @gol
328 -ffinite-math-only -ffloat-store -fforward-propagate @gol
329 -ffunction-sections -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
330 -fgcse-sm -fif-conversion -fif-conversion2 -finline-functions @gol
331 -finline-functions-called-once -finline-limit=@var{n} @gol
332 -finline-small-functions -fipa-cp -fipa-marix-reorg -fipa-pta @gol 
333 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
334 -fipa-type-escape -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
335 -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
336 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
337 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
338 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
339 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
340 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
341 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
342 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
343 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
344 -fprofile-dir=@var{path} -fprofile-generate -fprofile-generate=@var{path} @gol
345 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
346 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
347 -freorder-blocks-and-partition -freorder-functions @gol
348 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
349 -frounding-math -frtl-abstract-sequences -fsched2-use-superblocks @gol
350 -fsched2-use-traces -fsched-spec-load -fsched-spec-load-dangerous @gol
351 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
352 -fschedule-insns -fschedule-insns2 -fsection-anchors -fsee @gol
353 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
354 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
355 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
356 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
357 -ftree-copyrename -ftree-dce @gol
358 -ftree-dominator-opts -ftree-dse -ftree-fre -ftree-loop-im @gol
359 -ftree-loop-distribution @gol
360 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
361 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-reassoc @gol
362 -ftree-sink -ftree-sra -ftree-store-ccp -ftree-switch-conversion @gol
363 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
364 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
365 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
366 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
367 -fwhole-program @gol
368 --param @var{name}=@var{value}
369 -O  -O0  -O1  -O2  -O3  -Os}
370
371 @item Preprocessor Options
372 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
373 @gccoptlist{-A@var{question}=@var{answer} @gol
374 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
375 -C  -dD  -dI  -dM  -dN @gol
376 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
377 -idirafter @var{dir} @gol
378 -include @var{file}  -imacros @var{file} @gol
379 -iprefix @var{file}  -iwithprefix @var{dir} @gol
380 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
381 -imultilib @var{dir} -isysroot @var{dir} @gol
382 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
383 -P  -fworking-directory  -remap @gol
384 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
385 -Xpreprocessor @var{option}}
386
387 @item Assembler Option
388 @xref{Assembler Options,,Passing Options to the Assembler}.
389 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
390
391 @item Linker Options
392 @xref{Link Options,,Options for Linking}.
393 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
394 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
395 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
396 -Wl,@var{option}  -Xlinker @var{option} @gol
397 -u @var{symbol}}
398
399 @item Directory Options
400 @xref{Directory Options,,Options for Directory Search}.
401 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
402 -specs=@var{file}  -I- --sysroot=@var{dir}}
403
404 @item Target Options
405 @c I wrote this xref this way to avoid overfull hbox. -- rms
406 @xref{Target Options}.
407 @gccoptlist{-V @var{version}  -b @var{machine}}
408
409 @item Machine Dependent Options
410 @xref{Submodel Options,,Hardware Models and Configurations}.
411 @c This list is ordered alphanumerically by subsection name.
412 @c Try and put the significant identifier (CPU or system) first,
413 @c so users have a clue at guessing where the ones they want will be.
414
415 @emph{ARC Options}
416 @gccoptlist{-EB  -EL @gol
417 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
418 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
419
420 @emph{ARM Options}
421 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
422 -mabi=@var{name} @gol
423 -mapcs-stack-check  -mno-apcs-stack-check @gol
424 -mapcs-float  -mno-apcs-float @gol
425 -mapcs-reentrant  -mno-apcs-reentrant @gol
426 -msched-prolog  -mno-sched-prolog @gol
427 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
428 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
429 -mthumb-interwork  -mno-thumb-interwork @gol
430 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
431 -mstructure-size-boundary=@var{n} @gol
432 -mabort-on-noreturn @gol
433 -mlong-calls  -mno-long-calls @gol
434 -msingle-pic-base  -mno-single-pic-base @gol
435 -mpic-register=@var{reg} @gol
436 -mnop-fun-dllimport @gol
437 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
438 -mpoke-function-name @gol
439 -mthumb  -marm @gol
440 -mtpcs-frame  -mtpcs-leaf-frame @gol
441 -mcaller-super-interworking  -mcallee-super-interworking @gol
442 -mtp=@var{name}}
443
444 @emph{AVR Options}
445 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
446 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
447
448 @emph{Blackfin Options}
449 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
450 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
451 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
452 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
453 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
454 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
455 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
456 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram}
457
458 @emph{CRIS Options}
459 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
460 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
461 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
462 -mstack-align  -mdata-align  -mconst-align @gol
463 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
464 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
465 -mmul-bug-workaround  -mno-mul-bug-workaround}
466
467 @emph{CRX Options}
468 @gccoptlist{-mmac -mpush-args}
469
470 @emph{Darwin Options}
471 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
472 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
473 -client_name  -compatibility_version  -current_version @gol
474 -dead_strip @gol
475 -dependency-file  -dylib_file  -dylinker_install_name @gol
476 -dynamic  -dynamiclib  -exported_symbols_list @gol
477 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
478 -force_flat_namespace  -headerpad_max_install_names @gol
479 -iframework @gol
480 -image_base  -init  -install_name  -keep_private_externs @gol
481 -multi_module  -multiply_defined  -multiply_defined_unused @gol
482 -noall_load   -no_dead_strip_inits_and_terms @gol
483 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
484 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
485 -private_bundle  -read_only_relocs  -sectalign @gol
486 -sectobjectsymbols  -whyload  -seg1addr @gol
487 -sectcreate  -sectobjectsymbols  -sectorder @gol
488 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
489 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
490 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
491 -single_module  -static  -sub_library  -sub_umbrella @gol
492 -twolevel_namespace  -umbrella  -undefined @gol
493 -unexported_symbols_list  -weak_reference_mismatches @gol
494 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
495 -mkernel -mone-byte-bool}
496
497 @emph{DEC Alpha Options}
498 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
499 -mieee  -mieee-with-inexact  -mieee-conformant @gol
500 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
501 -mtrap-precision=@var{mode}  -mbuild-constants @gol
502 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
503 -mbwx  -mmax  -mfix  -mcix @gol
504 -mfloat-vax  -mfloat-ieee @gol
505 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
506 -msmall-text  -mlarge-text @gol
507 -mmemory-latency=@var{time}}
508
509 @emph{DEC Alpha/VMS Options}
510 @gccoptlist{-mvms-return-codes}
511
512 @emph{FRV Options}
513 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
514 -mhard-float  -msoft-float @gol
515 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
516 -mdouble  -mno-double @gol
517 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
518 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
519 -mlinked-fp  -mlong-calls  -malign-labels @gol
520 -mlibrary-pic  -macc-4  -macc-8 @gol
521 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
522 -moptimize-membar -mno-optimize-membar @gol
523 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
524 -mvliw-branch  -mno-vliw-branch @gol
525 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
526 -mno-nested-cond-exec  -mtomcat-stats @gol
527 -mTLS -mtls @gol
528 -mcpu=@var{cpu}}
529
530 @emph{GNU/Linux Options}
531 @gccoptlist{-muclibc}
532
533 @emph{H8/300 Options}
534 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
535
536 @emph{HPPA Options}
537 @gccoptlist{-march=@var{architecture-type} @gol
538 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
539 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
540 -mfixed-range=@var{register-range} @gol
541 -mjump-in-delay -mlinker-opt -mlong-calls @gol
542 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
543 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
544 -mno-jump-in-delay  -mno-long-load-store @gol
545 -mno-portable-runtime  -mno-soft-float @gol
546 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
547 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
548 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
549 -munix=@var{unix-std}  -nolibdld  -static  -threads}
550
551 @emph{i386 and x86-64 Options}
552 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
553 -mfpmath=@var{unit} @gol
554 -masm=@var{dialect}  -mno-fancy-math-387 @gol
555 -mno-fp-ret-in-387  -msoft-float @gol
556 -mno-wide-multiply  -mrtd  -malign-double @gol
557 -mpreferred-stack-boundary=@var{num} -mcld -mcx16 -msahf -mrecip @gol
558 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 @gol
559 -maes -mpclmul @gol
560 -msse4a -m3dnow -mpopcnt -mabm -msse5 @gol
561 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
562 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
563 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
564 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
565 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
566 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
567 -mcmodel=@var{code-model} @gol
568 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
569 -mfused-madd -mno-fused-madd}
570
571 @emph{IA-64 Options}
572 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
573 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
574 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
575 -minline-float-divide-max-throughput @gol
576 -minline-int-divide-min-latency @gol
577 -minline-int-divide-max-throughput  @gol
578 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
579 -mno-dwarf2-asm -mearly-stop-bits @gol
580 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
581 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
582 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
583 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
584 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
585 -mno-sched-prefer-non-data-spec-insns @gol
586 -mno-sched-prefer-non-control-spec-insns @gol
587 -mno-sched-count-spec-in-critical-path}
588
589 @emph{M32R/D Options}
590 @gccoptlist{-m32r2 -m32rx -m32r @gol
591 -mdebug @gol
592 -malign-loops -mno-align-loops @gol
593 -missue-rate=@var{number} @gol
594 -mbranch-cost=@var{number} @gol
595 -mmodel=@var{code-size-model-type} @gol
596 -msdata=@var{sdata-type} @gol
597 -mno-flush-func -mflush-func=@var{name} @gol
598 -mno-flush-trap -mflush-trap=@var{number} @gol
599 -G @var{num}}
600
601 @emph{M32C Options}
602 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
603
604 @emph{M680x0 Options}
605 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
606 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
607 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
608 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
609 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
610 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
611 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
612 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
613 -mxgot -mno-xgot}
614
615 @emph{M68hc1x Options}
616 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
617 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
618 -msoft-reg-count=@var{count}}
619
620 @emph{MCore Options}
621 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
622 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
623 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
624 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
625 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
626
627 @emph{MIPS Options}
628 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
629 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
630 -mips16  -mno-mips16  -mflip-mips16 @gol
631 -minterlink-mips16  -mno-interlink-mips16 @gol
632 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
633 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64 @gol
634 -mfp32  -mfp64  -mhard-float  -msoft-float @gol
635 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
636 -msmartmips  -mno-smartmips @gol
637 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
638 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
639 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
640 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
641 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
642 -membedded-data  -mno-embedded-data @gol
643 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
644 -mcode-readable=@var{setting} @gol
645 -msplit-addresses  -mno-split-addresses @gol
646 -mexplicit-relocs  -mno-explicit-relocs @gol
647 -mcheck-zero-division  -mno-check-zero-division @gol
648 -mdivide-traps  -mdivide-breaks @gol
649 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
650 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
651 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
652 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130  -mno-fix-vr4130 @gol
653 -mfix-sb1  -mno-fix-sb1 @gol
654 -mflush-func=@var{func}  -mno-flush-func @gol
655 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
656 -mfp-exceptions -mno-fp-exceptions @gol
657 -mvr4130-align -mno-vr4130-align}
658
659 @emph{MMIX Options}
660 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
661 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
662 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
663 -mno-base-addresses  -msingle-exit  -mno-single-exit}
664
665 @emph{MN10300 Options}
666 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
667 -mam33  -mno-am33 @gol
668 -mam33-2  -mno-am33-2 @gol
669 -mreturn-pointer-on-d0 @gol
670 -mno-crt0  -mrelax}
671
672 @emph{PDP-11 Options}
673 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
674 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
675 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
676 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
677 -mbranch-expensive  -mbranch-cheap @gol
678 -msplit  -mno-split  -munix-asm  -mdec-asm}
679
680 @emph{PowerPC Options}
681 See RS/6000 and PowerPC Options.
682
683 @emph{RS/6000 and PowerPC Options}
684 @gccoptlist{-mcpu=@var{cpu-type} @gol
685 -mtune=@var{cpu-type} @gol
686 -mpower  -mno-power  -mpower2  -mno-power2 @gol
687 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
688 -maltivec  -mno-altivec @gol
689 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
690 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
691 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
692 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
693 -mnew-mnemonics  -mold-mnemonics @gol
694 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
695 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
696 -malign-power  -malign-natural @gol
697 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
698 -mstring  -mno-string  -mupdate  -mno-update @gol
699 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
700 -mstrict-align  -mno-strict-align  -mrelocatable @gol
701 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
702 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
703 -mdynamic-no-pic  -maltivec  -mswdiv @gol
704 -mprioritize-restricted-insns=@var{priority} @gol
705 -msched-costly-dep=@var{dependence_type} @gol
706 -minsert-sched-nops=@var{scheme} @gol
707 -mcall-sysv  -mcall-netbsd @gol
708 -maix-struct-return  -msvr4-struct-return @gol
709 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
710 -misel -mno-isel @gol
711 -misel=yes  -misel=no @gol
712 -mspe -mno-spe @gol
713 -mspe=yes  -mspe=no @gol
714 -mpaired @gol
715 -mvrsave -mno-vrsave @gol
716 -mmulhw -mno-mulhw @gol
717 -mdlmzb -mno-dlmzb @gol
718 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
719 -mprototype  -mno-prototype @gol
720 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
721 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
722
723 @emph{S/390 and zSeries Options}
724 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
725 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
726 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
727 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
728 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
729 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
730 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
731
732 @emph{Score Options}
733 @gccoptlist{-meb -mel @gol
734 -mnhwloop @gol
735 -muls @gol
736 -mmac @gol
737 -mscore5 -mscore5u -mscore7 -mscore7d}
738
739 @emph{SH Options}
740 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
741 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
742 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
743 -m5-64media  -m5-64media-nofpu @gol
744 -m5-32media  -m5-32media-nofpu @gol
745 -m5-compact  -m5-compact-nofpu @gol
746 -mb  -ml  -mdalign  -mrelax @gol
747 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
748 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
749 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
750 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
751 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
752 -minvalid-symbols}
753
754 @emph{SPARC Options}
755 @gccoptlist{-mcpu=@var{cpu-type} @gol
756 -mtune=@var{cpu-type} @gol
757 -mcmodel=@var{code-model} @gol
758 -m32  -m64  -mapp-regs  -mno-app-regs @gol
759 -mfaster-structs  -mno-faster-structs @gol
760 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
761 -mhard-quad-float  -msoft-quad-float @gol
762 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
763 -mstack-bias  -mno-stack-bias @gol
764 -munaligned-doubles  -mno-unaligned-doubles @gol
765 -mv8plus  -mno-v8plus  -mvis  -mno-vis
766 -threads -pthreads -pthread}
767
768 @emph{SPU Options}
769 @gccoptlist{-mwarn-reloc -merror-reloc @gol
770 -msafe-dma -munsafe-dma @gol
771 -mbranch-hints @gol
772 -msmall-mem -mlarge-mem -mstdmain @gol
773 -mfixed-range=@var{register-range}}
774
775 @emph{System V Options}
776 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
777
778 @emph{V850 Options}
779 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
780 -mprolog-function  -mno-prolog-function  -mspace @gol
781 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
782 -mapp-regs  -mno-app-regs @gol
783 -mdisable-callt  -mno-disable-callt @gol
784 -mv850e1 @gol
785 -mv850e @gol
786 -mv850  -mbig-switch}
787
788 @emph{VAX Options}
789 @gccoptlist{-mg  -mgnu  -munix}
790
791 @emph{VxWorks Options}
792 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
793 -Xbind-lazy  -Xbind-now}
794
795 @emph{x86-64 Options}
796 See i386 and x86-64 Options.
797
798 @emph{Xstormy16 Options}
799 @gccoptlist{-msim}
800
801 @emph{Xtensa Options}
802 @gccoptlist{-mconst16 -mno-const16 @gol
803 -mfused-madd  -mno-fused-madd @gol
804 -mserialize-volatile  -mno-serialize-volatile @gol
805 -mtext-section-literals  -mno-text-section-literals @gol
806 -mtarget-align  -mno-target-align @gol
807 -mlongcalls  -mno-longcalls}
808
809 @emph{zSeries Options}
810 See S/390 and zSeries Options.
811
812 @item Code Generation Options
813 @xref{Code Gen Options,,Options for Code Generation Conventions}.
814 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
815 -ffixed-@var{reg}  -fexceptions @gol
816 -fnon-call-exceptions  -funwind-tables @gol
817 -fasynchronous-unwind-tables @gol
818 -finhibit-size-directive  -finstrument-functions @gol
819 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
820 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
821 -fno-common  -fno-ident @gol
822 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
823 -fno-jump-tables @gol
824 -frecord-gcc-switches @gol
825 -freg-struct-return  -fshort-enums @gol
826 -fshort-double  -fshort-wchar @gol
827 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
828 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
829 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
830 -fargument-noalias-global  -fargument-noalias-anything @gol
831 -fleading-underscore  -ftls-model=@var{model} @gol
832 -ftrapv  -fwrapv  -fbounds-check @gol
833 -fvisibility}
834 @end table
835
836 @menu
837 * Overall Options::     Controlling the kind of output:
838                         an executable, object files, assembler files,
839                         or preprocessed source.
840 * C Dialect Options::   Controlling the variant of C language compiled.
841 * C++ Dialect Options:: Variations on C++.
842 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
843                         and Objective-C++.
844 * Language Independent Options:: Controlling how diagnostics should be
845                         formatted.
846 * Warning Options::     How picky should the compiler be?
847 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
848 * Optimize Options::    How much optimization?
849 * Preprocessor Options:: Controlling header files and macro definitions.
850                          Also, getting dependency information for Make.
851 * Assembler Options::   Passing options to the assembler.
852 * Link Options::        Specifying libraries and so on.
853 * Directory Options::   Where to find header files and libraries.
854                         Where to find the compiler executable files.
855 * Spec Files::          How to pass switches to sub-processes.
856 * Target Options::      Running a cross-compiler, or an old version of GCC.
857 @end menu
858
859 @node Overall Options
860 @section Options Controlling the Kind of Output
861
862 Compilation can involve up to four stages: preprocessing, compilation
863 proper, assembly and linking, always in that order.  GCC is capable of
864 preprocessing and compiling several files either into several
865 assembler input files, or into one assembler input file; then each
866 assembler input file produces an object file, and linking combines all
867 the object files (those newly compiled, and those specified as input)
868 into an executable file.
869
870 @cindex file name suffix
871 For any given input file, the file name suffix determines what kind of
872 compilation is done:
873
874 @table @gcctabopt
875 @item @var{file}.c
876 C source code which must be preprocessed.
877
878 @item @var{file}.i
879 C source code which should not be preprocessed.
880
881 @item @var{file}.ii
882 C++ source code which should not be preprocessed.
883
884 @item @var{file}.m
885 Objective-C source code.  Note that you must link with the @file{libobjc}
886 library to make an Objective-C program work.
887
888 @item @var{file}.mi
889 Objective-C source code which should not be preprocessed.
890
891 @item @var{file}.mm
892 @itemx @var{file}.M
893 Objective-C++ source code.  Note that you must link with the @file{libobjc}
894 library to make an Objective-C++ program work.  Note that @samp{.M} refers
895 to a literal capital M@.
896
897 @item @var{file}.mii
898 Objective-C++ source code which should not be preprocessed.
899
900 @item @var{file}.h
901 C, C++, Objective-C or Objective-C++ header file to be turned into a
902 precompiled header.
903
904 @item @var{file}.cc
905 @itemx @var{file}.cp
906 @itemx @var{file}.cxx
907 @itemx @var{file}.cpp
908 @itemx @var{file}.CPP
909 @itemx @var{file}.c++
910 @itemx @var{file}.C
911 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
912 the last two letters must both be literally @samp{x}.  Likewise,
913 @samp{.C} refers to a literal capital C@.
914
915 @item @var{file}.mm
916 @itemx @var{file}.M
917 Objective-C++ source code which must be preprocessed.
918
919 @item @var{file}.mii
920 Objective-C++ source code which should not be preprocessed.
921
922 @item @var{file}.hh
923 @itemx @var{file}.H
924 @itemx @var{file}.hp
925 @itemx @var{file}.hxx
926 @itemx @var{file}.hpp
927 @itemx @var{file}.HPP
928 @itemx @var{file}.h++
929 @itemx @var{file}.tcc
930 C++ header file to be turned into a precompiled header.
931
932 @item @var{file}.f
933 @itemx @var{file}.for
934 @itemx @var{file}.ftn
935 Fixed form Fortran source code which should not be preprocessed.
936
937 @item @var{file}.F
938 @itemx @var{file}.FOR
939 @itemx @var{file}.fpp
940 @itemx @var{file}.FPP
941 @itemx @var{file}.FTN
942 Fixed form Fortran source code which must be preprocessed (with the traditional
943 preprocessor).
944
945 @item @var{file}.f90
946 @itemx @var{file}.f95
947 @itemx @var{file}.f03
948 @itemx @var{file}.f08
949 Free form Fortran source code which should not be preprocessed.
950
951 @item @var{file}.F90
952 @itemx @var{file}.F95
953 @itemx @var{file}.F03
954 @itemx @var{file}.F08
955 Free form Fortran source code which must be preprocessed (with the
956 traditional preprocessor).
957
958 @c FIXME: Descriptions of Java file types.
959 @c @var{file}.java
960 @c @var{file}.class
961 @c @var{file}.zip
962 @c @var{file}.jar
963
964 @item @var{file}.ads
965 Ada source code file which contains a library unit declaration (a
966 declaration of a package, subprogram, or generic, or a generic
967 instantiation), or a library unit renaming declaration (a package,
968 generic, or subprogram renaming declaration).  Such files are also
969 called @dfn{specs}.
970
971 @item @var{file}.adb
972 Ada source code file containing a library unit body (a subprogram or
973 package body).  Such files are also called @dfn{bodies}.
974
975 @c GCC also knows about some suffixes for languages not yet included:
976 @c Pascal:
977 @c @var{file}.p
978 @c @var{file}.pas
979 @c Ratfor:
980 @c @var{file}.r
981
982 @item @var{file}.s
983 Assembler code.
984
985 @item @var{file}.S
986 @itemx @var{file}.sx
987 Assembler code which must be preprocessed.
988
989 @item @var{other}
990 An object file to be fed straight into linking.
991 Any file name with no recognized suffix is treated this way.
992 @end table
993
994 @opindex x
995 You can specify the input language explicitly with the @option{-x} option:
996
997 @table @gcctabopt
998 @item -x @var{language}
999 Specify explicitly the @var{language} for the following input files
1000 (rather than letting the compiler choose a default based on the file
1001 name suffix).  This option applies to all following input files until
1002 the next @option{-x} option.  Possible values for @var{language} are:
1003 @smallexample
1004 c  c-header  c-cpp-output
1005 c++  c++-header  c++-cpp-output
1006 objective-c  objective-c-header  objective-c-cpp-output
1007 objective-c++ objective-c++-header objective-c++-cpp-output
1008 assembler  assembler-with-cpp
1009 ada
1010 f77  f77-cpp-input f95  f95-cpp-input
1011 java
1012 @end smallexample
1013
1014 @item -x none
1015 Turn off any specification of a language, so that subsequent files are
1016 handled according to their file name suffixes (as they are if @option{-x}
1017 has not been used at all).
1018
1019 @item -pass-exit-codes
1020 @opindex pass-exit-codes
1021 Normally the @command{gcc} program will exit with the code of 1 if any
1022 phase of the compiler returns a non-success return code.  If you specify
1023 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1024 numerically highest error produced by any phase that returned an error
1025 indication.  The C, C++, and Fortran frontends return 4, if an internal
1026 compiler error is encountered.
1027 @end table
1028
1029 If you only want some of the stages of compilation, you can use
1030 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1031 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1032 @command{gcc} is to stop.  Note that some combinations (for example,
1033 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1034
1035 @table @gcctabopt
1036 @item -c
1037 @opindex c
1038 Compile or assemble the source files, but do not link.  The linking
1039 stage simply is not done.  The ultimate output is in the form of an
1040 object file for each source file.
1041
1042 By default, the object file name for a source file is made by replacing
1043 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1044
1045 Unrecognized input files, not requiring compilation or assembly, are
1046 ignored.
1047
1048 @item -S
1049 @opindex S
1050 Stop after the stage of compilation proper; do not assemble.  The output
1051 is in the form of an assembler code file for each non-assembler input
1052 file specified.
1053
1054 By default, the assembler file name for a source file is made by
1055 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1056
1057 Input files that don't require compilation are ignored.
1058
1059 @item -E
1060 @opindex E
1061 Stop after the preprocessing stage; do not run the compiler proper.  The
1062 output is in the form of preprocessed source code, which is sent to the
1063 standard output.
1064
1065 Input files which don't require preprocessing are ignored.
1066
1067 @cindex output file option
1068 @item -o @var{file}
1069 @opindex o
1070 Place output in file @var{file}.  This applies regardless to whatever
1071 sort of output is being produced, whether it be an executable file,
1072 an object file, an assembler file or preprocessed C code.
1073
1074 If @option{-o} is not specified, the default is to put an executable
1075 file in @file{a.out}, the object file for
1076 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1077 assembler file in @file{@var{source}.s}, a precompiled header file in
1078 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1079 standard output.
1080
1081 @item -v
1082 @opindex v
1083 Print (on standard error output) the commands executed to run the stages
1084 of compilation.  Also print the version number of the compiler driver
1085 program and of the preprocessor and the compiler proper.
1086
1087 @item -###
1088 @opindex ###
1089 Like @option{-v} except the commands are not executed and all command
1090 arguments are quoted.  This is useful for shell scripts to capture the
1091 driver-generated command lines.
1092
1093 @item -pipe
1094 @opindex pipe
1095 Use pipes rather than temporary files for communication between the
1096 various stages of compilation.  This fails to work on some systems where
1097 the assembler is unable to read from a pipe; but the GNU assembler has
1098 no trouble.
1099
1100 @item -combine
1101 @opindex combine
1102 If you are compiling multiple source files, this option tells the driver
1103 to pass all the source files to the compiler at once (for those
1104 languages for which the compiler can handle this).  This will allow
1105 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1106 language for which this is supported is C@.  If you pass source files for
1107 multiple languages to the driver, using this option, the driver will invoke
1108 the compiler(s) that support IMA once each, passing each compiler all the
1109 source files appropriate for it.  For those languages that do not support
1110 IMA this option will be ignored, and the compiler will be invoked once for
1111 each source file in that language.  If you use this option in conjunction
1112 with @option{-save-temps}, the compiler will generate multiple
1113 pre-processed files
1114 (one for each source file), but only one (combined) @file{.o} or
1115 @file{.s} file.
1116
1117 @item --help
1118 @opindex help
1119 Print (on the standard output) a description of the command line options
1120 understood by @command{gcc}.  If the @option{-v} option is also specified
1121 then @option{--help} will also be passed on to the various processes
1122 invoked by @command{gcc}, so that they can display the command line options
1123 they accept.  If the @option{-Wextra} option has also been specified
1124 (prior to the @option{--help} option), then command line options which
1125 have no documentation associated with them will also be displayed.
1126
1127 @item --target-help
1128 @opindex target-help
1129 Print (on the standard output) a description of target-specific command
1130 line options for each tool.  For some targets extra target-specific
1131 information may also be printed.
1132
1133 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
1134 Print (on the standard output) a description of the command line
1135 options understood by the compiler that fit into a specific class.
1136 The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
1137 @samp{params}, or @var{language}:
1138
1139 @table @asis
1140 @item @samp{optimizers}
1141 This will display all of the optimization options supported by the
1142 compiler.
1143
1144 @item @samp{warnings}
1145 This will display all of the options controlling warning messages
1146 produced by the compiler.
1147
1148 @item @samp{target}
1149 This will display target-specific options.  Unlike the
1150 @option{--target-help} option however, target-specific options of the
1151 linker and assembler will not be displayed.  This is because those
1152 tools do not currently support the extended @option{--help=} syntax.
1153
1154 @item @samp{params}
1155 This will display the values recognized by the @option{--param}
1156 option.
1157
1158 @item @var{language}
1159 This will display the options supported for @var{language}, where 
1160 @var{language} is the name of one of the languages supported in this 
1161 version of GCC.
1162
1163 @item @samp{common}
1164 This will display the options that are common to all languages.
1165 @end table
1166
1167 It is possible to further refine the output of the @option{--help=}
1168 option by adding a comma separated list of qualifiers after the
1169 class.  These can be any from the following list:
1170
1171 @table @asis
1172 @item @samp{undocumented}
1173 Display only those options which are undocumented.
1174
1175 @item @samp{joined}
1176 Display options which take an argument that appears after an equal
1177 sign in the same continuous piece of text, such as:
1178 @samp{--help=target}.
1179
1180 @item @samp{separate}
1181 Display options which take an argument that appears as a separate word
1182 following the original option, such as: @samp{-o output-file}.
1183 @end table
1184
1185 Thus for example to display all the undocumented target-specific
1186 switches supported by the compiler the following can be used:
1187
1188 @smallexample
1189 --help=target,undocumented
1190 @end smallexample
1191
1192 The sense of a qualifier can be inverted by prefixing it with the
1193 @var{^} character, so for example to display all binary warning
1194 options (i.e., ones that are either on or off and that do not take an
1195 argument), which have a description the following can be used:
1196
1197 @smallexample
1198 --help=warnings,^joined,^undocumented
1199 @end smallexample
1200
1201 A class can also be used as a qualifier, although this usually
1202 restricts the output by so much that there is nothing to display.  One
1203 case where it does work however is when one of the classes is
1204 @var{target}.  So for example to display all the target-specific
1205 optimization options the following can be used:
1206
1207 @smallexample
1208 --help=target,optimizers
1209 @end smallexample
1210
1211 The @option{--help=} option can be repeated on the command line.  Each
1212 successive use will display its requested class of options, skipping
1213 those that have already been displayed.
1214
1215 If the @option{-Q} option appears on the command line before the
1216 @option{--help=} option, then the descriptive text displayed by
1217 @option{--help=} is changed.  Instead of describing the displayed
1218 options, an indication is given as to whether the option is enabled,
1219 disabled or set to a specific value (assuming that the compiler
1220 knows this at the point where the @option{--help=} option is used).
1221
1222 Here is a truncated example from the ARM port of @command{gcc}:
1223
1224 @smallexample
1225   % gcc -Q -mabi=2 --help=target -c
1226   The following options are target specific:
1227   -mabi=                                2
1228   -mabort-on-noreturn                   [disabled]
1229   -mapcs                                [disabled]
1230 @end smallexample
1231
1232 The output is sensitive to the effects of previous command line
1233 options, so for example it is possible to find out which optimizations
1234 are enabled at @option{-O2} by using:
1235
1236 @smallexample
1237 -O2 --help=optimizers
1238 @end smallexample
1239
1240 Alternatively you can discover which binary optimizations are enabled
1241 by @option{-O3} by using:
1242
1243 @smallexample
1244 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1245 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1246 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1247 @end smallexample
1248
1249 @item --version
1250 @opindex version
1251 Display the version number and copyrights of the invoked GCC@.
1252
1253 @item -wrapper
1254 @opindex wrapper
1255 Invoke all subcommands under a wrapper program. It takes a single
1256 comma separated list as an argument, which will be used to invoke
1257 the wrapper:
1258
1259 @smallexample
1260 gcc -c t.c -wrapper gdb,--args
1261 @end smallexample
1262
1263 This will invoke all subprograms of gcc under "gdb --args",
1264 thus cc1 invocation will be "gdb --args cc1 ...".
1265
1266 @include @value{srcdir}/../libiberty/at-file.texi
1267 @end table
1268
1269 @node Invoking G++
1270 @section Compiling C++ Programs
1271
1272 @cindex suffixes for C++ source
1273 @cindex C++ source file suffixes
1274 C++ source files conventionally use one of the suffixes @samp{.C},
1275 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1276 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1277 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1278 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1279 files with these names and compiles them as C++ programs even if you
1280 call the compiler the same way as for compiling C programs (usually
1281 with the name @command{gcc}).
1282
1283 @findex g++
1284 @findex c++
1285 However, the use of @command{gcc} does not add the C++ library.
1286 @command{g++} is a program that calls GCC and treats @samp{.c},
1287 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1288 files unless @option{-x} is used, and automatically specifies linking
1289 against the C++ library.  This program is also useful when
1290 precompiling a C header file with a @samp{.h} extension for use in C++
1291 compilations.  On many systems, @command{g++} is also installed with
1292 the name @command{c++}.
1293
1294 @cindex invoking @command{g++}
1295 When you compile C++ programs, you may specify many of the same
1296 command-line options that you use for compiling programs in any
1297 language; or command-line options meaningful for C and related
1298 languages; or options that are meaningful only for C++ programs.
1299 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1300 explanations of options for languages related to C@.
1301 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1302 explanations of options that are meaningful only for C++ programs.
1303
1304 @node C Dialect Options
1305 @section Options Controlling C Dialect
1306 @cindex dialect options
1307 @cindex language dialect options
1308 @cindex options, dialect
1309
1310 The following options control the dialect of C (or languages derived
1311 from C, such as C++, Objective-C and Objective-C++) that the compiler
1312 accepts:
1313
1314 @table @gcctabopt
1315 @cindex ANSI support
1316 @cindex ISO support
1317 @item -ansi
1318 @opindex ansi
1319 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1320 equivalent to @samp{-std=c++98}.
1321
1322 This turns off certain features of GCC that are incompatible with ISO
1323 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1324 such as the @code{asm} and @code{typeof} keywords, and
1325 predefined macros such as @code{unix} and @code{vax} that identify the
1326 type of system you are using.  It also enables the undesirable and
1327 rarely used ISO trigraph feature.  For the C compiler,
1328 it disables recognition of C++ style @samp{//} comments as well as
1329 the @code{inline} keyword.
1330
1331 The alternate keywords @code{__asm__}, @code{__extension__},
1332 @code{__inline__} and @code{__typeof__} continue to work despite
1333 @option{-ansi}.  You would not want to use them in an ISO C program, of
1334 course, but it is useful to put them in header files that might be included
1335 in compilations done with @option{-ansi}.  Alternate predefined macros
1336 such as @code{__unix__} and @code{__vax__} are also available, with or
1337 without @option{-ansi}.
1338
1339 The @option{-ansi} option does not cause non-ISO programs to be
1340 rejected gratuitously.  For that, @option{-pedantic} is required in
1341 addition to @option{-ansi}.  @xref{Warning Options}.
1342
1343 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1344 option is used.  Some header files may notice this macro and refrain
1345 from declaring certain functions or defining certain macros that the
1346 ISO standard doesn't call for; this is to avoid interfering with any
1347 programs that might use these names for other things.
1348
1349 Functions that would normally be built in but do not have semantics
1350 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1351 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1352 built-in functions provided by GCC}, for details of the functions
1353 affected.
1354
1355 @item -std=
1356 @opindex std
1357 Determine the language standard. @xref{Standards,,Language Standards
1358 Supported by GCC}, for details of these standard versions.  This option
1359 is currently only supported when compiling C or C++. 
1360
1361 The compiler can accept several base standards, such as @samp{c89} or
1362 @samp{c++98}, and GNU dialects of those standards, such as
1363 @samp{gnu89} or @samp{gnu++98}.  By specifing a base standard, the
1364 compiler will accept all programs following that standard and those
1365 using GNU extensions that do not contradict it.  For example,
1366 @samp{-std=c89} turns off certain features of GCC that are
1367 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1368 keywords, but not other GNU extensions that do not have a meaning in
1369 ISO C90, such as omitting the middle term of a @code{?:}
1370 expression. On the other hand, by specifing a GNU dialect of a
1371 standard, all features the compiler support are enabled, even when
1372 those features change the meaning of the base standard and some
1373 strict-conforming programs may be rejected.  The particular standard
1374 is used by @option{-pedantic} to identify which features are GNU
1375 extensions given that version of the standard. For example
1376 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1377 comments, while @samp{-std=gnu99 -pedantic} would not.
1378
1379 A value for this option must be provided; possible values are
1380
1381 @table @samp
1382 @item c89
1383 @itemx iso9899:1990
1384 Support all ISO C90 programs (certain GNU extensions that conflict
1385 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1386
1387 @item iso9899:199409
1388 ISO C90 as modified in amendment 1.
1389
1390 @item c99
1391 @itemx c9x
1392 @itemx iso9899:1999
1393 @itemx iso9899:199x
1394 ISO C99.  Note that this standard is not yet fully supported; see
1395 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1396 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1397
1398 @item gnu89
1399 GNU dialect of ISO C90 (including some C99 features). This
1400 is the default for C code.
1401
1402 @item gnu99
1403 @itemx gnu9x
1404 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1405 this will become the default.  The name @samp{gnu9x} is deprecated.
1406
1407 @item c++98
1408 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1409 C++ code.
1410
1411 @item gnu++98
1412 GNU dialect of @option{-std=c++98}.  This is the default for
1413 C++ code.
1414
1415 @item c++0x
1416 The working draft of the upcoming ISO C++0x standard. This option
1417 enables experimental features that are likely to be included in
1418 C++0x. The working draft is constantly changing, and any feature that is
1419 enabled by this flag may be removed from future versions of GCC if it is
1420 not part of the C++0x standard.
1421
1422 @item gnu++0x
1423 GNU dialect of @option{-std=c++0x}. This option enables
1424 experimental features that may be removed in future versions of GCC.
1425 @end table
1426
1427 @item -fgnu89-inline
1428 @opindex fgnu89-inline
1429 The option @option{-fgnu89-inline} tells GCC to use the traditional
1430 GNU semantics for @code{inline} functions when in C99 mode.
1431 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1432 is accepted and ignored by GCC versions 4.1.3 up to but not including
1433 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1434 C99 mode.  Using this option is roughly equivalent to adding the
1435 @code{gnu_inline} function attribute to all inline functions
1436 (@pxref{Function Attributes}).
1437
1438 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1439 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1440 specifies the default behavior).  This option was first supported in
1441 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1442
1443 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1444 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1445 in effect for @code{inline} functions.  @xref{Common Predefined
1446 Macros,,,cpp,The C Preprocessor}.
1447
1448 @item -aux-info @var{filename}
1449 @opindex aux-info
1450 Output to the given filename prototyped declarations for all functions
1451 declared and/or defined in a translation unit, including those in header
1452 files.  This option is silently ignored in any language other than C@.
1453
1454 Besides declarations, the file indicates, in comments, the origin of
1455 each declaration (source file and line), whether the declaration was
1456 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1457 @samp{O} for old, respectively, in the first character after the line
1458 number and the colon), and whether it came from a declaration or a
1459 definition (@samp{C} or @samp{F}, respectively, in the following
1460 character).  In the case of function definitions, a K&R-style list of
1461 arguments followed by their declarations is also provided, inside
1462 comments, after the declaration.
1463
1464 @item -fno-asm
1465 @opindex fno-asm
1466 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1467 keyword, so that code can use these words as identifiers.  You can use
1468 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1469 instead.  @option{-ansi} implies @option{-fno-asm}.
1470
1471 In C++, this switch only affects the @code{typeof} keyword, since
1472 @code{asm} and @code{inline} are standard keywords.  You may want to
1473 use the @option{-fno-gnu-keywords} flag instead, which has the same
1474 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1475 switch only affects the @code{asm} and @code{typeof} keywords, since
1476 @code{inline} is a standard keyword in ISO C99.
1477
1478 @item -fno-builtin
1479 @itemx -fno-builtin-@var{function}
1480 @opindex fno-builtin
1481 @cindex built-in functions
1482 Don't recognize built-in functions that do not begin with
1483 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1484 functions provided by GCC}, for details of the functions affected,
1485 including those which are not built-in functions when @option{-ansi} or
1486 @option{-std} options for strict ISO C conformance are used because they
1487 do not have an ISO standard meaning.
1488
1489 GCC normally generates special code to handle certain built-in functions
1490 more efficiently; for instance, calls to @code{alloca} may become single
1491 instructions that adjust the stack directly, and calls to @code{memcpy}
1492 may become inline copy loops.  The resulting code is often both smaller
1493 and faster, but since the function calls no longer appear as such, you
1494 cannot set a breakpoint on those calls, nor can you change the behavior
1495 of the functions by linking with a different library.  In addition,
1496 when a function is recognized as a built-in function, GCC may use
1497 information about that function to warn about problems with calls to
1498 that function, or to generate more efficient code, even if the
1499 resulting code still contains calls to that function.  For example,
1500 warnings are given with @option{-Wformat} for bad calls to
1501 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1502 known not to modify global memory.
1503
1504 With the @option{-fno-builtin-@var{function}} option
1505 only the built-in function @var{function} is
1506 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1507 function is named this is not built-in in this version of GCC, this
1508 option is ignored.  There is no corresponding
1509 @option{-fbuiltin-@var{function}} option; if you wish to enable
1510 built-in functions selectively when using @option{-fno-builtin} or
1511 @option{-ffreestanding}, you may define macros such as:
1512
1513 @smallexample
1514 #define abs(n)          __builtin_abs ((n))
1515 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1516 @end smallexample
1517
1518 @item -fhosted
1519 @opindex fhosted
1520 @cindex hosted environment
1521
1522 Assert that compilation takes place in a hosted environment.  This implies
1523 @option{-fbuiltin}.  A hosted environment is one in which the
1524 entire standard library is available, and in which @code{main} has a return
1525 type of @code{int}.  Examples are nearly everything except a kernel.
1526 This is equivalent to @option{-fno-freestanding}.
1527
1528 @item -ffreestanding
1529 @opindex ffreestanding
1530 @cindex hosted environment
1531
1532 Assert that compilation takes place in a freestanding environment.  This
1533 implies @option{-fno-builtin}.  A freestanding environment
1534 is one in which the standard library may not exist, and program startup may
1535 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1536 This is equivalent to @option{-fno-hosted}.
1537
1538 @xref{Standards,,Language Standards Supported by GCC}, for details of
1539 freestanding and hosted environments.
1540
1541 @item -fopenmp
1542 @opindex fopenmp
1543 @cindex openmp parallel
1544 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1545 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1546 compiler generates parallel code according to the OpenMP Application
1547 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.  This option
1548 implies @option{-pthread}, and thus is only supported on targets that
1549 have support for @option{-pthread}.
1550
1551 @item -fms-extensions
1552 @opindex fms-extensions
1553 Accept some non-standard constructs used in Microsoft header files.
1554
1555 Some cases of unnamed fields in structures and unions are only
1556 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1557 fields within structs/unions}, for details.
1558
1559 @item -trigraphs
1560 @opindex trigraphs
1561 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1562 options for strict ISO C conformance) implies @option{-trigraphs}.
1563
1564 @item -no-integrated-cpp
1565 @opindex no-integrated-cpp
1566 Performs a compilation in two passes: preprocessing and compiling.  This
1567 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1568 @option{-B} option.  The user supplied compilation step can then add in
1569 an additional preprocessing step after normal preprocessing but before
1570 compiling.  The default is to use the integrated cpp (internal cpp)
1571
1572 The semantics of this option will change if "cc1", "cc1plus", and
1573 "cc1obj" are merged.
1574
1575 @cindex traditional C language
1576 @cindex C language, traditional
1577 @item -traditional
1578 @itemx -traditional-cpp
1579 @opindex traditional-cpp
1580 @opindex traditional
1581 Formerly, these options caused GCC to attempt to emulate a pre-standard
1582 C compiler.  They are now only supported with the @option{-E} switch.
1583 The preprocessor continues to support a pre-standard mode.  See the GNU
1584 CPP manual for details.
1585
1586 @item -fcond-mismatch
1587 @opindex fcond-mismatch
1588 Allow conditional expressions with mismatched types in the second and
1589 third arguments.  The value of such an expression is void.  This option
1590 is not supported for C++.
1591
1592 @item -flax-vector-conversions
1593 @opindex flax-vector-conversions
1594 Allow implicit conversions between vectors with differing numbers of
1595 elements and/or incompatible element types.  This option should not be
1596 used for new code.
1597
1598 @item -funsigned-char
1599 @opindex funsigned-char
1600 Let the type @code{char} be unsigned, like @code{unsigned char}.
1601
1602 Each kind of machine has a default for what @code{char} should
1603 be.  It is either like @code{unsigned char} by default or like
1604 @code{signed char} by default.
1605
1606 Ideally, a portable program should always use @code{signed char} or
1607 @code{unsigned char} when it depends on the signedness of an object.
1608 But many programs have been written to use plain @code{char} and
1609 expect it to be signed, or expect it to be unsigned, depending on the
1610 machines they were written for.  This option, and its inverse, let you
1611 make such a program work with the opposite default.
1612
1613 The type @code{char} is always a distinct type from each of
1614 @code{signed char} or @code{unsigned char}, even though its behavior
1615 is always just like one of those two.
1616
1617 @item -fsigned-char
1618 @opindex fsigned-char
1619 Let the type @code{char} be signed, like @code{signed char}.
1620
1621 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1622 the negative form of @option{-funsigned-char}.  Likewise, the option
1623 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1624
1625 @item -fsigned-bitfields
1626 @itemx -funsigned-bitfields
1627 @itemx -fno-signed-bitfields
1628 @itemx -fno-unsigned-bitfields
1629 @opindex fsigned-bitfields
1630 @opindex funsigned-bitfields
1631 @opindex fno-signed-bitfields
1632 @opindex fno-unsigned-bitfields
1633 These options control whether a bit-field is signed or unsigned, when the
1634 declaration does not use either @code{signed} or @code{unsigned}.  By
1635 default, such a bit-field is signed, because this is consistent: the
1636 basic integer types such as @code{int} are signed types.
1637 @end table
1638
1639 @node C++ Dialect Options
1640 @section Options Controlling C++ Dialect
1641
1642 @cindex compiler options, C++
1643 @cindex C++ options, command line
1644 @cindex options, C++
1645 This section describes the command-line options that are only meaningful
1646 for C++ programs; but you can also use most of the GNU compiler options
1647 regardless of what language your program is in.  For example, you
1648 might compile a file @code{firstClass.C} like this:
1649
1650 @smallexample
1651 g++ -g -frepo -O -c firstClass.C
1652 @end smallexample
1653
1654 @noindent
1655 In this example, only @option{-frepo} is an option meant
1656 only for C++ programs; you can use the other options with any
1657 language supported by GCC@.
1658
1659 Here is a list of options that are @emph{only} for compiling C++ programs:
1660
1661 @table @gcctabopt
1662
1663 @item -fabi-version=@var{n}
1664 @opindex fabi-version
1665 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1666 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1667 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1668 the version that conforms most closely to the C++ ABI specification.
1669 Therefore, the ABI obtained using version 0 will change as ABI bugs
1670 are fixed.
1671
1672 The default is version 2.
1673
1674 @item -fno-access-control
1675 @opindex fno-access-control
1676 Turn off all access checking.  This switch is mainly useful for working
1677 around bugs in the access control code.
1678
1679 @item -fcheck-new
1680 @opindex fcheck-new
1681 Check that the pointer returned by @code{operator new} is non-null
1682 before attempting to modify the storage allocated.  This check is
1683 normally unnecessary because the C++ standard specifies that
1684 @code{operator new} will only return @code{0} if it is declared
1685 @samp{throw()}, in which case the compiler will always check the
1686 return value even without this option.  In all other cases, when
1687 @code{operator new} has a non-empty exception specification, memory
1688 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1689 @samp{new (nothrow)}.
1690
1691 @item -fconserve-space
1692 @opindex fconserve-space
1693 Put uninitialized or runtime-initialized global variables into the
1694 common segment, as C does.  This saves space in the executable at the
1695 cost of not diagnosing duplicate definitions.  If you compile with this
1696 flag and your program mysteriously crashes after @code{main()} has
1697 completed, you may have an object that is being destroyed twice because
1698 two definitions were merged.
1699
1700 This option is no longer useful on most targets, now that support has
1701 been added for putting variables into BSS without making them common.
1702
1703 @item -ffriend-injection
1704 @opindex ffriend-injection
1705 Inject friend functions into the enclosing namespace, so that they are
1706 visible outside the scope of the class in which they are declared.
1707 Friend functions were documented to work this way in the old Annotated
1708 C++ Reference Manual, and versions of G++ before 4.1 always worked
1709 that way.  However, in ISO C++ a friend function which is not declared
1710 in an enclosing scope can only be found using argument dependent
1711 lookup.  This option causes friends to be injected as they were in
1712 earlier releases.
1713
1714 This option is for compatibility, and may be removed in a future
1715 release of G++.
1716
1717 @item -fno-elide-constructors
1718 @opindex fno-elide-constructors
1719 The C++ standard allows an implementation to omit creating a temporary
1720 which is only used to initialize another object of the same type.
1721 Specifying this option disables that optimization, and forces G++ to
1722 call the copy constructor in all cases.
1723
1724 @item -fno-enforce-eh-specs
1725 @opindex fno-enforce-eh-specs
1726 Don't generate code to check for violation of exception specifications
1727 at runtime.  This option violates the C++ standard, but may be useful
1728 for reducing code size in production builds, much like defining
1729 @samp{NDEBUG}.  This does not give user code permission to throw
1730 exceptions in violation of the exception specifications; the compiler
1731 will still optimize based on the specifications, so throwing an
1732 unexpected exception will result in undefined behavior.
1733
1734 @item -ffor-scope
1735 @itemx -fno-for-scope
1736 @opindex ffor-scope
1737 @opindex fno-for-scope
1738 If @option{-ffor-scope} is specified, the scope of variables declared in
1739 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1740 as specified by the C++ standard.
1741 If @option{-fno-for-scope} is specified, the scope of variables declared in
1742 a @i{for-init-statement} extends to the end of the enclosing scope,
1743 as was the case in old versions of G++, and other (traditional)
1744 implementations of C++.
1745
1746 The default if neither flag is given to follow the standard,
1747 but to allow and give a warning for old-style code that would
1748 otherwise be invalid, or have different behavior.
1749
1750 @item -fno-gnu-keywords
1751 @opindex fno-gnu-keywords
1752 Do not recognize @code{typeof} as a keyword, so that code can use this
1753 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1754 @option{-ansi} implies @option{-fno-gnu-keywords}.
1755
1756 @item -fno-implicit-templates
1757 @opindex fno-implicit-templates
1758 Never emit code for non-inline templates which are instantiated
1759 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1760 @xref{Template Instantiation}, for more information.
1761
1762 @item -fno-implicit-inline-templates
1763 @opindex fno-implicit-inline-templates
1764 Don't emit code for implicit instantiations of inline templates, either.
1765 The default is to handle inlines differently so that compiles with and
1766 without optimization will need the same set of explicit instantiations.
1767
1768 @item -fno-implement-inlines
1769 @opindex fno-implement-inlines
1770 To save space, do not emit out-of-line copies of inline functions
1771 controlled by @samp{#pragma implementation}.  This will cause linker
1772 errors if these functions are not inlined everywhere they are called.
1773
1774 @item -fms-extensions
1775 @opindex fms-extensions
1776 Disable pedantic warnings about constructs used in MFC, such as implicit
1777 int and getting a pointer to member function via non-standard syntax.
1778
1779 @item -fno-nonansi-builtins
1780 @opindex fno-nonansi-builtins
1781 Disable built-in declarations of functions that are not mandated by
1782 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1783 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1784
1785 @item -fno-operator-names
1786 @opindex fno-operator-names
1787 Do not treat the operator name keywords @code{and}, @code{bitand},
1788 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1789 synonyms as keywords.
1790
1791 @item -fno-optional-diags
1792 @opindex fno-optional-diags
1793 Disable diagnostics that the standard says a compiler does not need to
1794 issue.  Currently, the only such diagnostic issued by G++ is the one for
1795 a name having multiple meanings within a class.
1796
1797 @item -fpermissive
1798 @opindex fpermissive
1799 Downgrade some diagnostics about nonconformant code from errors to
1800 warnings.  Thus, using @option{-fpermissive} will allow some
1801 nonconforming code to compile.
1802
1803 @item -frepo
1804 @opindex frepo
1805 Enable automatic template instantiation at link time.  This option also
1806 implies @option{-fno-implicit-templates}.  @xref{Template
1807 Instantiation}, for more information.
1808
1809 @item -fno-rtti
1810 @opindex fno-rtti
1811 Disable generation of information about every class with virtual
1812 functions for use by the C++ runtime type identification features
1813 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1814 of the language, you can save some space by using this flag.  Note that
1815 exception handling uses the same information, but it will generate it as
1816 needed. The @samp{dynamic_cast} operator can still be used for casts that
1817 do not require runtime type information, i.e.@: casts to @code{void *} or to
1818 unambiguous base classes.
1819
1820 @item -fstats
1821 @opindex fstats
1822 Emit statistics about front-end processing at the end of the compilation.
1823 This information is generally only useful to the G++ development team.
1824
1825 @item -ftemplate-depth-@var{n}
1826 @opindex ftemplate-depth
1827 Set the maximum instantiation depth for template classes to @var{n}.
1828 A limit on the template instantiation depth is needed to detect
1829 endless recursions during template class instantiation.  ANSI/ISO C++
1830 conforming programs must not rely on a maximum depth greater than 17.
1831
1832 @item -fno-threadsafe-statics
1833 @opindex fno-threadsafe-statics
1834 Do not emit the extra code to use the routines specified in the C++
1835 ABI for thread-safe initialization of local statics.  You can use this
1836 option to reduce code size slightly in code that doesn't need to be
1837 thread-safe.
1838
1839 @item -fuse-cxa-atexit
1840 @opindex fuse-cxa-atexit
1841 Register destructors for objects with static storage duration with the
1842 @code{__cxa_atexit} function rather than the @code{atexit} function.
1843 This option is required for fully standards-compliant handling of static
1844 destructors, but will only work if your C library supports
1845 @code{__cxa_atexit}.
1846
1847 @item -fno-use-cxa-get-exception-ptr
1848 @opindex fno-use-cxa-get-exception-ptr
1849 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1850 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1851 if the runtime routine is not available.
1852
1853 @item -fvisibility-inlines-hidden
1854 @opindex fvisibility-inlines-hidden
1855 This switch declares that the user does not attempt to compare
1856 pointers to inline methods where the addresses of the two functions
1857 were taken in different shared objects.
1858
1859 The effect of this is that GCC may, effectively, mark inline methods with
1860 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1861 appear in the export table of a DSO and do not require a PLT indirection
1862 when used within the DSO@.  Enabling this option can have a dramatic effect
1863 on load and link times of a DSO as it massively reduces the size of the
1864 dynamic export table when the library makes heavy use of templates.
1865
1866 The behavior of this switch is not quite the same as marking the
1867 methods as hidden directly, because it does not affect static variables
1868 local to the function or cause the compiler to deduce that
1869 the function is defined in only one shared object.
1870
1871 You may mark a method as having a visibility explicitly to negate the
1872 effect of the switch for that method.  For example, if you do want to
1873 compare pointers to a particular inline method, you might mark it as
1874 having default visibility.  Marking the enclosing class with explicit
1875 visibility will have no effect.
1876
1877 Explicitly instantiated inline methods are unaffected by this option
1878 as their linkage might otherwise cross a shared library boundary.
1879 @xref{Template Instantiation}.
1880
1881 @item -fvisibility-ms-compat
1882 @opindex fvisibility-ms-compat
1883 This flag attempts to use visibility settings to make GCC's C++
1884 linkage model compatible with that of Microsoft Visual Studio.
1885
1886 The flag makes these changes to GCC's linkage model:
1887
1888 @enumerate
1889 @item
1890 It sets the default visibility to @code{hidden}, like
1891 @option{-fvisibility=hidden}.
1892
1893 @item
1894 Types, but not their members, are not hidden by default.
1895
1896 @item
1897 The One Definition Rule is relaxed for types without explicit
1898 visibility specifications which are defined in more than one different
1899 shared object: those declarations are permitted if they would have
1900 been permitted when this option was not used.
1901 @end enumerate
1902
1903 In new code it is better to use @option{-fvisibility=hidden} and
1904 export those classes which are intended to be externally visible.
1905 Unfortunately it is possible for code to rely, perhaps accidentally,
1906 on the Visual Studio behavior.
1907
1908 Among the consequences of these changes are that static data members
1909 of the same type with the same name but defined in different shared
1910 objects will be different, so changing one will not change the other;
1911 and that pointers to function members defined in different shared
1912 objects may not compare equal.  When this flag is given, it is a
1913 violation of the ODR to define types with the same name differently.
1914
1915 @item -fno-weak
1916 @opindex fno-weak
1917 Do not use weak symbol support, even if it is provided by the linker.
1918 By default, G++ will use weak symbols if they are available.  This
1919 option exists only for testing, and should not be used by end-users;
1920 it will result in inferior code and has no benefits.  This option may
1921 be removed in a future release of G++.
1922
1923 @item -nostdinc++
1924 @opindex nostdinc++
1925 Do not search for header files in the standard directories specific to
1926 C++, but do still search the other standard directories.  (This option
1927 is used when building the C++ library.)
1928 @end table
1929
1930 In addition, these optimization, warning, and code generation options
1931 have meanings only for C++ programs:
1932
1933 @table @gcctabopt
1934 @item -fno-default-inline
1935 @opindex fno-default-inline
1936 Do not assume @samp{inline} for functions defined inside a class scope.
1937 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1938 functions will have linkage like inline functions; they just won't be
1939 inlined by default.
1940
1941 @item -Wabi @r{(C++ and Objective-C++ only)}
1942 @opindex Wabi
1943 @opindex Wno-abi
1944 Warn when G++ generates code that is probably not compatible with the
1945 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1946 all such cases, there are probably some cases that are not warned about,
1947 even though G++ is generating incompatible code.  There may also be
1948 cases where warnings are emitted even though the code that is generated
1949 will be compatible.
1950
1951 You should rewrite your code to avoid these warnings if you are
1952 concerned about the fact that code generated by G++ may not be binary
1953 compatible with code generated by other compilers.
1954
1955 The known incompatibilities at this point include:
1956
1957 @itemize @bullet
1958
1959 @item
1960 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1961 pack data into the same byte as a base class.  For example:
1962
1963 @smallexample
1964 struct A @{ virtual void f(); int f1 : 1; @};
1965 struct B : public A @{ int f2 : 1; @};
1966 @end smallexample
1967
1968 @noindent
1969 In this case, G++ will place @code{B::f2} into the same byte
1970 as@code{A::f1}; other compilers will not.  You can avoid this problem
1971 by explicitly padding @code{A} so that its size is a multiple of the
1972 byte size on your platform; that will cause G++ and other compilers to
1973 layout @code{B} identically.
1974
1975 @item
1976 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1977 tail padding when laying out virtual bases.  For example:
1978
1979 @smallexample
1980 struct A @{ virtual void f(); char c1; @};
1981 struct B @{ B(); char c2; @};
1982 struct C : public A, public virtual B @{@};
1983 @end smallexample
1984
1985 @noindent
1986 In this case, G++ will not place @code{B} into the tail-padding for
1987 @code{A}; other compilers will.  You can avoid this problem by
1988 explicitly padding @code{A} so that its size is a multiple of its
1989 alignment (ignoring virtual base classes); that will cause G++ and other
1990 compilers to layout @code{C} identically.
1991
1992 @item
1993 Incorrect handling of bit-fields with declared widths greater than that
1994 of their underlying types, when the bit-fields appear in a union.  For
1995 example:
1996
1997 @smallexample
1998 union U @{ int i : 4096; @};
1999 @end smallexample
2000
2001 @noindent
2002 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2003 union too small by the number of bits in an @code{int}.
2004
2005 @item
2006 Empty classes can be placed at incorrect offsets.  For example:
2007
2008 @smallexample
2009 struct A @{@};
2010
2011 struct B @{
2012   A a;
2013   virtual void f ();
2014 @};
2015
2016 struct C : public B, public A @{@};
2017 @end smallexample
2018
2019 @noindent
2020 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2021 it should be placed at offset zero.  G++ mistakenly believes that the
2022 @code{A} data member of @code{B} is already at offset zero.
2023
2024 @item
2025 Names of template functions whose types involve @code{typename} or
2026 template template parameters can be mangled incorrectly.
2027
2028 @smallexample
2029 template <typename Q>
2030 void f(typename Q::X) @{@}
2031
2032 template <template <typename> class Q>
2033 void f(typename Q<int>::X) @{@}
2034 @end smallexample
2035
2036 @noindent
2037 Instantiations of these templates may be mangled incorrectly.
2038
2039 @end itemize
2040
2041 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2042 @opindex Wctor-dtor-privacy
2043 @opindex Wno-ctor-dtor-privacy
2044 Warn when a class seems unusable because all the constructors or
2045 destructors in that class are private, and it has neither friends nor
2046 public static member functions.
2047
2048 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2049 @opindex Wnon-virtual-dtor
2050 @opindex Wno-non-virtual-dtor
2051 Warn when a class has virtual functions and accessible non-virtual
2052 destructor, in which case it would be possible but unsafe to delete
2053 an instance of a derived class through a pointer to the base class.
2054 This warning is also enabled if -Weffc++ is specified.
2055
2056 @item -Wreorder @r{(C++ and Objective-C++ only)}
2057 @opindex Wreorder
2058 @opindex Wno-reorder
2059 @cindex reordering, warning
2060 @cindex warning for reordering of member initializers
2061 Warn when the order of member initializers given in the code does not
2062 match the order in which they must be executed.  For instance:
2063
2064 @smallexample
2065 struct A @{
2066   int i;
2067   int j;
2068   A(): j (0), i (1) @{ @}
2069 @};
2070 @end smallexample
2071
2072 The compiler will rearrange the member initializers for @samp{i}
2073 and @samp{j} to match the declaration order of the members, emitting
2074 a warning to that effect.  This warning is enabled by @option{-Wall}.
2075 @end table
2076
2077 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2078
2079 @table @gcctabopt
2080 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2081 @opindex Weffc++
2082 @opindex Wno-effc++
2083 Warn about violations of the following style guidelines from Scott Meyers'
2084 @cite{Effective C++} book:
2085
2086 @itemize @bullet
2087 @item
2088 Item 11:  Define a copy constructor and an assignment operator for classes
2089 with dynamically allocated memory.
2090
2091 @item
2092 Item 12:  Prefer initialization to assignment in constructors.
2093
2094 @item
2095 Item 14:  Make destructors virtual in base classes.
2096
2097 @item
2098 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2099
2100 @item
2101 Item 23:  Don't try to return a reference when you must return an object.
2102
2103 @end itemize
2104
2105 Also warn about violations of the following style guidelines from
2106 Scott Meyers' @cite{More Effective C++} book:
2107
2108 @itemize @bullet
2109 @item
2110 Item 6:  Distinguish between prefix and postfix forms of increment and
2111 decrement operators.
2112
2113 @item
2114 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2115
2116 @end itemize
2117
2118 When selecting this option, be aware that the standard library
2119 headers do not obey all of these guidelines; use @samp{grep -v}
2120 to filter out those warnings.
2121
2122 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2123 @opindex Wstrict-null-sentinel
2124 @opindex Wno-strict-null-sentinel
2125 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2126 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2127 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2128 it is guaranteed to of the same size as a pointer.  But this use is
2129 not portable across different compilers.
2130
2131 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2132 @opindex Wno-non-template-friend
2133 @opindex Wnon-template-friend
2134 Disable warnings when non-templatized friend functions are declared
2135 within a template.  Since the advent of explicit template specification
2136 support in G++, if the name of the friend is an unqualified-id (i.e.,
2137 @samp{friend foo(int)}), the C++ language specification demands that the
2138 friend declare or define an ordinary, nontemplate function.  (Section
2139 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2140 could be interpreted as a particular specialization of a templatized
2141 function.  Because this non-conforming behavior is no longer the default
2142 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2143 check existing code for potential trouble spots and is on by default.
2144 This new compiler behavior can be turned off with
2145 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2146 but disables the helpful warning.
2147
2148 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2149 @opindex Wold-style-cast
2150 @opindex Wno-old-style-cast
2151 Warn if an old-style (C-style) cast to a non-void type is used within
2152 a C++ program.  The new-style casts (@samp{dynamic_cast},
2153 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2154 less vulnerable to unintended effects and much easier to search for.
2155
2156 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2157 @opindex Woverloaded-virtual
2158 @opindex Wno-overloaded-virtual
2159 @cindex overloaded virtual fn, warning
2160 @cindex warning for overloaded virtual fn
2161 Warn when a function declaration hides virtual functions from a
2162 base class.  For example, in:
2163
2164 @smallexample
2165 struct A @{
2166   virtual void f();
2167 @};
2168
2169 struct B: public A @{
2170   void f(int);
2171 @};
2172 @end smallexample
2173
2174 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2175 like:
2176
2177 @smallexample
2178 B* b;
2179 b->f();
2180 @end smallexample
2181
2182 will fail to compile.
2183
2184 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2185 @opindex Wno-pmf-conversions
2186 @opindex Wpmf-conversions
2187 Disable the diagnostic for converting a bound pointer to member function
2188 to a plain pointer.
2189
2190 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2191 @opindex Wsign-promo
2192 @opindex Wno-sign-promo
2193 Warn when overload resolution chooses a promotion from unsigned or
2194 enumerated type to a signed type, over a conversion to an unsigned type of
2195 the same size.  Previous versions of G++ would try to preserve
2196 unsignedness, but the standard mandates the current behavior.
2197
2198 @smallexample
2199 struct A @{
2200   operator int ();
2201   A& operator = (int);
2202 @};
2203
2204 main ()
2205 @{
2206   A a,b;
2207   a = b;
2208 @}
2209 @end smallexample
2210
2211 In this example, G++ will synthesize a default @samp{A& operator =
2212 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2213 @end table
2214
2215 @node Objective-C and Objective-C++ Dialect Options
2216 @section Options Controlling Objective-C and Objective-C++ Dialects
2217
2218 @cindex compiler options, Objective-C and Objective-C++
2219 @cindex Objective-C and Objective-C++ options, command line
2220 @cindex options, Objective-C and Objective-C++
2221 (NOTE: This manual does not describe the Objective-C and Objective-C++
2222 languages themselves.  See @xref{Standards,,Language Standards
2223 Supported by GCC}, for references.)
2224
2225 This section describes the command-line options that are only meaningful
2226 for Objective-C and Objective-C++ programs, but you can also use most of
2227 the language-independent GNU compiler options.
2228 For example, you might compile a file @code{some_class.m} like this:
2229
2230 @smallexample
2231 gcc -g -fgnu-runtime -O -c some_class.m
2232 @end smallexample
2233
2234 @noindent
2235 In this example, @option{-fgnu-runtime} is an option meant only for
2236 Objective-C and Objective-C++ programs; you can use the other options with
2237 any language supported by GCC@.
2238
2239 Note that since Objective-C is an extension of the C language, Objective-C
2240 compilations may also use options specific to the C front-end (e.g.,
2241 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2242 C++-specific options (e.g., @option{-Wabi}).
2243
2244 Here is a list of options that are @emph{only} for compiling Objective-C
2245 and Objective-C++ programs:
2246
2247 @table @gcctabopt
2248 @item -fconstant-string-class=@var{class-name}
2249 @opindex fconstant-string-class
2250 Use @var{class-name} as the name of the class to instantiate for each
2251 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2252 class name is @code{NXConstantString} if the GNU runtime is being used, and
2253 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2254 @option{-fconstant-cfstrings} option, if also present, will override the
2255 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2256 to be laid out as constant CoreFoundation strings.
2257
2258 @item -fgnu-runtime
2259 @opindex fgnu-runtime
2260 Generate object code compatible with the standard GNU Objective-C
2261 runtime.  This is the default for most types of systems.
2262
2263 @item -fnext-runtime
2264 @opindex fnext-runtime
2265 Generate output compatible with the NeXT runtime.  This is the default
2266 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2267 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2268 used.
2269
2270 @item -fno-nil-receivers
2271 @opindex fno-nil-receivers
2272 Assume that all Objective-C message dispatches (e.g.,
2273 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2274 is not @code{nil}.  This allows for more efficient entry points in the runtime
2275 to be used.  Currently, this option is only available in conjunction with
2276 the NeXT runtime on Mac OS X 10.3 and later.
2277
2278 @item -fobjc-call-cxx-cdtors
2279 @opindex fobjc-call-cxx-cdtors
2280 For each Objective-C class, check if any of its instance variables is a
2281 C++ object with a non-trivial default constructor.  If so, synthesize a
2282 special @code{- (id) .cxx_construct} instance method that will run
2283 non-trivial default constructors on any such instance variables, in order,
2284 and then return @code{self}.  Similarly, check if any instance variable
2285 is a C++ object with a non-trivial destructor, and if so, synthesize a
2286 special @code{- (void) .cxx_destruct} method that will run
2287 all such default destructors, in reverse order.
2288
2289 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2290 thusly generated will only operate on instance variables declared in the
2291 current Objective-C class, and not those inherited from superclasses.  It
2292 is the responsibility of the Objective-C runtime to invoke all such methods
2293 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2294 will be invoked by the runtime immediately after a new object
2295 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2296 be invoked immediately before the runtime deallocates an object instance.
2297
2298 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2299 support for invoking the @code{- (id) .cxx_construct} and
2300 @code{- (void) .cxx_destruct} methods.
2301
2302 @item -fobjc-direct-dispatch
2303 @opindex fobjc-direct-dispatch
2304 Allow fast jumps to the message dispatcher.  On Darwin this is
2305 accomplished via the comm page.
2306
2307 @item -fobjc-exceptions
2308 @opindex fobjc-exceptions
2309 Enable syntactic support for structured exception handling in Objective-C,
2310 similar to what is offered by C++ and Java.  This option is
2311 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2312 earlier.
2313
2314 @smallexample
2315   @@try @{
2316     @dots{}
2317        @@throw expr;
2318     @dots{}
2319   @}
2320   @@catch (AnObjCClass *exc) @{
2321     @dots{}
2322       @@throw expr;
2323     @dots{}
2324       @@throw;
2325     @dots{}
2326   @}
2327   @@catch (AnotherClass *exc) @{
2328     @dots{}
2329   @}
2330   @@catch (id allOthers) @{
2331     @dots{}
2332   @}
2333   @@finally @{
2334     @dots{}
2335       @@throw expr;
2336     @dots{}
2337   @}
2338 @end smallexample
2339
2340 The @code{@@throw} statement may appear anywhere in an Objective-C or
2341 Objective-C++ program; when used inside of a @code{@@catch} block, the
2342 @code{@@throw} may appear without an argument (as shown above), in which case
2343 the object caught by the @code{@@catch} will be rethrown.
2344
2345 Note that only (pointers to) Objective-C objects may be thrown and
2346 caught using this scheme.  When an object is thrown, it will be caught
2347 by the nearest @code{@@catch} clause capable of handling objects of that type,
2348 analogously to how @code{catch} blocks work in C++ and Java.  A
2349 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2350 any and all Objective-C exceptions not caught by previous @code{@@catch}
2351 clauses (if any).
2352
2353 The @code{@@finally} clause, if present, will be executed upon exit from the
2354 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2355 regardless of whether any exceptions are thrown, caught or rethrown
2356 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2357 of the @code{finally} clause in Java.
2358
2359 There are several caveats to using the new exception mechanism:
2360
2361 @itemize @bullet
2362 @item
2363 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2364 idioms provided by the @code{NSException} class, the new
2365 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2366 systems, due to additional functionality needed in the (NeXT) Objective-C
2367 runtime.
2368
2369 @item
2370 As mentioned above, the new exceptions do not support handling
2371 types other than Objective-C objects.   Furthermore, when used from
2372 Objective-C++, the Objective-C exception model does not interoperate with C++
2373 exceptions at this time.  This means you cannot @code{@@throw} an exception
2374 from Objective-C and @code{catch} it in C++, or vice versa
2375 (i.e., @code{throw @dots{} @@catch}).
2376 @end itemize
2377
2378 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2379 blocks for thread-safe execution:
2380
2381 @smallexample
2382   @@synchronized (ObjCClass *guard) @{
2383     @dots{}
2384   @}
2385 @end smallexample
2386
2387 Upon entering the @code{@@synchronized} block, a thread of execution shall
2388 first check whether a lock has been placed on the corresponding @code{guard}
2389 object by another thread.  If it has, the current thread shall wait until
2390 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2391 the current thread will place its own lock on it, execute the code contained in
2392 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2393 making @code{guard} available to other threads).
2394
2395 Unlike Java, Objective-C does not allow for entire methods to be marked
2396 @code{@@synchronized}.  Note that throwing exceptions out of
2397 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2398 to be unlocked properly.
2399
2400 @item -fobjc-gc
2401 @opindex fobjc-gc
2402 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2403
2404 @item -freplace-objc-classes
2405 @opindex freplace-objc-classes
2406 Emit a special marker instructing @command{ld(1)} not to statically link in
2407 the resulting object file, and allow @command{dyld(1)} to load it in at
2408 run time instead.  This is used in conjunction with the Fix-and-Continue
2409 debugging mode, where the object file in question may be recompiled and
2410 dynamically reloaded in the course of program execution, without the need
2411 to restart the program itself.  Currently, Fix-and-Continue functionality
2412 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2413 and later.
2414
2415 @item -fzero-link
2416 @opindex fzero-link
2417 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2418 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2419 compile time) with static class references that get initialized at load time,
2420 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2421 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2422 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2423 for individual class implementations to be modified during program execution.
2424
2425 @item -gen-decls
2426 @opindex gen-decls
2427 Dump interface declarations for all classes seen in the source file to a
2428 file named @file{@var{sourcename}.decl}.
2429
2430 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2431 @opindex Wassign-intercept
2432 @opindex Wno-assign-intercept
2433 Warn whenever an Objective-C assignment is being intercepted by the
2434 garbage collector.
2435
2436 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2437 @opindex Wno-protocol
2438 @opindex Wprotocol
2439 If a class is declared to implement a protocol, a warning is issued for
2440 every method in the protocol that is not implemented by the class.  The
2441 default behavior is to issue a warning for every method not explicitly
2442 implemented in the class, even if a method implementation is inherited
2443 from the superclass.  If you use the @option{-Wno-protocol} option, then
2444 methods inherited from the superclass are considered to be implemented,
2445 and no warning is issued for them.
2446
2447 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2448 @opindex Wselector
2449 @opindex Wno-selector
2450 Warn if multiple methods of different types for the same selector are
2451 found during compilation.  The check is performed on the list of methods
2452 in the final stage of compilation.  Additionally, a check is performed
2453 for each selector appearing in a @code{@@selector(@dots{})}
2454 expression, and a corresponding method for that selector has been found
2455 during compilation.  Because these checks scan the method table only at
2456 the end of compilation, these warnings are not produced if the final
2457 stage of compilation is not reached, for example because an error is
2458 found during compilation, or because the @option{-fsyntax-only} option is
2459 being used.
2460
2461 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2462 @opindex Wstrict-selector-match
2463 @opindex Wno-strict-selector-match
2464 Warn if multiple methods with differing argument and/or return types are
2465 found for a given selector when attempting to send a message using this
2466 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2467 is off (which is the default behavior), the compiler will omit such warnings
2468 if any differences found are confined to types which share the same size
2469 and alignment.
2470
2471 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2472 @opindex Wundeclared-selector
2473 @opindex Wno-undeclared-selector
2474 Warn if a @code{@@selector(@dots{})} expression referring to an
2475 undeclared selector is found.  A selector is considered undeclared if no
2476 method with that name has been declared before the
2477 @code{@@selector(@dots{})} expression, either explicitly in an
2478 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2479 an @code{@@implementation} section.  This option always performs its
2480 checks as soon as a @code{@@selector(@dots{})} expression is found,
2481 while @option{-Wselector} only performs its checks in the final stage of
2482 compilation.  This also enforces the coding style convention
2483 that methods and selectors must be declared before being used.
2484
2485 @item -print-objc-runtime-info
2486 @opindex print-objc-runtime-info
2487 Generate C header describing the largest structure that is passed by
2488 value, if any.
2489
2490 @end table
2491
2492 @node Language Independent Options
2493 @section Options to Control Diagnostic Messages Formatting
2494 @cindex options to control diagnostics formatting
2495 @cindex diagnostic messages
2496 @cindex message formatting
2497
2498 Traditionally, diagnostic messages have been formatted irrespective of
2499 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2500 below can be used to control the diagnostic messages formatting
2501 algorithm, e.g.@: how many characters per line, how often source location
2502 information should be reported.  Right now, only the C++ front end can
2503 honor these options.  However it is expected, in the near future, that
2504 the remaining front ends would be able to digest them correctly.
2505
2506 @table @gcctabopt
2507 @item -fmessage-length=@var{n}
2508 @opindex fmessage-length
2509 Try to format error messages so that they fit on lines of about @var{n}
2510 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2511 the front ends supported by GCC@.  If @var{n} is zero, then no
2512 line-wrapping will be done; each error message will appear on a single
2513 line.
2514
2515 @opindex fdiagnostics-show-location
2516 @item -fdiagnostics-show-location=once
2517 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2518 reporter to emit @emph{once} source location information; that is, in
2519 case the message is too long to fit on a single physical line and has to
2520 be wrapped, the source location won't be emitted (as prefix) again,
2521 over and over, in subsequent continuation lines.  This is the default
2522 behavior.
2523
2524 @item -fdiagnostics-show-location=every-line
2525 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2526 messages reporter to emit the same source location information (as
2527 prefix) for physical lines that result from the process of breaking
2528 a message which is too long to fit on a single line.
2529
2530 @item -fdiagnostics-show-option
2531 @opindex fdiagnostics-show-option
2532 This option instructs the diagnostic machinery to add text to each
2533 diagnostic emitted, which indicates which command line option directly
2534 controls that diagnostic, when such an option is known to the
2535 diagnostic machinery.
2536
2537 @item -Wcoverage-mismatch
2538 @opindex Wcoverage-mismatch
2539 Warn if feedback profiles do not match when using the
2540 @option{-fprofile-use} option.
2541 If a source file was changed between @option{-fprofile-gen} and
2542 @option{-fprofile-use}, the files with the profile feedback can fail
2543 to match the source file and GCC can not use the profile feedback
2544 information.  By default, GCC emits an error message in this case.
2545 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2546 error.  GCC does not use appropriate feedback profiles, so using this
2547 option can result in poorly optimized code.  This option is useful
2548 only in the case of very minor changes such as bug fixes to an
2549 existing code-base.
2550
2551 @end table
2552
2553 @node Warning Options
2554 @section Options to Request or Suppress Warnings
2555 @cindex options to control warnings
2556 @cindex warning messages
2557 @cindex messages, warning
2558 @cindex suppressing warnings
2559
2560 Warnings are diagnostic messages that report constructions which
2561 are not inherently erroneous but which are risky or suggest there
2562 may have been an error.
2563
2564 The following language-independent options do not enable specific
2565 warnings but control the kinds of diagnostics produced by GCC.
2566
2567 @table @gcctabopt
2568 @cindex syntax checking
2569 @item -fsyntax-only
2570 @opindex fsyntax-only
2571 Check the code for syntax errors, but don't do anything beyond that.
2572
2573 @item -w
2574 @opindex w
2575 Inhibit all warning messages.
2576
2577 @item -Werror
2578 @opindex Werror
2579 @opindex Wno-error
2580 Make all warnings into errors.
2581
2582 @item -Werror=
2583 @opindex Werror=
2584 @opindex Wno-error=
2585 Make the specified warning into an error.  The specifier for a warning
2586 is appended, for example @option{-Werror=switch} turns the warnings
2587 controlled by @option{-Wswitch} into errors.  This switch takes a
2588 negative form, to be used to negate @option{-Werror} for specific
2589 warnings, for example @option{-Wno-error=switch} makes
2590 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2591 is in effect.  You can use the @option{-fdiagnostics-show-option}
2592 option to have each controllable warning amended with the option which
2593 controls it, to determine what to use with this option.
2594
2595 Note that specifying @option{-Werror=}@var{foo} automatically implies
2596 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2597 imply anything.
2598
2599 @item -Wfatal-errors
2600 @opindex Wfatal-errors
2601 @opindex Wno-fatal-errors
2602 This option causes the compiler to abort compilation on the first error
2603 occurred rather than trying to keep going and printing further error
2604 messages.
2605
2606 @end table
2607
2608 You can request many specific warnings with options beginning
2609 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2610 implicit declarations.  Each of these specific warning options also
2611 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2612 example, @option{-Wno-implicit}.  This manual lists only one of the
2613 two forms, whichever is not the default.  For further,
2614 language-specific options also refer to @ref{C++ Dialect Options} and
2615 @ref{Objective-C and Objective-C++ Dialect Options}.
2616
2617 @table @gcctabopt
2618 @item -pedantic
2619 @opindex pedantic
2620 Issue all the warnings demanded by strict ISO C and ISO C++;
2621 reject all programs that use forbidden extensions, and some other
2622 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2623 version of the ISO C standard specified by any @option{-std} option used.
2624
2625 Valid ISO C and ISO C++ programs should compile properly with or without
2626 this option (though a rare few will require @option{-ansi} or a
2627 @option{-std} option specifying the required version of ISO C)@.  However,
2628 without this option, certain GNU extensions and traditional C and C++
2629 features are supported as well.  With this option, they are rejected.
2630
2631 @option{-pedantic} does not cause warning messages for use of the
2632 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2633 warnings are also disabled in the expression that follows
2634 @code{__extension__}.  However, only system header files should use
2635 these escape routes; application programs should avoid them.
2636 @xref{Alternate Keywords}.
2637
2638 Some users try to use @option{-pedantic} to check programs for strict ISO
2639 C conformance.  They soon find that it does not do quite what they want:
2640 it finds some non-ISO practices, but not all---only those for which
2641 ISO C @emph{requires} a diagnostic, and some others for which
2642 diagnostics have been added.
2643
2644 A feature to report any failure to conform to ISO C might be useful in
2645 some instances, but would require considerable additional work and would
2646 be quite different from @option{-pedantic}.  We don't have plans to
2647 support such a feature in the near future.
2648
2649 Where the standard specified with @option{-std} represents a GNU
2650 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2651 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2652 extended dialect is based.  Warnings from @option{-pedantic} are given
2653 where they are required by the base standard.  (It would not make sense
2654 for such warnings to be given only for features not in the specified GNU
2655 C dialect, since by definition the GNU dialects of C include all
2656 features the compiler supports with the given option, and there would be
2657 nothing to warn about.)
2658
2659 @item -pedantic-errors
2660 @opindex pedantic-errors
2661 Like @option{-pedantic}, except that errors are produced rather than
2662 warnings.
2663
2664 @item -Wall
2665 @opindex Wall
2666 @opindex Wno-all
2667 This enables all the warnings about constructions that some users
2668 consider questionable, and that are easy to avoid (or modify to
2669 prevent the warning), even in conjunction with macros.  This also
2670 enables some language-specific warnings described in @ref{C++ Dialect
2671 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2672
2673 @option{-Wall} turns on the following warning flags:
2674
2675 @gccoptlist{-Waddress   @gol
2676 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2677 -Wc++0x-compat  @gol
2678 -Wchar-subscripts  @gol
2679 -Wimplicit-int  @gol
2680 -Wimplicit-function-declaration  @gol
2681 -Wcomment  @gol
2682 -Wformat   @gol
2683 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2684 -Wmissing-braces  @gol
2685 -Wnonnull  @gol
2686 -Wparentheses  @gol
2687 -Wpointer-sign  @gol
2688 -Wreorder   @gol
2689 -Wreturn-type  @gol
2690 -Wsequence-point  @gol
2691 -Wsign-compare @r{(only in C++)}  @gol
2692 -Wstrict-aliasing  @gol
2693 -Wstrict-overflow=1  @gol
2694 -Wswitch  @gol
2695 -Wtrigraphs  @gol
2696 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2697 -Wunknown-pragmas  @gol
2698 -Wunused-function  @gol
2699 -Wunused-label     @gol
2700 -Wunused-value     @gol
2701 -Wunused-variable  @gol
2702 -Wvolatile-register-var @gol
2703 }
2704
2705 Note that some warning flags are not implied by @option{-Wall}.  Some of
2706 them warn about constructions that users generally do not consider
2707 questionable, but which occasionally you might wish to check for;
2708 others warn about constructions that are necessary or hard to avoid in
2709 some cases, and there is no simple way to modify the code to suppress
2710 the warning. Some of them are enabled by @option{-Wextra} but many of
2711 them must be enabled individually.
2712
2713 @item -Wextra
2714 @opindex W
2715 @opindex Wextra
2716 @opindex Wno-extra
2717 This enables some extra warning flags that are not enabled by
2718 @option{-Wall}. (This option used to be called @option{-W}.  The older
2719 name is still supported, but the newer name is more descriptive.)
2720
2721 @gccoptlist{-Wclobbered  @gol
2722 -Wempty-body  @gol
2723 -Wignored-qualifiers @gol
2724 -Wmissing-field-initializers  @gol
2725 -Wmissing-parameter-type @r{(C only)}  @gol
2726 -Wold-style-declaration @r{(C only)}  @gol
2727 -Woverride-init  @gol
2728 -Wsign-compare  @gol
2729 -Wtype-limits  @gol
2730 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2731 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2732 }
2733
2734 The option @option{-Wextra} also prints warning messages for the
2735 following cases:
2736
2737 @itemize @bullet
2738
2739 @item
2740 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2741 @samp{>}, or @samp{>=}.
2742
2743 @item 
2744 (C++ only) An enumerator and a non-enumerator both appear in a
2745 conditional expression.
2746
2747 @item 
2748 (C++ only) A non-static reference or non-static @samp{const} member
2749 appears in a class without constructors.
2750
2751 @item 
2752 (C++ only) Ambiguous virtual bases.
2753
2754 @item 
2755 (C++ only) Subscripting an array which has been declared @samp{register}.
2756
2757 @item 
2758 (C++ only) Taking the address of a variable which has been declared
2759 @samp{register}.
2760
2761 @item 
2762 (C++ only) A base class is not initialized in a derived class' copy
2763 constructor.
2764
2765 @end itemize
2766
2767 @item -Wchar-subscripts
2768 @opindex Wchar-subscripts
2769 @opindex Wno-char-subscripts
2770 Warn if an array subscript has type @code{char}.  This is a common cause
2771 of error, as programmers often forget that this type is signed on some
2772 machines.
2773 This warning is enabled by @option{-Wall}.
2774
2775 @item -Wcomment
2776 @opindex Wcomment
2777 @opindex Wno-comment
2778 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2779 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2780 This warning is enabled by @option{-Wall}.
2781
2782 @item -Wformat
2783 @opindex Wformat
2784 @opindex Wno-format
2785 @opindex ffreestanding
2786 @opindex fno-builtin
2787 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2788 the arguments supplied have types appropriate to the format string
2789 specified, and that the conversions specified in the format string make
2790 sense.  This includes standard functions, and others specified by format
2791 attributes (@pxref{Function Attributes}), in the @code{printf},
2792 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2793 not in the C standard) families (or other target-specific families).
2794 Which functions are checked without format attributes having been
2795 specified depends on the standard version selected, and such checks of
2796 functions without the attribute specified are disabled by
2797 @option{-ffreestanding} or @option{-fno-builtin}.
2798
2799 The formats are checked against the format features supported by GNU
2800 libc version 2.2.  These include all ISO C90 and C99 features, as well
2801 as features from the Single Unix Specification and some BSD and GNU
2802 extensions.  Other library implementations may not support all these
2803 features; GCC does not support warning about features that go beyond a
2804 particular library's limitations.  However, if @option{-pedantic} is used
2805 with @option{-Wformat}, warnings will be given about format features not
2806 in the selected standard version (but not for @code{strfmon} formats,
2807 since those are not in any version of the C standard).  @xref{C Dialect
2808 Options,,Options Controlling C Dialect}.
2809
2810 Since @option{-Wformat} also checks for null format arguments for
2811 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2812
2813 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2814 aspects of format checking, the options @option{-Wformat-y2k},
2815 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2816 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2817 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2818
2819 @item -Wformat-y2k
2820 @opindex Wformat-y2k
2821 @opindex Wno-format-y2k
2822 If @option{-Wformat} is specified, also warn about @code{strftime}
2823 formats which may yield only a two-digit year.
2824
2825 @item -Wno-format-contains-nul
2826 @opindex Wno-format-contains-nul
2827 @opindex Wformat-contains-nul
2828 If @option{-Wformat} is specified, do not warn about format strings that
2829 contain NUL bytes.
2830
2831 @item -Wno-format-extra-args
2832 @opindex Wno-format-extra-args
2833 @opindex Wformat-extra-args
2834 If @option{-Wformat} is specified, do not warn about excess arguments to a
2835 @code{printf} or @code{scanf} format function.  The C standard specifies
2836 that such arguments are ignored.
2837
2838 Where the unused arguments lie between used arguments that are
2839 specified with @samp{$} operand number specifications, normally
2840 warnings are still given, since the implementation could not know what
2841 type to pass to @code{va_arg} to skip the unused arguments.  However,
2842 in the case of @code{scanf} formats, this option will suppress the
2843 warning if the unused arguments are all pointers, since the Single
2844 Unix Specification says that such unused arguments are allowed.
2845
2846 @item -Wno-format-zero-length @r{(C and Objective-C only)}
2847 @opindex Wno-format-zero-length
2848 @opindex Wformat-zero-length
2849 If @option{-Wformat} is specified, do not warn about zero-length formats.
2850 The C standard specifies that zero-length formats are allowed.
2851
2852 @item -Wformat-nonliteral
2853 @opindex Wformat-nonliteral
2854 @opindex Wno-format-nonliteral
2855 If @option{-Wformat} is specified, also warn if the format string is not a
2856 string literal and so cannot be checked, unless the format function
2857 takes its format arguments as a @code{va_list}.
2858
2859 @item -Wformat-security
2860 @opindex Wformat-security
2861 @opindex Wno-format-security
2862 If @option{-Wformat} is specified, also warn about uses of format
2863 functions that represent possible security problems.  At present, this
2864 warns about calls to @code{printf} and @code{scanf} functions where the
2865 format string is not a string literal and there are no format arguments,
2866 as in @code{printf (foo);}.  This may be a security hole if the format
2867 string came from untrusted input and contains @samp{%n}.  (This is
2868 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2869 in future warnings may be added to @option{-Wformat-security} that are not
2870 included in @option{-Wformat-nonliteral}.)
2871
2872 @item -Wformat=2
2873 @opindex Wformat=2
2874 @opindex Wno-format=2
2875 Enable @option{-Wformat} plus format checks not included in
2876 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2877 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2878
2879 @item -Wnonnull @r{(C and Objective-C only)}
2880 @opindex Wnonnull
2881 @opindex Wno-nonnull
2882 Warn about passing a null pointer for arguments marked as
2883 requiring a non-null value by the @code{nonnull} function attribute.
2884
2885 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2886 can be disabled with the @option{-Wno-nonnull} option.
2887
2888 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2889 @opindex Winit-self
2890 @opindex Wno-init-self
2891 Warn about uninitialized variables which are initialized with themselves.
2892 Note this option can only be used with the @option{-Wuninitialized} option,
2893 which in turn only works with @option{-O1} and above.
2894
2895 For example, GCC will warn about @code{i} being uninitialized in the
2896 following snippet only when @option{-Winit-self} has been specified:
2897 @smallexample
2898 @group
2899 int f()
2900 @{
2901   int i = i;
2902   return i;
2903 @}
2904 @end group
2905 @end smallexample
2906
2907 @item -Wimplicit-int @r{(C and Objective-C only)}
2908 @opindex Wimplicit-int
2909 @opindex Wno-implicit-int
2910 Warn when a declaration does not specify a type.
2911 This warning is enabled by @option{-Wall}.
2912
2913 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
2914 @opindex Wimplicit-function-declaration
2915 @opindex Wno-implicit-function-declaration
2916 Give a warning whenever a function is used before being declared. In
2917 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
2918 enabled by default and it is made into an error by
2919 @option{-pedantic-errors}. This warning is also enabled by
2920 @option{-Wall}.
2921
2922 @item -Wimplicit
2923 @opindex Wimplicit
2924 @opindex Wno-implicit
2925 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2926 This warning is enabled by @option{-Wall}.
2927
2928 @item -Wignored-qualifiers @r{(C and C++ only)}
2929 @opindex Wignored-qualifiers
2930 @opindex Wno-ignored-qualifiers
2931 Warn if the return type of a function has a type qualifier
2932 such as @code{const}.  For ISO C such a type qualifier has no effect,
2933 since the value returned by a function is not an lvalue.
2934 For C++, the warning is only emitted for scalar types or @code{void}.
2935 ISO C prohibits qualified @code{void} return types on function
2936 definitions, so such return types always receive a warning
2937 even without this option.
2938
2939 This warning is also enabled by @option{-Wextra}.
2940
2941 @item -Wmain
2942 @opindex Wmain
2943 @opindex Wno-main
2944 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2945 function with external linkage, returning int, taking either zero
2946 arguments, two, or three arguments of appropriate types.
2947 This warning is enabled by @option{-Wall}.
2948
2949 @item -Wmissing-braces
2950 @opindex Wmissing-braces
2951 @opindex Wno-missing-braces
2952 Warn if an aggregate or union initializer is not fully bracketed.  In
2953 the following example, the initializer for @samp{a} is not fully
2954 bracketed, but that for @samp{b} is fully bracketed.
2955
2956 @smallexample
2957 int a[2][2] = @{ 0, 1, 2, 3 @};
2958 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2959 @end smallexample
2960
2961 This warning is enabled by @option{-Wall}.
2962
2963 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2964 @opindex Wmissing-include-dirs
2965 @opindex Wno-missing-include-dirs
2966 Warn if a user-supplied include directory does not exist.
2967
2968 @item -Wparentheses
2969 @opindex Wparentheses
2970 @opindex Wno-parentheses
2971 Warn if parentheses are omitted in certain contexts, such
2972 as when there is an assignment in a context where a truth value
2973 is expected, or when operators are nested whose precedence people
2974 often get confused about.
2975
2976 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2977 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2978 interpretation from that of ordinary mathematical notation.
2979
2980 Also warn about constructions where there may be confusion to which
2981 @code{if} statement an @code{else} branch belongs.  Here is an example of
2982 such a case:
2983
2984 @smallexample
2985 @group
2986 @{
2987   if (a)
2988     if (b)
2989       foo ();
2990   else
2991     bar ();
2992 @}
2993 @end group
2994 @end smallexample
2995
2996 In C/C++, every @code{else} branch belongs to the innermost possible
2997 @code{if} statement, which in this example is @code{if (b)}.  This is
2998 often not what the programmer expected, as illustrated in the above
2999 example by indentation the programmer chose.  When there is the
3000 potential for this confusion, GCC will issue a warning when this flag
3001 is specified.  To eliminate the warning, add explicit braces around
3002 the innermost @code{if} statement so there is no way the @code{else}
3003 could belong to the enclosing @code{if}.  The resulting code would
3004 look like this:
3005
3006 @smallexample
3007 @group
3008 @{
3009   if (a)
3010     @{
3011       if (b)
3012         foo ();
3013       else
3014         bar ();
3015     @}
3016 @}
3017 @end group
3018 @end smallexample
3019
3020 This warning is enabled by @option{-Wall}.
3021
3022 @item -Wsequence-point
3023 @opindex Wsequence-point
3024 @opindex Wno-sequence-point
3025 Warn about code that may have undefined semantics because of violations
3026 of sequence point rules in the C and C++ standards.
3027
3028 The C and C++ standards defines the order in which expressions in a C/C++
3029 program are evaluated in terms of @dfn{sequence points}, which represent
3030 a partial ordering between the execution of parts of the program: those
3031 executed before the sequence point, and those executed after it.  These
3032 occur after the evaluation of a full expression (one which is not part
3033 of a larger expression), after the evaluation of the first operand of a
3034 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3035 function is called (but after the evaluation of its arguments and the
3036 expression denoting the called function), and in certain other places.
3037 Other than as expressed by the sequence point rules, the order of
3038 evaluation of subexpressions of an expression is not specified.  All
3039 these rules describe only a partial order rather than a total order,
3040 since, for example, if two functions are called within one expression
3041 with no sequence point between them, the order in which the functions
3042 are called is not specified.  However, the standards committee have
3043 ruled that function calls do not overlap.
3044
3045 It is not specified when between sequence points modifications to the
3046 values of objects take effect.  Programs whose behavior depends on this
3047 have undefined behavior; the C and C++ standards specify that ``Between
3048 the previous and next sequence point an object shall have its stored
3049 value modified at most once by the evaluation of an expression.
3050 Furthermore, the prior value shall be read only to determine the value
3051 to be stored.''.  If a program breaks these rules, the results on any
3052 particular implementation are entirely unpredictable.
3053
3054 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3055 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3056 diagnosed by this option, and it may give an occasional false positive
3057 result, but in general it has been found fairly effective at detecting
3058 this sort of problem in programs.
3059
3060 The standard is worded confusingly, therefore there is some debate
3061 over the precise meaning of the sequence point rules in subtle cases.
3062 Links to discussions of the problem, including proposed formal
3063 definitions, may be found on the GCC readings page, at
3064 @w{@uref{http://gcc.gnu.org/readings.html}}.
3065
3066 This warning is enabled by @option{-Wall} for C and C++.
3067
3068 @item -Wreturn-type
3069 @opindex Wreturn-type
3070 @opindex Wno-return-type
3071 Warn whenever a function is defined with a return-type that defaults
3072 to @code{int}.  Also warn about any @code{return} statement with no
3073 return-value in a function whose return-type is not @code{void}
3074 (falling off the end of the function body is considered returning
3075 without a value), and about a @code{return} statement with a
3076 expression in a function whose return-type is @code{void}.
3077
3078 For C++, a function without return type always produces a diagnostic
3079 message, even when @option{-Wno-return-type} is specified.  The only
3080 exceptions are @samp{main} and functions defined in system headers.
3081
3082 This warning is enabled by @option{-Wall}.
3083
3084 @item -Wswitch
3085 @opindex Wswitch
3086 @opindex Wno-switch
3087 Warn whenever a @code{switch} statement has an index of enumerated type
3088 and lacks a @code{case} for one or more of the named codes of that
3089 enumeration.  (The presence of a @code{default} label prevents this
3090 warning.)  @code{case} labels outside the enumeration range also
3091 provoke warnings when this option is used.
3092 This warning is enabled by @option{-Wall}.
3093
3094 @item -Wswitch-default
3095 @opindex Wswitch-default
3096 @opindex Wno-switch-default
3097 Warn whenever a @code{switch} statement does not have a @code{default}
3098 case.
3099
3100 @item -Wswitch-enum
3101 @opindex Wswitch-enum
3102 @opindex Wno-switch-enum
3103 Warn whenever a @code{switch} statement has an index of enumerated type
3104 and lacks a @code{case} for one or more of the named codes of that
3105 enumeration.  @code{case} labels outside the enumeration range also
3106 provoke warnings when this option is used.
3107
3108 @item -Wtrigraphs
3109 @opindex Wtrigraphs
3110 @opindex Wno-trigraphs
3111 Warn if any trigraphs are encountered that might change the meaning of
3112 the program (trigraphs within comments are not warned about).
3113 This warning is enabled by @option{-Wall}.
3114
3115 @item -Wunused-function
3116 @opindex Wunused-function
3117 @opindex Wno-unused-function
3118 Warn whenever a static function is declared but not defined or a
3119 non-inline static function is unused.
3120 This warning is enabled by @option{-Wall}.
3121
3122 @item -Wunused-label
3123 @opindex Wunused-label
3124 @opindex Wno-unused-label
3125 Warn whenever a label is declared but not used.
3126 This warning is enabled by @option{-Wall}.
3127
3128 To suppress this warning use the @samp{unused} attribute
3129 (@pxref{Variable Attributes}).
3130
3131 @item -Wunused-parameter
3132 @opindex Wunused-parameter
3133 @opindex Wno-unused-parameter
3134 Warn whenever a function parameter is unused aside from its declaration.
3135
3136 To suppress this warning use the @samp{unused} attribute
3137 (@pxref{Variable Attributes}).
3138
3139 @item -Wunused-variable
3140 @opindex Wunused-variable
3141 @opindex Wno-unused-variable
3142 Warn whenever a local variable or non-constant static variable is unused
3143 aside from its declaration.
3144 This warning is enabled by @option{-Wall}.
3145
3146 To suppress this warning use the @samp{unused} attribute
3147 (@pxref{Variable Attributes}).
3148
3149 @item -Wunused-value
3150 @opindex Wunused-value
3151 @opindex Wno-unused-value
3152 Warn whenever a statement computes a result that is explicitly not
3153 used. To suppress this warning cast the unused expression to
3154 @samp{void}. This includes an expression-statement or the left-hand
3155 side of a comma expression that contains no side effects. For example,
3156 an expression such as @samp{x[i,j]} will cause a warning, while
3157 @samp{x[(void)i,j]} will not.
3158
3159 This warning is enabled by @option{-Wall}.
3160
3161 @item -Wunused
3162 @opindex Wunused
3163 @opindex Wno-unused
3164 All the above @option{-Wunused} options combined.
3165
3166 In order to get a warning about an unused function parameter, you must
3167 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3168 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3169
3170 @item -Wuninitialized
3171 @opindex Wuninitialized
3172 @opindex Wno-uninitialized
3173 Warn if an automatic variable is used without first being initialized or
3174 if a variable may be clobbered by a @code{setjmp} call.
3175
3176 These warnings are possible only in optimizing compilation,
3177 because they require data flow information that is computed only
3178 when optimizing.  If you do not specify @option{-O}, you will not get
3179 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
3180 requiring @option{-O}.
3181
3182 If you want to warn about code which uses the uninitialized value of the
3183 variable in its own initializer, use the @option{-Winit-self} option.
3184
3185 These warnings occur for individual uninitialized or clobbered
3186 elements of structure, union or array variables as well as for
3187 variables which are uninitialized or clobbered as a whole.  They do
3188 not occur for variables or elements declared @code{volatile}.  Because
3189 these warnings depend on optimization, the exact variables or elements
3190 for which there are warnings will depend on the precise optimization
3191 options and version of GCC used.
3192
3193 Note that there may be no warning about a variable that is used only
3194 to compute a value that itself is never used, because such
3195 computations may be deleted by data flow analysis before the warnings
3196 are printed.
3197
3198 These warnings are made optional because GCC is not smart
3199 enough to see all the reasons why the code might be correct
3200 despite appearing to have an error.  Here is one example of how
3201 this can happen:
3202
3203 @smallexample
3204 @group
3205 @{
3206   int x;
3207   switch (y)
3208     @{
3209     case 1: x = 1;
3210       break;
3211     case 2: x = 4;
3212       break;
3213     case 3: x = 5;
3214     @}
3215   foo (x);
3216 @}
3217 @end group
3218 @end smallexample
3219
3220 @noindent
3221 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3222 always initialized, but GCC doesn't know this.  Here is
3223 another common case:
3224
3225 @smallexample
3226 @{
3227   int save_y;
3228   if (change_y) save_y = y, y = new_y;
3229   @dots{}
3230   if (change_y) y = save_y;
3231 @}
3232 @end smallexample
3233
3234 @noindent
3235 This has no bug because @code{save_y} is used only if it is set.
3236
3237 @cindex @code{longjmp} warnings
3238 This option also warns when a non-volatile automatic variable might be
3239 changed by a call to @code{longjmp}.  These warnings as well are possible
3240 only in optimizing compilation.
3241
3242 The compiler sees only the calls to @code{setjmp}.  It cannot know
3243 where @code{longjmp} will be called; in fact, a signal handler could
3244 call it at any point in the code.  As a result, you may get a warning
3245 even when there is in fact no problem because @code{longjmp} cannot
3246 in fact be called at the place which would cause a problem.
3247
3248 Some spurious warnings can be avoided if you declare all the functions
3249 you use that never return as @code{noreturn}.  @xref{Function
3250 Attributes}.
3251
3252 This warning is enabled by @option{-Wall} or @option{-Wextra} in
3253 optimizing compilations (@option{-O1} and above).
3254
3255 @item -Wunknown-pragmas
3256 @opindex Wunknown-pragmas
3257 @opindex Wno-unknown-pragmas
3258 @cindex warning for unknown pragmas
3259 @cindex unknown pragmas, warning
3260 @cindex pragmas, warning of unknown
3261 Warn when a #pragma directive is encountered which is not understood by
3262 GCC@.  If this command line option is used, warnings will even be issued
3263 for unknown pragmas in system header files.  This is not the case if
3264 the warnings were only enabled by the @option{-Wall} command line option.
3265
3266 @item -Wno-pragmas
3267 @opindex Wno-pragmas
3268 @opindex Wpragmas
3269 Do not warn about misuses of pragmas, such as incorrect parameters,
3270 invalid syntax, or conflicts between pragmas.  See also
3271 @samp{-Wunknown-pragmas}.
3272
3273 @item -Wstrict-aliasing
3274 @opindex Wstrict-aliasing
3275 @opindex Wno-strict-aliasing
3276 This option is only active when @option{-fstrict-aliasing} is active.
3277 It warns about code which might break the strict aliasing rules that the
3278 compiler is using for optimization.  The warning does not catch all
3279 cases, but does attempt to catch the more common pitfalls.  It is
3280 included in @option{-Wall}.
3281 It is equivalent to @option{-Wstrict-aliasing=3}
3282
3283 @item -Wstrict-aliasing=n
3284 @opindex Wstrict-aliasing=n
3285 @opindex Wno-strict-aliasing=n
3286 This option is only active when @option{-fstrict-aliasing} is active.
3287 It warns about code which might break the strict aliasing rules that the
3288 compiler is using for optimization.
3289 Higher levels correspond to higher accuracy (fewer false positives).
3290 Higher levels also correspond to more effort, similar to the way -O works.
3291 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3292 with n=3.
3293
3294 Level 1: Most aggressive, quick, least accurate.
3295 Possibly useful when higher levels
3296 do not warn but -fstrict-aliasing still breaks the code, as it has very few 
3297 false negatives.  However, it has many false positives.
3298 Warns for all pointer conversions between possibly incompatible types, 
3299 even if never dereferenced.  Runs in the frontend only.
3300
3301 Level 2: Aggressive, quick, not too precise.
3302 May still have many false positives (not as many as level 1 though),
3303 and few false negatives (but possibly more than level 1).
3304 Unlike level 1, it only warns when an address is taken.  Warns about
3305 incomplete types.  Runs in the frontend only.
3306
3307 Level 3 (default for @option{-Wstrict-aliasing}): 
3308 Should have very few false positives and few false 
3309 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3310 Takes care of the common punn+dereference pattern in the frontend:
3311 @code{*(int*)&some_float}.
3312 If optimization is enabled, it also runs in the backend, where it deals 
3313 with multiple statement cases using flow-sensitive points-to information.
3314 Only warns when the converted pointer is dereferenced.
3315 Does not warn about incomplete types.
3316
3317 @item -Wstrict-overflow
3318 @itemx -Wstrict-overflow=@var{n}
3319 @opindex Wstrict-overflow
3320 @opindex Wno-strict-overflow
3321 This option is only active when @option{-fstrict-overflow} is active.
3322 It warns about cases where the compiler optimizes based on the
3323 assumption that signed overflow does not occur.  Note that it does not
3324 warn about all cases where the code might overflow: it only warns
3325 about cases where the compiler implements some optimization.  Thus
3326 this warning depends on the optimization level.
3327
3328 An optimization which assumes that signed overflow does not occur is
3329 perfectly safe if the values of the variables involved are such that
3330 overflow never does, in fact, occur.  Therefore this warning can
3331 easily give a false positive: a warning about code which is not
3332 actually a problem.  To help focus on important issues, several
3333 warning levels are defined.  No warnings are issued for the use of
3334 undefined signed overflow when estimating how many iterations a loop
3335 will require, in particular when determining whether a loop will be
3336 executed at all.
3337
3338 @table @gcctabopt
3339 @item -Wstrict-overflow=1
3340 Warn about cases which are both questionable and easy to avoid.  For
3341 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3342 compiler will simplify this to @code{1}.  This level of
3343 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3344 are not, and must be explicitly requested.
3345
3346 @item -Wstrict-overflow=2
3347 Also warn about other cases where a comparison is simplified to a
3348 constant.  For example: @code{abs (x) >= 0}.  This can only be
3349 simplified when @option{-fstrict-overflow} is in effect, because
3350 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3351 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3352 @option{-Wstrict-overflow=2}.
3353
3354 @item -Wstrict-overflow=3
3355 Also warn about other cases where a comparison is simplified.  For
3356 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3357
3358 @item -Wstrict-overflow=4
3359 Also warn about other simplifications not covered by the above cases.
3360 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3361
3362 @item -Wstrict-overflow=5
3363 Also warn about cases where the compiler reduces the magnitude of a
3364 constant involved in a comparison.  For example: @code{x + 2 > y} will
3365 be simplified to @code{x + 1 >= y}.  This is reported only at the
3366 highest warning level because this simplification applies to many
3367 comparisons, so this warning level will give a very large number of
3368 false positives.
3369 @end table
3370
3371 @item -Warray-bounds
3372 @opindex Wno-array-bounds
3373 @opindex Warray-bounds
3374 This option is only active when @option{-ftree-vrp} is active
3375 (default for -O2 and above). It warns about subscripts to arrays
3376 that are always out of bounds. This warning is enabled by @option{-Wall}.
3377
3378 @item -Wno-div-by-zero
3379 @opindex Wno-div-by-zero
3380 @opindex Wdiv-by-zero
3381 Do not warn about compile-time integer division by zero.  Floating point
3382 division by zero is not warned about, as it can be a legitimate way of
3383 obtaining infinities and NaNs.
3384
3385 @item -Wsystem-headers
3386 @opindex Wsystem-headers
3387 @opindex Wno-system-headers
3388 @cindex warnings from system headers
3389 @cindex system headers, warnings from
3390 Print warning messages for constructs found in system header files.
3391 Warnings from system headers are normally suppressed, on the assumption
3392 that they usually do not indicate real problems and would only make the
3393 compiler output harder to read.  Using this command line option tells
3394 GCC to emit warnings from system headers as if they occurred in user
3395 code.  However, note that using @option{-Wall} in conjunction with this
3396 option will @emph{not} warn about unknown pragmas in system
3397 headers---for that, @option{-Wunknown-pragmas} must also be used.
3398
3399 @item -Wfloat-equal
3400 @opindex Wfloat-equal
3401 @opindex Wno-float-equal
3402 Warn if floating point values are used in equality comparisons.
3403
3404 The idea behind this is that sometimes it is convenient (for the
3405 programmer) to consider floating-point values as approximations to
3406 infinitely precise real numbers.  If you are doing this, then you need
3407 to compute (by analyzing the code, or in some other way) the maximum or
3408 likely maximum error that the computation introduces, and allow for it
3409 when performing comparisons (and when producing output, but that's a
3410 different problem).  In particular, instead of testing for equality, you
3411 would check to see whether the two values have ranges that overlap; and
3412 this is done with the relational operators, so equality comparisons are
3413 probably mistaken.
3414
3415 @item -Wtraditional @r{(C and Objective-C only)}
3416 @opindex Wtraditional
3417 @opindex Wno-traditional
3418 Warn about certain constructs that behave differently in traditional and
3419 ISO C@.  Also warn about ISO C constructs that have no traditional C
3420 equivalent, and/or problematic constructs which should be avoided.
3421
3422 @itemize @bullet
3423 @item
3424 Macro parameters that appear within string literals in the macro body.
3425 In traditional C macro replacement takes place within string literals,
3426 but does not in ISO C@.
3427
3428 @item
3429 In traditional C, some preprocessor directives did not exist.
3430 Traditional preprocessors would only consider a line to be a directive
3431 if the @samp{#} appeared in column 1 on the line.  Therefore
3432 @option{-Wtraditional} warns about directives that traditional C
3433 understands but would ignore because the @samp{#} does not appear as the
3434 first character on the line.  It also suggests you hide directives like
3435 @samp{#pragma} not understood by traditional C by indenting them.  Some
3436 traditional implementations would not recognize @samp{#elif}, so it
3437 suggests avoiding it altogether.
3438
3439 @item
3440 A function-like macro that appears without arguments.
3441
3442 @item
3443 The unary plus operator.
3444
3445 @item
3446 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3447 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3448 constants.)  Note, these suffixes appear in macros defined in the system
3449 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3450 Use of these macros in user code might normally lead to spurious
3451 warnings, however GCC's integrated preprocessor has enough context to
3452 avoid warning in these cases.
3453
3454 @item
3455 A function declared external in one block and then used after the end of
3456 the block.
3457
3458 @item
3459 A @code{switch} statement has an operand of type @code{long}.
3460
3461 @item
3462 A non-@code{static} function declaration follows a @code{static} one.
3463 This construct is not accepted by some traditional C compilers.
3464
3465 @item
3466 The ISO type of an integer constant has a different width or
3467 signedness from its traditional type.  This warning is only issued if
3468 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3469 typically represent bit patterns, are not warned about.
3470
3471 @item
3472 Usage of ISO string concatenation is detected.
3473
3474 @item
3475 Initialization of automatic aggregates.
3476
3477 @item
3478 Identifier conflicts with labels.  Traditional C lacks a separate
3479 namespace for labels.
3480
3481 @item
3482 Initialization of unions.  If the initializer is zero, the warning is
3483 omitted.  This is done under the assumption that the zero initializer in
3484 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3485 initializer warnings and relies on default initialization to zero in the
3486 traditional C case.
3487
3488 @item
3489 Conversions by prototypes between fixed/floating point values and vice
3490 versa.  The absence of these prototypes when compiling with traditional
3491 C would cause serious problems.  This is a subset of the possible
3492 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3493
3494 @item
3495 Use of ISO C style function definitions.  This warning intentionally is
3496 @emph{not} issued for prototype declarations or variadic functions
3497 because these ISO C features will appear in your code when using
3498 libiberty's traditional C compatibility macros, @code{PARAMS} and
3499 @code{VPARAMS}.  This warning is also bypassed for nested functions
3500 because that feature is already a GCC extension and thus not relevant to
3501 traditional C compatibility.
3502 @end itemize
3503
3504 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3505 @opindex Wtraditional-conversion
3506 @opindex Wno-traditional-conversion
3507 Warn if a prototype causes a type conversion that is different from what
3508 would happen to the same argument in the absence of a prototype.  This
3509 includes conversions of fixed point to floating and vice versa, and
3510 conversions changing the width or signedness of a fixed point argument
3511 except when the same as the default promotion.
3512
3513 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3514 @opindex Wdeclaration-after-statement
3515 @opindex Wno-declaration-after-statement
3516 Warn when a declaration is found after a statement in a block.  This
3517 construct, known from C++, was introduced with ISO C99 and is by default
3518 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3519 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3520
3521 @item -Wundef
3522 @opindex Wundef
3523 @opindex Wno-undef
3524 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3525
3526 @item -Wno-endif-labels
3527 @opindex Wno-endif-labels
3528 @opindex Wendif-labels
3529 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3530
3531 @item -Wshadow
3532 @opindex Wshadow
3533 @opindex Wno-shadow
3534 Warn whenever a local variable shadows another local variable, parameter or
3535 global variable or whenever a built-in function is shadowed.
3536
3537 @item -Wlarger-than=@var{len}
3538 @opindex Wlarger-than=@var{len}
3539 @opindex Wlarger-than-@var{len}
3540 Warn whenever an object of larger than @var{len} bytes is defined.
3541
3542 @item -Wframe-larger-than=@var{len}
3543 @opindex Wframe-larger-than
3544 Warn if the size of a function frame is larger than @var{len} bytes.
3545 The computation done to determine the stack frame size is approximate
3546 and not conservative.
3547 The actual requirements may be somewhat greater than @var{len}
3548 even if you do not get a warning.  In addition, any space allocated
3549 via @code{alloca}, variable-length arrays, or related constructs
3550 is not included by the compiler when determining
3551 whether or not to issue a warning.
3552
3553 @item -Wunsafe-loop-optimizations
3554 @opindex Wunsafe-loop-optimizations
3555 @opindex Wno-unsafe-loop-optimizations
3556 Warn if the loop cannot be optimized because the compiler could not
3557 assume anything on the bounds of the loop indices.  With
3558 @option{-funsafe-loop-optimizations} warn if the compiler made
3559 such assumptions.
3560
3561 @item -Wpointer-arith
3562 @opindex Wpointer-arith
3563 @opindex Wno-pointer-arith
3564 Warn about anything that depends on the ``size of'' a function type or
3565 of @code{void}.  GNU C assigns these types a size of 1, for
3566 convenience in calculations with @code{void *} pointers and pointers
3567 to functions.  In C++, warn also when an arithmetic operation involves
3568 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3569
3570 @item -Wtype-limits
3571 @opindex Wtype-limits
3572 @opindex Wno-type-limits
3573 Warn if a comparison is always true or always false due to the limited
3574 range of the data type, but do not warn for constant expressions.  For
3575 example, warn if an unsigned variable is compared against zero with
3576 @samp{<} or @samp{>=}.  This warning is also enabled by
3577 @option{-Wextra}.
3578
3579 @item -Wbad-function-cast @r{(C and Objective-C only)}
3580 @opindex Wbad-function-cast
3581 @opindex Wno-bad-function-cast
3582 Warn whenever a function call is cast to a non-matching type.
3583 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3584
3585 @item -Wc++-compat @r{(C and Objective-C only)}
3586 Warn about ISO C constructs that are outside of the common subset of
3587 ISO C and ISO C++, e.g.@: request for implicit conversion from
3588 @code{void *} to a pointer to non-@code{void} type.
3589
3590 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3591 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3592 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3593 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3594
3595 @item -Wcast-qual
3596 @opindex Wcast-qual
3597 @opindex Wno-cast-qual
3598 Warn whenever a pointer is cast so as to remove a type qualifier from
3599 the target type.  For example, warn if a @code{const char *} is cast
3600 to an ordinary @code{char *}.
3601
3602 @item -Wcast-align
3603 @opindex Wcast-align
3604 @opindex Wno-cast-align
3605 Warn whenever a pointer is cast such that the required alignment of the
3606 target is increased.  For example, warn if a @code{char *} is cast to
3607 an @code{int *} on machines where integers can only be accessed at
3608 two- or four-byte boundaries.
3609
3610 @item -Wwrite-strings
3611 @opindex Wwrite-strings
3612 @opindex Wno-write-strings
3613 When compiling C, give string constants the type @code{const
3614 char[@var{length}]} so that
3615 copying the address of one into a non-@code{const} @code{char *}
3616 pointer will get a warning; when compiling C++, warn about the
3617 deprecated conversion from string literals to @code{char *}.  This
3618 warning, by default, is enabled for C++ programs.
3619 These warnings will help you find at
3620 compile time code that can try to write into a string constant, but
3621 only if you have been very careful about using @code{const} in
3622 declarations and prototypes.  Otherwise, it will just be a nuisance;
3623 this is why we did not make @option{-Wall} request these warnings.
3624
3625 @item -Wclobbered
3626 @opindex Wclobbered
3627 @opindex Wno-clobbered
3628 Warn for variables that might be changed by @samp{longjmp} or
3629 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3630
3631 @item -Wconversion
3632 @opindex Wconversion
3633 @opindex Wno-conversion
3634 Warn for implicit conversions that may alter a value. This includes
3635 conversions between real and integer, like @code{abs (x)} when
3636 @code{x} is @code{double}; conversions between signed and unsigned,
3637 like @code{unsigned ui = -1}; and conversions to smaller types, like
3638 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3639 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3640 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3641 conversions between signed and unsigned integers can be disabled by
3642 using @option{-Wno-sign-conversion}.
3643
3644 For C++, also warn for conversions between @code{NULL} and non-pointer
3645 types; confusing overload resolution for user-defined conversions; and
3646 conversions that will never use a type conversion operator:
3647 conversions to @code{void}, the same type, a base class or a reference
3648 to them. Warnings about conversions between signed and unsigned
3649 integers are disabled by default in C++ unless
3650 @option{-Wsign-conversion} is explicitly enabled.
3651
3652 @item -Wempty-body
3653 @opindex Wempty-body
3654 @opindex Wno-empty-body
3655 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3656 while} statement.  Additionally, in C++, warn when an empty body occurs
3657 in a @samp{while} or @samp{for} statement with no whitespacing before
3658 the semicolon.  This warning is also enabled by @option{-Wextra}.
3659
3660 @item -Wenum-compare @r{(C++ and Objective-C++ only)}
3661 @opindex Wenum-compare
3662 @opindex Wno-enum-compare
3663 Warn about a comparison between values of different enum types. This
3664 warning is enabled by default.
3665
3666 @item -Wsign-compare
3667 @opindex Wsign-compare
3668 @opindex Wno-sign-compare
3669 @cindex warning for comparison of signed and unsigned values
3670 @cindex comparison of signed and unsigned values, warning
3671 @cindex signed and unsigned values, comparison warning
3672 Warn when a comparison between signed and unsigned values could produce
3673 an incorrect result when the signed value is converted to unsigned.
3674 This warning is also enabled by @option{-Wextra}; to get the other warnings
3675 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3676
3677 @item -Wsign-conversion
3678 @opindex Wsign-conversion
3679 @opindex Wno-sign-conversion
3680 Warn for implicit conversions that may change the sign of an integer
3681 value, like assigning a signed integer expression to an unsigned
3682 integer variable. An explicit cast silences the warning. In C, this
3683 option is enabled also by @option{-Wconversion}.
3684
3685 @item -Waddress
3686 @opindex Waddress
3687 @opindex Wno-address
3688 Warn about suspicious uses of memory addresses. These include using
3689 the address of a function in a conditional expression, such as
3690 @code{void func(void); if (func)}, and comparisons against the memory
3691 address of a string literal, such as @code{if (x == "abc")}.  Such
3692 uses typically indicate a programmer error: the address of a function
3693 always evaluates to true, so their use in a conditional usually
3694 indicate that the programmer forgot the parentheses in a function
3695 call; and comparisons against string literals result in unspecified
3696 behavior and are not portable in C, so they usually indicate that the
3697 programmer intended to use @code{strcmp}.  This warning is enabled by
3698 @option{-Wall}.
3699
3700 @item -Wlogical-op
3701 @opindex Wlogical-op
3702 @opindex Wno-logical-op
3703 Warn about suspicious uses of logical operators in expressions.
3704 This includes using logical operators in contexts where a
3705 bit-wise operator is likely to be expected.
3706
3707 @item -Waggregate-return
3708 @opindex Waggregate-return
3709 @opindex Wno-aggregate-return
3710 Warn if any functions that return structures or unions are defined or
3711 called.  (In languages where you can return an array, this also elicits
3712 a warning.)
3713
3714 @item -Wno-attributes
3715 @opindex Wno-attributes
3716 @opindex Wattributes
3717 Do not warn if an unexpected @code{__attribute__} is used, such as
3718 unrecognized attributes, function attributes applied to variables,
3719 etc.  This will not stop errors for incorrect use of supported
3720 attributes.
3721
3722 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3723 @opindex Wstrict-prototypes
3724 @opindex Wno-strict-prototypes
3725 Warn if a function is declared or defined without specifying the
3726 argument types.  (An old-style function definition is permitted without
3727 a warning if preceded by a declaration which specifies the argument
3728 types.)
3729
3730 @item -Wold-style-declaration @r{(C and Objective-C only)}
3731 @opindex Wold-style-declaration
3732 @opindex Wno-old-style-declaration
3733 Warn for obsolescent usages, according to the C Standard, in a
3734 declaration. For example, warn if storage-class specifiers like
3735 @code{static} are not the first things in a declaration.  This warning
3736 is also enabled by @option{-Wextra}.
3737
3738 @item -Wold-style-definition @r{(C and Objective-C only)}
3739 @opindex Wold-style-definition
3740 @opindex Wno-old-style-definition
3741 Warn if an old-style function definition is used.  A warning is given
3742 even if there is a previous prototype.
3743
3744 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3745 @opindex Wmissing-parameter-type
3746 @opindex Wno-missing-parameter-type
3747 A function parameter is declared without a type specifier in K&R-style
3748 functions:
3749
3750 @smallexample
3751 void foo(bar) @{ @}
3752 @end smallexample
3753
3754 This warning is also enabled by @option{-Wextra}.
3755
3756 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3757 @opindex Wmissing-prototypes
3758 @opindex Wno-missing-prototypes
3759 Warn if a global function is defined without a previous prototype
3760 declaration.  This warning is issued even if the definition itself
3761 provides a prototype.  The aim is to detect global functions that fail
3762 to be declared in header files.
3763
3764 @item -Wmissing-declarations
3765 @opindex Wmissing-declarations
3766 @opindex Wno-missing-declarations
3767 Warn if a global function is defined without a previous declaration.
3768 Do so even if the definition itself provides a prototype.
3769 Use this option to detect global functions that are not declared in
3770 header files.  In C++, no warnings are issued for function templates,
3771 or for inline functions, or for functions in anonymous namespaces.
3772
3773 @item -Wmissing-field-initializers
3774 @opindex Wmissing-field-initializers
3775 @opindex Wno-missing-field-initializers
3776 @opindex W
3777 @opindex Wextra
3778 @opindex Wno-extra
3779 Warn if a structure's initializer has some fields missing.  For
3780 example, the following code would cause such a warning, because
3781 @code{x.h} is implicitly zero:
3782
3783 @smallexample
3784 struct s @{ int f, g, h; @};
3785 struct s x = @{ 3, 4 @};
3786 @end smallexample
3787
3788 This option does not warn about designated initializers, so the following
3789 modification would not trigger a warning:
3790
3791 @smallexample
3792 struct s @{ int f, g, h; @};
3793 struct s x = @{ .f = 3, .g = 4 @};
3794 @end smallexample
3795
3796 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3797 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3798
3799 @item -Wmissing-noreturn
3800 @opindex Wmissing-noreturn
3801 @opindex Wno-missing-noreturn
3802 Warn about functions which might be candidates for attribute @code{noreturn}.
3803 Note these are only possible candidates, not absolute ones.  Care should
3804 be taken to manually verify functions actually do not ever return before
3805 adding the @code{noreturn} attribute, otherwise subtle code generation
3806 bugs could be introduced.  You will not get a warning for @code{main} in
3807 hosted C environments.
3808
3809 @item -Wmissing-format-attribute
3810 @opindex Wmissing-format-attribute
3811 @opindex Wno-missing-format-attribute
3812 @opindex Wformat
3813 @opindex Wno-format
3814 Warn about function pointers which might be candidates for @code{format}
3815 attributes.  Note these are only possible candidates, not absolute ones.
3816 GCC will guess that function pointers with @code{format} attributes that
3817 are used in assignment, initialization, parameter passing or return
3818 statements should have a corresponding @code{format} attribute in the
3819 resulting type.  I.e.@: the left-hand side of the assignment or
3820 initialization, the type of the parameter variable, or the return type
3821 of the containing function respectively should also have a @code{format}
3822 attribute to avoid the warning.
3823
3824 GCC will also warn about function definitions which might be
3825 candidates for @code{format} attributes.  Again, these are only
3826 possible candidates.  GCC will guess that @code{format} attributes
3827 might be appropriate for any function that calls a function like
3828 @code{vprintf} or @code{vscanf}, but this might not always be the
3829 case, and some functions for which @code{format} attributes are
3830 appropriate may not be detected.
3831
3832 @item -Wno-multichar
3833 @opindex Wno-multichar
3834 @opindex Wmultichar
3835 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3836 Usually they indicate a typo in the user's code, as they have
3837 implementation-defined values, and should not be used in portable code.
3838
3839 @item -Wnormalized=<none|id|nfc|nfkc>
3840 @opindex Wnormalized=
3841 @cindex NFC
3842 @cindex NFKC
3843 @cindex character set, input normalization
3844 In ISO C and ISO C++, two identifiers are different if they are
3845 different sequences of characters.  However, sometimes when characters
3846 outside the basic ASCII character set are used, you can have two
3847 different character sequences that look the same.  To avoid confusion,
3848 the ISO 10646 standard sets out some @dfn{normalization rules} which
3849 when applied ensure that two sequences that look the same are turned into
3850 the same sequence.  GCC can warn you if you are using identifiers which
3851 have not been normalized; this option controls that warning.
3852
3853 There are four levels of warning that GCC supports.  The default is
3854 @option{-Wnormalized=nfc}, which warns about any identifier which is
3855 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3856 recommended form for most uses.
3857
3858 Unfortunately, there are some characters which ISO C and ISO C++ allow
3859 in identifiers that when turned into NFC aren't allowable as
3860 identifiers.  That is, there's no way to use these symbols in portable
3861 ISO C or C++ and have all your identifiers in NFC@.
3862 @option{-Wnormalized=id} suppresses the warning for these characters.
3863 It is hoped that future versions of the standards involved will correct
3864 this, which is why this option is not the default.
3865
3866 You can switch the warning off for all characters by writing
3867 @option{-Wnormalized=none}.  You would only want to do this if you
3868 were using some other normalization scheme (like ``D''), because
3869 otherwise you can easily create bugs that are literally impossible to see.
3870
3871 Some characters in ISO 10646 have distinct meanings but look identical
3872 in some fonts or display methodologies, especially once formatting has
3873 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3874 LETTER N'', will display just like a regular @code{n} which has been
3875 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3876 normalization scheme to convert all these into a standard form as
3877 well, and GCC will warn if your code is not in NFKC if you use
3878 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3879 about every identifier that contains the letter O because it might be
3880 confused with the digit 0, and so is not the default, but may be
3881 useful as a local coding convention if the programming environment is
3882 unable to be fixed to display these characters distinctly.
3883
3884 @item -Wno-deprecated
3885 @opindex Wno-deprecated
3886 @opindex Wdeprecated
3887 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
3888
3889 @item -Wno-deprecated-declarations
3890 @opindex Wno-deprecated-declarations
3891 @opindex Wdeprecated-declarations
3892 Do not warn about uses of functions (@pxref{Function Attributes}),
3893 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3894 Attributes}) marked as deprecated by using the @code{deprecated}
3895 attribute.
3896
3897 @item -Wno-overflow
3898 @opindex Wno-overflow
3899 @opindex Woverflow
3900 Do not warn about compile-time overflow in constant expressions.
3901
3902 @item -Woverride-init @r{(C and Objective-C only)}
3903 @opindex Woverride-init
3904 @opindex Wno-override-init
3905 @opindex W
3906 @opindex Wextra
3907 @opindex Wno-extra
3908 Warn if an initialized field without side effects is overridden when
3909 using designated initializers (@pxref{Designated Inits, , Designated
3910 Initializers}).
3911
3912 This warning is included in @option{-Wextra}.  To get other
3913 @option{-Wextra} warnings without this one, use @samp{-Wextra
3914 -Wno-override-init}.
3915
3916 @item -Wpacked
3917 @opindex Wpacked
3918 @opindex Wno-packed
3919 Warn if a structure is given the packed attribute, but the packed
3920 attribute has no effect on the layout or size of the structure.
3921 Such structures may be mis-aligned for little benefit.  For
3922 instance, in this code, the variable @code{f.x} in @code{struct bar}
3923 will be misaligned even though @code{struct bar} does not itself
3924 have the packed attribute:
3925
3926 @smallexample
3927 @group
3928 struct foo @{
3929   int x;
3930   char a, b, c, d;
3931 @} __attribute__((packed));
3932 struct bar @{
3933   char z;
3934   struct foo f;
3935 @};
3936 @end group
3937 @end smallexample
3938
3939 @item -Wpadded
3940 @opindex Wpadded
3941 @opindex Wno-padded
3942 Warn if padding is included in a structure, either to align an element
3943 of the structure or to align the whole structure.  Sometimes when this
3944 happens it is possible to rearrange the fields of the structure to
3945 reduce the padding and so make the structure smaller.
3946
3947 @item -Wredundant-decls
3948 @opindex Wredundant-decls
3949 @opindex Wno-redundant-decls
3950 Warn if anything is declared more than once in the same scope, even in
3951 cases where multiple declaration is valid and changes nothing.
3952
3953 @item -Wnested-externs @r{(C and Objective-C only)}
3954 @opindex Wnested-externs
3955 @opindex Wno-nested-externs
3956 Warn if an @code{extern} declaration is encountered within a function.
3957
3958 @item -Wunreachable-code
3959 @opindex Wunreachable-code
3960 @opindex Wno-unreachable-code
3961 Warn if the compiler detects that code will never be executed.
3962
3963 This option is intended to warn when the compiler detects that at
3964 least a whole line of source code will never be executed, because
3965 some condition is never satisfied or because it is after a
3966 procedure that never returns.
3967
3968 It is possible for this option to produce a warning even though there
3969 are circumstances under which part of the affected line can be executed,
3970 so care should be taken when removing apparently-unreachable code.
3971
3972 For instance, when a function is inlined, a warning may mean that the
3973 line is unreachable in only one inlined copy of the function.
3974
3975 This option is not made part of @option{-Wall} because in a debugging
3976 version of a program there is often substantial code which checks
3977 correct functioning of the program and is, hopefully, unreachable
3978 because the program does work.  Another common use of unreachable
3979 code is to provide behavior which is selectable at compile-time.
3980
3981 @item -Winline
3982 @opindex Winline
3983 @opindex Wno-inline
3984 Warn if a function can not be inlined and it was declared as inline.
3985 Even with this option, the compiler will not warn about failures to
3986 inline functions declared in system headers.
3987
3988 The compiler uses a variety of heuristics to determine whether or not
3989 to inline a function.  For example, the compiler takes into account
3990 the size of the function being inlined and the amount of inlining
3991 that has already been done in the current function.  Therefore,
3992 seemingly insignificant changes in the source program can cause the
3993 warnings produced by @option{-Winline} to appear or disappear.
3994
3995 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
3996 @opindex Wno-invalid-offsetof
3997 @opindex Winvalid-offsetof
3998 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3999 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4000 to a non-POD type is undefined.  In existing C++ implementations,
4001 however, @samp{offsetof} typically gives meaningful results even when
4002 applied to certain kinds of non-POD types. (Such as a simple
4003 @samp{struct} that fails to be a POD type only by virtue of having a
4004 constructor.)  This flag is for users who are aware that they are
4005 writing nonportable code and who have deliberately chosen to ignore the
4006 warning about it.
4007
4008 The restrictions on @samp{offsetof} may be relaxed in a future version
4009 of the C++ standard.
4010
4011 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4012 @opindex Wno-int-to-pointer-cast
4013 @opindex Wint-to-pointer-cast
4014 Suppress warnings from casts to pointer type of an integer of a
4015 different size.
4016
4017 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4018 @opindex Wno-pointer-to-int-cast
4019 @opindex Wpointer-to-int-cast
4020 Suppress warnings from casts from a pointer to an integer type of a
4021 different size.
4022
4023 @item -Winvalid-pch
4024 @opindex Winvalid-pch
4025 @opindex Wno-invalid-pch
4026 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4027 the search path but can't be used.
4028
4029 @item -Wlong-long
4030 @opindex Wlong-long
4031 @opindex Wno-long-long
4032 Warn if @samp{long long} type is used.  This is default.  To inhibit
4033 the warning messages, use @option{-Wno-long-long}.  Flags
4034 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
4035 only when @option{-pedantic} flag is used.
4036
4037 @item -Wvariadic-macros
4038 @opindex Wvariadic-macros
4039 @opindex Wno-variadic-macros
4040 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4041 alternate syntax when in pedantic ISO C99 mode.  This is default.
4042 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4043
4044 @item -Wvla
4045 @opindex Wvla
4046 @opindex Wno-vla
4047 Warn if variable length array is used in the code.
4048 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4049 the variable length array.
4050
4051 @item -Wvolatile-register-var
4052 @opindex Wvolatile-register-var
4053 @opindex Wno-volatile-register-var
4054 Warn if a register variable is declared volatile.  The volatile
4055 modifier does not inhibit all optimizations that may eliminate reads
4056 and/or writes to register variables.  This warning is enabled by
4057 @option{-Wall}.
4058
4059 @item -Wdisabled-optimization
4060 @opindex Wdisabled-optimization
4061 @opindex Wno-disabled-optimization
4062 Warn if a requested optimization pass is disabled.  This warning does
4063 not generally indicate that there is anything wrong with your code; it
4064 merely indicates that GCC's optimizers were unable to handle the code
4065 effectively.  Often, the problem is that your code is too big or too
4066 complex; GCC will refuse to optimize programs when the optimization
4067 itself is likely to take inordinate amounts of time.
4068
4069 @item -Wpointer-sign @r{(C and Objective-C only)}
4070 @opindex Wpointer-sign
4071 @opindex Wno-pointer-sign
4072 Warn for pointer argument passing or assignment with different signedness.
4073 This option is only supported for C and Objective-C@.  It is implied by
4074 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4075 @option{-Wno-pointer-sign}.
4076
4077 @item -Wstack-protector
4078 @opindex Wstack-protector
4079 @opindex Wno-stack-protector
4080 This option is only active when @option{-fstack-protector} is active.  It
4081 warns about functions that will not be protected against stack smashing.
4082
4083 @item -Wno-mudflap
4084 @opindex Wno-mudflap
4085 Suppress warnings about constructs that cannot be instrumented by
4086 @option{-fmudflap}.
4087
4088 @item -Woverlength-strings
4089 @opindex Woverlength-strings
4090 @opindex Wno-overlength-strings
4091 Warn about string constants which are longer than the ``minimum
4092 maximum'' length specified in the C standard.  Modern compilers
4093 generally allow string constants which are much longer than the
4094 standard's minimum limit, but very portable programs should avoid
4095 using longer strings.
4096
4097 The limit applies @emph{after} string constant concatenation, and does
4098 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4099 C99, it was raised to 4095.  C++98 does not specify a normative
4100 minimum maximum, so we do not diagnose overlength strings in C++@.
4101
4102 This option is implied by @option{-pedantic}, and can be disabled with
4103 @option{-Wno-overlength-strings}.
4104 @end table
4105
4106 @node Debugging Options
4107 @section Options for Debugging Your Program or GCC
4108 @cindex options, debugging
4109 @cindex debugging information options
4110
4111 GCC has various special options that are used for debugging
4112 either your program or GCC:
4113
4114 @table @gcctabopt
4115 @item -g
4116 @opindex g
4117 Produce debugging information in the operating system's native format
4118 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4119 information.
4120
4121 On most systems that use stabs format, @option{-g} enables use of extra
4122 debugging information that only GDB can use; this extra information
4123 makes debugging work better in GDB but will probably make other debuggers
4124 crash or
4125 refuse to read the program.  If you want to control for certain whether
4126 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4127 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4128
4129 GCC allows you to use @option{-g} with
4130 @option{-O}.  The shortcuts taken by optimized code may occasionally
4131 produce surprising results: some variables you declared may not exist
4132 at all; flow of control may briefly move where you did not expect it;
4133 some statements may not be executed because they compute constant
4134 results or their values were already at hand; some statements may
4135 execute in different places because they were moved out of loops.
4136
4137 Nevertheless it proves possible to debug optimized output.  This makes
4138 it reasonable to use the optimizer for programs that might have bugs.
4139
4140 The following options are useful when GCC is generated with the
4141 capability for more than one debugging format.
4142
4143 @item -ggdb
4144 @opindex ggdb
4145 Produce debugging information for use by GDB@.  This means to use the
4146 most expressive format available (DWARF 2, stabs, or the native format
4147 if neither of those are supported), including GDB extensions if at all
4148 possible.
4149
4150 @item -gstabs
4151 @opindex gstabs
4152 Produce debugging information in stabs format (if that is supported),
4153 without GDB extensions.  This is the format used by DBX on most BSD
4154 systems.  On MIPS, Alpha and System V Release 4 systems this option
4155 produces stabs debugging output which is not understood by DBX or SDB@.
4156 On System V Release 4 systems this option requires the GNU assembler.
4157
4158 @item -feliminate-unused-debug-symbols
4159 @opindex feliminate-unused-debug-symbols
4160 Produce debugging information in stabs format (if that is supported),
4161 for only symbols that are actually used.
4162
4163 @item -femit-class-debug-always
4164 Instead of emitting debugging information for a C++ class in only one
4165 object file, emit it in all object files using the class.  This option
4166 should be used only with debuggers that are unable to handle the way GCC
4167 normally emits debugging information for classes because using this
4168 option will increase the size of debugging information by as much as a
4169 factor of two.
4170
4171 @item -gstabs+
4172 @opindex gstabs+
4173 Produce debugging information in stabs format (if that is supported),
4174 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4175 use of these extensions is likely to make other debuggers crash or
4176 refuse to read the program.
4177
4178 @item -gcoff
4179 @opindex gcoff
4180 Produce debugging information in COFF format (if that is supported).
4181 This is the format used by SDB on most System V systems prior to
4182 System V Release 4.
4183
4184 @item -gxcoff
4185 @opindex gxcoff
4186 Produce debugging information in XCOFF format (if that is supported).
4187 This is the format used by the DBX debugger on IBM RS/6000 systems.
4188
4189 @item -gxcoff+
4190 @opindex gxcoff+
4191 Produce debugging information in XCOFF format (if that is supported),
4192 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4193 use of these extensions is likely to make other debuggers crash or
4194 refuse to read the program, and may cause assemblers other than the GNU
4195 assembler (GAS) to fail with an error.
4196
4197 @item -gdwarf-2
4198 @opindex gdwarf-2
4199 Produce debugging information in DWARF version 2 format (if that is
4200 supported).  This is the format used by DBX on IRIX 6.  With this
4201 option, GCC uses features of DWARF version 3 when they are useful;
4202 version 3 is upward compatible with version 2, but may still cause
4203 problems for older debuggers.
4204
4205 @item -gvms
4206 @opindex gvms
4207 Produce debugging information in VMS debug format (if that is
4208 supported).  This is the format used by DEBUG on VMS systems.
4209
4210 @item -g@var{level}
4211 @itemx -ggdb@var{level}
4212 @itemx -gstabs@var{level}
4213 @itemx -gcoff@var{level}
4214 @itemx -gxcoff@var{level}
4215 @itemx -gvms@var{level}
4216 Request debugging information and also use @var{level} to specify how
4217 much information.  The default level is 2.
4218
4219 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4220 @option{-g}.
4221
4222 Level 1 produces minimal information, enough for making backtraces in
4223 parts of the program that you don't plan to debug.  This includes
4224 descriptions of functions and external variables, but no information
4225 about local variables and no line numbers.
4226
4227 Level 3 includes extra information, such as all the macro definitions
4228 present in the program.  Some debuggers support macro expansion when
4229 you use @option{-g3}.
4230
4231 @option{-gdwarf-2} does not accept a concatenated debug level, because
4232 GCC used to support an option @option{-gdwarf} that meant to generate
4233 debug information in version 1 of the DWARF format (which is very
4234 different from version 2), and it would have been too confusing.  That
4235 debug format is long obsolete, but the option cannot be changed now.
4236 Instead use an additional @option{-g@var{level}} option to change the
4237 debug level for DWARF2.
4238
4239 @item -feliminate-dwarf2-dups
4240 @opindex feliminate-dwarf2-dups
4241 Compress DWARF2 debugging information by eliminating duplicated
4242 information about each symbol.  This option only makes sense when
4243 generating DWARF2 debugging information with @option{-gdwarf-2}.
4244
4245 @item -femit-struct-debug-baseonly
4246 Emit debug information for struct-like types
4247 only when the base name of the compilation source file
4248 matches the base name of file in which the struct was defined.
4249
4250 This option substantially reduces the size of debugging information,
4251 but at significant potential loss in type information to the debugger.
4252 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4253 See @option{-femit-struct-debug-detailed} for more detailed control.
4254
4255 This option works only with DWARF 2.
4256
4257 @item -femit-struct-debug-reduced
4258 Emit debug information for struct-like types
4259 only when the base name of the compilation source file
4260 matches the base name of file in which the type was defined,
4261 unless the struct is a template or defined in a system header.
4262
4263 This option significantly reduces the size of debugging information,
4264 with some potential loss in type information to the debugger.
4265 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4266 See @option{-femit-struct-debug-detailed} for more detailed control.
4267
4268 This option works only with DWARF 2.
4269
4270 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4271 Specify the struct-like types
4272 for which the compiler will generate debug information.
4273 The intent is to reduce duplicate struct debug information
4274 between different object files within the same program.
4275
4276 This option is a detailed version of
4277 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4278 which will serve for most needs.
4279
4280 A specification has the syntax
4281 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4282
4283 The optional first word limits the specification to
4284 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4285 A struct type is used directly when it is the type of a variable, member.
4286 Indirect uses arise through pointers to structs.
4287 That is, when use of an incomplete struct would be legal, the use is indirect.
4288 An example is
4289 @samp{struct one direct; struct two * indirect;}.
4290
4291 The optional second word limits the specification to
4292 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4293 Generic structs are a bit complicated to explain.
4294 For C++, these are non-explicit specializations of template classes,
4295 or non-template classes within the above.
4296 Other programming languages have generics,
4297 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4298
4299 The third word specifies the source files for those
4300 structs for which the compiler will emit debug information.
4301 The values @samp{none} and @samp{any} have the normal meaning.
4302 The value @samp{base} means that
4303 the base of name of the file in which the type declaration appears
4304 must match the base of the name of the main compilation file.
4305 In practice, this means that
4306 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4307 but types declared in other header will not.
4308 The value @samp{sys} means those types satisfying @samp{base}
4309 or declared in system or compiler headers.
4310
4311 You may need to experiment to determine the best settings for your application.
4312
4313 The default is @samp{-femit-struct-debug-detailed=all}.
4314
4315 This option works only with DWARF 2.
4316
4317 @item -fno-merge-debug-strings
4318 @opindex fmerge-debug-strings
4319 @opindex fno-merge-debug-strings
4320 Direct the linker to merge together strings which are identical in
4321 different object files.  This is not supported by all assemblers or
4322 linker.  This decreases the size of the debug information in the
4323 output file at the cost of increasing link processing time.  This is
4324 on by default.
4325
4326 @item -fdebug-prefix-map=@var{old}=@var{new}
4327 @opindex fdebug-prefix-map
4328 When compiling files in directory @file{@var{old}}, record debugging
4329 information describing them as in @file{@var{new}} instead.
4330
4331 @cindex @command{prof}
4332 @item -p
4333 @opindex p
4334 Generate extra code to write profile information suitable for the
4335 analysis program @command{prof}.  You must use this option when compiling
4336 the source files you want data about, and you must also use it when
4337 linking.
4338
4339 @cindex @command{gprof}
4340 @item -pg
4341 @opindex pg
4342 Generate extra code to write profile information suitable for the
4343 analysis program @command{gprof}.  You must use this option when compiling
4344 the source files you want data about, and you must also use it when
4345 linking.
4346
4347 @item -Q
4348 @opindex Q
4349 Makes the compiler print out each function name as it is compiled, and
4350 print some statistics about each pass when it finishes.
4351
4352 @item -ftime-report
4353 @opindex ftime-report
4354 Makes the compiler print some statistics about the time consumed by each
4355 pass when it finishes.
4356
4357 @item -fmem-report
4358 @opindex fmem-report
4359 Makes the compiler print some statistics about permanent memory
4360 allocation when it finishes.
4361
4362 @item -fpre-ipa-mem-report
4363 @opindex fpre-ipa-mem-report
4364 @item -fpost-ipa-mem-report
4365 @opindex fpost-ipa-mem-report
4366 Makes the compiler print some statistics about permanent memory
4367 allocation before or after interprocedural optimization.
4368
4369 @item -fprofile-arcs
4370 @opindex fprofile-arcs
4371 Add code so that program flow @dfn{arcs} are instrumented.  During
4372 execution the program records how many times each branch and call is
4373 executed and how many times it is taken or returns.  When the compiled
4374 program exits it saves this data to a file called
4375 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4376 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4377 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4378 @var{auxname} is generated from the name of the output file, if
4379 explicitly specified and it is not the final executable, otherwise it is
4380 the basename of the source file.  In both cases any suffix is removed
4381 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4382 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4383 @xref{Cross-profiling}.
4384
4385 @cindex @command{gcov}
4386 @item --coverage
4387 @opindex coverage
4388
4389 This option is used to compile and link code instrumented for coverage
4390 analysis.  The option is a synonym for @option{-fprofile-arcs}
4391 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4392 linking).  See the documentation for those options for more details.
4393
4394 @itemize
4395
4396 @item
4397 Compile the source files with @option{-fprofile-arcs} plus optimization
4398 and code generation options.  For test coverage analysis, use the
4399 additional @option{-ftest-coverage} option.  You do not need to profile
4400 every source file in a program.
4401
4402 @item
4403 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4404 (the latter implies the former).
4405
4406 @item
4407 Run the program on a representative workload to generate the arc profile
4408 information.  This may be repeated any number of times.  You can run
4409 concurrent instances of your program, and provided that the file system
4410 supports locking, the data files will be correctly updated.  Also
4411 @code{fork} calls are detected and correctly handled (double counting
4412 will not happen).
4413
4414 @item
4415 For profile-directed optimizations, compile the source files again with
4416 the same optimization and code generation options plus
4417 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4418 Control Optimization}).
4419
4420 @item
4421 For test coverage analysis, use @command{gcov} to produce human readable
4422 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4423 @command{gcov} documentation for further information.
4424
4425 @end itemize
4426
4427 With @option{-fprofile-arcs}, for each function of your program GCC
4428 creates a program flow graph, then finds a spanning tree for the graph.
4429 Only arcs that are not on the spanning tree have to be instrumented: the
4430 compiler adds code to count the number of times that these arcs are
4431 executed.  When an arc is the only exit or only entrance to a block, the
4432 instrumentation code can be added to the block; otherwise, a new basic
4433 block must be created to hold the instrumentation code.
4434
4435 @need 2000
4436 @item -ftest-coverage
4437 @opindex ftest-coverage
4438 Produce a notes file that the @command{gcov} code-coverage utility
4439 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4440 show program coverage.  Each source file's note file is called
4441 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4442 above for a description of @var{auxname} and instructions on how to
4443 generate test coverage data.  Coverage data will match the source files
4444 more closely, if you do not optimize.
4445
4446 @item -fdbg-cnt-list
4447 @opindex fdbg-cnt-list
4448 Print the name and the counter upperbound for all debug counters.
4449
4450 @item -fdbg-cnt=@var{counter-value-list}
4451 @opindex fdbg-cnt
4452 Set the internal debug counter upperbound. @var{counter-value-list} 
4453 is a comma-separated list of @var{name}:@var{value} pairs
4454 which sets the upperbound of each debug counter @var{name} to @var{value}.
4455 All debug counters have the initial upperbound of @var{UINT_MAX},
4456 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4457 e.g. With -fdbg-cnt=dce:10,tail_call:0
4458 dbg_cnt(dce) will return true only for first 10 invocations
4459 and dbg_cnt(tail_call) will return false always.
4460
4461 @item -d@var{letters}
4462 @itemx -fdump-rtl-@var{pass}
4463 @opindex d
4464 Says to make debugging dumps during compilation at times specified by
4465 @var{letters}.    This is used for debugging the RTL-based passes of the
4466 compiler.  The file names for most of the dumps are made by appending a
4467 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
4468 from the name of the output file, if explicitly specified and it is not
4469 an executable, otherwise it is the basename of the source file. These
4470 switches may have different effects when @option{-E} is used for
4471 preprocessing.
4472
4473 Most debug dumps can be enabled either passing a letter to the @option{-d}
4474 option, or with a long @option{-fdump-rtl} switch; here are the possible
4475 letters for use in @var{letters} and @var{pass}, and their meanings:
4476
4477 @table @gcctabopt
4478 @item -dA
4479 @opindex dA
4480 Annotate the assembler output with miscellaneous debugging information.
4481
4482 @item -fdump-rtl-bbro
4483 @opindex fdump-rtl-bbro
4484 Dump after block reordering, to @file{@var{file}.148r.bbro}.
4485
4486 @item -fdump-rtl-combine
4487 @opindex fdump-rtl-combine
4488 Dump after the RTL instruction combination pass, to the file
4489 @file{@var{file}.129r.combine}.
4490
4491 @item -fdump-rtl-ce1
4492 @itemx -fdump-rtl-ce2
4493 @opindex fdump-rtl-ce1
4494 @opindex fdump-rtl-ce2
4495 @option{-fdump-rtl-ce1} enable dumping after the
4496 first if conversion, to the file @file{@var{file}.117r.ce1}. 
4497 @option{-fdump-rtl-ce2} enable dumping after the second if
4498 conversion, to the file @file{@var{file}.130r.ce2}.
4499
4500 @item -fdump-rtl-btl
4501 @itemx -fdump-rtl-dbr
4502 @opindex fdump-rtl-btl
4503 @opindex fdump-rtl-dbr
4504 @option{-fdump-rtl-btl} enable dumping after branch
4505 target load optimization, to @file{@var{file}.31.btl}.  
4506 @option{-fdump-rtl-dbr} enable dumping after delayed branch
4507 scheduling, to @file{@var{file}.36.dbr}.
4508
4509 @item -dD
4510 @opindex dD
4511 Dump all macro definitions, at the end of preprocessing, in addition to
4512 normal output.
4513
4514 @item -fdump-rtl-ce3
4515 @opindex fdump-rtl-ce3
4516 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
4517
4518 @item -fdump-rtl-cfg
4519 @itemx -fdump-rtl-life
4520 @opindex fdump-rtl-cfg
4521 @opindex fdump-rtl-life
4522 @option{-fdump-rtl-cfg} enable dumping after control
4523 and data flow analysis, to @file{@var{file}.116r.cfg}.  
4524 @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
4525 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
4526
4527 @item -fdump-rtl-greg
4528 @opindex fdump-rtl-greg
4529 Dump after global register allocation, to @file{@var{file}.139r.greg}.
4530
4531 @item -fdump-rtl-gcse
4532 @itemx -fdump-rtl-bypass
4533 @opindex fdump-rtl-gcse
4534 @opindex fdump-rtl-bypass
4535 @option{-fdump-rtl-gcse} enable dumping after GCSE, to
4536 @file{@var{file}.114r.gcse}.  @option{-fdump-rtl-bypass}
4537 enable dumping after jump bypassing and control flow optimizations, to
4538 @file{@var{file}.115r.bypass}.
4539
4540 @item -fdump-rtl-eh
4541 @opindex fdump-rtl-eh
4542 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
4543
4544 @item -fdump-rtl-sibling
4545 @opindex fdump-rtl-sibling
4546 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
4547
4548 @item -fdump-rtl-jump
4549 @opindex fdump-rtl-jump
4550 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
4551
4552 @item -fdump-rtl-stack
4553 @opindex fdump-rtl-stack
4554 Dump after conversion from GCC's "flat register file" registers to the
4555 x87's stack-like registers, to @file{@var{file}.152r.stack}.
4556
4557 @item -fdump-rtl-lreg
4558 @opindex fdump-rtl-lreg
4559 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
4560
4561 @item -fdump-rtl-loop2
4562 @opindex fdump-rtl-loop2
4563 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
4564 loop optimization pass, to @file{@var{file}.119r.loop2},
4565 @file{@var{file}.120r.loop2_init},
4566 @file{@var{file}.121r.loop2_invariant}, and
4567 @file{@var{file}.125r.loop2_done}.
4568
4569 @item -fdump-rtl-sms
4570 @opindex fdump-rtl-sms
4571 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4572
4573 @item -fdump-rtl-mach
4574 @opindex fdump-rtl-mach
4575 Dump after performing the machine dependent reorganization pass, to
4576 @file{@var{file}.155r.mach} if that pass exists.
4577
4578 @item -fdump-rtl-rnreg
4579 @opindex fdump-rtl-rnreg
4580 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4581
4582 @item -fdump-rtl-regmove
4583 @opindex fdump-rtl-regmove
4584 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4585
4586 @item -fdump-rtl-postreload
4587 @opindex fdump-rtl-postreload
4588 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4589
4590 @item -fdump-rtl-expand
4591 @opindex fdump-rtl-expand
4592 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4593
4594 @item -fdump-rtl-sched2
4595 @opindex fdump-rtl-sched2
4596 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4597
4598 @item -fdump-rtl-cse
4599 @opindex fdump-rtl-cse
4600 Dump after CSE (including the jump optimization that sometimes follows
4601 CSE), to @file{@var{file}.113r.cse}.
4602
4603 @item -fdump-rtl-sched1
4604 @opindex fdump-rtl-sched1
4605 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4606
4607 @item -fdump-rtl-cse2
4608 @opindex fdump-rtl-cse2
4609 Dump after the second CSE pass (including the jump optimization that
4610 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4611
4612 @item -fdump-rtl-tracer
4613 @opindex fdump-rtl-tracer
4614 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4615
4616 @item -fdump-rtl-vpt
4617 @itemx -fdump-rtl-vartrack
4618 @opindex fdump-rtl-vpt
4619 @opindex fdump-rtl-vartrack
4620 @option{-fdump-rtl-vpt} enable dumping after the value
4621 profile transformations, to @file{@var{file}.10.vpt}.
4622 @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4623 to @file{@var{file}.154r.vartrack}.
4624
4625 @item -fdump-rtl-flow2
4626 @opindex fdump-rtl-flow2
4627 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4628
4629 @item -fdump-rtl-peephole2
4630 @opindex fdump-rtl-peephole2
4631 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4632
4633 @item -fdump-rtl-web
4634 @opindex fdump-rtl-web
4635 Dump after live range splitting, to @file{@var{file}.126r.web}.
4636
4637 @item -fdump-rtl-all
4638 @opindex fdump-rtl-all
4639 Produce all the dumps listed above.
4640
4641 @item -dH
4642 @opindex dH
4643 Produce a core dump whenever an error occurs.
4644
4645 @item -dm
4646 @opindex dm
4647 Print statistics on memory usage, at the end of the run, to
4648 standard error.
4649
4650 @item -dp
4651 @opindex dp
4652 Annotate the assembler output with a comment indicating which
4653 pattern and alternative was used.  The length of each instruction is
4654 also printed.
4655
4656 @item -dP
4657 @opindex dP
4658 Dump the RTL in the assembler output as a comment before each instruction.
4659 Also turns on @option{-dp} annotation.
4660
4661 @item -dv
4662 @opindex dv
4663 For each of the other indicated dump files (either with @option{-d} or
4664 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4665 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4666
4667 @item -dx
4668 @opindex dx
4669 Just generate RTL for a function instead of compiling it.  Usually used
4670 with @samp{r} (@option{-fdump-rtl-expand}).
4671
4672 @item -dy
4673 @opindex dy
4674 Dump debugging information during parsing, to standard error.
4675 @end table
4676
4677 @item -fdump-noaddr
4678 @opindex fdump-noaddr
4679 When doing debugging dumps (see @option{-d} option above), suppress
4680 address output.  This makes it more feasible to use diff on debugging
4681 dumps for compiler invocations with different compiler binaries and/or
4682 different text / bss / data / heap / stack / dso start locations.
4683
4684 @item -fdump-unnumbered
4685 @opindex fdump-unnumbered
4686 When doing debugging dumps (see @option{-d} option above), suppress instruction
4687 numbers and address output.  This makes it more feasible to
4688 use diff on debugging dumps for compiler invocations with different
4689 options, in particular with and without @option{-g}.
4690
4691 @item -fdump-translation-unit @r{(C++ only)}
4692 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4693 @opindex fdump-translation-unit
4694 Dump a representation of the tree structure for the entire translation
4695 unit to a file.  The file name is made by appending @file{.tu} to the
4696 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4697 controls the details of the dump as described for the
4698 @option{-fdump-tree} options.
4699
4700 @item -fdump-class-hierarchy @r{(C++ only)}
4701 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4702 @opindex fdump-class-hierarchy
4703 Dump a representation of each class's hierarchy and virtual function
4704 table layout to a file.  The file name is made by appending @file{.class}
4705 to the source file name.  If the @samp{-@var{options}} form is used,
4706 @var{options} controls the details of the dump as described for the
4707 @option{-fdump-tree} options.
4708
4709 @item -fdump-ipa-@var{switch}
4710 @opindex fdump-ipa
4711 Control the dumping at various stages of inter-procedural analysis
4712 language tree to a file.  The file name is generated by appending a switch
4713 specific suffix to the source file name.  The following dumps are possible:
4714
4715 @table @samp
4716 @item all
4717 Enables all inter-procedural analysis dumps.
4718
4719 @item cgraph
4720 Dumps information about call-graph optimization, unused function removal,
4721 and inlining decisions.
4722
4723 @item inline
4724 Dump after function inlining.
4725
4726 @end table
4727
4728 @item -fdump-statistics-@var{option}
4729 @opindex -fdump-statistics
4730 Enable and control dumping of pass statistics in a separate file.  The
4731 file name is generated by appending a suffix ending in @samp{.statistics}
4732 to the source file name.  If the @samp{-@var{option}} form is used,
4733 @samp{-stats} will cause counters to be summed over the whole compilation unit
4734 while @samp{-details} will dump every event as the passes generate them.
4735 The default with no option is to sum counters for each function compiled.
4736
4737 @item -fdump-tree-@var{switch}
4738 @itemx -fdump-tree-@var{switch}-@var{options}
4739 @opindex fdump-tree
4740 Control the dumping at various stages of processing the intermediate
4741 language tree to a file.  The file name is generated by appending a switch
4742 specific suffix to the source file name.  If the @samp{-@var{options}}
4743 form is used, @var{options} is a list of @samp{-} separated options that
4744 control the details of the dump.  Not all options are applicable to all
4745 dumps, those which are not meaningful will be ignored.  The following
4746 options are available
4747
4748 @table @samp
4749 @item address
4750 Print the address of each node.  Usually this is not meaningful as it
4751 changes according to the environment and source file.  Its primary use
4752 is for tying up a dump file with a debug environment.
4753 @item slim
4754 Inhibit dumping of members of a scope or body of a function merely
4755 because that scope has been reached.  Only dump such items when they
4756 are directly reachable by some other path.  When dumping pretty-printed
4757 trees, this option inhibits dumping the bodies of control structures.
4758 @item raw
4759 Print a raw representation of the tree.  By default, trees are
4760 pretty-printed into a C-like representation.
4761 @item details
4762 Enable more detailed dumps (not honored by every dump option).
4763 @item stats
4764 Enable dumping various statistics about the pass (not honored by every dump
4765 option).
4766 @item blocks
4767 Enable showing basic block boundaries (disabled in raw dumps).
4768 @item vops
4769 Enable showing virtual operands for every statement.
4770 @item lineno
4771 Enable showing line numbers for statements.
4772 @item uid
4773 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4774 @item verbose
4775 Enable showing the tree dump for each statement.
4776 @item all
4777 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
4778 and @option{lineno}.
4779 @end table
4780
4781 The following tree dumps are possible:
4782 @table @samp
4783
4784 @item original
4785 Dump before any tree based optimization, to @file{@var{file}.original}.
4786
4787 @item optimized
4788 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4789
4790 @item gimple
4791 @opindex fdump-tree-gimple
4792 Dump each function before and after the gimplification pass to a file.  The
4793 file name is made by appending @file{.gimple} to the source file name.
4794
4795 @item cfg
4796 @opindex fdump-tree-cfg
4797 Dump the control flow graph of each function to a file.  The file name is
4798 made by appending @file{.cfg} to the source file name.
4799
4800 @item vcg
4801 @opindex fdump-tree-vcg
4802 Dump the control flow graph of each function to a file in VCG format.  The
4803 file name is made by appending @file{.vcg} to the source file name.  Note
4804 that if the file contains more than one function, the generated file cannot
4805 be used directly by VCG@.  You will need to cut and paste each function's
4806 graph into its own separate file first.
4807
4808 @item ch
4809 @opindex fdump-tree-ch
4810 Dump each function after copying loop headers.  The file name is made by
4811 appending @file{.ch} to the source file name.
4812
4813 @item ssa
4814 @opindex fdump-tree-ssa
4815 Dump SSA related information to a file.  The file name is made by appending
4816 @file{.ssa} to the source file name.
4817
4818 @item alias
4819 @opindex fdump-tree-alias
4820 Dump aliasing information for each function.  The file name is made by
4821 appending @file{.alias} to the source file name.
4822
4823 @item ccp
4824 @opindex fdump-tree-ccp
4825 Dump each function after CCP@.  The file name is made by appending
4826 @file{.ccp} to the source file name.
4827
4828 @item storeccp
4829 @opindex fdump-tree-storeccp
4830 Dump each function after STORE-CCP@.  The file name is made by appending
4831 @file{.storeccp} to the source file name.
4832
4833 @item pre
4834 @opindex fdump-tree-pre
4835 Dump trees after partial redundancy elimination.  The file name is made
4836 by appending @file{.pre} to the source file name.
4837
4838 @item fre
4839 @opindex fdump-tree-fre
4840 Dump trees after full redundancy elimination.  The file name is made
4841 by appending @file{.fre} to the source file name.
4842
4843 @item copyprop
4844 @opindex fdump-tree-copyprop
4845 Dump trees after copy propagation.  The file name is made
4846 by appending @file{.copyprop} to the source file name.
4847
4848 @item store_copyprop
4849 @opindex fdump-tree-store_copyprop
4850 Dump trees after store copy-propagation.  The file name is made
4851 by appending @file{.store_copyprop} to the source file name.
4852
4853 @item dce
4854 @opindex fdump-tree-dce
4855 Dump each function after dead code elimination.  The file name is made by
4856 appending @file{.dce} to the source file name.
4857
4858 @item mudflap
4859 @opindex fdump-tree-mudflap
4860 Dump each function after adding mudflap instrumentation.  The file name is
4861 made by appending @file{.mudflap} to the source file name.
4862
4863 @item sra
4864 @opindex fdump-tree-sra
4865 Dump each function after performing scalar replacement of aggregates.  The
4866 file name is made by appending @file{.sra} to the source file name.
4867
4868 @item sink
4869 @opindex fdump-tree-sink
4870 Dump each function after performing code sinking.  The file name is made
4871 by appending @file{.sink} to the source file name.
4872
4873 @item dom
4874 @opindex fdump-tree-dom
4875 Dump each function after applying dominator tree optimizations.  The file
4876 name is made by appending @file{.dom} to the source file name.
4877
4878 @item dse
4879 @opindex fdump-tree-dse
4880 Dump each function after applying dead store elimination.  The file
4881 name is made by appending @file{.dse} to the source file name.
4882
4883 @item phiopt
4884 @opindex fdump-tree-phiopt
4885 Dump each function after optimizing PHI nodes into straightline code.  The file
4886 name is made by appending @file{.phiopt} to the source file name.
4887
4888 @item forwprop
4889 @opindex fdump-tree-forwprop
4890 Dump each function after forward propagating single use variables.  The file
4891 name is made by appending @file{.forwprop} to the source file name.
4892
4893 @item copyrename
4894 @opindex fdump-tree-copyrename
4895 Dump each function after applying the copy rename optimization.  The file
4896 name is made by appending @file{.copyrename} to the source file name.
4897
4898 @item nrv
4899 @opindex fdump-tree-nrv
4900 Dump each function after applying the named return value optimization on
4901 generic trees.  The file name is made by appending @file{.nrv} to the source
4902 file name.
4903
4904 @item vect
4905 @opindex fdump-tree-vect
4906 Dump each function after applying vectorization of loops.  The file name is
4907 made by appending @file{.vect} to the source file name.
4908
4909 @item vrp
4910 @opindex fdump-tree-vrp
4911 Dump each function after Value Range Propagation (VRP).  The file name
4912 is made by appending @file{.vrp} to the source file name.
4913
4914 @item all
4915 @opindex fdump-tree-all
4916 Enable all the available tree dumps with the flags provided in this option.
4917 @end table
4918
4919 @item -ftree-vectorizer-verbose=@var{n}
4920 @opindex ftree-vectorizer-verbose
4921 This option controls the amount of debugging output the vectorizer prints.
4922 This information is written to standard error, unless
4923 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4924 in which case it is output to the usual dump listing file, @file{.vect}.
4925 For @var{n}=0 no diagnostic information is reported.
4926 If @var{n}=1 the vectorizer reports each loop that got vectorized,
4927 and the total number of loops that got vectorized.
4928 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4929 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
4930 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
4931 level that @option{-fdump-tree-vect-stats} uses.
4932 Higher verbosity levels mean either more information dumped for each
4933 reported loop, or same amount of information reported for more loops:
4934 If @var{n}=3, alignment related information is added to the reports.
4935 If @var{n}=4, data-references related information (e.g.@: memory dependences,
4936 memory access-patterns) is added to the reports.
4937 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4938 that did not pass the first analysis phase (i.e., may not be countable, or
4939 may have complicated control-flow).
4940 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4941 For @var{n}=7, all the information the vectorizer generates during its
4942 analysis and transformation is reported.  This is the same verbosity level
4943 that @option{-fdump-tree-vect-details} uses.
4944
4945 @item -frandom-seed=@var{string}
4946 @opindex frandom-string
4947 This option provides a seed that GCC uses when it would otherwise use
4948 random numbers.  It is used to generate certain symbol names
4949 that have to be different in every compiled file.  It is also used to
4950 place unique stamps in coverage data files and the object files that
4951 produce them.  You can use the @option{-frandom-seed} option to produce
4952 reproducibly identical object files.
4953
4954 The @var{string} should be different for every file you compile.
4955
4956 @item -fsched-verbose=@var{n}
4957 @opindex fsched-verbose
4958 On targets that use instruction scheduling, this option controls the
4959 amount of debugging output the scheduler prints.  This information is
4960 written to standard error, unless @option{-dS} or @option{-dR} is
4961 specified, in which case it is output to the usual dump
4962 listing file, @file{.sched} or @file{.sched2} respectively.  However
4963 for @var{n} greater than nine, the output is always printed to standard
4964 error.
4965
4966 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4967 same information as @option{-dRS}.  For @var{n} greater than one, it
4968 also output basic block probabilities, detailed ready list information
4969 and unit/insn info.  For @var{n} greater than two, it includes RTL
4970 at abort point, control-flow and regions info.  And for @var{n} over
4971 four, @option{-fsched-verbose} also includes dependence info.
4972
4973 @item -save-temps
4974 @opindex save-temps
4975 Store the usual ``temporary'' intermediate files permanently; place them
4976 in the current directory and name them based on the source file.  Thus,
4977 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4978 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4979 preprocessed @file{foo.i} output file even though the compiler now
4980 normally uses an integrated preprocessor.
4981
4982 When used in combination with the @option{-x} command line option,
4983 @option{-save-temps} is sensible enough to avoid over writing an
4984 input source file with the same extension as an intermediate file.
4985 The corresponding intermediate file may be obtained by renaming the
4986 source file before using @option{-save-temps}.
4987
4988 @item -time
4989 @opindex time
4990 Report the CPU time taken by each subprocess in the compilation
4991 sequence.  For C source files, this is the compiler proper and assembler
4992 (plus the linker if linking is done).  The output looks like this:
4993
4994 @smallexample
4995 # cc1 0.12 0.01
4996 # as 0.00 0.01
4997 @end smallexample
4998
4999 The first number on each line is the ``user time'', that is time spent
5000 executing the program itself.  The second number is ``system time'',
5001 time spent executing operating system routines on behalf of the program.
5002 Both numbers are in seconds.
5003
5004 @item -fvar-tracking
5005 @opindex fvar-tracking
5006 Run variable tracking pass.  It computes where variables are stored at each
5007 position in code.  Better debugging information is then generated
5008 (if the debugging information format supports this information).
5009
5010 It is enabled by default when compiling with optimization (@option{-Os},
5011 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5012 the debug info format supports it.
5013
5014 @item -print-file-name=@var{library}
5015 @opindex print-file-name
5016 Print the full absolute name of the library file @var{library} that
5017 would be used when linking---and don't do anything else.  With this
5018 option, GCC does not compile or link anything; it just prints the
5019 file name.
5020
5021 @item -print-multi-directory
5022 @opindex print-multi-directory
5023 Print the directory name corresponding to the multilib selected by any
5024 other switches present in the command line.  This directory is supposed
5025 to exist in @env{GCC_EXEC_PREFIX}.
5026
5027 @item -print-multi-lib
5028 @opindex print-multi-lib
5029 Print the mapping from multilib directory names to compiler switches
5030 that enable them.  The directory name is separated from the switches by
5031 @samp{;}, and each switch starts with an @samp{@@} instead of the
5032 @samp{-}, without spaces between multiple switches.  This is supposed to
5033 ease shell-processing.
5034
5035 @item -print-prog-name=@var{program}
5036 @opindex print-prog-name
5037 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5038
5039 @item -print-libgcc-file-name
5040 @opindex print-libgcc-file-name
5041 Same as @option{-print-file-name=libgcc.a}.
5042
5043 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5044 but you do want to link with @file{libgcc.a}.  You can do
5045
5046 @smallexample
5047 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5048 @end smallexample
5049
5050 @item -print-search-dirs
5051 @opindex print-search-dirs
5052 Print the name of the configured installation directory and a list of
5053 program and library directories @command{gcc} will search---and don't do anything else.
5054
5055 This is useful when @command{gcc} prints the error message
5056 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5057 To resolve this you either need to put @file{cpp0} and the other compiler
5058 components where @command{gcc} expects to find them, or you can set the environment
5059 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5060 Don't forget the trailing @samp{/}.
5061 @xref{Environment Variables}.
5062
5063 @item -print-sysroot
5064 @opindex print-sysroot
5065 Print the target sysroot directory that will be used during
5066 compilation.  This is the target sysroot specified either at configure
5067 time or or using the @option{--sysroot} option, possibly with an extra
5068 suffix that depends on compilation options.  If no target sysroot is
5069 specified, the option prints nothing.
5070
5071 @item -print-sysroot-headers-suffix
5072 @opindex print-sysroot-headers-suffix
5073 Print the suffix added to the target sysroot when searching for
5074 headers, or give an error if the compiler is not configured with such
5075 a suffix---and don't do anything else.
5076
5077 @item -dumpmachine
5078 @opindex dumpmachine
5079 Print the compiler's target machine (for example,
5080 @samp{i686-pc-linux-gnu})---and don't do anything else.
5081
5082 @item -dumpversion
5083 @opindex dumpversion
5084 Print the compiler version (for example, @samp{3.0})---and don't do
5085 anything else.
5086
5087 @item -dumpspecs
5088 @opindex dumpspecs
5089 Print the compiler's built-in specs---and don't do anything else.  (This
5090 is used when GCC itself is being built.)  @xref{Spec Files}.
5091
5092 @item -feliminate-unused-debug-types
5093 @opindex feliminate-unused-debug-types
5094 Normally, when producing DWARF2 output, GCC will emit debugging
5095 information for all types declared in a compilation
5096 unit, regardless of whether or not they are actually used
5097 in that compilation unit.  Sometimes this is useful, such as
5098 if, in the debugger, you want to cast a value to a type that is
5099 not actually used in your program (but is declared).  More often,
5100 however, this results in a significant amount of wasted space.
5101 With this option, GCC will avoid producing debug symbol output
5102 for types that are nowhere used in the source file being compiled.
5103 @end table
5104
5105 @node Optimize Options
5106 @section Options That Control Optimization
5107 @cindex optimize options
5108 @cindex options, optimization
5109
5110 These options control various sorts of optimizations.
5111
5112 Without any optimization option, the compiler's goal is to reduce the
5113 cost of compilation and to make debugging produce the expected
5114 results.  Statements are independent: if you stop the program with a
5115 breakpoint between statements, you can then assign a new value to any
5116 variable or change the program counter to any other statement in the
5117 function and get exactly the results you would expect from the source
5118 code.
5119
5120 Turning on optimization flags makes the compiler attempt to improve
5121 the performance and/or code size at the expense of compilation time
5122 and possibly the ability to debug the program.
5123
5124 The compiler performs optimization based on the knowledge it has of
5125 the program.  Optimization levels @option{-O} and above, in
5126 particular, enable @emph{unit-at-a-time} mode, which allows the
5127 compiler to consider information gained from later functions in
5128 the file when compiling a function.  Compiling multiple files at
5129 once to a single output file in @emph{unit-at-a-time} mode allows
5130 the compiler to use information gained from all of the files when
5131 compiling each of them.
5132
5133 Not all optimizations are controlled directly by a flag.  Only
5134 optimizations that have a flag are listed.
5135
5136 @table @gcctabopt
5137 @item -O
5138 @itemx -O1
5139 @opindex O
5140 @opindex O1
5141 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5142 more memory for a large function.
5143
5144 With @option{-O}, the compiler tries to reduce code size and execution
5145 time, without performing any optimizations that take a great deal of
5146 compilation time.
5147
5148 @option{-O} turns on the following optimization flags:
5149 @gccoptlist{
5150 -fauto-inc-dec @gol
5151 -fcprop-registers @gol
5152 -fdce @gol
5153 -fdefer-pop @gol
5154 -fdelayed-branch @gol
5155 -fdse @gol
5156 -fguess-branch-probability @gol
5157 -fif-conversion2 @gol
5158 -fif-conversion @gol
5159 -finline-small-functions @gol
5160 -fipa-pure-const @gol
5161 -fipa-reference @gol
5162 -fmerge-constants
5163 -fsplit-wide-types @gol
5164 -ftree-builtin-call-dce @gol
5165 -ftree-ccp @gol
5166 -ftree-ch @gol
5167 -ftree-copyrename @gol
5168 -ftree-dce @gol
5169 -ftree-dominator-opts @gol
5170 -ftree-dse @gol
5171 -ftree-fre @gol
5172 -ftree-sra @gol
5173 -ftree-ter @gol
5174 -funit-at-a-time}
5175
5176 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5177 where doing so does not interfere with debugging.
5178
5179 @item -O2
5180 @opindex O2
5181 Optimize even more.  GCC performs nearly all supported optimizations
5182 that do not involve a space-speed tradeoff.  The compiler does not
5183 perform loop unrolling or function inlining when you specify @option{-O2}.
5184 As compared to @option{-O}, this option increases both compilation time
5185 and the performance of the generated code.
5186
5187 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5188 also turns on the following optimization flags:
5189 @gccoptlist{-fthread-jumps @gol
5190 -falign-functions  -falign-jumps @gol
5191 -falign-loops  -falign-labels @gol
5192 -fcaller-saves @gol
5193 -fcrossjumping @gol
5194 -fcse-follow-jumps  -fcse-skip-blocks @gol
5195 -fdelete-null-pointer-checks @gol
5196 -fexpensive-optimizations @gol
5197 -fgcse  -fgcse-lm  @gol
5198 -foptimize-sibling-calls @gol
5199 -fpeephole2 @gol
5200 -fregmove @gol
5201 -freorder-blocks  -freorder-functions @gol
5202 -frerun-cse-after-loop  @gol
5203 -fsched-interblock  -fsched-spec @gol
5204 -fschedule-insns  -fschedule-insns2 @gol
5205 -fstrict-aliasing -fstrict-overflow @gol
5206 -ftree-switch-conversion @gol
5207 -ftree-pre @gol
5208 -ftree-vrp}
5209
5210 Please note the warning under @option{-fgcse} about
5211 invoking @option{-O2} on programs that use computed gotos.
5212
5213 @item -O3
5214 @opindex O3
5215 Optimize yet more.  @option{-O3} turns on all optimizations specified by
5216 @option{-O2} and also turns on the @option{-finline-functions},
5217 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5218 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5219
5220 @item -O0
5221 @opindex O0
5222 Reduce compilation time and make debugging produce the expected
5223 results.  This is the default.
5224
5225 @item -Os
5226 @opindex Os
5227 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5228 do not typically increase code size.  It also performs further
5229 optimizations designed to reduce code size.
5230
5231 @option{-Os} disables the following optimization flags:
5232 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5233 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5234 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5235
5236 If you use multiple @option{-O} options, with or without level numbers,
5237 the last such option is the one that is effective.
5238 @end table
5239
5240 Options of the form @option{-f@var{flag}} specify machine-independent
5241 flags.  Most flags have both positive and negative forms; the negative
5242 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5243 below, only one of the forms is listed---the one you typically will
5244 use.  You can figure out the other form by either removing @samp{no-}
5245 or adding it.
5246
5247 The following options control specific optimizations.  They are either
5248 activated by @option{-O} options or are related to ones that are.  You
5249 can use the following flags in the rare cases when ``fine-tuning'' of
5250 optimizations to be performed is desired.
5251
5252 @table @gcctabopt
5253 @item -fno-default-inline
5254 @opindex fno-default-inline
5255 Do not make member functions inline by default merely because they are
5256 defined inside the class scope (C++ only).  Otherwise, when you specify
5257 @w{@option{-O}}, member functions defined inside class scope are compiled
5258 inline by default; i.e., you don't need to add @samp{inline} in front of
5259 the member function name.
5260
5261 @item -fno-defer-pop
5262 @opindex fno-defer-pop
5263 Always pop the arguments to each function call as soon as that function
5264 returns.  For machines which must pop arguments after a function call,
5265 the compiler normally lets arguments accumulate on the stack for several
5266 function calls and pops them all at once.
5267
5268 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5269
5270 @item -fforward-propagate
5271 @opindex fforward-propagate
5272 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5273 instructions and checks if the result can be simplified.  If loop unrolling
5274 is active, two passes are performed and the second is scheduled after
5275 loop unrolling.
5276
5277 This option is enabled by default at optimization levels @option{-O2},
5278 @option{-O3}, @option{-Os}.
5279
5280 @item -fomit-frame-pointer
5281 @opindex fomit-frame-pointer
5282 Don't keep the frame pointer in a register for functions that
5283 don't need one.  This avoids the instructions to save, set up and
5284 restore frame pointers; it also makes an extra register available
5285 in many functions.  @strong{It also makes debugging impossible on
5286 some machines.}
5287
5288 On some machines, such as the VAX, this flag has no effect, because
5289 the standard calling sequence automatically handles the frame pointer
5290 and nothing is saved by pretending it doesn't exist.  The
5291 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5292 whether a target machine supports this flag.  @xref{Registers,,Register
5293 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5294
5295 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5296
5297 @item -foptimize-sibling-calls
5298 @opindex foptimize-sibling-calls
5299 Optimize sibling and tail recursive calls.
5300
5301 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5302
5303 @item -fno-inline
5304 @opindex fno-inline
5305 Don't pay attention to the @code{inline} keyword.  Normally this option
5306 is used to keep the compiler from expanding any functions inline.
5307 Note that if you are not optimizing, no functions can be expanded inline.
5308
5309 @item -finline-small-functions
5310 @opindex finline-small-functions
5311 Integrate functions into their callers when their body is smaller than expected
5312 function call code (so overall size of program gets smaller).  The compiler
5313 heuristically decides which functions are simple enough to be worth integrating
5314 in this way.
5315
5316 Enabled at level @option{-O2}.
5317
5318 @item -finline-functions
5319 @opindex finline-functions
5320 Integrate all simple functions into their callers.  The compiler
5321 heuristically decides which functions are simple enough to be worth
5322 integrating in this way.
5323
5324 If all calls to a given function are integrated, and the function is
5325 declared @code{static}, then the function is normally not output as
5326 assembler code in its own right.
5327
5328 Enabled at level @option{-O3}.
5329
5330 @item -finline-functions-called-once
5331 @opindex finline-functions-called-once
5332 Consider all @code{static} functions called once for inlining into their
5333 caller even if they are not marked @code{inline}.  If a call to a given
5334 function is integrated, then the function is not output as assembler code
5335 in its own right.
5336
5337 Enabled if @option{-funit-at-a-time} is enabled.
5338
5339 @item -fearly-inlining
5340 @opindex fearly-inlining
5341 Inline functions marked by @code{always_inline} and functions whose body seems
5342 smaller than the function call overhead early before doing
5343 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5344 makes profiling significantly cheaper and usually inlining faster on programs
5345 having large chains of nested wrapper functions.
5346
5347 Enabled by default.
5348
5349 @item -finline-limit=@var{n}
5350 @opindex finline-limit
5351 By default, GCC limits the size of functions that can be inlined.  This flag
5352 allows coarse control of this limit.  @var{n} is the size of functions that
5353 can be inlined in number of pseudo instructions.
5354
5355 Inlining is actually controlled by a number of parameters, which may be
5356 specified individually by using @option{--param @var{name}=@var{value}}.
5357 The @option{-finline-limit=@var{n}} option sets some of these parameters
5358 as follows:
5359
5360 @table @gcctabopt
5361 @item max-inline-insns-single
5362 is set to @var{n}/2.
5363 @item max-inline-insns-auto
5364 is set to @var{n}/2.
5365 @end table
5366
5367 See below for a documentation of the individual
5368 parameters controlling inlining and for the defaults of these parameters.
5369
5370 @emph{Note:} there may be no value to @option{-finline-limit} that results
5371 in default behavior.
5372
5373 @emph{Note:} pseudo instruction represents, in this particular context, an
5374 abstract measurement of function's size.  In no way does it represent a count
5375 of assembly instructions and as such its exact meaning might change from one
5376 release to an another.
5377
5378 @item -fkeep-inline-functions
5379 @opindex fkeep-inline-functions
5380 In C, emit @code{static} functions that are declared @code{inline}
5381 into the object file, even if the function has been inlined into all
5382 of its callers.  This switch does not affect functions using the
5383 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5384 inline functions into the object file.
5385
5386 @item -fkeep-static-consts
5387 @opindex fkeep-static-consts
5388 Emit variables declared @code{static const} when optimization isn't turned
5389 on, even if the variables aren't referenced.
5390
5391 GCC enables this option by default.  If you want to force the compiler to
5392 check if the variable was referenced, regardless of whether or not
5393 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5394
5395 @item -fmerge-constants
5396 @opindex fmerge-constants
5397 Attempt to merge identical constants (string constants and floating point
5398 constants) across compilation units.
5399
5400 This option is the default for optimized compilation if the assembler and
5401 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5402 behavior.
5403
5404 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5405
5406 @item -fmerge-all-constants
5407 @opindex fmerge-all-constants
5408 Attempt to merge identical constants and identical variables.
5409
5410 This option implies @option{-fmerge-constants}.  In addition to
5411 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5412 arrays or initialized constant variables with integral or floating point
5413 types.  Languages like C or C++ require each non-automatic variable to
5414 have distinct location, so using this option will result in non-conforming
5415 behavior.
5416
5417 @item -fmodulo-sched
5418 @opindex fmodulo-sched
5419 Perform swing modulo scheduling immediately before the first scheduling
5420 pass.  This pass looks at innermost loops and reorders their
5421 instructions by overlapping different iterations.
5422
5423 @item -fmodulo-sched-allow-regmoves
5424 @opindex fmodulo-sched-allow-regmoves
5425 Perform more aggressive SMS based modulo scheduling with register moves
5426 allowed.  By setting this flag certain anti-dependences edges will be
5427 deleted which will trigger the generation of reg-moves based on the
5428 life-range analysis.  This option is effective only with
5429 @option{-fmodulo-sched} enabled.
5430
5431 @item -fno-branch-count-reg
5432 @opindex fno-branch-count-reg
5433 Do not use ``decrement and branch'' instructions on a count register,
5434 but instead generate a sequence of instructions that decrement a
5435 register, compare it against zero, then branch based upon the result.
5436 This option is only meaningful on architectures that support such
5437 instructions, which include x86, PowerPC, IA-64 and S/390.
5438
5439 The default is @option{-fbranch-count-reg}.
5440
5441 @item -fno-function-cse
5442 @opindex fno-function-cse
5443 Do not put function addresses in registers; make each instruction that
5444 calls a constant function contain the function's address explicitly.
5445
5446 This option results in less efficient code, but some strange hacks
5447 that alter the assembler output may be confused by the optimizations
5448 performed when this option is not used.
5449
5450 The default is @option{-ffunction-cse}
5451
5452 @item -fno-zero-initialized-in-bss
5453 @opindex fno-zero-initialized-in-bss
5454 If the target supports a BSS section, GCC by default puts variables that
5455 are initialized to zero into BSS@.  This can save space in the resulting
5456 code.
5457
5458 This option turns off this behavior because some programs explicitly
5459 rely on variables going to the data section.  E.g., so that the
5460 resulting executable can find the beginning of that section and/or make
5461 assumptions based on that.
5462
5463 The default is @option{-fzero-initialized-in-bss}.
5464
5465 @item -fmudflap -fmudflapth -fmudflapir
5466 @opindex fmudflap
5467 @opindex fmudflapth
5468 @opindex fmudflapir
5469 @cindex bounds checking
5470 @cindex mudflap
5471 For front-ends that support it (C and C++), instrument all risky
5472 pointer/array dereferencing operations, some standard library
5473 string/heap functions, and some other associated constructs with
5474 range/validity tests.  Modules so instrumented should be immune to
5475 buffer overflows, invalid heap use, and some other classes of C/C++
5476 programming errors.  The instrumentation relies on a separate runtime
5477 library (@file{libmudflap}), which will be linked into a program if
5478 @option{-fmudflap} is given at link time.  Run-time behavior of the
5479 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5480 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5481 for its options.
5482
5483 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5484 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5485 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5486 instrumentation should ignore pointer reads.  This produces less
5487 instrumentation (and therefore faster execution) and still provides
5488 some protection against outright memory corrupting writes, but allows
5489 erroneously read data to propagate within a program.
5490
5491 @item -fthread-jumps
5492 @opindex fthread-jumps
5493 Perform optimizations where we check to see if a jump branches to a
5494 location where another comparison subsumed by the first is found.  If
5495 so, the first branch is redirected to either the destination of the
5496 second branch or a point immediately following it, depending on whether
5497 the condition is known to be true or false.
5498
5499 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5500
5501 @item -fsplit-wide-types
5502 @opindex fsplit-wide-types
5503 When using a type that occupies multiple registers, such as @code{long
5504 long} on a 32-bit system, split the registers apart and allocate them
5505 independently.  This normally generates better code for those types,
5506 but may make debugging more difficult.
5507
5508 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5509 @option{-Os}.
5510
5511 @item -fcse-follow-jumps
5512 @opindex fcse-follow-jumps
5513 In common subexpression elimination (CSE), scan through jump instructions
5514 when the target of the jump is not reached by any other path.  For
5515 example, when CSE encounters an @code{if} statement with an
5516 @code{else} clause, CSE will follow the jump when the condition
5517 tested is false.
5518
5519 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5520
5521 @item -fcse-skip-blocks
5522 @opindex fcse-skip-blocks
5523 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5524 follow jumps which conditionally skip over blocks.  When CSE
5525 encounters a simple @code{if} statement with no else clause,
5526 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5527 body of the @code{if}.
5528
5529 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5530
5531 @item -frerun-cse-after-loop
5532 @opindex frerun-cse-after-loop
5533 Re-run common subexpression elimination after loop optimizations has been
5534 performed.
5535
5536 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5537
5538 @item -fgcse
5539 @opindex fgcse
5540 Perform a global common subexpression elimination pass.
5541 This pass also performs global constant and copy propagation.
5542
5543 @emph{Note:} When compiling a program using computed gotos, a GCC
5544 extension, you may get better runtime performance if you disable
5545 the global common subexpression elimination pass by adding
5546 @option{-fno-gcse} to the command line.
5547
5548 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5549
5550 @item -fgcse-lm
5551 @opindex fgcse-lm
5552 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5553 attempt to move loads which are only killed by stores into themselves.  This
5554 allows a loop containing a load/store sequence to be changed to a load outside
5555 the loop, and a copy/store within the loop.
5556
5557 Enabled by default when gcse is enabled.
5558
5559 @item -fgcse-sm
5560 @opindex fgcse-sm
5561 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5562 global common subexpression elimination.  This pass will attempt to move
5563 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5564 loops containing a load/store sequence can be changed to a load before
5565 the loop and a store after the loop.
5566
5567 Not enabled at any optimization level.
5568
5569 @item -fgcse-las
5570 @opindex fgcse-las
5571 When @option{-fgcse-las} is enabled, the global common subexpression
5572 elimination pass eliminates redundant loads that come after stores to the
5573 same memory location (both partial and full redundancies).
5574
5575 Not enabled at any optimization level.
5576
5577 @item -fgcse-after-reload
5578 @opindex fgcse-after-reload
5579 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5580 pass is performed after reload.  The purpose of this pass is to cleanup
5581 redundant spilling.
5582
5583 @item -funsafe-loop-optimizations
5584 @opindex funsafe-loop-optimizations
5585 If given, the loop optimizer will assume that loop indices do not
5586 overflow, and that the loops with nontrivial exit condition are not
5587 infinite.  This enables a wider range of loop optimizations even if
5588 the loop optimizer itself cannot prove that these assumptions are valid.
5589 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5590 if it finds this kind of loop.
5591
5592 @item -fcrossjumping
5593 @opindex fcrossjumping
5594 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5595 resulting code may or may not perform better than without cross-jumping.
5596
5597 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5598
5599 @item -fauto-inc-dec
5600 @opindex fauto-inc-dec
5601 Combine increments or decrements of addresses with memory accesses.
5602 This pass is always skipped on architectures that do not have
5603 instructions to support this.  Enabled by default at @option{-O} and
5604 higher on architectures that support this.
5605
5606 @item -fdce
5607 @opindex fdce
5608 Perform dead code elimination (DCE) on RTL@.
5609 Enabled by default at @option{-O} and higher.
5610
5611 @item -fdse
5612 @opindex fdse
5613 Perform dead store elimination (DSE) on RTL@.
5614 Enabled by default at @option{-O} and higher.
5615
5616 @item -fif-conversion
5617 @opindex fif-conversion
5618 Attempt to transform conditional jumps into branch-less equivalents.  This
5619 include use of conditional moves, min, max, set flags and abs instructions, and
5620 some tricks doable by standard arithmetics.  The use of conditional execution
5621 on chips where it is available is controlled by @code{if-conversion2}.
5622
5623 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5624
5625 @item -fif-conversion2
5626 @opindex fif-conversion2
5627 Use conditional execution (where available) to transform conditional jumps into
5628 branch-less equivalents.
5629
5630 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5631
5632 @item -fdelete-null-pointer-checks
5633 @opindex fdelete-null-pointer-checks
5634 Use global dataflow analysis to identify and eliminate useless checks
5635 for null pointers.  The compiler assumes that dereferencing a null
5636 pointer would have halted the program.  If a pointer is checked after
5637 it has already been dereferenced, it cannot be null.
5638
5639 In some environments, this assumption is not true, and programs can
5640 safely dereference null pointers.  Use
5641 @option{-fno-delete-null-pointer-checks} to disable this optimization
5642 for programs which depend on that behavior.
5643
5644 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5645
5646 @item -fexpensive-optimizations
5647 @opindex fexpensive-optimizations
5648 Perform a number of minor optimizations that are relatively expensive.
5649
5650 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5651
5652 @item -foptimize-register-move
5653 @itemx -fregmove
5654 @opindex foptimize-register-move
5655 @opindex fregmove
5656 Attempt to reassign register numbers in move instructions and as
5657 operands of other simple instructions in order to maximize the amount of
5658 register tying.  This is especially helpful on machines with two-operand
5659 instructions.
5660
5661 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5662 optimization.
5663
5664 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5665
5666 @item -fdelayed-branch
5667 @opindex fdelayed-branch
5668 If supported for the target machine, attempt to reorder instructions
5669 to exploit instruction slots available after delayed branch
5670 instructions.
5671
5672 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5673
5674 @item -fschedule-insns
5675 @opindex fschedule-insns
5676 If supported for the target machine, attempt to reorder instructions to
5677 eliminate execution stalls due to required data being unavailable.  This
5678 helps machines that have slow floating point or memory load instructions
5679 by allowing other instructions to be issued until the result of the load
5680 or floating point instruction is required.
5681
5682 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5683
5684 @item -fschedule-insns2
5685 @opindex fschedule-insns2
5686 Similar to @option{-fschedule-insns}, but requests an additional pass of
5687 instruction scheduling after register allocation has been done.  This is
5688 especially useful on machines with a relatively small number of
5689 registers and where memory load instructions take more than one cycle.
5690
5691 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5692
5693 @item -fno-sched-interblock
5694 @opindex fno-sched-interblock
5695 Don't schedule instructions across basic blocks.  This is normally
5696 enabled by default when scheduling before register allocation, i.e.@:
5697 with @option{-fschedule-insns} or at @option{-O2} or higher.
5698
5699 @item -fno-sched-spec
5700 @opindex fno-sched-spec
5701 Don't allow speculative motion of non-load instructions.  This is normally
5702 enabled by default when scheduling before register allocation, i.e.@:
5703 with @option{-fschedule-insns} or at @option{-O2} or higher.
5704
5705 @item -fsched-spec-load
5706 @opindex fsched-spec-load
5707 Allow speculative motion of some load instructions.  This only makes
5708 sense when scheduling before register allocation, i.e.@: with
5709 @option{-fschedule-insns} or at @option{-O2} or higher.
5710
5711 @item -fsched-spec-load-dangerous
5712 @opindex fsched-spec-load-dangerous
5713 Allow speculative motion of more load instructions.  This only makes
5714 sense when scheduling before register allocation, i.e.@: with
5715 @option{-fschedule-insns} or at @option{-O2} or higher.
5716
5717 @item -fsched-stalled-insns
5718 @itemx -fsched-stalled-insns=@var{n}
5719 @opindex fsched-stalled-insns
5720 Define how many insns (if any) can be moved prematurely from the queue
5721 of stalled insns into the ready list, during the second scheduling pass.
5722 @option{-fno-sched-stalled-insns} means that no insns will be moved
5723 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
5724 on how many queued insns can be moved prematurely.
5725 @option{-fsched-stalled-insns} without a value is equivalent to
5726 @option{-fsched-stalled-insns=1}.
5727
5728 @item -fsched-stalled-insns-dep
5729 @itemx -fsched-stalled-insns-dep=@var{n}
5730 @opindex fsched-stalled-insns-dep
5731 Define how many insn groups (cycles) will be examined for a dependency
5732 on a stalled insn that is candidate for premature removal from the queue
5733 of stalled insns.  This has an effect only during the second scheduling pass,
5734 and only if @option{-fsched-stalled-insns} is used.
5735 @option{-fno-sched-stalled-insns-dep} is equivalent to
5736 @option{-fsched-stalled-insns-dep=0}.
5737 @option{-fsched-stalled-insns-dep} without a value is equivalent to
5738 @option{-fsched-stalled-insns-dep=1}.
5739
5740 @item -fsched2-use-superblocks
5741 @opindex fsched2-use-superblocks
5742 When scheduling after register allocation, do use superblock scheduling
5743 algorithm.  Superblock scheduling allows motion across basic block boundaries
5744 resulting on faster schedules.  This option is experimental, as not all machine
5745 descriptions used by GCC model the CPU closely enough to avoid unreliable
5746 results from the algorithm.
5747
5748 This only makes sense when scheduling after register allocation, i.e.@: with
5749 @option{-fschedule-insns2} or at @option{-O2} or higher.
5750
5751 @item -fsched2-use-traces
5752 @opindex fsched2-use-traces
5753 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5754 allocation and additionally perform code duplication in order to increase the
5755 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5756 trace formation.
5757
5758 This mode should produce faster but significantly longer programs.  Also
5759 without @option{-fbranch-probabilities} the traces constructed may not
5760 match the reality and hurt the performance.  This only makes
5761 sense when scheduling after register allocation, i.e.@: with
5762 @option{-fschedule-insns2} or at @option{-O2} or higher.
5763
5764 @item -fsee
5765 @opindex fsee
5766 Eliminate redundant sign extension instructions and move the non-redundant
5767 ones to optimal placement using lazy code motion (LCM).
5768
5769 @item -freschedule-modulo-scheduled-loops
5770 @opindex freschedule-modulo-scheduled-loops
5771 The modulo scheduling comes before the traditional scheduling, if a loop
5772 was modulo scheduled we may want to prevent the later scheduling passes
5773 from changing its schedule, we use this option to control that.
5774
5775 @item -fcaller-saves
5776 @opindex fcaller-saves
5777 Enable values to be allocated in registers that will be clobbered by
5778 function calls, by emitting extra instructions to save and restore the
5779 registers around such calls.  Such allocation is done only when it
5780 seems to result in better code than would otherwise be produced.
5781
5782 This option is always enabled by default on certain machines, usually
5783 those which have no call-preserved registers to use instead.
5784
5785 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5786
5787 @item -ftree-reassoc
5788 @opindex ftree-reassoc
5789 Perform reassociation on trees.  This flag is enabled by default
5790 at @option{-O} and higher.
5791
5792 @item -ftree-pre
5793 @opindex ftree-pre
5794 Perform partial redundancy elimination (PRE) on trees.  This flag is
5795 enabled by default at @option{-O2} and @option{-O3}.
5796
5797 @item -ftree-fre
5798 @opindex ftree-fre
5799 Perform full redundancy elimination (FRE) on trees.  The difference
5800 between FRE and PRE is that FRE only considers expressions
5801 that are computed on all paths leading to the redundant computation.
5802 This analysis is faster than PRE, though it exposes fewer redundancies.
5803 This flag is enabled by default at @option{-O} and higher.
5804
5805 @item -ftree-copy-prop
5806 @opindex ftree-copy-prop
5807 Perform copy propagation on trees.  This pass eliminates unnecessary
5808 copy operations.  This flag is enabled by default at @option{-O} and
5809 higher.
5810
5811 @item -fipa-pure-const
5812 @opindex fipa-pure-const
5813 Discover which functions are pure or constant.
5814 Enabled by default at @option{-O} and higher.
5815
5816 @item -fipa-reference
5817 @opindex fipa-reference
5818 Discover which static variables do not escape cannot escape the
5819 compilation unit.
5820 Enabled by default at @option{-O} and higher.
5821
5822 @item -fipa-struct-reorg
5823 @opindex fipa-struct-reorg
5824 Perform structure reorganization optimization, that change C-like structures 
5825 layout in order to better utilize spatial locality.  This transformation is 
5826 affective for programs containing arrays of structures.  Available in two 
5827 compilation modes: profile-based (enabled with @option{-fprofile-generate})
5828 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
5829 to provide the safety of this transformation.  It works only in whole program
5830 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
5831 enabled.  Structures considered @samp{cold} by this transformation are not
5832 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
5833
5834 With this flag, the program debug info reflects a new structure layout.
5835
5836 @item -fipa-pta
5837 @opindex fipa-pta
5838 Perform interprocedural pointer analysis.
5839
5840 @item -fipa-cp
5841 @opindex fipa-cp
5842 Perform interprocedural constant propagation.
5843 This optimization analyzes the program to determine when values passed
5844 to functions are constants and then optimizes accordingly.  
5845 This optimization can substantially increase performance
5846 if the application has constants passed to functions, but
5847 because this optimization can create multiple copies of functions,
5848 it may significantly increase code size.
5849
5850 @item -fipa-matrix-reorg
5851 @opindex fipa-matrix-reorg
5852 Perform matrix flattening and transposing.
5853 Matrix flattening tries to replace a m-dimensional matrix 
5854 with its equivalent n-dimensional matrix, where n < m.
5855 This reduces the level of indirection needed for accessing the elements
5856 of the matrix. The second optimization is matrix transposing that
5857 attemps to change the order of the matrix's dimensions in order to 
5858 improve cache locality.
5859 Both optimizations need fwhole-program flag. 
5860 Transposing is enabled only if profiling information is avaliable.
5861
5862
5863 @item -ftree-sink
5864 @opindex ftree-sink
5865 Perform forward store motion  on trees.  This flag is
5866 enabled by default at @option{-O} and higher.
5867
5868 @item -ftree-ccp
5869 @opindex ftree-ccp
5870 Perform sparse conditional constant propagation (CCP) on trees.  This
5871 pass only operates on local scalar variables and is enabled by default
5872 at @option{-O} and higher.
5873
5874 @item -ftree-store-ccp
5875 @opindex ftree-store-ccp
5876 Perform sparse conditional constant propagation (CCP) on trees.  This
5877 pass operates on both local scalar variables and memory stores and
5878 loads (global variables, structures, arrays, etc).  This flag is
5879 enabled by default at @option{-O2} and higher.
5880
5881 @item -ftree-switch-conversion
5882 Perform conversion of simple initializations in a switch to
5883 initializations from a scalar array.  This flag is enabled by default
5884 at @option{-O2} and higher.
5885
5886 @item -ftree-dce
5887 @opindex ftree-dce
5888 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5889 default at @option{-O} and higher.
5890
5891 @item -ftree-builtin-call-dce
5892 @opindex ftree-builtin-call-dce
5893 Perform conditional dead code elimination (DCE) for calls to builtin functions 
5894 that may set @code{errno} but are otherwise side-effect free.  This flag is 
5895 enabled by default at @option{-O2} and higher if @option{-Os} is not also 
5896 specified.
5897
5898 @item -ftree-dominator-opts
5899 @opindex ftree-dominator-opts
5900 Perform a variety of simple scalar cleanups (constant/copy
5901 propagation, redundancy elimination, range propagation and expression
5902 simplification) based on a dominator tree traversal.  This also
5903 performs jump threading (to reduce jumps to jumps). This flag is
5904 enabled by default at @option{-O} and higher.
5905
5906 @item -ftree-dse
5907 @opindex ftree-dse
5908 Perform dead store elimination (DSE) on trees.  A dead store is a store into
5909 a memory location which will later be overwritten by another store without
5910 any intervening loads.  In this case the earlier store can be deleted.  This
5911 flag is enabled by default at @option{-O} and higher.
5912
5913 @item -ftree-ch
5914 @opindex ftree-ch
5915 Perform loop header copying on trees.  This is beneficial since it increases
5916 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5917 is enabled by default at @option{-O} and higher.  It is not enabled
5918 for @option{-Os}, since it usually increases code size.
5919
5920 @item -ftree-loop-optimize
5921 @opindex ftree-loop-optimize
5922 Perform loop optimizations on trees.  This flag is enabled by default
5923 at @option{-O} and higher.
5924
5925 @item -ftree-loop-linear
5926 @opindex ftree-loop-linear
5927 Perform linear loop transformations on tree.  This flag can improve cache
5928 performance and allow further loop optimizations to take place.
5929
5930 @item -fcheck-data-deps
5931 @opindex fcheck-data-deps
5932 Compare the results of several data dependence analyzers.  This option
5933 is used for debugging the data dependence analyzers.
5934
5935 @item -ftree-loop-distribution
5936 Perform loop distribution.  This flag can improve cache performance on
5937 big loop bodies and allow further loop optimizations, like
5938 parallelization or vectorization, to take place.  For example, the loop
5939 @smallexample
5940 DO I = 1, N
5941   A(I) = B(I) + C
5942   D(I) = E(I) * F
5943 ENDDO
5944 @end smallexample
5945 is transformed to
5946 @smallexample
5947 DO I = 1, N
5948    A(I) = B(I) + C
5949 ENDDO
5950 DO I = 1, N
5951    D(I) = E(I) * F
5952 ENDDO
5953 @end smallexample
5954
5955 @item -ftree-loop-im
5956 @opindex ftree-loop-im
5957 Perform loop invariant motion on trees.  This pass moves only invariants that
5958 would be hard to handle at RTL level (function calls, operations that expand to
5959 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5960 operands of conditions that are invariant out of the loop, so that we can use
5961 just trivial invariantness analysis in loop unswitching.  The pass also includes
5962 store motion.
5963
5964 @item -ftree-loop-ivcanon
5965 @opindex ftree-loop-ivcanon
5966 Create a canonical counter for number of iterations in the loop for that
5967 determining number of iterations requires complicated analysis.  Later
5968 optimizations then may determine the number easily.  Useful especially
5969 in connection with unrolling.
5970
5971 @item -fivopts
5972 @opindex fivopts
5973 Perform induction variable optimizations (strength reduction, induction
5974 variable merging and induction variable elimination) on trees.
5975
5976 @item -ftree-parallelize-loops=n
5977 @opindex ftree-parallelize-loops
5978 Parallelize loops, i.e., split their iteration space to run in n threads.
5979 This is only possible for loops whose iterations are independent
5980 and can be arbitrarily reordered.  The optimization is only
5981 profitable on multiprocessor machines, for loops that are CPU-intensive,
5982 rather than constrained e.g.@: by memory bandwidth.  This option
5983 implies @option{-pthread}, and thus is only supported on targets
5984 that have support for @option{-pthread}.
5985
5986 @item -ftree-sra
5987 @opindex ftree-sra
5988 Perform scalar replacement of aggregates.  This pass replaces structure
5989 references with scalars to prevent committing structures to memory too
5990 early.  This flag is enabled by default at @option{-O} and higher.
5991
5992 @item -ftree-copyrename
5993 @opindex ftree-copyrename
5994 Perform copy renaming on trees.  This pass attempts to rename compiler
5995 temporaries to other variables at copy locations, usually resulting in
5996 variable names which more closely resemble the original variables.  This flag
5997 is enabled by default at @option{-O} and higher.
5998
5999 @item -ftree-ter
6000 @opindex ftree-ter
6001 Perform temporary expression replacement during the SSA->normal phase.  Single
6002 use/single def temporaries are replaced at their use location with their
6003 defining expression.  This results in non-GIMPLE code, but gives the expanders
6004 much more complex trees to work on resulting in better RTL generation.  This is
6005 enabled by default at @option{-O} and higher.
6006
6007 @item -ftree-vectorize
6008 @opindex ftree-vectorize
6009 Perform loop vectorization on trees. This flag is enabled by default at
6010 @option{-O3}.
6011
6012 @item -ftree-vect-loop-version
6013 @opindex ftree-vect-loop-version
6014 Perform loop versioning when doing loop vectorization on trees.  When a loop
6015 appears to be vectorizable except that data alignment or data dependence cannot
6016 be determined at compile time then vectorized and non-vectorized versions of
6017 the loop are generated along with runtime checks for alignment or dependence
6018 to control which version is executed.  This option is enabled by default
6019 except at level @option{-Os} where it is disabled.
6020
6021 @item -fvect-cost-model
6022 @opindex fvect-cost-model
6023 Enable cost model for vectorization.
6024
6025 @item -ftree-vrp
6026 @opindex ftree-vrp
6027 Perform Value Range Propagation on trees.  This is similar to the
6028 constant propagation pass, but instead of values, ranges of values are
6029 propagated.  This allows the optimizers to remove unnecessary range
6030 checks like array bound checks and null pointer checks.  This is
6031 enabled by default at @option{-O2} and higher.  Null pointer check
6032 elimination is only done if @option{-fdelete-null-pointer-checks} is
6033 enabled.
6034
6035 @item -ftracer
6036 @opindex ftracer
6037 Perform tail duplication to enlarge superblock size.  This transformation
6038 simplifies the control flow of the function allowing other optimizations to do
6039 better job.
6040
6041 @item -funroll-loops
6042 @opindex funroll-loops
6043 Unroll loops whose number of iterations can be determined at compile
6044 time or upon entry to the loop.  @option{-funroll-loops} implies
6045 @option{-frerun-cse-after-loop}.  This option makes code larger,
6046 and may or may not make it run faster.
6047
6048 @item -funroll-all-loops
6049 @opindex funroll-all-loops
6050 Unroll all loops, even if their number of iterations is uncertain when
6051 the loop is entered.  This usually makes programs run more slowly.
6052 @option{-funroll-all-loops} implies the same options as
6053 @option{-funroll-loops},
6054
6055 @item -fsplit-ivs-in-unroller
6056 @opindex fsplit-ivs-in-unroller
6057 Enables expressing of values of induction variables in later iterations
6058 of the unrolled loop using the value in the first iteration.  This breaks
6059 long dependency chains, thus improving efficiency of the scheduling passes.
6060
6061 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6062 same effect.  However in cases the loop body is more complicated than
6063 a single basic block, this is not reliable.  It also does not work at all
6064 on some of the architectures due to restrictions in the CSE pass.
6065
6066 This optimization is enabled by default.
6067
6068 @item -fvariable-expansion-in-unroller
6069 @opindex fvariable-expansion-in-unroller
6070 With this option, the compiler will create multiple copies of some
6071 local variables when unrolling a loop which can result in superior code.
6072
6073 @item -fpredictive-commoning
6074 @opindex fpredictive-commoning
6075 Perform predictive commoning optimization, i.e., reusing computations
6076 (especially memory loads and stores) performed in previous
6077 iterations of loops.
6078
6079 This option is enabled at level @option{-O3}.
6080
6081 @item -fprefetch-loop-arrays
6082 @opindex fprefetch-loop-arrays
6083 If supported by the target machine, generate instructions to prefetch
6084 memory to improve the performance of loops that access large arrays.
6085
6086 This option may generate better or worse code; results are highly
6087 dependent on the structure of loops within the source code.
6088
6089 Disabled at level @option{-Os}.
6090
6091 @item -fno-peephole
6092 @itemx -fno-peephole2
6093 @opindex fno-peephole
6094 @opindex fno-peephole2
6095 Disable any machine-specific peephole optimizations.  The difference
6096 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6097 are implemented in the compiler; some targets use one, some use the
6098 other, a few use both.
6099
6100 @option{-fpeephole} is enabled by default.
6101 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6102
6103 @item -fno-guess-branch-probability
6104 @opindex fno-guess-branch-probability
6105 Do not guess branch probabilities using heuristics.
6106
6107 GCC will use heuristics to guess branch probabilities if they are
6108 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6109 heuristics are based on the control flow graph.  If some branch probabilities
6110 are specified by @samp{__builtin_expect}, then the heuristics will be
6111 used to guess branch probabilities for the rest of the control flow graph,
6112 taking the @samp{__builtin_expect} info into account.  The interactions
6113 between the heuristics and @samp{__builtin_expect} can be complex, and in
6114 some cases, it may be useful to disable the heuristics so that the effects
6115 of @samp{__builtin_expect} are easier to understand.
6116
6117 The default is @option{-fguess-branch-probability} at levels
6118 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6119
6120 @item -freorder-blocks
6121 @opindex freorder-blocks
6122 Reorder basic blocks in the compiled function in order to reduce number of
6123 taken branches and improve code locality.
6124
6125 Enabled at levels @option{-O2}, @option{-O3}.
6126
6127 @item -freorder-blocks-and-partition
6128 @opindex freorder-blocks-and-partition
6129 In addition to reordering basic blocks in the compiled function, in order
6130 to reduce number of taken branches, partitions hot and cold basic blocks
6131 into separate sections of the assembly and .o files, to improve
6132 paging and cache locality performance.
6133
6134 This optimization is automatically turned off in the presence of
6135 exception handling, for linkonce sections, for functions with a user-defined
6136 section attribute and on any architecture that does not support named
6137 sections.
6138
6139 @item -freorder-functions
6140 @opindex freorder-functions
6141 Reorder functions in the object file in order to
6142 improve code locality.  This is implemented by using special
6143 subsections @code{.text.hot} for most frequently executed functions and
6144 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6145 the linker so object file format must support named sections and linker must
6146 place them in a reasonable way.
6147
6148 Also profile feedback must be available in to make this option effective.  See
6149 @option{-fprofile-arcs} for details.
6150
6151 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6152
6153 @item -fstrict-aliasing
6154 @opindex fstrict-aliasing
6155 Allows the compiler to assume the strictest aliasing rules applicable to
6156 the language being compiled.  For C (and C++), this activates
6157 optimizations based on the type of expressions.  In particular, an
6158 object of one type is assumed never to reside at the same address as an
6159 object of a different type, unless the types are almost the same.  For
6160 example, an @code{unsigned int} can alias an @code{int}, but not a
6161 @code{void*} or a @code{double}.  A character type may alias any other
6162 type.
6163
6164 @anchor{Type-punning}Pay special attention to code like this:
6165 @smallexample
6166 union a_union @{
6167   int i;
6168   double d;
6169 @};
6170
6171 int f() @{
6172   a_union t;
6173   t.d = 3.0;
6174   return t.i;
6175 @}
6176 @end smallexample
6177 The practice of reading from a different union member than the one most
6178 recently written to (called ``type-punning'') is common.  Even with
6179 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6180 is accessed through the union type.  So, the code above will work as
6181 expected.  @xref{Structures unions enumerations and bit-fields
6182 implementation}.  However, this code might not:
6183 @smallexample
6184 int f() @{
6185   a_union t;
6186   int* ip;
6187   t.d = 3.0;
6188   ip = &t.i;
6189   return *ip;
6190 @}
6191 @end smallexample
6192
6193 Similarly, access by taking the address, casting the resulting pointer
6194 and dereferencing the result has undefined behavior, even if the cast
6195 uses a union type, e.g.:
6196 @smallexample
6197 int f() @{
6198   double d = 3.0;
6199   return ((union a_union *) &d)->i;
6200 @}
6201 @end smallexample
6202
6203 The @option{-fstrict-aliasing} option is enabled at levels
6204 @option{-O2}, @option{-O3}, @option{-Os}.
6205
6206 @item -fstrict-overflow
6207 @opindex fstrict-overflow
6208 Allow the compiler to assume strict signed overflow rules, depending
6209 on the language being compiled.  For C (and C++) this means that
6210 overflow when doing arithmetic with signed numbers is undefined, which
6211 means that the compiler may assume that it will not happen.  This
6212 permits various optimizations.  For example, the compiler will assume
6213 that an expression like @code{i + 10 > i} will always be true for
6214 signed @code{i}.  This assumption is only valid if signed overflow is
6215 undefined, as the expression is false if @code{i + 10} overflows when
6216 using twos complement arithmetic.  When this option is in effect any
6217 attempt to determine whether an operation on signed numbers will
6218 overflow must be written carefully to not actually involve overflow.
6219
6220 This option also allows the compiler to assume strict pointer
6221 semantics: given a pointer to an object, if adding an offset to that
6222 pointer does not produce a pointer to the same object, the addition is
6223 undefined.  This permits the compiler to conclude that @code{p + u >
6224 p} is always true for a pointer @code{p} and unsigned integer
6225 @code{u}.  This assumption is only valid because pointer wraparound is
6226 undefined, as the expression is false if @code{p + u} overflows using
6227 twos complement arithmetic.
6228
6229 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6230 that integer signed overflow is fully defined: it wraps.  When
6231 @option{-fwrapv} is used, there is no difference between
6232 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
6233 integers.  With @option{-fwrapv} certain types of overflow are
6234 permitted.  For example, if the compiler gets an overflow when doing
6235 arithmetic on constants, the overflowed value can still be used with
6236 @option{-fwrapv}, but not otherwise.
6237
6238 The @option{-fstrict-overflow} option is enabled at levels
6239 @option{-O2}, @option{-O3}, @option{-Os}.
6240
6241 @item -falign-functions
6242 @itemx -falign-functions=@var{n}
6243 @opindex falign-functions
6244 Align the start of functions to the next power-of-two greater than
6245 @var{n}, skipping up to @var{n} bytes.  For instance,
6246 @option{-falign-functions=32} aligns functions to the next 32-byte
6247 boundary, but @option{-falign-functions=24} would align to the next
6248 32-byte boundary only if this can be done by skipping 23 bytes or less.
6249
6250 @option{-fno-align-functions} and @option{-falign-functions=1} are
6251 equivalent and mean that functions will not be aligned.
6252
6253 Some assemblers only support this flag when @var{n} is a power of two;
6254 in that case, it is rounded up.
6255
6256 If @var{n} is not specified or is zero, use a machine-dependent default.
6257
6258 Enabled at levels @option{-O2}, @option{-O3}.
6259
6260 @item -falign-labels
6261 @itemx -falign-labels=@var{n}
6262 @opindex falign-labels
6263 Align all branch targets to a power-of-two boundary, skipping up to
6264 @var{n} bytes like @option{-falign-functions}.  This option can easily
6265 make code slower, because it must insert dummy operations for when the
6266 branch target is reached in the usual flow of the code.
6267
6268 @option{-fno-align-labels} and @option{-falign-labels=1} are
6269 equivalent and mean that labels will not be aligned.
6270
6271 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6272 are greater than this value, then their values are used instead.
6273
6274 If @var{n} is not specified or is zero, use a machine-dependent default
6275 which is very likely to be @samp{1}, meaning no alignment.
6276
6277 Enabled at levels @option{-O2}, @option{-O3}.
6278
6279 @item -falign-loops
6280 @itemx -falign-loops=@var{n}
6281 @opindex falign-loops
6282 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6283 like @option{-falign-functions}.  The hope is that the loop will be
6284 executed many times, which will make up for any execution of the dummy
6285 operations.
6286
6287 @option{-fno-align-loops} and @option{-falign-loops=1} are
6288 equivalent and mean that loops will not be aligned.
6289
6290 If @var{n} is not specified or is zero, use a machine-dependent default.
6291
6292 Enabled at levels @option{-O2}, @option{-O3}.
6293
6294 @item -falign-jumps
6295 @itemx -falign-jumps=@var{n}
6296 @opindex falign-jumps
6297 Align branch targets to a power-of-two boundary, for branch targets
6298 where the targets can only be reached by jumping, skipping up to @var{n}
6299 bytes like @option{-falign-functions}.  In this case, no dummy operations
6300 need be executed.
6301
6302 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6303 equivalent and mean that loops will not be aligned.
6304
6305 If @var{n} is not specified or is zero, use a machine-dependent default.
6306
6307 Enabled at levels @option{-O2}, @option{-O3}.
6308
6309 @item -funit-at-a-time
6310 @opindex funit-at-a-time
6311 Parse the whole compilation unit before starting to produce code.
6312 This allows some extra optimizations to take place but consumes
6313 more memory (in general).  There are some compatibility issues
6314 with @emph{unit-at-a-time} mode:
6315 @itemize @bullet
6316 @item
6317 enabling @emph{unit-at-a-time} mode may change the order
6318 in which functions, variables, and top-level @code{asm} statements
6319 are emitted, and will likely break code relying on some particular
6320 ordering.  The majority of such top-level @code{asm} statements,
6321 though, can be replaced by @code{section} attributes.  The
6322 @option{fno-toplevel-reorder} option may be used to keep the ordering
6323 used in the input file, at the cost of some optimizations.
6324
6325 @item
6326 @emph{unit-at-a-time} mode removes unreferenced static variables
6327 and functions.  This may result in undefined references
6328 when an @code{asm} statement refers directly to variables or functions
6329 that are otherwise unused.  In that case either the variable/function
6330 shall be listed as an operand of the @code{asm} statement operand or,
6331 in the case of top-level @code{asm} statements the attribute @code{used}
6332 shall be used on the declaration.
6333
6334 @item
6335 Static functions now can use non-standard passing conventions that
6336 may break @code{asm} statements calling functions directly.  Again,
6337 attribute @code{used} will prevent this behavior.
6338 @end itemize
6339
6340 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
6341 but this scheme may not be supported by future releases of GCC@.
6342
6343 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6344
6345 @item -fno-toplevel-reorder
6346 @opindex fno-toplevel-reorder
6347 Do not reorder top-level functions, variables, and @code{asm}
6348 statements.  Output them in the same order that they appear in the
6349 input file.  When this option is used, unreferenced static variables
6350 will not be removed.  This option is intended to support existing code
6351 which relies on a particular ordering.  For new code, it is better to
6352 use attributes.
6353
6354 @item -fweb
6355 @opindex fweb
6356 Constructs webs as commonly used for register allocation purposes and assign
6357 each web individual pseudo register.  This allows the register allocation pass
6358 to operate on pseudos directly, but also strengthens several other optimization
6359 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6360 however, make debugging impossible, since variables will no longer stay in a
6361 ``home register''.
6362
6363 Enabled by default with @option{-funroll-loops}.
6364
6365 @item -fwhole-program
6366 @opindex fwhole-program
6367 Assume that the current compilation unit represents whole program being
6368 compiled.  All public functions and variables with the exception of @code{main}
6369 and those merged by attribute @code{externally_visible} become static functions
6370 and in a affect gets more aggressively optimized by interprocedural optimizers.
6371 While this option is equivalent to proper use of @code{static} keyword for
6372 programs consisting of single file, in combination with option
6373 @option{--combine} this flag can be used to compile most of smaller scale C
6374 programs since the functions and variables become local for the whole combined
6375 compilation unit, not for the single source file itself.
6376
6377 This option is not supported for Fortran programs.
6378
6379 @item -fcprop-registers
6380 @opindex fcprop-registers
6381 After register allocation and post-register allocation instruction splitting,
6382 we perform a copy-propagation pass to try to reduce scheduling dependencies
6383 and occasionally eliminate the copy.
6384
6385 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6386
6387 @item -fprofile-dir=@var{path}
6388 @opindex fprofile-dir
6389
6390 Set the directory to search the profile data files in to @var{path}.
6391 This option affects only the profile data generated by
6392 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
6393 and used by @option{-fprofile-use} and @option{-fbranch-probabilities} 
6394 and its related options.
6395 By default, GCC will use the current directory as @var{path}
6396 thus the profile data file will appear in the same directory as the object file.
6397
6398 @item -fprofile-generate
6399 @itemx -fprofile-generate=@var{path}
6400 @opindex fprofile-generate
6401
6402 Enable options usually used for instrumenting application to produce
6403 profile useful for later recompilation with profile feedback based
6404 optimization.  You must use @option{-fprofile-generate} both when
6405 compiling and when linking your program.
6406
6407 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6408
6409 If @var{path} is specified, GCC will look at the @var{path} to find
6410 the profile feeedback data files. See @option{-fprofile-dir}.
6411
6412 @item -fprofile-use
6413 @itemx -fprofile-use=@var{path}
6414 @opindex fprofile-use
6415 Enable profile feedback directed optimizations, and optimizations
6416 generally profitable only with profile feedback available.
6417
6418 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6419 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6420
6421 By default, GCC emits an error message if the feedback profiles do not
6422 match the source code.  This error can be turned into a warning by using
6423 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6424 code.
6425
6426 If @var{path} is specified, GCC will look at the @var{path} to find
6427 the profile feedback data files. See @option{-fprofile-dir}.
6428 @end table
6429
6430 The following options control compiler behavior regarding floating
6431 point arithmetic.  These options trade off between speed and
6432 correctness.  All must be specifically enabled.
6433
6434 @table @gcctabopt
6435 @item -ffloat-store
6436 @opindex ffloat-store
6437 Do not store floating point variables in registers, and inhibit other
6438 options that might change whether a floating point value is taken from a
6439 register or memory.
6440
6441 @cindex floating point precision
6442 This option prevents undesirable excess precision on machines such as
6443 the 68000 where the floating registers (of the 68881) keep more
6444 precision than a @code{double} is supposed to have.  Similarly for the
6445 x86 architecture.  For most programs, the excess precision does only
6446 good, but a few programs rely on the precise definition of IEEE floating
6447 point.  Use @option{-ffloat-store} for such programs, after modifying
6448 them to store all pertinent intermediate computations into variables.
6449
6450 @item -ffast-math
6451 @opindex ffast-math
6452 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
6453 @option{-ffinite-math-only}, @option{-fno-rounding-math},
6454 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
6455
6456 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6457
6458 This option is not turned on by any @option{-O} option since
6459 it can result in incorrect output for programs which depend on
6460 an exact implementation of IEEE or ISO rules/specifications for
6461 math functions. It may, however, yield faster code for programs
6462 that do not require the guarantees of these specifications.
6463
6464 @item -fno-math-errno
6465 @opindex fno-math-errno
6466 Do not set ERRNO after calling math functions that are executed
6467 with a single instruction, e.g., sqrt.  A program that relies on
6468 IEEE exceptions for math error handling may want to use this flag
6469 for speed while maintaining IEEE arithmetic compatibility.
6470
6471 This option is not turned on by any @option{-O} option since
6472 it can result in incorrect output for programs which depend on
6473 an exact implementation of IEEE or ISO rules/specifications for
6474 math functions. It may, however, yield faster code for programs
6475 that do not require the guarantees of these specifications.
6476
6477 The default is @option{-fmath-errno}.
6478
6479 On Darwin systems, the math library never sets @code{errno}.  There is
6480 therefore no reason for the compiler to consider the possibility that
6481 it might, and @option{-fno-math-errno} is the default.
6482
6483 @item -funsafe-math-optimizations
6484 @opindex funsafe-math-optimizations
6485
6486 Allow optimizations for floating-point arithmetic that (a) assume
6487 that arguments and results are valid and (b) may violate IEEE or
6488 ANSI standards.  When used at link-time, it may include libraries
6489 or startup files that change the default FPU control word or other
6490 similar optimizations.
6491
6492 This option is not turned on by any @option{-O} option since
6493 it can result in incorrect output for programs which depend on
6494 an exact implementation of IEEE or ISO rules/specifications for
6495 math functions. It may, however, yield faster code for programs
6496 that do not require the guarantees of these specifications.
6497 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
6498 @option{-fassociative-math} and @option{-freciprocal-math}.
6499
6500 The default is @option{-fno-unsafe-math-optimizations}.
6501
6502 @item -fassociative-math
6503 @opindex fassociative-math
6504
6505 Allow re-association of operands in series of floating-point operations.
6506 This violates the ISO C and C++ language standard by possibly changing
6507 computation result.  NOTE: re-ordering may change the sign of zero as
6508 well as ignore NaNs and inhibit or create underflow or overflow (and
6509 thus cannot be used on a code which relies on rounding behavior like
6510 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
6511 and thus may not be used when ordered comparisons are required.
6512 This option requires that both @option{-fno-signed-zeros} and
6513 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
6514 much sense with @option{-frounding-math}.
6515
6516 The default is @option{-fno-associative-math}.
6517
6518 @item -freciprocal-math
6519 @opindex freciprocal-math
6520
6521 Allow the reciprocal of a value to be used instead of dividing by
6522 the value if this enables optimizations.  For example @code{x / y}
6523 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
6524 is subject to common subexpression elimination.  Note that this loses
6525 precision and increases the number of flops operating on the value.
6526
6527 The default is @option{-fno-reciprocal-math}.
6528
6529 @item -ffinite-math-only
6530 @opindex ffinite-math-only
6531 Allow optimizations for floating-point arithmetic that assume
6532 that arguments and results are not NaNs or +-Infs.
6533
6534 This option is not turned on by any @option{-O} option since
6535 it can result in incorrect output for programs which depend on
6536 an exact implementation of IEEE or ISO rules/specifications for
6537 math functions. It may, however, yield faster code for programs
6538 that do not require the guarantees of these specifications.
6539
6540 The default is @option{-fno-finite-math-only}.
6541
6542 @item -fno-signed-zeros
6543 @opindex fno-signed-zeros
6544 Allow optimizations for floating point arithmetic that ignore the
6545 signedness of zero.  IEEE arithmetic specifies the behavior of
6546 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6547 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6548 This option implies that the sign of a zero result isn't significant.
6549
6550 The default is @option{-fsigned-zeros}.
6551
6552 @item -fno-trapping-math
6553 @opindex fno-trapping-math
6554 Compile code assuming that floating-point operations cannot generate
6555 user-visible traps.  These traps include division by zero, overflow,
6556 underflow, inexact result and invalid operation.  This option requires
6557 that @option{-fno-signaling-nans} be in effect.  Setting this option may
6558 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
6559
6560 This option should never be turned on by any @option{-O} option since
6561 it can result in incorrect output for programs which depend on
6562 an exact implementation of IEEE or ISO rules/specifications for
6563 math functions.
6564
6565 The default is @option{-ftrapping-math}.
6566
6567 @item -frounding-math
6568 @opindex frounding-math
6569 Disable transformations and optimizations that assume default floating
6570 point rounding behavior.  This is round-to-zero for all floating point
6571 to integer conversions, and round-to-nearest for all other arithmetic
6572 truncations.  This option should be specified for programs that change
6573 the FP rounding mode dynamically, or that may be executed with a
6574 non-default rounding mode.  This option disables constant folding of
6575 floating point expressions at compile-time (which may be affected by
6576 rounding mode) and arithmetic transformations that are unsafe in the
6577 presence of sign-dependent rounding modes.
6578
6579 The default is @option{-fno-rounding-math}.
6580
6581 This option is experimental and does not currently guarantee to
6582 disable all GCC optimizations that are affected by rounding mode.
6583 Future versions of GCC may provide finer control of this setting
6584 using C99's @code{FENV_ACCESS} pragma.  This command line option
6585 will be used to specify the default state for @code{FENV_ACCESS}.
6586
6587 @item -frtl-abstract-sequences
6588 @opindex frtl-abstract-sequences
6589 It is a size optimization method. This option is to find identical
6590 sequences of code, which can be turned into pseudo-procedures  and
6591 then  replace  all  occurrences with  calls to  the  newly created
6592 subroutine. It is kind of an opposite of @option{-finline-functions}.
6593 This optimization runs at RTL level.
6594
6595 @item -fsignaling-nans
6596 @opindex fsignaling-nans
6597 Compile code assuming that IEEE signaling NaNs may generate user-visible
6598 traps during floating-point operations.  Setting this option disables
6599 optimizations that may change the number of exceptions visible with
6600 signaling NaNs.  This option implies @option{-ftrapping-math}.
6601
6602 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6603 be defined.
6604
6605 The default is @option{-fno-signaling-nans}.
6606
6607 This option is experimental and does not currently guarantee to
6608 disable all GCC optimizations that affect signaling NaN behavior.
6609
6610 @item -fsingle-precision-constant
6611 @opindex fsingle-precision-constant
6612 Treat floating point constant as single precision constant instead of
6613 implicitly converting it to double precision constant.
6614
6615 @item -fcx-limited-range
6616 @opindex fcx-limited-range
6617 When enabled, this option states that a range reduction step is not
6618 needed when performing complex division.  Also, there is no checking
6619 whether the result of a complex multiplication or division is @code{NaN
6620 + I*NaN}, with an attempt to rescue the situation in that case.  The
6621 default is @option{-fno-cx-limited-range}, but is enabled by
6622 @option{-ffast-math}.
6623
6624 This option controls the default setting of the ISO C99
6625 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6626 all languages.
6627
6628 @item -fcx-fortran-rules
6629 @opindex fcx-fortran-rules
6630 Complex multiplication and division follow Fortran rules.  Range
6631 reduction is done as part of complex division, but there is no checking
6632 whether the result of a complex multiplication or division is @code{NaN
6633 + I*NaN}, with an attempt to rescue the situation in that case.
6634
6635 The default is @option{-fno-cx-fortran-rules}.
6636
6637 @end table
6638
6639 The following options control optimizations that may improve
6640 performance, but are not enabled by any @option{-O} options.  This
6641 section includes experimental options that may produce broken code.
6642
6643 @table @gcctabopt
6644 @item -fbranch-probabilities
6645 @opindex fbranch-probabilities
6646 After running a program compiled with @option{-fprofile-arcs}
6647 (@pxref{Debugging Options,, Options for Debugging Your Program or
6648 @command{gcc}}), you can compile it a second time using
6649 @option{-fbranch-probabilities}, to improve optimizations based on
6650 the number of times each branch was taken.  When the program
6651 compiled with @option{-fprofile-arcs} exits it saves arc execution
6652 counts to a file called @file{@var{sourcename}.gcda} for each source
6653 file.  The information in this data file is very dependent on the
6654 structure of the generated code, so you must use the same source code
6655 and the same optimization options for both compilations.
6656
6657 With @option{-fbranch-probabilities}, GCC puts a
6658 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6659 These can be used to improve optimization.  Currently, they are only
6660 used in one place: in @file{reorg.c}, instead of guessing which path a
6661 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6662 exactly determine which path is taken more often.
6663
6664 @item -fprofile-values
6665 @opindex fprofile-values
6666 If combined with @option{-fprofile-arcs}, it adds code so that some
6667 data about values of expressions in the program is gathered.
6668
6669 With @option{-fbranch-probabilities}, it reads back the data gathered
6670 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6671 notes to instructions for their later usage in optimizations.
6672
6673 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6674
6675 @item -fvpt
6676 @opindex fvpt
6677 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
6678 a code to gather information about values of expressions.
6679
6680 With @option{-fbranch-probabilities}, it reads back the data gathered
6681 and actually performs the optimizations based on them.
6682 Currently the optimizations include specialization of division operation
6683 using the knowledge about the value of the denominator.
6684
6685 @item -frename-registers
6686 @opindex frename-registers
6687 Attempt to avoid false dependencies in scheduled code by making use
6688 of registers left over after register allocation.  This optimization
6689 will most benefit processors with lots of registers.  Depending on the
6690 debug information format adopted by the target, however, it can
6691 make debugging impossible, since variables will no longer stay in
6692 a ``home register''.
6693
6694 Enabled by default with @option{-funroll-loops}.
6695
6696 @item -ftracer
6697 @opindex ftracer
6698 Perform tail duplication to enlarge superblock size.  This transformation
6699 simplifies the control flow of the function allowing other optimizations to do
6700 better job.
6701
6702 Enabled with @option{-fprofile-use}.
6703
6704 @item -funroll-loops
6705 @opindex funroll-loops
6706 Unroll loops whose number of iterations can be determined at compile time or
6707 upon entry to the loop.  @option{-funroll-loops} implies
6708 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
6709 It also turns on complete loop peeling (i.e.@: complete removal of loops with
6710 small constant number of iterations).  This option makes code larger, and may
6711 or may not make it run faster.
6712
6713 Enabled with @option{-fprofile-use}.
6714
6715 @item -funroll-all-loops
6716 @opindex funroll-all-loops
6717 Unroll all loops, even if their number of iterations is uncertain when
6718 the loop is entered.  This usually makes programs run more slowly.
6719 @option{-funroll-all-loops} implies the same options as
6720 @option{-funroll-loops}.
6721
6722 @item -fpeel-loops
6723 @opindex fpeel-loops
6724 Peels the loops for that there is enough information that they do not
6725 roll much (from profile feedback).  It also turns on complete loop peeling
6726 (i.e.@: complete removal of loops with small constant number of iterations).
6727
6728 Enabled with @option{-fprofile-use}.
6729
6730 @item -fmove-loop-invariants
6731 @opindex fmove-loop-invariants
6732 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
6733 at level @option{-O1}
6734
6735 @item -funswitch-loops
6736 @opindex funswitch-loops
6737 Move branches with loop invariant conditions out of the loop, with duplicates
6738 of the loop on both branches (modified according to result of the condition).
6739
6740 @item -ffunction-sections
6741 @itemx -fdata-sections
6742 @opindex ffunction-sections
6743 @opindex fdata-sections
6744 Place each function or data item into its own section in the output
6745 file if the target supports arbitrary sections.  The name of the
6746 function or the name of the data item determines the section's name
6747 in the output file.
6748
6749 Use these options on systems where the linker can perform optimizations
6750 to improve locality of reference in the instruction space.  Most systems
6751 using the ELF object format and SPARC processors running Solaris 2 have
6752 linkers with such optimizations.  AIX may have these optimizations in
6753 the future.
6754
6755 Only use these options when there are significant benefits from doing
6756 so.  When you specify these options, the assembler and linker will
6757 create larger object and executable files and will also be slower.
6758 You will not be able to use @code{gprof} on all systems if you
6759 specify this option and you may have problems with debugging if
6760 you specify both this option and @option{-g}.
6761
6762 @item -fbranch-target-load-optimize
6763 @opindex fbranch-target-load-optimize
6764 Perform branch target register load optimization before prologue / epilogue
6765 threading.
6766 The use of target registers can typically be exposed only during reload,
6767 thus hoisting loads out of loops and doing inter-block scheduling needs
6768 a separate optimization pass.
6769
6770 @item -fbranch-target-load-optimize2
6771 @opindex fbranch-target-load-optimize2
6772 Perform branch target register load optimization after prologue / epilogue
6773 threading.
6774
6775 @item -fbtr-bb-exclusive
6776 @opindex fbtr-bb-exclusive
6777 When performing branch target register load optimization, don't reuse
6778 branch target registers in within any basic block.
6779
6780 @item -fstack-protector
6781 @opindex fstack-protector
6782 Emit extra code to check for buffer overflows, such as stack smashing
6783 attacks.  This is done by adding a guard variable to functions with
6784 vulnerable objects.  This includes functions that call alloca, and
6785 functions with buffers larger than 8 bytes.  The guards are initialized
6786 when a function is entered and then checked when the function exits.
6787 If a guard check fails, an error message is printed and the program exits.
6788
6789 @item -fstack-protector-all
6790 @opindex fstack-protector-all
6791 Like @option{-fstack-protector} except that all functions are protected.
6792
6793 @item -fsection-anchors
6794 @opindex fsection-anchors
6795 Try to reduce the number of symbolic address calculations by using
6796 shared ``anchor'' symbols to address nearby objects.  This transformation
6797 can help to reduce the number of GOT entries and GOT accesses on some
6798 targets.
6799
6800 For example, the implementation of the following function @code{foo}:
6801
6802 @smallexample
6803 static int a, b, c;
6804 int foo (void) @{ return a + b + c; @}
6805 @end smallexample
6806
6807 would usually calculate the addresses of all three variables, but if you
6808 compile it with @option{-fsection-anchors}, it will access the variables
6809 from a common anchor point instead.  The effect is similar to the
6810 following pseudocode (which isn't valid C):
6811
6812 @smallexample
6813 int foo (void)
6814 @{
6815   register int *xr = &x;
6816   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6817 @}
6818 @end smallexample
6819
6820 Not all targets support this option.
6821
6822 @item --param @var{name}=@var{value}
6823 @opindex param
6824 In some places, GCC uses various constants to control the amount of
6825 optimization that is done.  For example, GCC will not inline functions
6826 that contain more that a certain number of instructions.  You can
6827 control some of these constants on the command-line using the
6828 @option{--param} option.
6829
6830 The names of specific parameters, and the meaning of the values, are
6831 tied to the internals of the compiler, and are subject to change
6832 without notice in future releases.
6833
6834 In each case, the @var{value} is an integer.  The allowable choices for
6835 @var{name} are given in the following table:
6836
6837 @table @gcctabopt
6838 @item sra-max-structure-size
6839 The maximum structure size, in bytes, at which the scalar replacement
6840 of aggregates (SRA) optimization will perform block copies.  The
6841 default value, 0, implies that GCC will select the most appropriate
6842 size itself.
6843
6844 @item sra-field-structure-ratio
6845 The threshold ratio (as a percentage) between instantiated fields and
6846 the complete structure size.  We say that if the ratio of the number
6847 of bytes in instantiated fields to the number of bytes in the complete
6848 structure exceeds this parameter, then block copies are not used.  The
6849 default is 75.
6850
6851 @item struct-reorg-cold-struct-ratio
6852 The threshold ratio (as a percentage) between a structure frequency
6853 and the frequency of the hottest structure in the program.  This parameter
6854 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
6855 We say that if the ratio of a structure frequency, calculated by profiling, 
6856 to the hottest structure frequency in the program is less than this 
6857 parameter, then structure reorganization is not applied to this structure.
6858 The default is 10.
6859
6860 @item max-crossjump-edges
6861 The maximum number of incoming edges to consider for crossjumping.
6862 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6863 the number of edges incoming to each block.  Increasing values mean
6864 more aggressive optimization, making the compile time increase with
6865 probably small improvement in executable size.
6866
6867 @item min-crossjump-insns
6868 The minimum number of instructions which must be matched at the end
6869 of two blocks before crossjumping will be performed on them.  This
6870 value is ignored in the case where all instructions in the block being
6871 crossjumped from are matched.  The default value is 5.
6872
6873 @item max-grow-copy-bb-insns
6874 The maximum code size expansion factor when copying basic blocks
6875 instead of jumping.  The expansion is relative to a jump instruction.
6876 The default value is 8.
6877
6878 @item max-goto-duplication-insns
6879 The maximum number of instructions to duplicate to a block that jumps
6880 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6881 passes, GCC factors computed gotos early in the compilation process,
6882 and unfactors them as late as possible.  Only computed jumps at the
6883 end of a basic blocks with no more than max-goto-duplication-insns are
6884 unfactored.  The default value is 8.
6885
6886 @item max-delay-slot-insn-search
6887 The maximum number of instructions to consider when looking for an
6888 instruction to fill a delay slot.  If more than this arbitrary number of
6889 instructions is searched, the time savings from filling the delay slot
6890 will be minimal so stop searching.  Increasing values mean more
6891 aggressive optimization, making the compile time increase with probably
6892 small improvement in executable run time.
6893
6894 @item max-delay-slot-live-search
6895 When trying to fill delay slots, the maximum number of instructions to
6896 consider when searching for a block with valid live register
6897 information.  Increasing this arbitrarily chosen value means more
6898 aggressive optimization, increasing the compile time.  This parameter
6899 should be removed when the delay slot code is rewritten to maintain the
6900 control-flow graph.
6901
6902 @item max-gcse-memory
6903 The approximate maximum amount of memory that will be allocated in
6904 order to perform the global common subexpression elimination
6905 optimization.  If more memory than specified is required, the
6906 optimization will not be done.
6907
6908 @item max-gcse-passes
6909 The maximum number of passes of GCSE to run.  The default is 1.
6910
6911 @item max-pending-list-length
6912 The maximum number of pending dependencies scheduling will allow
6913 before flushing the current state and starting over.  Large functions
6914 with few branches or calls can create excessively large lists which
6915 needlessly consume memory and resources.
6916
6917 @item max-inline-insns-single
6918 Several parameters control the tree inliner used in gcc.
6919 This number sets the maximum number of instructions (counted in GCC's
6920 internal representation) in a single function that the tree inliner
6921 will consider for inlining.  This only affects functions declared
6922 inline and methods implemented in a class declaration (C++).
6923 The default value is 450.
6924
6925 @item max-inline-insns-auto
6926 When you use @option{-finline-functions} (included in @option{-O3}),
6927 a lot of functions that would otherwise not be considered for inlining
6928 by the compiler will be investigated.  To those functions, a different
6929 (more restrictive) limit compared to functions declared inline can
6930 be applied.
6931 The default value is 90.
6932
6933 @item large-function-insns
6934 The limit specifying really large functions.  For functions larger than this
6935 limit after inlining inlining is constrained by
6936 @option{--param large-function-growth}.  This parameter is useful primarily
6937 to avoid extreme compilation time caused by non-linear algorithms used by the
6938 backend.
6939 This parameter is ignored when @option{-funit-at-a-time} is not used.
6940 The default value is 2700.
6941
6942 @item large-function-growth
6943 Specifies maximal growth of large function caused by inlining in percents.
6944 This parameter is ignored when @option{-funit-at-a-time} is not used.
6945 The default value is 100 which limits large function growth to 2.0 times
6946 the original size.
6947
6948 @item large-unit-insns
6949 The limit specifying large translation unit.  Growth caused by inlining of
6950 units larger than this limit is limited by @option{--param inline-unit-growth}.
6951 For small units this might be too tight (consider unit consisting of function A
6952 that is inline and B that just calls A three time.  If B is small relative to
6953 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6954 large units consisting of small inlineable functions however the overall unit
6955 growth limit is needed to avoid exponential explosion of code size.  Thus for
6956 smaller units, the size is increased to @option{--param large-unit-insns}
6957 before applying @option{--param inline-unit-growth}.  The default is 10000
6958
6959 @item inline-unit-growth
6960 Specifies maximal overall growth of the compilation unit caused by inlining.
6961 This parameter is ignored when @option{-funit-at-a-time} is not used.
6962 The default value is 30 which limits unit growth to 1.3 times the original
6963 size.
6964
6965 @item large-stack-frame
6966 The limit specifying large stack frames.  While inlining the algorithm is trying
6967 to not grow past this limit too much.  Default value is 256 bytes.
6968
6969 @item large-stack-frame-growth
6970 Specifies maximal growth of large stack frames caused by inlining in percents.
6971 The default value is 1000 which limits large stack frame growth to 11 times
6972 the original size.
6973
6974 @item max-inline-insns-recursive
6975 @itemx max-inline-insns-recursive-auto
6976 Specifies maximum number of instructions out-of-line copy of self recursive inline
6977 function can grow into by performing recursive inlining.
6978
6979 For functions declared inline @option{--param max-inline-insns-recursive} is
6980 taken into account.  For function not declared inline, recursive inlining
6981 happens only when @option{-finline-functions} (included in @option{-O3}) is
6982 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6983 default value is 450.
6984
6985 @item max-inline-recursive-depth
6986 @itemx max-inline-recursive-depth-auto
6987 Specifies maximum recursion depth used by the recursive inlining.
6988
6989 For functions declared inline @option{--param max-inline-recursive-depth} is
6990 taken into account.  For function not declared inline, recursive inlining
6991 happens only when @option{-finline-functions} (included in @option{-O3}) is
6992 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6993 default value is 8.
6994
6995 @item min-inline-recursive-probability
6996 Recursive inlining is profitable only for function having deep recursion
6997 in average and can hurt for function having little recursion depth by
6998 increasing the prologue size or complexity of function body to other
6999 optimizers.
7000
7001 When profile feedback is available (see @option{-fprofile-generate}) the actual
7002 recursion depth can be guessed from probability that function will recurse via
7003 given call expression.  This parameter limits inlining only to call expression
7004 whose probability exceeds given threshold (in percents).  The default value is
7005 10.
7006
7007 @item inline-call-cost
7008 Specify cost of call instruction relative to simple arithmetics operations
7009 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
7010 functions and at the same time increases size of leaf function that is believed to
7011 reduce function size by being inlined.  In effect it increases amount of
7012 inlining for code having large abstraction penalty (many functions that just
7013 pass the arguments to other functions) and decrease inlining for code with low
7014 abstraction penalty.  The default value is 12.
7015
7016 @item min-vect-loop-bound
7017 The minimum number of iterations under which a loop will not get vectorized
7018 when @option{-ftree-vectorize} is used.  The number of iterations after
7019 vectorization needs to be greater than the value specified by this option
7020 to allow vectorization.  The default value is 0.
7021
7022 @item max-unrolled-insns
7023 The maximum number of instructions that a loop should have if that loop
7024 is unrolled, and if the loop is unrolled, it determines how many times
7025 the loop code is unrolled.
7026
7027 @item max-average-unrolled-insns
7028 The maximum number of instructions biased by probabilities of their execution
7029 that a loop should have if that loop is unrolled, and if the loop is unrolled,
7030 it determines how many times the loop code is unrolled.
7031
7032 @item max-unroll-times
7033 The maximum number of unrollings of a single loop.
7034
7035 @item max-peeled-insns
7036 The maximum number of instructions that a loop should have if that loop
7037 is peeled, and if the loop is peeled, it determines how many times
7038 the loop code is peeled.
7039
7040 @item max-peel-times
7041 The maximum number of peelings of a single loop.
7042
7043 @item max-completely-peeled-insns
7044 The maximum number of insns of a completely peeled loop.
7045
7046 @item max-completely-peel-times
7047 The maximum number of iterations of a loop to be suitable for complete peeling.
7048
7049 @item max-unswitch-insns
7050 The maximum number of insns of an unswitched loop.
7051
7052 @item max-unswitch-level
7053 The maximum number of branches unswitched in a single loop.
7054
7055 @item lim-expensive
7056 The minimum cost of an expensive expression in the loop invariant motion.
7057
7058 @item iv-consider-all-candidates-bound
7059 Bound on number of candidates for induction variables below that
7060 all candidates are considered for each use in induction variable
7061 optimizations.  Only the most relevant candidates are considered
7062 if there are more candidates, to avoid quadratic time complexity.
7063
7064 @item iv-max-considered-uses
7065 The induction variable optimizations give up on loops that contain more
7066 induction variable uses.
7067
7068 @item iv-always-prune-cand-set-bound
7069 If number of candidates in the set is smaller than this value,
7070 we always try to remove unnecessary ivs from the set during its
7071 optimization when a new iv is added to the set.
7072
7073 @item scev-max-expr-size
7074 Bound on size of expressions used in the scalar evolutions analyzer.
7075 Large expressions slow the analyzer.
7076
7077 @item omega-max-vars
7078 The maximum number of variables in an Omega constraint system.
7079 The default value is 128.
7080
7081 @item omega-max-geqs
7082 The maximum number of inequalities in an Omega constraint system.
7083 The default value is 256.
7084
7085 @item omega-max-eqs
7086 The maximum number of equalities in an Omega constraint system.
7087 The default value is 128.
7088
7089 @item omega-max-wild-cards
7090 The maximum number of wildcard variables that the Omega solver will
7091 be able to insert.  The default value is 18.
7092
7093 @item omega-hash-table-size
7094 The size of the hash table in the Omega solver.  The default value is
7095 550.
7096
7097 @item omega-max-keys
7098 The maximal number of keys used by the Omega solver.  The default
7099 value is 500.
7100
7101 @item omega-eliminate-redundant-constraints
7102 When set to 1, use expensive methods to eliminate all redundant
7103 constraints.  The default value is 0.
7104
7105 @item vect-max-version-for-alignment-checks
7106 The maximum number of runtime checks that can be performed when
7107 doing loop versioning for alignment in the vectorizer.  See option
7108 ftree-vect-loop-version for more information.
7109
7110 @item vect-max-version-for-alias-checks
7111 The maximum number of runtime checks that can be performed when
7112 doing loop versioning for alias in the vectorizer.  See option
7113 ftree-vect-loop-version for more information.
7114
7115 @item max-iterations-to-track
7116
7117 The maximum number of iterations of a loop the brute force algorithm
7118 for analysis of # of iterations of the loop tries to evaluate.
7119
7120 @item hot-bb-count-fraction
7121 Select fraction of the maximal count of repetitions of basic block in program
7122 given basic block needs to have to be considered hot.
7123
7124 @item hot-bb-frequency-fraction
7125 Select fraction of the maximal frequency of executions of basic block in
7126 function given basic block needs to have to be considered hot
7127
7128 @item max-predicted-iterations
7129 The maximum number of loop iterations we predict statically.  This is useful
7130 in cases where function contain single loop with known bound and other loop
7131 with unknown.  We predict the known number of iterations correctly, while
7132 the unknown number of iterations average to roughly 10.  This means that the
7133 loop without bounds would appear artificially cold relative to the other one.
7134
7135 @item align-threshold
7136
7137 Select fraction of the maximal frequency of executions of basic block in
7138 function given basic block will get aligned.
7139
7140 @item align-loop-iterations
7141
7142 A loop expected to iterate at lest the selected number of iterations will get
7143 aligned.
7144
7145 @item tracer-dynamic-coverage
7146 @itemx tracer-dynamic-coverage-feedback
7147
7148 This value is used to limit superblock formation once the given percentage of
7149 executed instructions is covered.  This limits unnecessary code size
7150 expansion.
7151
7152 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7153 feedback is available.  The real profiles (as opposed to statically estimated
7154 ones) are much less balanced allowing the threshold to be larger value.
7155
7156 @item tracer-max-code-growth
7157 Stop tail duplication once code growth has reached given percentage.  This is
7158 rather hokey argument, as most of the duplicates will be eliminated later in
7159 cross jumping, so it may be set to much higher values than is the desired code
7160 growth.
7161
7162 @item tracer-min-branch-ratio
7163
7164 Stop reverse growth when the reverse probability of best edge is less than this
7165 threshold (in percent).
7166
7167 @item tracer-min-branch-ratio
7168 @itemx tracer-min-branch-ratio-feedback
7169
7170 Stop forward growth if the best edge do have probability lower than this
7171 threshold.
7172
7173 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7174 compilation for profile feedback and one for compilation without.  The value
7175 for compilation with profile feedback needs to be more conservative (higher) in
7176 order to make tracer effective.
7177
7178 @item max-cse-path-length
7179
7180 Maximum number of basic blocks on path that cse considers.  The default is 10.
7181
7182 @item max-cse-insns
7183 The maximum instructions CSE process before flushing. The default is 1000.
7184
7185 @item max-aliased-vops
7186
7187 Maximum number of virtual operands per function allowed to represent
7188 aliases before triggering the alias partitioning heuristic.  Alias
7189 partitioning reduces compile times and memory consumption needed for
7190 aliasing at the expense of precision loss in alias information.  The
7191 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
7192 for -O3.
7193
7194 Notice that if a function contains more memory statements than the
7195 value of this parameter, it is not really possible to achieve this
7196 reduction.  In this case, the compiler will use the number of memory
7197 statements as the value for @option{max-aliased-vops}.
7198
7199 @item avg-aliased-vops
7200
7201 Average number of virtual operands per statement allowed to represent
7202 aliases before triggering the alias partitioning heuristic.  This
7203 works in conjunction with @option{max-aliased-vops}.  If a function
7204 contains more than @option{max-aliased-vops} virtual operators, then
7205 memory symbols will be grouped into memory partitions until either the
7206 total number of virtual operators is below @option{max-aliased-vops}
7207 or the average number of virtual operators per memory statement is
7208 below @option{avg-aliased-vops}.  The default value for this parameter
7209 is 1 for -O1 and -O2, and 3 for -O3.
7210
7211 @item ggc-min-expand
7212
7213 GCC uses a garbage collector to manage its own memory allocation.  This
7214 parameter specifies the minimum percentage by which the garbage
7215 collector's heap should be allowed to expand between collections.
7216 Tuning this may improve compilation speed; it has no effect on code
7217 generation.
7218
7219 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7220 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7221 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7222 GCC is not able to calculate RAM on a particular platform, the lower
7223 bound of 30% is used.  Setting this parameter and
7224 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7225 every opportunity.  This is extremely slow, but can be useful for
7226 debugging.
7227
7228 @item ggc-min-heapsize
7229
7230 Minimum size of the garbage collector's heap before it begins bothering
7231 to collect garbage.  The first collection occurs after the heap expands
7232 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7233 tuning this may improve compilation speed, and has no effect on code
7234 generation.
7235
7236 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7237 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7238 with a lower bound of 4096 (four megabytes) and an upper bound of
7239 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7240 particular platform, the lower bound is used.  Setting this parameter
7241 very large effectively disables garbage collection.  Setting this
7242 parameter and @option{ggc-min-expand} to zero causes a full collection
7243 to occur at every opportunity.
7244
7245 @item max-reload-search-insns
7246 The maximum number of instruction reload should look backward for equivalent
7247 register.  Increasing values mean more aggressive optimization, making the
7248 compile time increase with probably slightly better performance.  The default
7249 value is 100.
7250
7251 @item max-cselib-memory-locations
7252 The maximum number of memory locations cselib should take into account.
7253 Increasing values mean more aggressive optimization, making the compile time
7254 increase with probably slightly better performance.  The default value is 500.
7255
7256 @item reorder-blocks-duplicate
7257 @itemx reorder-blocks-duplicate-feedback
7258
7259 Used by basic block reordering pass to decide whether to use unconditional
7260 branch or duplicate the code on its destination.  Code is duplicated when its
7261 estimated size is smaller than this value multiplied by the estimated size of
7262 unconditional jump in the hot spots of the program.
7263
7264 The @option{reorder-block-duplicate-feedback} is used only when profile
7265 feedback is available and may be set to higher values than
7266 @option{reorder-block-duplicate} since information about the hot spots is more
7267 accurate.
7268
7269 @item max-sched-ready-insns
7270 The maximum number of instructions ready to be issued the scheduler should
7271 consider at any given time during the first scheduling pass.  Increasing
7272 values mean more thorough searches, making the compilation time increase
7273 with probably little benefit.  The default value is 100.
7274
7275 @item max-sched-region-blocks
7276 The maximum number of blocks in a region to be considered for
7277 interblock scheduling.  The default value is 10.
7278
7279 @item max-sched-region-insns
7280 The maximum number of insns in a region to be considered for
7281 interblock scheduling.  The default value is 100.
7282
7283 @item min-spec-prob
7284 The minimum probability (in percents) of reaching a source block
7285 for interblock speculative scheduling.  The default value is 40.
7286
7287 @item max-sched-extend-regions-iters
7288 The maximum number of iterations through CFG to extend regions.
7289 0 - disable region extension,
7290 N - do at most N iterations.
7291 The default value is 0.
7292
7293 @item max-sched-insn-conflict-delay
7294 The maximum conflict delay for an insn to be considered for speculative motion.
7295 The default value is 3.
7296
7297 @item sched-spec-prob-cutoff
7298 The minimal probability of speculation success (in percents), so that
7299 speculative insn will be scheduled.
7300 The default value is 40.
7301
7302 @item max-last-value-rtl
7303
7304 The maximum size measured as number of RTLs that can be recorded in an expression
7305 in combiner for a pseudo register as last known value of that register.  The default
7306 is 10000.
7307
7308 @item integer-share-limit
7309 Small integer constants can use a shared data structure, reducing the
7310 compiler's memory usage and increasing its speed.  This sets the maximum
7311 value of a shared integer constant.  The default value is 256.
7312
7313 @item min-virtual-mappings
7314 Specifies the minimum number of virtual mappings in the incremental
7315 SSA updater that should be registered to trigger the virtual mappings
7316 heuristic defined by virtual-mappings-ratio.  The default value is
7317 100.
7318
7319 @item virtual-mappings-ratio
7320 If the number of virtual mappings is virtual-mappings-ratio bigger
7321 than the number of virtual symbols to be updated, then the incremental
7322 SSA updater switches to a full update for those symbols.  The default
7323 ratio is 3.
7324
7325 @item ssp-buffer-size
7326 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
7327 protection when @option{-fstack-protection} is used.
7328
7329 @item max-jump-thread-duplication-stmts
7330 Maximum number of statements allowed in a block that needs to be
7331 duplicated when threading jumps.
7332
7333 @item max-fields-for-field-sensitive
7334 Maximum number of fields in a structure we will treat in
7335 a field sensitive manner during pointer analysis.  The default is zero
7336 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
7337
7338 @item prefetch-latency
7339 Estimate on average number of instructions that are executed before
7340 prefetch finishes.  The distance we prefetch ahead is proportional
7341 to this constant.  Increasing this number may also lead to less
7342 streams being prefetched (see @option{simultaneous-prefetches}).
7343
7344 @item simultaneous-prefetches
7345 Maximum number of prefetches that can run at the same time.
7346
7347 @item l1-cache-line-size
7348 The size of cache line in L1 cache, in bytes.
7349
7350 @item l1-cache-size
7351 The size of L1 cache, in kilobytes.
7352
7353 @item l2-cache-size
7354 The size of L2 cache, in kilobytes.
7355
7356 @item use-canonical-types
7357 Whether the compiler should use the ``canonical'' type system.  By
7358 default, this should always be 1, which uses a more efficient internal
7359 mechanism for comparing types in C++ and Objective-C++.  However, if
7360 bugs in the canonical type system are causing compilation failures,
7361 set this value to 0 to disable canonical types.
7362
7363 @item switch-conversion-max-branch-ratio
7364 Switch initialization conversion will refuse to create arrays that are
7365 bigger than @option{switch-conversion-max-branch-ratio} times the number of
7366 branches in the switch.
7367
7368 @item max-partial-antic-length
7369 Maximum length of the partial antic set computed during the tree
7370 partial redundancy elimination optimization (@option{-ftree-pre}) when
7371 optimizing at @option{-O3} and above.  For some sorts of source code
7372 the enhanced partial redundancy elimination optimization can run away,
7373 consuming all of the memory available on the host machine.  This
7374 parameter sets a limit on the length of the sets that are computed,
7375 which prevents the runaway behaviour.  Setting a value of 0 for
7376 this paramter will allow an unlimited set length.
7377
7378 @item sccvn-max-scc-size
7379 Maximum size of a strongly connected component (SCC) during SCCVN
7380 processing.  If this limit is hit, SCCVN processing for the whole
7381 function will not be done and optimizations depending on it will
7382 be disabled.  The default maximum SCC size is 10000.
7383
7384 @end table
7385 @end table
7386
7387 @node Preprocessor Options
7388 @section Options Controlling the Preprocessor
7389 @cindex preprocessor options
7390 @cindex options, preprocessor
7391
7392 These options control the C preprocessor, which is run on each C source
7393 file before actual compilation.
7394
7395 If you use the @option{-E} option, nothing is done except preprocessing.
7396 Some of these options make sense only together with @option{-E} because
7397 they cause the preprocessor output to be unsuitable for actual
7398 compilation.
7399
7400 @table @gcctabopt
7401 @opindex Wp
7402 You can use @option{-Wp,@var{option}} to bypass the compiler driver
7403 and pass @var{option} directly through to the preprocessor.  If
7404 @var{option} contains commas, it is split into multiple options at the
7405 commas.  However, many options are modified, translated or interpreted
7406 by the compiler driver before being passed to the preprocessor, and
7407 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
7408 interface is undocumented and subject to change, so whenever possible
7409 you should avoid using @option{-Wp} and let the driver handle the
7410 options instead.
7411
7412 @item -Xpreprocessor @var{option}
7413 @opindex preprocessor
7414 Pass @var{option} as an option to the preprocessor.  You can use this to
7415 supply system-specific preprocessor options which GCC does not know how to
7416 recognize.
7417
7418 If you want to pass an option that takes an argument, you must use
7419 @option{-Xpreprocessor} twice, once for the option and once for the argument.
7420 @end table
7421
7422 @include cppopts.texi
7423
7424 @node Assembler Options
7425 @section Passing Options to the Assembler
7426
7427 @c prevent bad page break with this line
7428 You can pass options to the assembler.
7429
7430 @table @gcctabopt
7431 @item -Wa,@var{option}
7432 @opindex Wa
7433 Pass @var{option} as an option to the assembler.  If @var{option}
7434 contains commas, it is split into multiple options at the commas.
7435
7436 @item -Xassembler @var{option}
7437 @opindex Xassembler
7438 Pass @var{option} as an option to the assembler.  You can use this to
7439 supply system-specific assembler options which GCC does not know how to
7440 recognize.
7441
7442 If you want to pass an option that takes an argument, you must use
7443 @option{-Xassembler} twice, once for the option and once for the argument.
7444
7445 @end table
7446
7447 @node Link Options
7448 @section Options for Linking
7449 @cindex link options
7450 @cindex options, linking
7451
7452 These options come into play when the compiler links object files into
7453 an executable output file.  They are meaningless if the compiler is
7454 not doing a link step.
7455
7456 @table @gcctabopt
7457 @cindex file names
7458 @item @var{object-file-name}
7459 A file name that does not end in a special recognized suffix is
7460 considered to name an object file or library.  (Object files are
7461 distinguished from libraries by the linker according to the file
7462 contents.)  If linking is done, these object files are used as input
7463 to the linker.
7464
7465 @item -c
7466 @itemx -S
7467 @itemx -E
7468 @opindex c
7469 @opindex S
7470 @opindex E
7471 If any of these options is used, then the linker is not run, and
7472 object file names should not be used as arguments.  @xref{Overall
7473 Options}.
7474
7475 @cindex Libraries
7476 @item -l@var{library}
7477 @itemx -l @var{library}
7478 @opindex l
7479 Search the library named @var{library} when linking.  (The second
7480 alternative with the library as a separate argument is only for
7481 POSIX compliance and is not recommended.)
7482
7483 It makes a difference where in the command you write this option; the
7484 linker searches and processes libraries and object files in the order they
7485 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7486 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7487 to functions in @samp{z}, those functions may not be loaded.
7488
7489 The linker searches a standard list of directories for the library,
7490 which is actually a file named @file{lib@var{library}.a}.  The linker
7491 then uses this file as if it had been specified precisely by name.
7492
7493 The directories searched include several standard system directories
7494 plus any that you specify with @option{-L}.
7495
7496 Normally the files found this way are library files---archive files
7497 whose members are object files.  The linker handles an archive file by
7498 scanning through it for members which define symbols that have so far
7499 been referenced but not defined.  But if the file that is found is an
7500 ordinary object file, it is linked in the usual fashion.  The only
7501 difference between using an @option{-l} option and specifying a file name
7502 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7503 and searches several directories.
7504
7505 @item -lobjc
7506 @opindex lobjc
7507 You need this special case of the @option{-l} option in order to
7508 link an Objective-C or Objective-C++ program.
7509
7510 @item -nostartfiles
7511 @opindex nostartfiles
7512 Do not use the standard system startup files when linking.
7513 The standard system libraries are used normally, unless @option{-nostdlib}
7514 or @option{-nodefaultlibs} is used.
7515
7516 @item -nodefaultlibs
7517 @opindex nodefaultlibs
7518 Do not use the standard system libraries when linking.
7519 Only the libraries you specify will be passed to the linker.
7520 The standard startup files are used normally, unless @option{-nostartfiles}
7521 is used.  The compiler may generate calls to @code{memcmp},
7522 @code{memset}, @code{memcpy} and @code{memmove}.
7523 These entries are usually resolved by entries in
7524 libc.  These entry points should be supplied through some other
7525 mechanism when this option is specified.
7526
7527 @item -nostdlib
7528 @opindex nostdlib
7529 Do not use the standard system startup files or libraries when linking.
7530 No startup files and only the libraries you specify will be passed to
7531 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7532 @code{memcpy} and @code{memmove}.
7533 These entries are usually resolved by entries in
7534 libc.  These entry points should be supplied through some other
7535 mechanism when this option is specified.
7536
7537 @cindex @option{-lgcc}, use with @option{-nostdlib}
7538 @cindex @option{-nostdlib} and unresolved references
7539 @cindex unresolved references and @option{-nostdlib}
7540 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7541 @cindex @option{-nodefaultlibs} and unresolved references
7542 @cindex unresolved references and @option{-nodefaultlibs}
7543 One of the standard libraries bypassed by @option{-nostdlib} and
7544 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7545 that GCC uses to overcome shortcomings of particular machines, or special
7546 needs for some languages.
7547 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7548 Collection (GCC) Internals},
7549 for more discussion of @file{libgcc.a}.)
7550 In most cases, you need @file{libgcc.a} even when you want to avoid
7551 other standard libraries.  In other words, when you specify @option{-nostdlib}
7552 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7553 This ensures that you have no unresolved references to internal GCC
7554 library subroutines.  (For example, @samp{__main}, used to ensure C++
7555 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7556 GNU Compiler Collection (GCC) Internals}.)
7557
7558 @item -pie
7559 @opindex pie
7560 Produce a position independent executable on targets which support it.
7561 For predictable results, you must also specify the same set of options
7562 that were used to generate code (@option{-fpie}, @option{-fPIE},
7563 or model suboptions) when you specify this option.
7564
7565 @item -rdynamic
7566 @opindex rdynamic
7567 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7568 that support it. This instructs the linker to add all symbols, not
7569 only used ones, to the dynamic symbol table. This option is needed
7570 for some uses of @code{dlopen} or to allow obtaining backtraces
7571 from within a program.
7572
7573 @item -s
7574 @opindex s
7575 Remove all symbol table and relocation information from the executable.
7576
7577 @item -static
7578 @opindex static
7579 On systems that support dynamic linking, this prevents linking with the shared
7580 libraries.  On other systems, this option has no effect.
7581
7582 @item -shared
7583 @opindex shared
7584 Produce a shared object which can then be linked with other objects to
7585 form an executable.  Not all systems support this option.  For predictable
7586 results, you must also specify the same set of options that were used to
7587 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7588 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7589 needs to build supplementary stub code for constructors to work.  On
7590 multi-libbed systems, @samp{gcc -shared} must select the correct support
7591 libraries to link against.  Failing to supply the correct flags may lead
7592 to subtle defects.  Supplying them in cases where they are not necessary
7593 is innocuous.}
7594
7595 @item -shared-libgcc
7596 @itemx -static-libgcc
7597 @opindex shared-libgcc
7598 @opindex static-libgcc
7599 On systems that provide @file{libgcc} as a shared library, these options
7600 force the use of either the shared or static version respectively.
7601 If no shared version of @file{libgcc} was built when the compiler was
7602 configured, these options have no effect.
7603
7604 There are several situations in which an application should use the
7605 shared @file{libgcc} instead of the static version.  The most common
7606 of these is when the application wishes to throw and catch exceptions
7607 across different shared libraries.  In that case, each of the libraries
7608 as well as the application itself should use the shared @file{libgcc}.
7609
7610 Therefore, the G++ and GCJ drivers automatically add
7611 @option{-shared-libgcc} whenever you build a shared library or a main
7612 executable, because C++ and Java programs typically use exceptions, so
7613 this is the right thing to do.
7614
7615 If, instead, you use the GCC driver to create shared libraries, you may
7616 find that they will not always be linked with the shared @file{libgcc}.
7617 If GCC finds, at its configuration time, that you have a non-GNU linker
7618 or a GNU linker that does not support option @option{--eh-frame-hdr},
7619 it will link the shared version of @file{libgcc} into shared libraries
7620 by default.  Otherwise, it will take advantage of the linker and optimize
7621 away the linking with the shared version of @file{libgcc}, linking with
7622 the static version of libgcc by default.  This allows exceptions to
7623 propagate through such shared libraries, without incurring relocation
7624 costs at library load time.
7625
7626 However, if a library or main executable is supposed to throw or catch
7627 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7628 for the languages used in the program, or using the option
7629 @option{-shared-libgcc}, such that it is linked with the shared
7630 @file{libgcc}.
7631
7632 @item -symbolic
7633 @opindex symbolic
7634 Bind references to global symbols when building a shared object.  Warn
7635 about any unresolved references (unless overridden by the link editor
7636 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
7637 this option.
7638
7639 @item -Xlinker @var{option}
7640 @opindex Xlinker
7641 Pass @var{option} as an option to the linker.  You can use this to
7642 supply system-specific linker options which GCC does not know how to
7643 recognize.
7644
7645 If you want to pass an option that takes an argument, you must use
7646 @option{-Xlinker} twice, once for the option and once for the argument.
7647 For example, to pass @option{-assert definitions}, you must write
7648 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
7649 @option{-Xlinker "-assert definitions"}, because this passes the entire
7650 string as a single argument, which is not what the linker expects.
7651
7652 @item -Wl,@var{option}
7653 @opindex Wl
7654 Pass @var{option} as an option to the linker.  If @var{option} contains
7655 commas, it is split into multiple options at the commas.
7656
7657 @item -u @var{symbol}
7658 @opindex u
7659 Pretend the symbol @var{symbol} is undefined, to force linking of
7660 library modules to define it.  You can use @option{-u} multiple times with
7661 different symbols to force loading of additional library modules.
7662 @end table
7663
7664 @node Directory Options
7665 @section Options for Directory Search
7666 @cindex directory options
7667 @cindex options, directory search
7668 @cindex search path
7669
7670 These options specify directories to search for header files, for
7671 libraries and for parts of the compiler:
7672
7673 @table @gcctabopt
7674 @item -I@var{dir}
7675 @opindex I
7676 Add the directory @var{dir} to the head of the list of directories to be
7677 searched for header files.  This can be used to override a system header
7678 file, substituting your own version, since these directories are
7679 searched before the system header file directories.  However, you should
7680 not use this option to add directories that contain vendor-supplied
7681 system header files (use @option{-isystem} for that).  If you use more than
7682 one @option{-I} option, the directories are scanned in left-to-right
7683 order; the standard system directories come after.
7684
7685 If a standard system include directory, or a directory specified with
7686 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
7687 option will be ignored.  The directory will still be searched but as a
7688 system directory at its normal position in the system include chain.
7689 This is to ensure that GCC's procedure to fix buggy system headers and
7690 the ordering for the include_next directive are not inadvertently changed.
7691 If you really need to change the search order for system directories,
7692 use the @option{-nostdinc} and/or @option{-isystem} options.
7693
7694 @item -iquote@var{dir}
7695 @opindex iquote
7696 Add the directory @var{dir} to the head of the list of directories to
7697 be searched for header files only for the case of @samp{#include
7698 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
7699 otherwise just like @option{-I}.
7700
7701 @item -L@var{dir}
7702 @opindex L
7703 Add directory @var{dir} to the list of directories to be searched
7704 for @option{-l}.
7705
7706 @item -B@var{prefix}
7707 @opindex B
7708 This option specifies where to find the executables, libraries,
7709 include files, and data files of the compiler itself.
7710
7711 The compiler driver program runs one or more of the subprograms
7712 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
7713 @var{prefix} as a prefix for each program it tries to run, both with and
7714 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
7715
7716 For each subprogram to be run, the compiler driver first tries the
7717 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
7718 was not specified, the driver tries two standard prefixes, which are
7719 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
7720 those results in a file name that is found, the unmodified program
7721 name is searched for using the directories specified in your
7722 @env{PATH} environment variable.
7723
7724 The compiler will check to see if the path provided by the @option{-B}
7725 refers to a directory, and if necessary it will add a directory
7726 separator character at the end of the path.
7727
7728 @option{-B} prefixes that effectively specify directory names also apply
7729 to libraries in the linker, because the compiler translates these
7730 options into @option{-L} options for the linker.  They also apply to
7731 includes files in the preprocessor, because the compiler translates these
7732 options into @option{-isystem} options for the preprocessor.  In this case,
7733 the compiler appends @samp{include} to the prefix.
7734
7735 The run-time support file @file{libgcc.a} can also be searched for using
7736 the @option{-B} prefix, if needed.  If it is not found there, the two
7737 standard prefixes above are tried, and that is all.  The file is left
7738 out of the link if it is not found by those means.
7739
7740 Another way to specify a prefix much like the @option{-B} prefix is to use
7741 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
7742 Variables}.
7743
7744 As a special kludge, if the path provided by @option{-B} is
7745 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
7746 9, then it will be replaced by @file{[dir/]include}.  This is to help
7747 with boot-strapping the compiler.
7748
7749 @item -specs=@var{file}
7750 @opindex specs
7751 Process @var{file} after the compiler reads in the standard @file{specs}
7752 file, in order to override the defaults that the @file{gcc} driver
7753 program uses when determining what switches to pass to @file{cc1},
7754 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
7755 @option{-specs=@var{file}} can be specified on the command line, and they
7756 are processed in order, from left to right.
7757
7758 @item --sysroot=@var{dir}
7759 @opindex sysroot
7760 Use @var{dir} as the logical root directory for headers and libraries.
7761 For example, if the compiler would normally search for headers in
7762 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
7763 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
7764
7765 If you use both this option and the @option{-isysroot} option, then
7766 the @option{--sysroot} option will apply to libraries, but the
7767 @option{-isysroot} option will apply to header files.
7768
7769 The GNU linker (beginning with version 2.16) has the necessary support
7770 for this option.  If your linker does not support this option, the
7771 header file aspect of @option{--sysroot} will still work, but the
7772 library aspect will not.
7773
7774 @item -I-
7775 @opindex I-
7776 This option has been deprecated.  Please use @option{-iquote} instead for
7777 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
7778 Any directories you specify with @option{-I} options before the @option{-I-}
7779 option are searched only for the case of @samp{#include "@var{file}"};
7780 they are not searched for @samp{#include <@var{file}>}.
7781
7782 If additional directories are specified with @option{-I} options after
7783 the @option{-I-}, these directories are searched for all @samp{#include}
7784 directives.  (Ordinarily @emph{all} @option{-I} directories are used
7785 this way.)
7786
7787 In addition, the @option{-I-} option inhibits the use of the current
7788 directory (where the current input file came from) as the first search
7789 directory for @samp{#include "@var{file}"}.  There is no way to
7790 override this effect of @option{-I-}.  With @option{-I.} you can specify
7791 searching the directory which was current when the compiler was
7792 invoked.  That is not exactly the same as what the preprocessor does
7793 by default, but it is often satisfactory.
7794
7795 @option{-I-} does not inhibit the use of the standard system directories
7796 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
7797 independent.
7798 @end table
7799
7800 @c man end
7801
7802 @node Spec Files
7803 @section Specifying subprocesses and the switches to pass to them
7804 @cindex Spec Files
7805
7806 @command{gcc} is a driver program.  It performs its job by invoking a
7807 sequence of other programs to do the work of compiling, assembling and
7808 linking.  GCC interprets its command-line parameters and uses these to
7809 deduce which programs it should invoke, and which command-line options
7810 it ought to place on their command lines.  This behavior is controlled
7811 by @dfn{spec strings}.  In most cases there is one spec string for each
7812 program that GCC can invoke, but a few programs have multiple spec
7813 strings to control their behavior.  The spec strings built into GCC can
7814 be overridden by using the @option{-specs=} command-line switch to specify
7815 a spec file.
7816
7817 @dfn{Spec files} are plaintext files that are used to construct spec
7818 strings.  They consist of a sequence of directives separated by blank
7819 lines.  The type of directive is determined by the first non-whitespace
7820 character on the line and it can be one of the following:
7821
7822 @table @code
7823 @item %@var{command}
7824 Issues a @var{command} to the spec file processor.  The commands that can
7825 appear here are:
7826
7827 @table @code
7828 @item %include <@var{file}>
7829 @cindex %include
7830 Search for @var{file} and insert its text at the current point in the
7831 specs file.
7832
7833 @item %include_noerr <@var{file}>
7834 @cindex %include_noerr
7835 Just like @samp{%include}, but do not generate an error message if the include
7836 file cannot be found.
7837
7838 @item %rename @var{old_name} @var{new_name}
7839 @cindex %rename
7840 Rename the spec string @var{old_name} to @var{new_name}.
7841
7842 @end table
7843
7844 @item *[@var{spec_name}]:
7845 This tells the compiler to create, override or delete the named spec
7846 string.  All lines after this directive up to the next directive or
7847 blank line are considered to be the text for the spec string.  If this
7848 results in an empty string then the spec will be deleted.  (Or, if the
7849 spec did not exist, then nothing will happened.)  Otherwise, if the spec
7850 does not currently exist a new spec will be created.  If the spec does
7851 exist then its contents will be overridden by the text of this
7852 directive, unless the first character of that text is the @samp{+}
7853 character, in which case the text will be appended to the spec.
7854
7855 @item [@var{suffix}]:
7856 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
7857 and up to the next directive or blank line are considered to make up the
7858 spec string for the indicated suffix.  When the compiler encounters an
7859 input file with the named suffix, it will processes the spec string in
7860 order to work out how to compile that file.  For example:
7861
7862 @smallexample
7863 .ZZ:
7864 z-compile -input %i
7865 @end smallexample
7866
7867 This says that any input file whose name ends in @samp{.ZZ} should be
7868 passed to the program @samp{z-compile}, which should be invoked with the
7869 command-line switch @option{-input} and with the result of performing the
7870 @samp{%i} substitution.  (See below.)
7871
7872 As an alternative to providing a spec string, the text that follows a
7873 suffix directive can be one of the following:
7874
7875 @table @code
7876 @item @@@var{language}
7877 This says that the suffix is an alias for a known @var{language}.  This is
7878 similar to using the @option{-x} command-line switch to GCC to specify a
7879 language explicitly.  For example:
7880
7881 @smallexample
7882 .ZZ:
7883 @@c++
7884 @end smallexample
7885
7886 Says that .ZZ files are, in fact, C++ source files.
7887
7888 @item #@var{name}
7889 This causes an error messages saying:
7890
7891 @smallexample
7892 @var{name} compiler not installed on this system.
7893 @end smallexample
7894 @end table
7895
7896 GCC already has an extensive list of suffixes built into it.
7897 This directive will add an entry to the end of the list of suffixes, but
7898 since the list is searched from the end backwards, it is effectively
7899 possible to override earlier entries using this technique.
7900
7901 @end table
7902
7903 GCC has the following spec strings built into it.  Spec files can
7904 override these strings or create their own.  Note that individual
7905 targets can also add their own spec strings to this list.
7906
7907 @smallexample
7908 asm          Options to pass to the assembler
7909 asm_final    Options to pass to the assembler post-processor
7910 cpp          Options to pass to the C preprocessor
7911 cc1          Options to pass to the C compiler
7912 cc1plus      Options to pass to the C++ compiler
7913 endfile      Object files to include at the end of the link
7914 link         Options to pass to the linker
7915 lib          Libraries to include on the command line to the linker
7916 libgcc       Decides which GCC support library to pass to the linker
7917 linker       Sets the name of the linker
7918 predefines   Defines to be passed to the C preprocessor
7919 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7920              by default
7921 startfile    Object files to include at the start of the link
7922 @end smallexample
7923
7924 Here is a small example of a spec file:
7925
7926 @smallexample
7927 %rename lib                 old_lib
7928
7929 *lib:
7930 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7931 @end smallexample
7932
7933 This example renames the spec called @samp{lib} to @samp{old_lib} and
7934 then overrides the previous definition of @samp{lib} with a new one.
7935 The new definition adds in some extra command-line options before
7936 including the text of the old definition.
7937
7938 @dfn{Spec strings} are a list of command-line options to be passed to their
7939 corresponding program.  In addition, the spec strings can contain
7940 @samp{%}-prefixed sequences to substitute variable text or to
7941 conditionally insert text into the command line.  Using these constructs
7942 it is possible to generate quite complex command lines.
7943
7944 Here is a table of all defined @samp{%}-sequences for spec
7945 strings.  Note that spaces are not generated automatically around the
7946 results of expanding these sequences.  Therefore you can concatenate them
7947 together or combine them with constant text in a single argument.
7948
7949 @table @code
7950 @item %%
7951 Substitute one @samp{%} into the program name or argument.
7952
7953 @item %i
7954 Substitute the name of the input file being processed.
7955
7956 @item %b
7957 Substitute the basename of the input file being processed.
7958 This is the substring up to (and not including) the last period
7959 and not including the directory.
7960
7961 @item %B
7962 This is the same as @samp{%b}, but include the file suffix (text after
7963 the last period).
7964
7965 @item %d
7966 Marks the argument containing or following the @samp{%d} as a
7967 temporary file name, so that that file will be deleted if GCC exits
7968 successfully.  Unlike @samp{%g}, this contributes no text to the
7969 argument.
7970
7971 @item %g@var{suffix}
7972 Substitute a file name that has suffix @var{suffix} and is chosen
7973 once per compilation, and mark the argument in the same way as
7974 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7975 name is now chosen in a way that is hard to predict even when previously
7976 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7977 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7978 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7979 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7980 was simply substituted with a file name chosen once per compilation,
7981 without regard to any appended suffix (which was therefore treated
7982 just like ordinary text), making such attacks more likely to succeed.
7983
7984 @item %u@var{suffix}
7985 Like @samp{%g}, but generates a new temporary file name even if
7986 @samp{%u@var{suffix}} was already seen.
7987
7988 @item %U@var{suffix}
7989 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7990 new one if there is no such last file name.  In the absence of any
7991 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7992 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7993 would involve the generation of two distinct file names, one
7994 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7995 simply substituted with a file name chosen for the previous @samp{%u},
7996 without regard to any appended suffix.
7997
7998 @item %j@var{suffix}
7999 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
8000 writable, and if save-temps is off; otherwise, substitute the name
8001 of a temporary file, just like @samp{%u}.  This temporary file is not
8002 meant for communication between processes, but rather as a junk
8003 disposal mechanism.
8004
8005 @item %|@var{suffix}
8006 @itemx %m@var{suffix}
8007 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
8008 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
8009 all.  These are the two most common ways to instruct a program that it
8010 should read from standard input or write to standard output.  If you
8011 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
8012 construct: see for example @file{f/lang-specs.h}.
8013
8014 @item %.@var{SUFFIX}
8015 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
8016 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
8017 terminated by the next space or %.
8018
8019 @item %w
8020 Marks the argument containing or following the @samp{%w} as the
8021 designated output file of this compilation.  This puts the argument
8022 into the sequence of arguments that @samp{%o} will substitute later.
8023
8024 @item %o
8025 Substitutes the names of all the output files, with spaces
8026 automatically placed around them.  You should write spaces
8027 around the @samp{%o} as well or the results are undefined.
8028 @samp{%o} is for use in the specs for running the linker.
8029 Input files whose names have no recognized suffix are not compiled
8030 at all, but they are included among the output files, so they will
8031 be linked.
8032
8033 @item %O
8034 Substitutes the suffix for object files.  Note that this is
8035 handled specially when it immediately follows @samp{%g, %u, or %U},
8036 because of the need for those to form complete file names.  The
8037 handling is such that @samp{%O} is treated exactly as if it had already
8038 been substituted, except that @samp{%g, %u, and %U} do not currently
8039 support additional @var{suffix} characters following @samp{%O} as they would
8040 following, for example, @samp{.o}.
8041
8042 @item %p
8043 Substitutes the standard macro predefinitions for the
8044 current target machine.  Use this when running @code{cpp}.
8045
8046 @item %P
8047 Like @samp{%p}, but puts @samp{__} before and after the name of each
8048 predefined macro, except for macros that start with @samp{__} or with
8049 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8050 C@.
8051
8052 @item %I
8053 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8054 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8055 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8056 and @option{-imultilib} as necessary.
8057
8058 @item %s
8059 Current argument is the name of a library or startup file of some sort.
8060 Search for that file in a standard list of directories and substitute
8061 the full name found.
8062
8063 @item %e@var{str}
8064 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8065 Use this when inconsistent options are detected.
8066
8067 @item %(@var{name})
8068 Substitute the contents of spec string @var{name} at this point.
8069
8070 @item %[@var{name}]
8071 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8072
8073 @item %x@{@var{option}@}
8074 Accumulate an option for @samp{%X}.
8075
8076 @item %X
8077 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8078 spec string.
8079
8080 @item %Y
8081 Output the accumulated assembler options specified by @option{-Wa}.
8082
8083 @item %Z
8084 Output the accumulated preprocessor options specified by @option{-Wp}.
8085
8086 @item %a
8087 Process the @code{asm} spec.  This is used to compute the
8088 switches to be passed to the assembler.
8089
8090 @item %A
8091 Process the @code{asm_final} spec.  This is a spec string for
8092 passing switches to an assembler post-processor, if such a program is
8093 needed.
8094
8095 @item %l
8096 Process the @code{link} spec.  This is the spec for computing the
8097 command line passed to the linker.  Typically it will make use of the
8098 @samp{%L %G %S %D and %E} sequences.
8099
8100 @item %D
8101 Dump out a @option{-L} option for each directory that GCC believes might
8102 contain startup files.  If the target supports multilibs then the
8103 current multilib directory will be prepended to each of these paths.
8104
8105 @item %L
8106 Process the @code{lib} spec.  This is a spec string for deciding which
8107 libraries should be included on the command line to the linker.
8108
8109 @item %G
8110 Process the @code{libgcc} spec.  This is a spec string for deciding
8111 which GCC support library should be included on the command line to the linker.
8112
8113 @item %S
8114 Process the @code{startfile} spec.  This is a spec for deciding which
8115 object files should be the first ones passed to the linker.  Typically
8116 this might be a file named @file{crt0.o}.
8117
8118 @item %E
8119 Process the @code{endfile} spec.  This is a spec string that specifies
8120 the last object files that will be passed to the linker.
8121
8122 @item %C
8123 Process the @code{cpp} spec.  This is used to construct the arguments
8124 to be passed to the C preprocessor.
8125
8126 @item %1
8127 Process the @code{cc1} spec.  This is used to construct the options to be
8128 passed to the actual C compiler (@samp{cc1}).
8129
8130 @item %2
8131 Process the @code{cc1plus} spec.  This is used to construct the options to be
8132 passed to the actual C++ compiler (@samp{cc1plus}).
8133
8134 @item %*
8135 Substitute the variable part of a matched option.  See below.
8136 Note that each comma in the substituted string is replaced by
8137 a single space.
8138
8139 @item %<@code{S}
8140 Remove all occurrences of @code{-S} from the command line.  Note---this
8141 command is position dependent.  @samp{%} commands in the spec string
8142 before this one will see @code{-S}, @samp{%} commands in the spec string
8143 after this one will not.
8144
8145 @item %:@var{function}(@var{args})
8146 Call the named function @var{function}, passing it @var{args}.
8147 @var{args} is first processed as a nested spec string, then split
8148 into an argument vector in the usual fashion.  The function returns
8149 a string which is processed as if it had appeared literally as part
8150 of the current spec.
8151
8152 The following built-in spec functions are provided:
8153
8154 @table @code
8155 @item @code{getenv}
8156 The @code{getenv} spec function takes two arguments: an environment
8157 variable name and a string.  If the environment variable is not
8158 defined, a fatal error is issued.  Otherwise, the return value is the
8159 value of the environment variable concatenated with the string.  For
8160 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
8161
8162 @smallexample
8163 %:getenv(TOPDIR /include)
8164 @end smallexample
8165
8166 expands to @file{/path/to/top/include}.
8167
8168 @item @code{if-exists}
8169 The @code{if-exists} spec function takes one argument, an absolute
8170 pathname to a file.  If the file exists, @code{if-exists} returns the
8171 pathname.  Here is a small example of its usage:
8172
8173 @smallexample
8174 *startfile:
8175 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
8176 @end smallexample
8177
8178 @item @code{if-exists-else}
8179 The @code{if-exists-else} spec function is similar to the @code{if-exists}
8180 spec function, except that it takes two arguments.  The first argument is
8181 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
8182 returns the pathname.  If it does not exist, it returns the second argument.
8183 This way, @code{if-exists-else} can be used to select one file or another,
8184 based on the existence of the first.  Here is a small example of its usage:
8185
8186 @smallexample
8187 *startfile:
8188 crt0%O%s %:if-exists(crti%O%s) \
8189 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
8190 @end smallexample
8191
8192 @item @code{replace-outfile}
8193 The @code{replace-outfile} spec function takes two arguments.  It looks for the
8194 first argument in the outfiles array and replaces it with the second argument.  Here
8195 is a small example of its usage:
8196
8197 @smallexample
8198 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
8199 @end smallexample
8200
8201 @item @code{print-asm-header}
8202 The @code{print-asm-header} function takes no arguments and simply
8203 prints a banner like:
8204
8205 @smallexample
8206 Assembler options
8207 =================
8208
8209 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
8210 @end smallexample
8211
8212 It is used to separate compiler options from assembler options
8213 in the @option{--target-help} output.
8214 @end table
8215
8216 @item %@{@code{S}@}
8217 Substitutes the @code{-S} switch, if that switch was given to GCC@.
8218 If that switch was not specified, this substitutes nothing.  Note that
8219 the leading dash is omitted when specifying this option, and it is
8220 automatically inserted if the substitution is performed.  Thus the spec
8221 string @samp{%@{foo@}} would match the command-line option @option{-foo}
8222 and would output the command line option @option{-foo}.
8223
8224 @item %W@{@code{S}@}
8225 Like %@{@code{S}@} but mark last argument supplied within as a file to be
8226 deleted on failure.
8227
8228 @item %@{@code{S}*@}
8229 Substitutes all the switches specified to GCC whose names start
8230 with @code{-S}, but which also take an argument.  This is used for
8231 switches like @option{-o}, @option{-D}, @option{-I}, etc.
8232 GCC considers @option{-o foo} as being
8233 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
8234 text, including the space.  Thus two arguments would be generated.
8235
8236 @item %@{@code{S}*&@code{T}*@}
8237 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
8238 (the order of @code{S} and @code{T} in the spec is not significant).
8239 There can be any number of ampersand-separated variables; for each the
8240 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
8241
8242 @item %@{@code{S}:@code{X}@}
8243 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
8244
8245 @item %@{!@code{S}:@code{X}@}
8246 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
8247
8248 @item %@{@code{S}*:@code{X}@}
8249 Substitutes @code{X} if one or more switches whose names start with
8250 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
8251 once, no matter how many such switches appeared.  However, if @code{%*}
8252 appears somewhere in @code{X}, then @code{X} will be substituted once
8253 for each matching switch, with the @code{%*} replaced by the part of
8254 that switch that matched the @code{*}.
8255
8256 @item %@{.@code{S}:@code{X}@}
8257 Substitutes @code{X}, if processing a file with suffix @code{S}.
8258
8259 @item %@{!.@code{S}:@code{X}@}
8260 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
8261
8262 @item %@{,@code{S}:@code{X}@}
8263 Substitutes @code{X}, if processing a file for language @code{S}.
8264
8265 @item %@{!,@code{S}:@code{X}@}
8266 Substitutes @code{X}, if not processing a file for language @code{S}.
8267
8268 @item %@{@code{S}|@code{P}:@code{X}@}
8269 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
8270 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
8271 @code{*} sequences as well, although they have a stronger binding than
8272 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
8273 alternatives must be starred, and only the first matching alternative
8274 is substituted.
8275
8276 For example, a spec string like this:
8277
8278 @smallexample
8279 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
8280 @end smallexample
8281
8282 will output the following command-line options from the following input
8283 command-line options:
8284
8285 @smallexample
8286 fred.c        -foo -baz
8287 jim.d         -bar -boggle
8288 -d fred.c     -foo -baz -boggle
8289 -d jim.d      -bar -baz -boggle
8290 @end smallexample
8291
8292 @item %@{S:X; T:Y; :D@}
8293
8294 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
8295 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
8296 be as many clauses as you need.  This may be combined with @code{.},
8297 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
8298
8299
8300 @end table
8301
8302 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
8303 construct may contain other nested @samp{%} constructs or spaces, or
8304 even newlines.  They are processed as usual, as described above.
8305 Trailing white space in @code{X} is ignored.  White space may also
8306 appear anywhere on the left side of the colon in these constructs,
8307 except between @code{.} or @code{*} and the corresponding word.
8308
8309 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
8310 handled specifically in these constructs.  If another value of
8311 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
8312 @option{-W} switch is found later in the command line, the earlier
8313 switch value is ignored, except with @{@code{S}*@} where @code{S} is
8314 just one letter, which passes all matching options.
8315
8316 The character @samp{|} at the beginning of the predicate text is used to
8317 indicate that a command should be piped to the following command, but
8318 only if @option{-pipe} is specified.
8319
8320 It is built into GCC which switches take arguments and which do not.
8321 (You might think it would be useful to generalize this to allow each
8322 compiler's spec to say which switches take arguments.  But this cannot
8323 be done in a consistent fashion.  GCC cannot even decide which input
8324 files have been specified without knowing which switches take arguments,
8325 and it must know which input files to compile in order to tell which
8326 compilers to run).
8327
8328 GCC also knows implicitly that arguments starting in @option{-l} are to be
8329 treated as compiler output files, and passed to the linker in their
8330 proper position among the other output files.
8331
8332 @c man begin OPTIONS
8333
8334 @node Target Options
8335 @section Specifying Target Machine and Compiler Version
8336 @cindex target options
8337 @cindex cross compiling
8338 @cindex specifying machine version
8339 @cindex specifying compiler version and target machine
8340 @cindex compiler version, specifying
8341 @cindex target machine, specifying
8342
8343 The usual way to run GCC is to run the executable called @file{gcc}, or
8344 @file{<machine>-gcc} when cross-compiling, or
8345 @file{<machine>-gcc-<version>} to run a version other than the one that
8346 was installed last.  Sometimes this is inconvenient, so GCC provides
8347 options that will switch to another cross-compiler or version.
8348
8349 @table @gcctabopt
8350 @item -b @var{machine}
8351 @opindex b
8352 The argument @var{machine} specifies the target machine for compilation.
8353
8354 The value to use for @var{machine} is the same as was specified as the
8355 machine type when configuring GCC as a cross-compiler.  For
8356 example, if a cross-compiler was configured with @samp{configure
8357 arm-elf}, meaning to compile for an arm processor with elf binaries,
8358 then you would specify @option{-b arm-elf} to run that cross compiler.
8359 Because there are other options beginning with @option{-b}, the
8360 configuration must contain a hyphen.
8361
8362 @item -V @var{version}
8363 @opindex V
8364 The argument @var{version} specifies which version of GCC to run.
8365 This is useful when multiple versions are installed.  For example,
8366 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
8367 @end table
8368
8369 The @option{-V} and @option{-b} options work by running the
8370 @file{<machine>-gcc-<version>} executable, so there's no real reason to
8371 use them if you can just run that directly.
8372
8373 @node Submodel Options
8374 @section Hardware Models and Configurations
8375 @cindex submodel options
8376 @cindex specifying hardware config
8377 @cindex hardware models and configurations, specifying
8378 @cindex machine dependent options
8379
8380 Earlier we discussed the standard option @option{-b} which chooses among
8381 different installed compilers for completely different target
8382 machines, such as VAX vs.@: 68000 vs.@: 80386.
8383
8384 In addition, each of these target machine types can have its own
8385 special options, starting with @samp{-m}, to choose among various
8386 hardware models or configurations---for example, 68010 vs 68020,
8387 floating coprocessor or none.  A single installed version of the
8388 compiler can compile for any model or configuration, according to the
8389 options specified.
8390
8391 Some configurations of the compiler also support additional special
8392 options, usually for compatibility with other compilers on the same
8393 platform.
8394
8395 @c This list is ordered alphanumerically by subsection name.
8396 @c It should be the same order and spelling as these options are listed
8397 @c in Machine Dependent Options
8398
8399 @menu
8400 * ARC Options::
8401 * ARM Options::
8402 * AVR Options::
8403 * Blackfin Options::
8404 * CRIS Options::
8405 * CRX Options::
8406 * Darwin Options::
8407 * DEC Alpha Options::
8408 * DEC Alpha/VMS Options::
8409 * FRV Options::
8410 * GNU/Linux Options::
8411 * H8/300 Options::
8412 * HPPA Options::
8413 * i386 and x86-64 Options::
8414 * IA-64 Options::
8415 * M32C Options::
8416 * M32R/D Options::
8417 * M680x0 Options::
8418 * M68hc1x Options::
8419 * MCore Options::
8420 * MIPS Options::
8421 * MMIX Options::
8422 * MN10300 Options::
8423 * PDP-11 Options::
8424 * PowerPC Options::
8425 * RS/6000 and PowerPC Options::
8426 * S/390 and zSeries Options::
8427 * Score Options::
8428 * SH Options::
8429 * SPARC Options::
8430 * SPU Options::
8431 * System V Options::
8432 * V850 Options::
8433 * VAX Options::
8434 * VxWorks Options::
8435 * x86-64 Options::
8436 * Xstormy16 Options::
8437 * Xtensa Options::
8438 * zSeries Options::
8439 @end menu
8440
8441 @node ARC Options
8442 @subsection ARC Options
8443 @cindex ARC Options
8444
8445 These options are defined for ARC implementations:
8446
8447 @table @gcctabopt
8448 @item -EL
8449 @opindex EL
8450 Compile code for little endian mode.  This is the default.
8451
8452 @item -EB
8453 @opindex EB
8454 Compile code for big endian mode.
8455
8456 @item -mmangle-cpu
8457 @opindex mmangle-cpu
8458 Prepend the name of the cpu to all public symbol names.
8459 In multiple-processor systems, there are many ARC variants with different
8460 instruction and register set characteristics.  This flag prevents code
8461 compiled for one cpu to be linked with code compiled for another.
8462 No facility exists for handling variants that are ``almost identical''.
8463 This is an all or nothing option.
8464
8465 @item -mcpu=@var{cpu}
8466 @opindex mcpu
8467 Compile code for ARC variant @var{cpu}.
8468 Which variants are supported depend on the configuration.
8469 All variants support @option{-mcpu=base}, this is the default.
8470
8471 @item -mtext=@var{text-section}
8472 @itemx -mdata=@var{data-section}
8473 @itemx -mrodata=@var{readonly-data-section}
8474 @opindex mtext
8475 @opindex mdata
8476 @opindex mrodata
8477 Put functions, data, and readonly data in @var{text-section},
8478 @var{data-section}, and @var{readonly-data-section} respectively
8479 by default.  This can be overridden with the @code{section} attribute.
8480 @xref{Variable Attributes}.
8481
8482 @end table
8483
8484 @node ARM Options
8485 @subsection ARM Options
8486 @cindex ARM options
8487
8488 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8489 architectures:
8490
8491 @table @gcctabopt
8492 @item -mabi=@var{name}
8493 @opindex mabi
8494 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8495 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8496
8497 @item -mapcs-frame
8498 @opindex mapcs-frame
8499 Generate a stack frame that is compliant with the ARM Procedure Call
8500 Standard for all functions, even if this is not strictly necessary for
8501 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8502 with this option will cause the stack frames not to be generated for
8503 leaf functions.  The default is @option{-mno-apcs-frame}.
8504
8505 @item -mapcs
8506 @opindex mapcs
8507 This is a synonym for @option{-mapcs-frame}.
8508
8509 @ignore
8510 @c not currently implemented
8511 @item -mapcs-stack-check
8512 @opindex mapcs-stack-check
8513 Generate code to check the amount of stack space available upon entry to
8514 every function (that actually uses some stack space).  If there is
8515 insufficient space available then either the function
8516 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8517 called, depending upon the amount of stack space required.  The run time
8518 system is required to provide these functions.  The default is
8519 @option{-mno-apcs-stack-check}, since this produces smaller code.
8520
8521 @c not currently implemented
8522 @item -mapcs-float
8523 @opindex mapcs-float
8524 Pass floating point arguments using the float point registers.  This is
8525 one of the variants of the APCS@.  This option is recommended if the
8526 target hardware has a floating point unit or if a lot of floating point
8527 arithmetic is going to be performed by the code.  The default is
8528 @option{-mno-apcs-float}, since integer only code is slightly increased in
8529 size if @option{-mapcs-float} is used.
8530
8531 @c not currently implemented
8532 @item -mapcs-reentrant
8533 @opindex mapcs-reentrant
8534 Generate reentrant, position independent code.  The default is
8535 @option{-mno-apcs-reentrant}.
8536 @end ignore
8537
8538 @item -mthumb-interwork
8539 @opindex mthumb-interwork
8540 Generate code which supports calling between the ARM and Thumb
8541 instruction sets.  Without this option the two instruction sets cannot
8542 be reliably used inside one program.  The default is
8543 @option{-mno-thumb-interwork}, since slightly larger code is generated
8544 when @option{-mthumb-interwork} is specified.
8545
8546 @item -mno-sched-prolog
8547 @opindex mno-sched-prolog
8548 Prevent the reordering of instructions in the function prolog, or the
8549 merging of those instruction with the instructions in the function's
8550 body.  This means that all functions will start with a recognizable set
8551 of instructions (or in fact one of a choice from a small set of
8552 different function prologues), and this information can be used to
8553 locate the start if functions inside an executable piece of code.  The
8554 default is @option{-msched-prolog}.
8555
8556 @item -mhard-float
8557 @opindex mhard-float
8558 Generate output containing floating point instructions.  This is the
8559 default.
8560
8561 @item -msoft-float
8562 @opindex msoft-float
8563 Generate output containing library calls for floating point.
8564 @strong{Warning:} the requisite libraries are not available for all ARM
8565 targets.  Normally the facilities of the machine's usual C compiler are
8566 used, but this cannot be done directly in cross-compilation.  You must make
8567 your own arrangements to provide suitable library functions for
8568 cross-compilation.
8569
8570 @option{-msoft-float} changes the calling convention in the output file;
8571 therefore, it is only useful if you compile @emph{all} of a program with
8572 this option.  In particular, you need to compile @file{libgcc.a}, the
8573 library that comes with GCC, with @option{-msoft-float} in order for
8574 this to work.
8575
8576 @item -mfloat-abi=@var{name}
8577 @opindex mfloat-abi
8578 Specifies which ABI to use for floating point values.  Permissible values
8579 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8580
8581 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
8582 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
8583 of floating point instructions, but still uses the soft-float calling
8584 conventions.
8585
8586 @item -mlittle-endian
8587 @opindex mlittle-endian
8588 Generate code for a processor running in little-endian mode.  This is
8589 the default for all standard configurations.
8590
8591 @item -mbig-endian
8592 @opindex mbig-endian
8593 Generate code for a processor running in big-endian mode; the default is
8594 to compile code for a little-endian processor.
8595
8596 @item -mwords-little-endian
8597 @opindex mwords-little-endian
8598 This option only applies when generating code for big-endian processors.
8599 Generate code for a little-endian word order but a big-endian byte
8600 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8601 option should only be used if you require compatibility with code for
8602 big-endian ARM processors generated by versions of the compiler prior to
8603 2.8.
8604
8605 @item -mcpu=@var{name}
8606 @opindex mcpu
8607 This specifies the name of the target ARM processor.  GCC uses this name
8608 to determine what kind of instructions it can emit when generating
8609 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8610 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8611 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8612 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
8613 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
8614 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
8615 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
8616 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
8617 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
8618 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
8619 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
8620 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
8621 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
8622 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
8623 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3}, @samp{cortex-m1},
8624 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
8625
8626 @item -mtune=@var{name}
8627 @opindex mtune
8628 This option is very similar to the @option{-mcpu=} option, except that
8629 instead of specifying the actual target processor type, and hence
8630 restricting which instructions can be used, it specifies that GCC should
8631 tune the performance of the code as if the target were of the type
8632 specified in this option, but still choosing the instructions that it
8633 will generate based on the cpu specified by a @option{-mcpu=} option.
8634 For some ARM implementations better performance can be obtained by using
8635 this option.
8636
8637 @item -march=@var{name}
8638 @opindex march
8639 This specifies the name of the target ARM architecture.  GCC uses this
8640 name to determine what kind of instructions it can emit when generating
8641 assembly code.  This option can be used in conjunction with or instead
8642 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
8643 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
8644 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
8645 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
8646 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
8647 @samp{iwmmxt}, @samp{ep9312}.
8648
8649 @item -mfpu=@var{name}
8650 @itemx -mfpe=@var{number}
8651 @itemx -mfp=@var{number}
8652 @opindex mfpu
8653 @opindex mfpe
8654 @opindex mfp
8655 This specifies what floating point hardware (or hardware emulation) is
8656 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
8657 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
8658 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
8659 with older versions of GCC@.
8660
8661 If @option{-msoft-float} is specified this specifies the format of
8662 floating point values.
8663
8664 @item -mstructure-size-boundary=@var{n}
8665 @opindex mstructure-size-boundary
8666 The size of all structures and unions will be rounded up to a multiple
8667 of the number of bits set by this option.  Permissible values are 8, 32
8668 and 64.  The default value varies for different toolchains.  For the COFF
8669 targeted toolchain the default value is 8.  A value of 64 is only allowed
8670 if the underlying ABI supports it.
8671
8672 Specifying the larger number can produce faster, more efficient code, but
8673 can also increase the size of the program.  Different values are potentially
8674 incompatible.  Code compiled with one value cannot necessarily expect to
8675 work with code or libraries compiled with another value, if they exchange
8676 information using structures or unions.
8677
8678 @item -mabort-on-noreturn
8679 @opindex mabort-on-noreturn
8680 Generate a call to the function @code{abort} at the end of a
8681 @code{noreturn} function.  It will be executed if the function tries to
8682 return.
8683
8684 @item -mlong-calls
8685 @itemx -mno-long-calls
8686 @opindex mlong-calls
8687 @opindex mno-long-calls
8688 Tells the compiler to perform function calls by first loading the
8689 address of the function into a register and then performing a subroutine
8690 call on this register.  This switch is needed if the target function
8691 will lie outside of the 64 megabyte addressing range of the offset based
8692 version of subroutine call instruction.
8693
8694 Even if this switch is enabled, not all function calls will be turned
8695 into long calls.  The heuristic is that static functions, functions
8696 which have the @samp{short-call} attribute, functions that are inside
8697 the scope of a @samp{#pragma no_long_calls} directive and functions whose
8698 definitions have already been compiled within the current compilation
8699 unit, will not be turned into long calls.  The exception to this rule is
8700 that weak function definitions, functions with the @samp{long-call}
8701 attribute or the @samp{section} attribute, and functions that are within
8702 the scope of a @samp{#pragma long_calls} directive, will always be
8703 turned into long calls.
8704
8705 This feature is not enabled by default.  Specifying
8706 @option{-mno-long-calls} will restore the default behavior, as will
8707 placing the function calls within the scope of a @samp{#pragma
8708 long_calls_off} directive.  Note these switches have no effect on how
8709 the compiler generates code to handle function calls via function
8710 pointers.
8711
8712 @item -mnop-fun-dllimport
8713 @opindex mnop-fun-dllimport
8714 Disable support for the @code{dllimport} attribute.
8715
8716 @item -msingle-pic-base
8717 @opindex msingle-pic-base
8718 Treat the register used for PIC addressing as read-only, rather than
8719 loading it in the prologue for each function.  The run-time system is
8720 responsible for initializing this register with an appropriate value
8721 before execution begins.
8722
8723 @item -mpic-register=@var{reg}
8724 @opindex mpic-register
8725 Specify the register to be used for PIC addressing.  The default is R10
8726 unless stack-checking is enabled, when R9 is used.
8727
8728 @item -mcirrus-fix-invalid-insns
8729 @opindex mcirrus-fix-invalid-insns
8730 @opindex mno-cirrus-fix-invalid-insns
8731 Insert NOPs into the instruction stream to in order to work around
8732 problems with invalid Maverick instruction combinations.  This option
8733 is only valid if the @option{-mcpu=ep9312} option has been used to
8734 enable generation of instructions for the Cirrus Maverick floating
8735 point co-processor.  This option is not enabled by default, since the
8736 problem is only present in older Maverick implementations.  The default
8737 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
8738 switch.
8739
8740 @item -mpoke-function-name
8741 @opindex mpoke-function-name
8742 Write the name of each function into the text section, directly
8743 preceding the function prologue.  The generated code is similar to this:
8744
8745 @smallexample
8746      t0
8747          .ascii "arm_poke_function_name", 0
8748          .align
8749      t1
8750          .word 0xff000000 + (t1 - t0)
8751      arm_poke_function_name
8752          mov     ip, sp
8753          stmfd   sp!, @{fp, ip, lr, pc@}
8754          sub     fp, ip, #4
8755 @end smallexample
8756
8757 When performing a stack backtrace, code can inspect the value of
8758 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
8759 location @code{pc - 12} and the top 8 bits are set, then we know that
8760 there is a function name embedded immediately preceding this location
8761 and has length @code{((pc[-3]) & 0xff000000)}.
8762
8763 @item -mthumb
8764 @opindex mthumb
8765 Generate code for the Thumb instruction set.  The default is to
8766 use the 32-bit ARM instruction set.
8767 This option automatically enables either 16-bit Thumb-1 or
8768 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
8769 and @option{-march=@var{name}} options.
8770
8771 @item -mtpcs-frame
8772 @opindex mtpcs-frame
8773 Generate a stack frame that is compliant with the Thumb Procedure Call
8774 Standard for all non-leaf functions.  (A leaf function is one that does
8775 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
8776
8777 @item -mtpcs-leaf-frame
8778 @opindex mtpcs-leaf-frame
8779 Generate a stack frame that is compliant with the Thumb Procedure Call
8780 Standard for all leaf functions.  (A leaf function is one that does
8781 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
8782
8783 @item -mcallee-super-interworking
8784 @opindex mcallee-super-interworking
8785 Gives all externally visible functions in the file being compiled an ARM
8786 instruction set header which switches to Thumb mode before executing the
8787 rest of the function.  This allows these functions to be called from
8788 non-interworking code.
8789
8790 @item -mcaller-super-interworking
8791 @opindex mcaller-super-interworking
8792 Allows calls via function pointers (including virtual functions) to
8793 execute correctly regardless of whether the target code has been
8794 compiled for interworking or not.  There is a small overhead in the cost
8795 of executing a function pointer if this option is enabled.
8796
8797 @item -mtp=@var{name}
8798 @opindex mtp
8799 Specify the access model for the thread local storage pointer.  The valid
8800 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
8801 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
8802 (supported in the arm6k architecture), and @option{auto}, which uses the
8803 best available method for the selected processor.  The default setting is
8804 @option{auto}.
8805
8806 @end table
8807
8808 @node AVR Options
8809 @subsection AVR Options
8810 @cindex AVR Options
8811
8812 These options are defined for AVR implementations:
8813
8814 @table @gcctabopt
8815 @item -mmcu=@var{mcu}
8816 @opindex mmcu
8817 Specify ATMEL AVR instruction set or MCU type.
8818
8819 Instruction set avr1 is for the minimal AVR core, not supported by the C
8820 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8821 attiny11, attiny12, attiny15, attiny28).
8822
8823 Instruction set avr2 (default) is for the classic AVR core with up to
8824 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8825 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8826 at90c8534, at90s8535).
8827
8828 Instruction set avr3 is for the classic AVR core with up to 128K program
8829 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
8830
8831 Instruction set avr4 is for the enhanced AVR core with up to 8K program
8832 memory space (MCU types: atmega8, atmega83, atmega85).
8833
8834 Instruction set avr5 is for the enhanced AVR core with up to 128K program
8835 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8836 atmega64, atmega128, at43usb355, at94k).
8837
8838 @item -msize
8839 @opindex msize
8840 Output instruction sizes to the asm file.
8841
8842 @item -minit-stack=@var{N}
8843 @opindex minit-stack
8844 Specify the initial stack address, which may be a symbol or numeric value,
8845 @samp{__stack} is the default.
8846
8847 @item -mno-interrupts
8848 @opindex mno-interrupts
8849 Generated code is not compatible with hardware interrupts.
8850 Code size will be smaller.
8851
8852 @item -mcall-prologues
8853 @opindex mcall-prologues
8854 Functions prologues/epilogues expanded as call to appropriate
8855 subroutines.  Code size will be smaller.
8856
8857 @item -mno-tablejump
8858 @opindex mno-tablejump
8859 Do not generate tablejump insns which sometimes increase code size.
8860
8861 @item -mtiny-stack
8862 @opindex mtiny-stack
8863 Change only the low 8 bits of the stack pointer.
8864
8865 @item -mint8
8866 @opindex mint8
8867 Assume int to be 8 bit integer.  This affects the sizes of all types: A
8868 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8869 and long long will be 4 bytes.  Please note that this option does not
8870 comply to the C standards, but it will provide you with smaller code
8871 size.
8872 @end table
8873
8874 @node Blackfin Options
8875 @subsection Blackfin Options
8876 @cindex Blackfin Options
8877
8878 @table @gcctabopt
8879 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
8880 @opindex mcpu=
8881 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
8882 can be one of @samp{bf522}, @samp{bf523}, @samp{bf524},
8883 @samp{bf525}, @samp{bf526}, @samp{bf527},
8884 @samp{bf531}, @samp{bf532}, @samp{bf533}, @samp{bf534},
8885 @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
8886 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
8887 @samp{bf561}.
8888 The optional @var{sirevision} specifies the silicon revision of the target
8889 Blackfin processor.  Any workarounds available for the targeted silicon revision
8890 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
8891 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
8892 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
8893 hexadecimal digits representing the major and minor numbers in the silicon
8894 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
8895 is not defined.  If @var{sirevision} is @samp{any}, the
8896 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
8897 If this optional @var{sirevision} is not used, GCC assumes the latest known
8898 silicon revision of the targeted Blackfin processor.
8899
8900 Support for @samp{bf561} is incomplete.  For @samp{bf561},
8901 Only the processor macro is defined.
8902 Without this option, @samp{bf532} is used as the processor by default.
8903 The corresponding predefined processor macros for @var{cpu} is to
8904 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
8905 provided by libgloss to be linked in if @option{-msim} is not given.
8906
8907 @item -msim
8908 @opindex msim
8909 Specifies that the program will be run on the simulator.  This causes
8910 the simulator BSP provided by libgloss to be linked in.  This option
8911 has effect only for @samp{bfin-elf} toolchain.
8912 Certain other options, such as @option{-mid-shared-library} and
8913 @option{-mfdpic}, imply @option{-msim}.
8914
8915 @item -momit-leaf-frame-pointer
8916 @opindex momit-leaf-frame-pointer
8917 Don't keep the frame pointer in a register for leaf functions.  This
8918 avoids the instructions to save, set up and restore frame pointers and
8919 makes an extra register available in leaf functions.  The option
8920 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8921 which might make debugging harder.
8922
8923 @item -mspecld-anomaly
8924 @opindex mspecld-anomaly
8925 When enabled, the compiler will ensure that the generated code does not
8926 contain speculative loads after jump instructions. If this option is used,
8927 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
8928
8929 @item -mno-specld-anomaly
8930 @opindex mno-specld-anomaly
8931 Don't generate extra code to prevent speculative loads from occurring.
8932
8933 @item -mcsync-anomaly
8934 @opindex mcsync-anomaly
8935 When enabled, the compiler will ensure that the generated code does not
8936 contain CSYNC or SSYNC instructions too soon after conditional branches.
8937 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
8938
8939 @item -mno-csync-anomaly
8940 @opindex mno-csync-anomaly
8941 Don't generate extra code to prevent CSYNC or SSYNC instructions from
8942 occurring too soon after a conditional branch.
8943
8944 @item -mlow-64k
8945 @opindex mlow-64k
8946 When enabled, the compiler is free to take advantage of the knowledge that
8947 the entire program fits into the low 64k of memory.
8948
8949 @item -mno-low-64k
8950 @opindex mno-low-64k
8951 Assume that the program is arbitrarily large.  This is the default.
8952
8953 @item -mstack-check-l1
8954 @opindex mstack-check-l1
8955 Do stack checking using information placed into L1 scratchpad memory by the
8956 uClinux kernel.
8957
8958 @item -mid-shared-library
8959 @opindex mid-shared-library
8960 Generate code that supports shared libraries via the library ID method.
8961 This allows for execute in place and shared libraries in an environment
8962 without virtual memory management.  This option implies @option{-fPIC}.
8963 With a @samp{bfin-elf} target, this option implies @option{-msim}.
8964
8965 @item -mno-id-shared-library
8966 @opindex mno-id-shared-library
8967 Generate code that doesn't assume ID based shared libraries are being used.
8968 This is the default.
8969
8970 @item -mleaf-id-shared-library
8971 @opindex mleaf-id-shared-library
8972 Generate code that supports shared libraries via the library ID method,
8973 but assumes that this library or executable won't link against any other
8974 ID shared libraries.  That allows the compiler to use faster code for jumps
8975 and calls.
8976
8977 @item -mno-leaf-id-shared-library
8978 @opindex mno-leaf-id-shared-library
8979 Do not assume that the code being compiled won't link against any ID shared
8980 libraries.  Slower code will be generated for jump and call insns.
8981
8982 @item -mshared-library-id=n
8983 @opindex mshared-library-id
8984 Specified the identification number of the ID based shared library being
8985 compiled.  Specifying a value of 0 will generate more compact code, specifying
8986 other values will force the allocation of that number to the current
8987 library but is no more space or time efficient than omitting this option.
8988
8989 @item -msep-data
8990 @opindex msep-data
8991 Generate code that allows the data segment to be located in a different
8992 area of memory from the text segment.  This allows for execute in place in
8993 an environment without virtual memory management by eliminating relocations
8994 against the text section.
8995
8996 @item -mno-sep-data
8997 @opindex mno-sep-data
8998 Generate code that assumes that the data segment follows the text segment.
8999 This is the default.
9000
9001 @item -mlong-calls
9002 @itemx -mno-long-calls
9003 @opindex mlong-calls
9004 @opindex mno-long-calls
9005 Tells the compiler to perform function calls by first loading the
9006 address of the function into a register and then performing a subroutine
9007 call on this register.  This switch is needed if the target function
9008 will lie outside of the 24 bit addressing range of the offset based
9009 version of subroutine call instruction.
9010
9011 This feature is not enabled by default.  Specifying
9012 @option{-mno-long-calls} will restore the default behavior.  Note these
9013 switches have no effect on how the compiler generates code to handle
9014 function calls via function pointers.
9015
9016 @item -mfast-fp
9017 @opindex mfast-fp
9018 Link with the fast floating-point library. This library relaxes some of
9019 the IEEE floating-point standard's rules for checking inputs against
9020 Not-a-Number (NAN), in the interest of performance.
9021
9022 @item -minline-plt
9023 @opindex minline-plt
9024 Enable inlining of PLT entries in function calls to functions that are
9025 not known to bind locally.  It has no effect without @option{-mfdpic}.
9026
9027 @item -mmulticore
9028 @opindex mmulticore
9029 Build standalone application for multicore Blackfin processor. Proper
9030 start files and link scripts will be used to support multicore.
9031 This option defines @code{__BFIN_MULTICORE}. It can only be used with
9032 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
9033 @option{-mcorea} or @option{-mcoreb}. If it's used without
9034 @option{-mcorea} or @option{-mcoreb}, single application/dual core
9035 programming model is used. In this model, the main function of Core B
9036 should be named as coreb_main. If it's used with @option{-mcorea} or
9037 @option{-mcoreb}, one application per core programming model is used.
9038 If this option is not used, single core application programming
9039 model is used.
9040
9041 @item -mcorea
9042 @opindex mcorea
9043 Build standalone application for Core A of BF561 when using
9044 one application per core programming model. Proper start files
9045 and link scripts will be used to support Core A. This option
9046 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
9047
9048 @item -mcoreb
9049 @opindex mcoreb
9050 Build standalone application for Core B of BF561 when using
9051 one application per core programming model. Proper start files
9052 and link scripts will be used to support Core B. This option
9053 defines @code{__BFIN_COREB}. When this option is used, coreb_main
9054 should be used instead of main. It must be used with
9055 @option{-mmulticore}. 
9056
9057 @item -msdram
9058 @opindex msdram
9059 Build standalone application for SDRAM. Proper start files and
9060 link scripts will be used to put the application into SDRAM.
9061 Loader should initialize SDRAM before loading the application
9062 into SDRAM. This option defines @code{__BFIN_SDRAM}.
9063 @end table
9064
9065 @node CRIS Options
9066 @subsection CRIS Options
9067 @cindex CRIS Options
9068
9069 These options are defined specifically for the CRIS ports.
9070
9071 @table @gcctabopt
9072 @item -march=@var{architecture-type}
9073 @itemx -mcpu=@var{architecture-type}
9074 @opindex march
9075 @opindex mcpu
9076 Generate code for the specified architecture.  The choices for
9077 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9078 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9079 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9080 @samp{v10}.
9081
9082 @item -mtune=@var{architecture-type}
9083 @opindex mtune
9084 Tune to @var{architecture-type} everything applicable about the generated
9085 code, except for the ABI and the set of available instructions.  The
9086 choices for @var{architecture-type} are the same as for
9087 @option{-march=@var{architecture-type}}.
9088
9089 @item -mmax-stack-frame=@var{n}
9090 @opindex mmax-stack-frame
9091 Warn when the stack frame of a function exceeds @var{n} bytes.
9092
9093 @item -metrax4
9094 @itemx -metrax100
9095 @opindex metrax4
9096 @opindex metrax100
9097 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9098 @option{-march=v3} and @option{-march=v8} respectively.
9099
9100 @item -mmul-bug-workaround
9101 @itemx -mno-mul-bug-workaround
9102 @opindex mmul-bug-workaround
9103 @opindex mno-mul-bug-workaround
9104 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
9105 models where it applies.  This option is active by default.
9106
9107 @item -mpdebug
9108 @opindex mpdebug
9109 Enable CRIS-specific verbose debug-related information in the assembly
9110 code.  This option also has the effect to turn off the @samp{#NO_APP}
9111 formatted-code indicator to the assembler at the beginning of the
9112 assembly file.
9113
9114 @item -mcc-init
9115 @opindex mcc-init
9116 Do not use condition-code results from previous instruction; always emit
9117 compare and test instructions before use of condition codes.
9118
9119 @item -mno-side-effects
9120 @opindex mno-side-effects
9121 Do not emit instructions with side-effects in addressing modes other than
9122 post-increment.
9123
9124 @item -mstack-align
9125 @itemx -mno-stack-align
9126 @itemx -mdata-align
9127 @itemx -mno-data-align
9128 @itemx -mconst-align
9129 @itemx -mno-const-align
9130 @opindex mstack-align
9131 @opindex mno-stack-align
9132 @opindex mdata-align
9133 @opindex mno-data-align
9134 @opindex mconst-align
9135 @opindex mno-const-align
9136 These options (no-options) arranges (eliminate arrangements) for the
9137 stack-frame, individual data and constants to be aligned for the maximum
9138 single data access size for the chosen CPU model.  The default is to
9139 arrange for 32-bit alignment.  ABI details such as structure layout are
9140 not affected by these options.
9141
9142 @item -m32-bit
9143 @itemx -m16-bit
9144 @itemx -m8-bit
9145 @opindex m32-bit
9146 @opindex m16-bit
9147 @opindex m8-bit
9148 Similar to the stack- data- and const-align options above, these options
9149 arrange for stack-frame, writable data and constants to all be 32-bit,
9150 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9151
9152 @item -mno-prologue-epilogue
9153 @itemx -mprologue-epilogue
9154 @opindex mno-prologue-epilogue
9155 @opindex mprologue-epilogue
9156 With @option{-mno-prologue-epilogue}, the normal function prologue and
9157 epilogue that sets up the stack-frame are omitted and no return
9158 instructions or return sequences are generated in the code.  Use this
9159 option only together with visual inspection of the compiled code: no
9160 warnings or errors are generated when call-saved registers must be saved,
9161 or storage for local variable needs to be allocated.
9162
9163 @item -mno-gotplt
9164 @itemx -mgotplt
9165 @opindex mno-gotplt
9166 @opindex mgotplt
9167 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9168 instruction sequences that load addresses for functions from the PLT part
9169 of the GOT rather than (traditional on other architectures) calls to the
9170 PLT@.  The default is @option{-mgotplt}.
9171
9172 @item -melf
9173 @opindex melf
9174 Legacy no-op option only recognized with the cris-axis-elf and
9175 cris-axis-linux-gnu targets.
9176
9177 @item -mlinux
9178 @opindex mlinux
9179 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9180
9181 @item -sim
9182 @opindex sim
9183 This option, recognized for the cris-axis-elf arranges
9184 to link with input-output functions from a simulator library.  Code,
9185 initialized data and zero-initialized data are allocated consecutively.
9186
9187 @item -sim2
9188 @opindex sim2
9189 Like @option{-sim}, but pass linker options to locate initialized data at
9190 0x40000000 and zero-initialized data at 0x80000000.
9191 @end table
9192
9193 @node CRX Options
9194 @subsection CRX Options
9195 @cindex CRX Options
9196
9197 These options are defined specifically for the CRX ports.
9198
9199 @table @gcctabopt
9200
9201 @item -mmac
9202 @opindex mmac
9203 Enable the use of multiply-accumulate instructions. Disabled by default.
9204
9205 @item -mpush-args
9206 @opindex mpush-args
9207 Push instructions will be used to pass outgoing arguments when functions
9208 are called. Enabled by default.
9209 @end table
9210
9211 @node Darwin Options
9212 @subsection Darwin Options
9213 @cindex Darwin options
9214
9215 These options are defined for all architectures running the Darwin operating
9216 system.
9217
9218 FSF GCC on Darwin does not create ``fat'' object files; it will create
9219 an object file for the single architecture that it was built to
9220 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
9221 @option{-arch} options are used; it does so by running the compiler or
9222 linker multiple times and joining the results together with
9223 @file{lipo}.
9224
9225 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
9226 @samp{i686}) is determined by the flags that specify the ISA
9227 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
9228 @option{-force_cpusubtype_ALL} option can be used to override this.
9229
9230 The Darwin tools vary in their behavior when presented with an ISA
9231 mismatch.  The assembler, @file{as}, will only permit instructions to
9232 be used that are valid for the subtype of the file it is generating,
9233 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
9234 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
9235 and print an error if asked to create a shared library with a less
9236 restrictive subtype than its input files (for instance, trying to put
9237 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
9238 for executables, @file{ld}, will quietly give the executable the most
9239 restrictive subtype of any of its input files.
9240
9241 @table @gcctabopt
9242 @item -F@var{dir}
9243 @opindex F
9244 Add the framework directory @var{dir} to the head of the list of
9245 directories to be searched for header files.  These directories are
9246 interleaved with those specified by @option{-I} options and are
9247 scanned in a left-to-right order.
9248
9249 A framework directory is a directory with frameworks in it.  A
9250 framework is a directory with a @samp{"Headers"} and/or
9251 @samp{"PrivateHeaders"} directory contained directly in it that ends
9252 in @samp{".framework"}.  The name of a framework is the name of this
9253 directory excluding the @samp{".framework"}.  Headers associated with
9254 the framework are found in one of those two directories, with
9255 @samp{"Headers"} being searched first.  A subframework is a framework
9256 directory that is in a framework's @samp{"Frameworks"} directory.
9257 Includes of subframework headers can only appear in a header of a
9258 framework that contains the subframework, or in a sibling subframework
9259 header.  Two subframeworks are siblings if they occur in the same
9260 framework.  A subframework should not have the same name as a
9261 framework, a warning will be issued if this is violated.  Currently a
9262 subframework cannot have subframeworks, in the future, the mechanism
9263 may be extended to support this.  The standard frameworks can be found
9264 in @samp{"/System/Library/Frameworks"} and
9265 @samp{"/Library/Frameworks"}.  An example include looks like
9266 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
9267 the name of the framework and header.h is found in the
9268 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
9269
9270 @item -iframework@var{dir}
9271 @opindex iframework
9272 Like @option{-F} except the directory is a treated as a system
9273 directory.  The main difference between this @option{-iframework} and
9274 @option{-F} is that with @option{-iframework} the compiler does not
9275 warn about constructs contained within header files found via
9276 @var{dir}.  This option is valid only for the C family of languages.
9277
9278 @item -gused
9279 @opindex gused
9280 Emit debugging information for symbols that are used.  For STABS
9281 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
9282 This is by default ON@.
9283
9284 @item -gfull
9285 @opindex gfull
9286 Emit debugging information for all symbols and types.
9287
9288 @item -mmacosx-version-min=@var{version}
9289 The earliest version of MacOS X that this executable will run on
9290 is @var{version}.  Typical values of @var{version} include @code{10.1},
9291 @code{10.2}, and @code{10.3.9}.
9292
9293 If the compiler was built to use the system's headers by default,
9294 then the default for this option is the system version on which the
9295 compiler is running, otherwise the default is to make choices which
9296 are compatible with as many systems and code bases as possible.
9297
9298 @item -mkernel
9299 @opindex mkernel
9300 Enable kernel development mode.  The @option{-mkernel} option sets
9301 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
9302 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
9303 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
9304 applicable.  This mode also sets @option{-mno-altivec},
9305 @option{-msoft-float}, @option{-fno-builtin} and
9306 @option{-mlong-branch} for PowerPC targets.
9307
9308 @item -mone-byte-bool
9309 @opindex mone-byte-bool
9310 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
9311 By default @samp{sizeof(bool)} is @samp{4} when compiling for
9312 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
9313 option has no effect on x86.
9314
9315 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
9316 to generate code that is not binary compatible with code generated
9317 without that switch.  Using this switch may require recompiling all
9318 other modules in a program, including system libraries.  Use this
9319 switch to conform to a non-default data model.
9320
9321 @item -mfix-and-continue
9322 @itemx -ffix-and-continue
9323 @itemx -findirect-data
9324 @opindex mfix-and-continue
9325 @opindex ffix-and-continue
9326 @opindex findirect-data
9327 Generate code suitable for fast turn around development.  Needed to
9328 enable gdb to dynamically load @code{.o} files into already running
9329 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
9330 are provided for backwards compatibility.
9331
9332 @item -all_load
9333 @opindex all_load
9334 Loads all members of static archive libraries.
9335 See man ld(1) for more information.
9336
9337 @item -arch_errors_fatal
9338 @opindex arch_errors_fatal
9339 Cause the errors having to do with files that have the wrong architecture
9340 to be fatal.
9341
9342 @item -bind_at_load
9343 @opindex bind_at_load
9344 Causes the output file to be marked such that the dynamic linker will
9345 bind all undefined references when the file is loaded or launched.
9346
9347 @item -bundle
9348 @opindex bundle
9349 Produce a Mach-o bundle format file.
9350 See man ld(1) for more information.
9351
9352 @item -bundle_loader @var{executable}
9353 @opindex bundle_loader
9354 This option specifies the @var{executable} that will be loading the build
9355 output file being linked.  See man ld(1) for more information.
9356
9357 @item -dynamiclib
9358 @opindex dynamiclib
9359 When passed this option, GCC will produce a dynamic library instead of
9360 an executable when linking, using the Darwin @file{libtool} command.
9361
9362 @item -force_cpusubtype_ALL
9363 @opindex force_cpusubtype_ALL
9364 This causes GCC's output file to have the @var{ALL} subtype, instead of
9365 one controlled by the @option{-mcpu} or @option{-march} option.
9366
9367 @item -allowable_client  @var{client_name}
9368 @itemx -client_name
9369 @itemx -compatibility_version
9370 @itemx -current_version
9371 @itemx -dead_strip
9372 @itemx -dependency-file
9373 @itemx -dylib_file
9374 @itemx -dylinker_install_name
9375 @itemx -dynamic
9376 @itemx -exported_symbols_list
9377 @itemx -filelist
9378 @itemx -flat_namespace
9379 @itemx -force_flat_namespace
9380 @itemx -headerpad_max_install_names
9381 @itemx -image_base
9382 @itemx -init
9383 @itemx -install_name
9384 @itemx -keep_private_externs
9385 @itemx -multi_module
9386 @itemx -multiply_defined
9387 @itemx -multiply_defined_unused
9388 @itemx -noall_load
9389 @itemx -no_dead_strip_inits_and_terms
9390 @itemx -nofixprebinding
9391 @itemx -nomultidefs
9392 @itemx -noprebind
9393 @itemx -noseglinkedit
9394 @itemx -pagezero_size
9395 @itemx -prebind
9396 @itemx -prebind_all_twolevel_modules
9397 @itemx -private_bundle
9398 @itemx -read_only_relocs
9399 @itemx -sectalign
9400 @itemx -sectobjectsymbols
9401 @itemx -whyload
9402 @itemx -seg1addr
9403 @itemx -sectcreate
9404 @itemx -sectobjectsymbols
9405 @itemx -sectorder
9406 @itemx -segaddr
9407 @itemx -segs_read_only_addr
9408 @itemx -segs_read_write_addr
9409 @itemx -seg_addr_table
9410 @itemx -seg_addr_table_filename
9411 @itemx -seglinkedit
9412 @itemx -segprot
9413 @itemx -segs_read_only_addr
9414 @itemx -segs_read_write_addr
9415 @itemx -single_module
9416 @itemx -static
9417 @itemx -sub_library
9418 @itemx -sub_umbrella
9419 @itemx -twolevel_namespace
9420 @itemx -umbrella
9421 @itemx -undefined
9422 @itemx -unexported_symbols_list
9423 @itemx -weak_reference_mismatches
9424 @itemx -whatsloaded
9425 @opindex allowable_client
9426 @opindex client_name
9427 @opindex compatibility_version
9428 @opindex current_version
9429 @opindex dead_strip
9430 @opindex dependency-file
9431 @opindex dylib_file
9432 @opindex dylinker_install_name
9433 @opindex dynamic
9434 @opindex exported_symbols_list
9435 @opindex filelist
9436 @opindex flat_namespace
9437 @opindex force_flat_namespace
9438 @opindex headerpad_max_install_names
9439 @opindex image_base
9440 @opindex init
9441 @opindex install_name
9442 @opindex keep_private_externs
9443 @opindex multi_module
9444 @opindex multiply_defined
9445 @opindex multiply_defined_unused
9446 @opindex noall_load
9447 @opindex no_dead_strip_inits_and_terms
9448 @opindex nofixprebinding
9449 @opindex nomultidefs
9450 @opindex noprebind
9451 @opindex noseglinkedit
9452 @opindex pagezero_size
9453 @opindex prebind
9454 @opindex prebind_all_twolevel_modules
9455 @opindex private_bundle
9456 @opindex read_only_relocs
9457 @opindex sectalign
9458 @opindex sectobjectsymbols
9459 @opindex whyload
9460 @opindex seg1addr
9461 @opindex sectcreate
9462 @opindex sectobjectsymbols
9463 @opindex sectorder
9464 @opindex segaddr
9465 @opindex segs_read_only_addr
9466 @opindex segs_read_write_addr
9467 @opindex seg_addr_table
9468 @opindex seg_addr_table_filename
9469 @opindex seglinkedit
9470 @opindex segprot
9471 @opindex segs_read_only_addr
9472 @opindex segs_read_write_addr
9473 @opindex single_module
9474 @opindex static
9475 @opindex sub_library
9476 @opindex sub_umbrella
9477 @opindex twolevel_namespace
9478 @opindex umbrella
9479 @opindex undefined
9480 @opindex unexported_symbols_list
9481 @opindex weak_reference_mismatches
9482 @opindex whatsloaded
9483 These options are passed to the Darwin linker.  The Darwin linker man page
9484 describes them in detail.
9485 @end table
9486
9487 @node DEC Alpha Options
9488 @subsection DEC Alpha Options
9489
9490 These @samp{-m} options are defined for the DEC Alpha implementations:
9491
9492 @table @gcctabopt
9493 @item -mno-soft-float
9494 @itemx -msoft-float
9495 @opindex mno-soft-float
9496 @opindex msoft-float
9497 Use (do not use) the hardware floating-point instructions for
9498 floating-point operations.  When @option{-msoft-float} is specified,
9499 functions in @file{libgcc.a} will be used to perform floating-point
9500 operations.  Unless they are replaced by routines that emulate the
9501 floating-point operations, or compiled in such a way as to call such
9502 emulations routines, these routines will issue floating-point
9503 operations.   If you are compiling for an Alpha without floating-point
9504 operations, you must ensure that the library is built so as not to call
9505 them.
9506
9507 Note that Alpha implementations without floating-point operations are
9508 required to have floating-point registers.
9509
9510 @item -mfp-reg
9511 @itemx -mno-fp-regs
9512 @opindex mfp-reg
9513 @opindex mno-fp-regs
9514 Generate code that uses (does not use) the floating-point register set.
9515 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9516 register set is not used, floating point operands are passed in integer
9517 registers as if they were integers and floating-point results are passed
9518 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9519 so any function with a floating-point argument or return value called by code
9520 compiled with @option{-mno-fp-regs} must also be compiled with that
9521 option.
9522
9523 A typical use of this option is building a kernel that does not use,
9524 and hence need not save and restore, any floating-point registers.
9525
9526 @item -mieee
9527 @opindex mieee
9528 The Alpha architecture implements floating-point hardware optimized for
9529 maximum performance.  It is mostly compliant with the IEEE floating
9530 point standard.  However, for full compliance, software assistance is
9531 required.  This option generates code fully IEEE compliant code
9532 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9533 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9534 defined during compilation.  The resulting code is less efficient but is
9535 able to correctly support denormalized numbers and exceptional IEEE
9536 values such as not-a-number and plus/minus infinity.  Other Alpha
9537 compilers call this option @option{-ieee_with_no_inexact}.
9538
9539 @item -mieee-with-inexact
9540 @opindex mieee-with-inexact
9541 This is like @option{-mieee} except the generated code also maintains
9542 the IEEE @var{inexact-flag}.  Turning on this option causes the
9543 generated code to implement fully-compliant IEEE math.  In addition to
9544 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9545 macro.  On some Alpha implementations the resulting code may execute
9546 significantly slower than the code generated by default.  Since there is
9547 very little code that depends on the @var{inexact-flag}, you should
9548 normally not specify this option.  Other Alpha compilers call this
9549 option @option{-ieee_with_inexact}.
9550
9551 @item -mfp-trap-mode=@var{trap-mode}
9552 @opindex mfp-trap-mode
9553 This option controls what floating-point related traps are enabled.
9554 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9555 The trap mode can be set to one of four values:
9556
9557 @table @samp
9558 @item n
9559 This is the default (normal) setting.  The only traps that are enabled
9560 are the ones that cannot be disabled in software (e.g., division by zero
9561 trap).
9562
9563 @item u
9564 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9565 as well.
9566
9567 @item su
9568 Like @samp{u}, but the instructions are marked to be safe for software
9569 completion (see Alpha architecture manual for details).
9570
9571 @item sui
9572 Like @samp{su}, but inexact traps are enabled as well.
9573 @end table
9574
9575 @item -mfp-rounding-mode=@var{rounding-mode}
9576 @opindex mfp-rounding-mode
9577 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9578 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9579 of:
9580
9581 @table @samp
9582 @item n
9583 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9584 the nearest machine number or towards the even machine number in case
9585 of a tie.
9586
9587 @item m
9588 Round towards minus infinity.
9589
9590 @item c
9591 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9592
9593 @item d
9594 Dynamic rounding mode.  A field in the floating point control register
9595 (@var{fpcr}, see Alpha architecture reference manual) controls the
9596 rounding mode in effect.  The C library initializes this register for
9597 rounding towards plus infinity.  Thus, unless your program modifies the
9598 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9599 @end table
9600
9601 @item -mtrap-precision=@var{trap-precision}
9602 @opindex mtrap-precision
9603 In the Alpha architecture, floating point traps are imprecise.  This
9604 means without software assistance it is impossible to recover from a
9605 floating trap and program execution normally needs to be terminated.
9606 GCC can generate code that can assist operating system trap handlers
9607 in determining the exact location that caused a floating point trap.
9608 Depending on the requirements of an application, different levels of
9609 precisions can be selected:
9610
9611 @table @samp
9612 @item p
9613 Program precision.  This option is the default and means a trap handler
9614 can only identify which program caused a floating point exception.
9615
9616 @item f
9617 Function precision.  The trap handler can determine the function that
9618 caused a floating point exception.
9619
9620 @item i
9621 Instruction precision.  The trap handler can determine the exact
9622 instruction that caused a floating point exception.
9623 @end table
9624
9625 Other Alpha compilers provide the equivalent options called
9626 @option{-scope_safe} and @option{-resumption_safe}.
9627
9628 @item -mieee-conformant
9629 @opindex mieee-conformant
9630 This option marks the generated code as IEEE conformant.  You must not
9631 use this option unless you also specify @option{-mtrap-precision=i} and either
9632 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9633 is to emit the line @samp{.eflag 48} in the function prologue of the
9634 generated assembly file.  Under DEC Unix, this has the effect that
9635 IEEE-conformant math library routines will be linked in.
9636
9637 @item -mbuild-constants
9638 @opindex mbuild-constants
9639 Normally GCC examines a 32- or 64-bit integer constant to
9640 see if it can construct it from smaller constants in two or three
9641 instructions.  If it cannot, it will output the constant as a literal and
9642 generate code to load it from the data segment at runtime.
9643
9644 Use this option to require GCC to construct @emph{all} integer constants
9645 using code, even if it takes more instructions (the maximum is six).
9646
9647 You would typically use this option to build a shared library dynamic
9648 loader.  Itself a shared library, it must relocate itself in memory
9649 before it can find the variables and constants in its own data segment.
9650
9651 @item -malpha-as
9652 @itemx -mgas
9653 @opindex malpha-as
9654 @opindex mgas
9655 Select whether to generate code to be assembled by the vendor-supplied
9656 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9657
9658 @item -mbwx
9659 @itemx -mno-bwx
9660 @itemx -mcix
9661 @itemx -mno-cix
9662 @itemx -mfix
9663 @itemx -mno-fix
9664 @itemx -mmax
9665 @itemx -mno-max
9666 @opindex mbwx
9667 @opindex mno-bwx
9668 @opindex mcix
9669 @opindex mno-cix
9670 @opindex mfix
9671 @opindex mno-fix
9672 @opindex mmax
9673 @opindex mno-max
9674 Indicate whether GCC should generate code to use the optional BWX,
9675 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9676 sets supported by the CPU type specified via @option{-mcpu=} option or that
9677 of the CPU on which GCC was built if none was specified.
9678
9679 @item -mfloat-vax
9680 @itemx -mfloat-ieee
9681 @opindex mfloat-vax
9682 @opindex mfloat-ieee
9683 Generate code that uses (does not use) VAX F and G floating point
9684 arithmetic instead of IEEE single and double precision.
9685
9686 @item -mexplicit-relocs
9687 @itemx -mno-explicit-relocs
9688 @opindex mexplicit-relocs
9689 @opindex mno-explicit-relocs
9690 Older Alpha assemblers provided no way to generate symbol relocations
9691 except via assembler macros.  Use of these macros does not allow
9692 optimal instruction scheduling.  GNU binutils as of version 2.12
9693 supports a new syntax that allows the compiler to explicitly mark
9694 which relocations should apply to which instructions.  This option
9695 is mostly useful for debugging, as GCC detects the capabilities of
9696 the assembler when it is built and sets the default accordingly.
9697
9698 @item -msmall-data
9699 @itemx -mlarge-data
9700 @opindex msmall-data
9701 @opindex mlarge-data
9702 When @option{-mexplicit-relocs} is in effect, static data is
9703 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9704 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9705 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9706 16-bit relocations off of the @code{$gp} register.  This limits the
9707 size of the small data area to 64KB, but allows the variables to be
9708 directly accessed via a single instruction.
9709
9710 The default is @option{-mlarge-data}.  With this option the data area
9711 is limited to just below 2GB@.  Programs that require more than 2GB of
9712 data must use @code{malloc} or @code{mmap} to allocate the data in the
9713 heap instead of in the program's data segment.
9714
9715 When generating code for shared libraries, @option{-fpic} implies
9716 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9717
9718 @item -msmall-text
9719 @itemx -mlarge-text
9720 @opindex msmall-text
9721 @opindex mlarge-text
9722 When @option{-msmall-text} is used, the compiler assumes that the
9723 code of the entire program (or shared library) fits in 4MB, and is
9724 thus reachable with a branch instruction.  When @option{-msmall-data}
9725 is used, the compiler can assume that all local symbols share the
9726 same @code{$gp} value, and thus reduce the number of instructions
9727 required for a function call from 4 to 1.
9728
9729 The default is @option{-mlarge-text}.
9730
9731 @item -mcpu=@var{cpu_type}
9732 @opindex mcpu
9733 Set the instruction set and instruction scheduling parameters for
9734 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9735 style name or the corresponding chip number.  GCC supports scheduling
9736 parameters for the EV4, EV5 and EV6 family of processors and will
9737 choose the default values for the instruction set from the processor
9738 you specify.  If you do not specify a processor type, GCC will default
9739 to the processor on which the compiler was built.
9740
9741 Supported values for @var{cpu_type} are
9742
9743 @table @samp
9744 @item ev4
9745 @itemx ev45
9746 @itemx 21064
9747 Schedules as an EV4 and has no instruction set extensions.
9748
9749 @item ev5
9750 @itemx 21164
9751 Schedules as an EV5 and has no instruction set extensions.
9752
9753 @item ev56
9754 @itemx 21164a
9755 Schedules as an EV5 and supports the BWX extension.
9756
9757 @item pca56
9758 @itemx 21164pc
9759 @itemx 21164PC
9760 Schedules as an EV5 and supports the BWX and MAX extensions.
9761
9762 @item ev6
9763 @itemx 21264
9764 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9765
9766 @item ev67
9767 @itemx 21264a
9768 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9769 @end table
9770
9771 @item -mtune=@var{cpu_type}
9772 @opindex mtune
9773 Set only the instruction scheduling parameters for machine type
9774 @var{cpu_type}.  The instruction set is not changed.
9775
9776 @item -mmemory-latency=@var{time}
9777 @opindex mmemory-latency
9778 Sets the latency the scheduler should assume for typical memory
9779 references as seen by the application.  This number is highly
9780 dependent on the memory access patterns used by the application
9781 and the size of the external cache on the machine.
9782
9783 Valid options for @var{time} are
9784
9785 @table @samp
9786 @item @var{number}
9787 A decimal number representing clock cycles.
9788
9789 @item L1
9790 @itemx L2
9791 @itemx L3
9792 @itemx main
9793 The compiler contains estimates of the number of clock cycles for
9794 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9795 (also called Dcache, Scache, and Bcache), as well as to main memory.
9796 Note that L3 is only valid for EV5.
9797
9798 @end table
9799 @end table
9800
9801 @node DEC Alpha/VMS Options
9802 @subsection DEC Alpha/VMS Options
9803
9804 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9805
9806 @table @gcctabopt
9807 @item -mvms-return-codes
9808 @opindex mvms-return-codes
9809 Return VMS condition codes from main.  The default is to return POSIX
9810 style condition (e.g.@: error) codes.
9811 @end table
9812
9813 @node FRV Options
9814 @subsection FRV Options
9815 @cindex FRV Options
9816
9817 @table @gcctabopt
9818 @item -mgpr-32
9819 @opindex mgpr-32
9820
9821 Only use the first 32 general purpose registers.
9822
9823 @item -mgpr-64
9824 @opindex mgpr-64
9825
9826 Use all 64 general purpose registers.
9827
9828 @item -mfpr-32
9829 @opindex mfpr-32
9830
9831 Use only the first 32 floating point registers.
9832
9833 @item -mfpr-64
9834 @opindex mfpr-64
9835
9836 Use all 64 floating point registers
9837
9838 @item -mhard-float
9839 @opindex mhard-float
9840
9841 Use hardware instructions for floating point operations.
9842
9843 @item -msoft-float
9844 @opindex msoft-float
9845
9846 Use library routines for floating point operations.
9847
9848 @item -malloc-cc
9849 @opindex malloc-cc
9850
9851 Dynamically allocate condition code registers.
9852
9853 @item -mfixed-cc
9854 @opindex mfixed-cc
9855
9856 Do not try to dynamically allocate condition code registers, only
9857 use @code{icc0} and @code{fcc0}.
9858
9859 @item -mdword
9860 @opindex mdword
9861
9862 Change ABI to use double word insns.
9863
9864 @item -mno-dword
9865 @opindex mno-dword
9866
9867 Do not use double word instructions.
9868
9869 @item -mdouble
9870 @opindex mdouble
9871
9872 Use floating point double instructions.
9873
9874 @item -mno-double
9875 @opindex mno-double
9876
9877 Do not use floating point double instructions.
9878
9879 @item -mmedia
9880 @opindex mmedia
9881
9882 Use media instructions.
9883
9884 @item -mno-media
9885 @opindex mno-media
9886
9887 Do not use media instructions.
9888
9889 @item -mmuladd
9890 @opindex mmuladd
9891
9892 Use multiply and add/subtract instructions.
9893
9894 @item -mno-muladd
9895 @opindex mno-muladd
9896
9897 Do not use multiply and add/subtract instructions.
9898
9899 @item -mfdpic
9900 @opindex mfdpic
9901
9902 Select the FDPIC ABI, that uses function descriptors to represent
9903 pointers to functions.  Without any PIC/PIE-related options, it
9904 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
9905 assumes GOT entries and small data are within a 12-bit range from the
9906 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
9907 are computed with 32 bits.
9908 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9909
9910 @item -minline-plt
9911 @opindex minline-plt
9912
9913 Enable inlining of PLT entries in function calls to functions that are
9914 not known to bind locally.  It has no effect without @option{-mfdpic}.
9915 It's enabled by default if optimizing for speed and compiling for
9916 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
9917 optimization option such as @option{-O3} or above is present in the
9918 command line.
9919
9920 @item -mTLS
9921 @opindex TLS
9922
9923 Assume a large TLS segment when generating thread-local code.
9924
9925 @item -mtls
9926 @opindex tls
9927
9928 Do not assume a large TLS segment when generating thread-local code.
9929
9930 @item -mgprel-ro
9931 @opindex mgprel-ro
9932
9933 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
9934 that is known to be in read-only sections.  It's enabled by default,
9935 except for @option{-fpic} or @option{-fpie}: even though it may help
9936 make the global offset table smaller, it trades 1 instruction for 4.
9937 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
9938 one of which may be shared by multiple symbols, and it avoids the need
9939 for a GOT entry for the referenced symbol, so it's more likely to be a
9940 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
9941
9942 @item -multilib-library-pic
9943 @opindex multilib-library-pic
9944
9945 Link with the (library, not FD) pic libraries.  It's implied by
9946 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
9947 @option{-fpic} without @option{-mfdpic}.  You should never have to use
9948 it explicitly.
9949
9950 @item -mlinked-fp
9951 @opindex mlinked-fp
9952
9953 Follow the EABI requirement of always creating a frame pointer whenever
9954 a stack frame is allocated.  This option is enabled by default and can
9955 be disabled with @option{-mno-linked-fp}.
9956
9957 @item -mlong-calls
9958 @opindex mlong-calls
9959
9960 Use indirect addressing to call functions outside the current
9961 compilation unit.  This allows the functions to be placed anywhere
9962 within the 32-bit address space.
9963
9964 @item -malign-labels
9965 @opindex malign-labels
9966
9967 Try to align labels to an 8-byte boundary by inserting nops into the
9968 previous packet.  This option only has an effect when VLIW packing
9969 is enabled.  It doesn't create new packets; it merely adds nops to
9970 existing ones.
9971
9972 @item -mlibrary-pic
9973 @opindex mlibrary-pic
9974
9975 Generate position-independent EABI code.
9976
9977 @item -macc-4
9978 @opindex macc-4
9979
9980 Use only the first four media accumulator registers.
9981
9982 @item -macc-8
9983 @opindex macc-8
9984
9985 Use all eight media accumulator registers.
9986
9987 @item -mpack
9988 @opindex mpack
9989
9990 Pack VLIW instructions.
9991
9992 @item -mno-pack
9993 @opindex mno-pack
9994
9995 Do not pack VLIW instructions.
9996
9997 @item -mno-eflags
9998 @opindex mno-eflags
9999
10000 Do not mark ABI switches in e_flags.
10001
10002 @item -mcond-move
10003 @opindex mcond-move
10004
10005 Enable the use of conditional-move instructions (default).
10006
10007 This switch is mainly for debugging the compiler and will likely be removed
10008 in a future version.
10009
10010 @item -mno-cond-move
10011 @opindex mno-cond-move
10012
10013 Disable the use of conditional-move instructions.
10014
10015 This switch is mainly for debugging the compiler and will likely be removed
10016 in a future version.
10017
10018 @item -mscc
10019 @opindex mscc
10020
10021 Enable the use of conditional set instructions (default).
10022
10023 This switch is mainly for debugging the compiler and will likely be removed
10024 in a future version.
10025
10026 @item -mno-scc
10027 @opindex mno-scc
10028
10029 Disable the use of conditional set instructions.
10030
10031 This switch is mainly for debugging the compiler and will likely be removed
10032 in a future version.
10033
10034 @item -mcond-exec
10035 @opindex mcond-exec
10036
10037 Enable the use of conditional execution (default).
10038
10039 This switch is mainly for debugging the compiler and will likely be removed
10040 in a future version.
10041
10042 @item -mno-cond-exec
10043 @opindex mno-cond-exec
10044
10045 Disable the use of conditional execution.
10046
10047 This switch is mainly for debugging the compiler and will likely be removed
10048 in a future version.
10049
10050 @item -mvliw-branch
10051 @opindex mvliw-branch
10052
10053 Run a pass to pack branches into VLIW instructions (default).
10054
10055 This switch is mainly for debugging the compiler and will likely be removed
10056 in a future version.
10057
10058 @item -mno-vliw-branch
10059 @opindex mno-vliw-branch
10060
10061 Do not run a pass to pack branches into VLIW instructions.
10062
10063 This switch is mainly for debugging the compiler and will likely be removed
10064 in a future version.
10065
10066 @item -mmulti-cond-exec
10067 @opindex mmulti-cond-exec
10068
10069 Enable optimization of @code{&&} and @code{||} in conditional execution
10070 (default).
10071
10072 This switch is mainly for debugging the compiler and will likely be removed
10073 in a future version.
10074
10075 @item -mno-multi-cond-exec
10076 @opindex mno-multi-cond-exec
10077
10078 Disable optimization of @code{&&} and @code{||} in conditional execution.
10079
10080 This switch is mainly for debugging the compiler and will likely be removed
10081 in a future version.
10082
10083 @item -mnested-cond-exec
10084 @opindex mnested-cond-exec
10085
10086 Enable nested conditional execution optimizations (default).
10087
10088 This switch is mainly for debugging the compiler and will likely be removed
10089 in a future version.
10090
10091 @item -mno-nested-cond-exec
10092 @opindex mno-nested-cond-exec
10093
10094 Disable nested conditional execution optimizations.
10095
10096 This switch is mainly for debugging the compiler and will likely be removed
10097 in a future version.
10098
10099 @item -moptimize-membar
10100 @opindex moptimize-membar
10101
10102 This switch removes redundant @code{membar} instructions from the
10103 compiler generated code.  It is enabled by default.
10104
10105 @item -mno-optimize-membar
10106 @opindex mno-optimize-membar
10107
10108 This switch disables the automatic removal of redundant @code{membar}
10109 instructions from the generated code.
10110
10111 @item -mtomcat-stats
10112 @opindex mtomcat-stats
10113
10114 Cause gas to print out tomcat statistics.
10115
10116 @item -mcpu=@var{cpu}
10117 @opindex mcpu
10118
10119 Select the processor type for which to generate code.  Possible values are
10120 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
10121 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
10122
10123 @end table
10124
10125 @node GNU/Linux Options
10126 @subsection GNU/Linux Options
10127
10128 These @samp{-m} options are defined for GNU/Linux targets:
10129
10130 @table @gcctabopt
10131 @item -mglibc
10132 @opindex mglibc
10133 Use the GNU C library instead of uClibc.  This is the default except
10134 on @samp{*-*-linux-*uclibc*} targets.
10135
10136 @item -muclibc
10137 @opindex muclibc
10138 Use uClibc instead of the GNU C library.  This is the default on
10139 @samp{*-*-linux-*uclibc*} targets.
10140 @end table
10141
10142 @node H8/300 Options
10143 @subsection H8/300 Options
10144
10145 These @samp{-m} options are defined for the H8/300 implementations:
10146
10147 @table @gcctabopt
10148 @item -mrelax
10149 @opindex mrelax
10150 Shorten some address references at link time, when possible; uses the
10151 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
10152 ld, Using ld}, for a fuller description.
10153
10154 @item -mh
10155 @opindex mh
10156 Generate code for the H8/300H@.
10157
10158 @item -ms
10159 @opindex ms
10160 Generate code for the H8S@.
10161
10162 @item -mn
10163 @opindex mn
10164 Generate code for the H8S and H8/300H in the normal mode.  This switch
10165 must be used either with @option{-mh} or @option{-ms}.
10166
10167 @item -ms2600
10168 @opindex ms2600
10169 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
10170
10171 @item -mint32
10172 @opindex mint32
10173 Make @code{int} data 32 bits by default.
10174
10175 @item -malign-300
10176 @opindex malign-300
10177 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
10178 The default for the H8/300H and H8S is to align longs and floats on 4
10179 byte boundaries.
10180 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
10181 This option has no effect on the H8/300.
10182 @end table
10183
10184 @node HPPA Options
10185 @subsection HPPA Options
10186 @cindex HPPA Options
10187
10188 These @samp{-m} options are defined for the HPPA family of computers:
10189
10190 @table @gcctabopt
10191 @item -march=@var{architecture-type}
10192 @opindex march
10193 Generate code for the specified architecture.  The choices for
10194 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
10195 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
10196 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
10197 architecture option for your machine.  Code compiled for lower numbered
10198 architectures will run on higher numbered architectures, but not the
10199 other way around.
10200
10201 @item -mpa-risc-1-0
10202 @itemx -mpa-risc-1-1
10203 @itemx -mpa-risc-2-0
10204 @opindex mpa-risc-1-0
10205 @opindex mpa-risc-1-1
10206 @opindex mpa-risc-2-0
10207 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
10208
10209 @item -mbig-switch
10210 @opindex mbig-switch
10211 Generate code suitable for big switch tables.  Use this option only if
10212 the assembler/linker complain about out of range branches within a switch
10213 table.
10214
10215 @item -mjump-in-delay
10216 @opindex mjump-in-delay
10217 Fill delay slots of function calls with unconditional jump instructions
10218 by modifying the return pointer for the function call to be the target
10219 of the conditional jump.
10220
10221 @item -mdisable-fpregs
10222 @opindex mdisable-fpregs
10223 Prevent floating point registers from being used in any manner.  This is
10224 necessary for compiling kernels which perform lazy context switching of
10225 floating point registers.  If you use this option and attempt to perform
10226 floating point operations, the compiler will abort.
10227
10228 @item -mdisable-indexing
10229 @opindex mdisable-indexing
10230 Prevent the compiler from using indexing address modes.  This avoids some
10231 rather obscure problems when compiling MIG generated code under MACH@.
10232
10233 @item -mno-space-regs
10234 @opindex mno-space-regs
10235 Generate code that assumes the target has no space registers.  This allows
10236 GCC to generate faster indirect calls and use unscaled index address modes.
10237
10238 Such code is suitable for level 0 PA systems and kernels.
10239
10240 @item -mfast-indirect-calls
10241 @opindex mfast-indirect-calls
10242 Generate code that assumes calls never cross space boundaries.  This
10243 allows GCC to emit code which performs faster indirect calls.
10244
10245 This option will not work in the presence of shared libraries or nested
10246 functions.
10247
10248 @item -mfixed-range=@var{register-range}
10249 @opindex mfixed-range
10250 Generate code treating the given register range as fixed registers.
10251 A fixed register is one that the register allocator can not use.  This is
10252 useful when compiling kernel code.  A register range is specified as
10253 two registers separated by a dash.  Multiple register ranges can be
10254 specified separated by a comma.
10255
10256 @item -mlong-load-store
10257 @opindex mlong-load-store
10258 Generate 3-instruction load and store sequences as sometimes required by
10259 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
10260 the HP compilers.
10261
10262 @item -mportable-runtime
10263 @opindex mportable-runtime
10264 Use the portable calling conventions proposed by HP for ELF systems.
10265
10266 @item -mgas
10267 @opindex mgas
10268 Enable the use of assembler directives only GAS understands.
10269
10270 @item -mschedule=@var{cpu-type}
10271 @opindex mschedule
10272 Schedule code according to the constraints for the machine type
10273 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
10274 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
10275 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
10276 proper scheduling option for your machine.  The default scheduling is
10277 @samp{8000}.
10278
10279 @item -mlinker-opt
10280 @opindex mlinker-opt
10281 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
10282 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
10283 linkers in which they give bogus error messages when linking some programs.
10284
10285 @item -msoft-float
10286 @opindex msoft-float
10287 Generate output containing library calls for floating point.
10288 @strong{Warning:} the requisite libraries are not available for all HPPA
10289 targets.  Normally the facilities of the machine's usual C compiler are
10290 used, but this cannot be done directly in cross-compilation.  You must make
10291 your own arrangements to provide suitable library functions for
10292 cross-compilation.
10293
10294 @option{-msoft-float} changes the calling convention in the output file;
10295 therefore, it is only useful if you compile @emph{all} of a program with
10296 this option.  In particular, you need to compile @file{libgcc.a}, the
10297 library that comes with GCC, with @option{-msoft-float} in order for
10298 this to work.
10299
10300 @item -msio
10301 @opindex msio
10302 Generate the predefine, @code{_SIO}, for server IO@.  The default is
10303 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
10304 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
10305 options are available under HP-UX and HI-UX@.
10306
10307 @item -mgnu-ld
10308 @opindex gnu-ld
10309 Use GNU ld specific options.  This passes @option{-shared} to ld when
10310 building a shared library.  It is the default when GCC is configured,
10311 explicitly or implicitly, with the GNU linker.  This option does not
10312 have any affect on which ld is called, it only changes what parameters
10313 are passed to that ld.  The ld that is called is determined by the
10314 @option{--with-ld} configure option, GCC's program search path, and
10315 finally by the user's @env{PATH}.  The linker used by GCC can be printed
10316 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
10317 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10318
10319 @item -mhp-ld
10320 @opindex hp-ld
10321 Use HP ld specific options.  This passes @option{-b} to ld when building
10322 a shared library and passes @option{+Accept TypeMismatch} to ld on all
10323 links.  It is the default when GCC is configured, explicitly or
10324 implicitly, with the HP linker.  This option does not have any affect on
10325 which ld is called, it only changes what parameters are passed to that
10326 ld.  The ld that is called is determined by the @option{--with-ld}
10327 configure option, GCC's program search path, and finally by the user's
10328 @env{PATH}.  The linker used by GCC can be printed using @samp{which
10329 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
10330 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10331
10332 @item -mlong-calls
10333 @opindex mno-long-calls
10334 Generate code that uses long call sequences.  This ensures that a call
10335 is always able to reach linker generated stubs.  The default is to generate
10336 long calls only when the distance from the call site to the beginning
10337 of the function or translation unit, as the case may be, exceeds a
10338 predefined limit set by the branch type being used.  The limits for
10339 normal calls are 7,600,000 and 240,000 bytes, respectively for the
10340 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
10341 240,000 bytes.
10342
10343 Distances are measured from the beginning of functions when using the
10344 @option{-ffunction-sections} option, or when using the @option{-mgas}
10345 and @option{-mno-portable-runtime} options together under HP-UX with
10346 the SOM linker.
10347
10348 It is normally not desirable to use this option as it will degrade
10349 performance.  However, it may be useful in large applications,
10350 particularly when partial linking is used to build the application.
10351
10352 The types of long calls used depends on the capabilities of the
10353 assembler and linker, and the type of code being generated.  The
10354 impact on systems that support long absolute calls, and long pic
10355 symbol-difference or pc-relative calls should be relatively small.
10356 However, an indirect call is used on 32-bit ELF systems in pic code
10357 and it is quite long.
10358
10359 @item -munix=@var{unix-std}
10360 @opindex march
10361 Generate compiler predefines and select a startfile for the specified
10362 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
10363 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
10364 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
10365 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
10366 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
10367 and later.
10368
10369 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
10370 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
10371 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
10372 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
10373 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
10374 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
10375
10376 It is @emph{important} to note that this option changes the interfaces
10377 for various library routines.  It also affects the operational behavior
10378 of the C library.  Thus, @emph{extreme} care is needed in using this
10379 option.
10380
10381 Library code that is intended to operate with more than one UNIX
10382 standard must test, set and restore the variable @var{__xpg4_extended_mask}
10383 as appropriate.  Most GNU software doesn't provide this capability.
10384
10385 @item -nolibdld
10386 @opindex nolibdld
10387 Suppress the generation of link options to search libdld.sl when the
10388 @option{-static} option is specified on HP-UX 10 and later.
10389
10390 @item -static
10391 @opindex static
10392 The HP-UX implementation of setlocale in libc has a dependency on
10393 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
10394 when the @option{-static} option is specified, special link options
10395 are needed to resolve this dependency.
10396
10397 On HP-UX 10 and later, the GCC driver adds the necessary options to
10398 link with libdld.sl when the @option{-static} option is specified.
10399 This causes the resulting binary to be dynamic.  On the 64-bit port,
10400 the linkers generate dynamic binaries by default in any case.  The
10401 @option{-nolibdld} option can be used to prevent the GCC driver from
10402 adding these link options.
10403
10404 @item -threads
10405 @opindex threads
10406 Add support for multithreading with the @dfn{dce thread} library
10407 under HP-UX@.  This option sets flags for both the preprocessor and
10408 linker.
10409 @end table
10410
10411 @node i386 and x86-64 Options
10412 @subsection Intel 386 and AMD x86-64 Options
10413 @cindex i386 Options
10414 @cindex x86-64 Options
10415 @cindex Intel 386 Options
10416 @cindex AMD x86-64 Options
10417
10418 These @samp{-m} options are defined for the i386 and x86-64 family of
10419 computers:
10420
10421 @table @gcctabopt
10422 @item -mtune=@var{cpu-type}
10423 @opindex mtune
10424 Tune to @var{cpu-type} everything applicable about the generated code, except
10425 for the ABI and the set of available instructions.  The choices for
10426 @var{cpu-type} are:
10427 @table @emph
10428 @item generic
10429 Produce code optimized for the most common IA32/AMD64/EM64T processors.
10430 If you know the CPU on which your code will run, then you should use
10431 the corresponding @option{-mtune} option instead of
10432 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
10433 of your application will have, then you should use this option.
10434
10435 As new processors are deployed in the marketplace, the behavior of this
10436 option will change.  Therefore, if you upgrade to a newer version of
10437 GCC, the code generated option will change to reflect the processors
10438 that were most common when that version of GCC was released.
10439
10440 There is no @option{-march=generic} option because @option{-march}
10441 indicates the instruction set the compiler can use, and there is no
10442 generic instruction set applicable to all processors.  In contrast,
10443 @option{-mtune} indicates the processor (or, in this case, collection of
10444 processors) for which the code is optimized.
10445 @item native
10446 This selects the CPU to tune for at compilation time by determining
10447 the processor type of the compiling machine.  Using @option{-mtune=native}
10448 will produce code optimized for the local machine under the constraints
10449 of the selected instruction set.  Using @option{-march=native} will
10450 enable all instruction subsets supported by the local machine (hence
10451 the result might not run on different machines).
10452 @item i386
10453 Original Intel's i386 CPU@.
10454 @item i486
10455 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
10456 @item i586, pentium
10457 Intel Pentium CPU with no MMX support.
10458 @item pentium-mmx
10459 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
10460 @item pentiumpro
10461 Intel PentiumPro CPU@.
10462 @item i686
10463 Same as @code{generic}, but when used as @code{march} option, PentiumPro
10464 instruction set will be used, so the code will run on all i686 family chips.
10465 @item pentium2
10466 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
10467 @item pentium3, pentium3m
10468 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
10469 support.
10470 @item pentium-m
10471 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10472 support.  Used by Centrino notebooks.
10473 @item pentium4, pentium4m
10474 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10475 @item prescott
10476 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10477 set support.
10478 @item nocona
10479 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10480 SSE2 and SSE3 instruction set support.
10481 @item core2
10482 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10483 instruction set support.
10484 @item k6
10485 AMD K6 CPU with MMX instruction set support.
10486 @item k6-2, k6-3
10487 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
10488 @item athlon, athlon-tbird
10489 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
10490 support.
10491 @item athlon-4, athlon-xp, athlon-mp
10492 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
10493 instruction set support.
10494 @item k8, opteron, athlon64, athlon-fx
10495 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10496 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
10497 @item k8-sse3, opteron-sse3, athlon64-sse3
10498 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10499 @item amdfam10, barcelona
10500 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10501 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10502 instruction set extensions.)
10503 @item winchip-c6
10504 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10505 set support.
10506 @item winchip2
10507 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
10508 instruction set support.
10509 @item c3
10510 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
10511 implemented for this chip.)
10512 @item c3-2
10513 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10514 implemented for this chip.)
10515 @item geode
10516 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10517 @end table
10518
10519 While picking a specific @var{cpu-type} will schedule things appropriately
10520 for that particular chip, the compiler will not generate any code that
10521 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10522 being used.
10523
10524 @item -march=@var{cpu-type}
10525 @opindex march
10526 Generate instructions for the machine type @var{cpu-type}.  The choices
10527 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10528 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10529
10530 @item -mcpu=@var{cpu-type}
10531 @opindex mcpu
10532 A deprecated synonym for @option{-mtune}.
10533
10534 @item -mfpmath=@var{unit}
10535 @opindex march
10536 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10537 for @var{unit} are:
10538
10539 @table @samp
10540 @item 387
10541 Use the standard 387 floating point coprocessor present majority of chips and
10542 emulated otherwise.  Code compiled with this option will run almost everywhere.
10543 The temporary results are computed in 80bit precision instead of precision
10544 specified by the type resulting in slightly different results compared to most
10545 of other chips.  See @option{-ffloat-store} for more detailed description.
10546
10547 This is the default choice for i386 compiler.
10548
10549 @item sse
10550 Use scalar floating point instructions present in the SSE instruction set.
10551 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10552 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10553 instruction set supports only single precision arithmetics, thus the double and
10554 extended precision arithmetics is still done using 387.  Later version, present
10555 only in Pentium4 and the future AMD x86-64 chips supports double precision
10556 arithmetics too.
10557
10558 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10559 or @option{-msse2} switches to enable SSE extensions and make this option
10560 effective.  For the x86-64 compiler, these extensions are enabled by default.
10561
10562 The resulting code should be considerably faster in the majority of cases and avoid
10563 the numerical instability problems of 387 code, but may break some existing
10564 code that expects temporaries to be 80bit.
10565
10566 This is the default choice for the x86-64 compiler.
10567
10568 @item sse,387
10569 Attempt to utilize both instruction sets at once.  This effectively double the
10570 amount of available registers and on chips with separate execution units for
10571 387 and SSE the execution resources too.  Use this option with care, as it is
10572 still experimental, because the GCC register allocator does not model separate
10573 functional units well resulting in instable performance.
10574 @end table
10575
10576 @item -masm=@var{dialect}
10577 @opindex masm=@var{dialect}
10578 Output asm instructions using selected @var{dialect}.  Supported
10579 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10580 not support @samp{intel}.
10581
10582 @item -mieee-fp
10583 @itemx -mno-ieee-fp
10584 @opindex mieee-fp
10585 @opindex mno-ieee-fp
10586 Control whether or not the compiler uses IEEE floating point
10587 comparisons.  These handle correctly the case where the result of a
10588 comparison is unordered.
10589
10590 @item -msoft-float
10591 @opindex msoft-float
10592 Generate output containing library calls for floating point.
10593 @strong{Warning:} the requisite libraries are not part of GCC@.
10594 Normally the facilities of the machine's usual C compiler are used, but
10595 this can't be done directly in cross-compilation.  You must make your
10596 own arrangements to provide suitable library functions for
10597 cross-compilation.
10598
10599 On machines where a function returns floating point results in the 80387
10600 register stack, some floating point opcodes may be emitted even if
10601 @option{-msoft-float} is used.
10602
10603 @item -mno-fp-ret-in-387
10604 @opindex mno-fp-ret-in-387
10605 Do not use the FPU registers for return values of functions.
10606
10607 The usual calling convention has functions return values of types
10608 @code{float} and @code{double} in an FPU register, even if there
10609 is no FPU@.  The idea is that the operating system should emulate
10610 an FPU@.
10611
10612 The option @option{-mno-fp-ret-in-387} causes such values to be returned
10613 in ordinary CPU registers instead.
10614
10615 @item -mno-fancy-math-387
10616 @opindex mno-fancy-math-387
10617 Some 387 emulators do not support the @code{sin}, @code{cos} and
10618 @code{sqrt} instructions for the 387.  Specify this option to avoid
10619 generating those instructions.  This option is the default on FreeBSD,
10620 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
10621 indicates that the target cpu will always have an FPU and so the
10622 instruction will not need emulation.  As of revision 2.6.1, these
10623 instructions are not generated unless you also use the
10624 @option{-funsafe-math-optimizations} switch.
10625
10626 @item -malign-double
10627 @itemx -mno-align-double
10628 @opindex malign-double
10629 @opindex mno-align-double
10630 Control whether GCC aligns @code{double}, @code{long double}, and
10631 @code{long long} variables on a two word boundary or a one word
10632 boundary.  Aligning @code{double} variables on a two word boundary will
10633 produce code that runs somewhat faster on a @samp{Pentium} at the
10634 expense of more memory.
10635
10636 On x86-64, @option{-malign-double} is enabled by default.
10637
10638 @strong{Warning:} if you use the @option{-malign-double} switch,
10639 structures containing the above types will be aligned differently than
10640 the published application binary interface specifications for the 386
10641 and will not be binary compatible with structures in code compiled
10642 without that switch.
10643
10644 @item -m96bit-long-double
10645 @itemx -m128bit-long-double
10646 @opindex m96bit-long-double
10647 @opindex m128bit-long-double
10648 These switches control the size of @code{long double} type.  The i386
10649 application binary interface specifies the size to be 96 bits,
10650 so @option{-m96bit-long-double} is the default in 32 bit mode.
10651
10652 Modern architectures (Pentium and newer) would prefer @code{long double}
10653 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
10654 conforming to the ABI, this would not be possible.  So specifying a
10655 @option{-m128bit-long-double} will align @code{long double}
10656 to a 16 byte boundary by padding the @code{long double} with an additional
10657 32 bit zero.
10658
10659 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
10660 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
10661
10662 Notice that neither of these options enable any extra precision over the x87
10663 standard of 80 bits for a @code{long double}.
10664
10665 @strong{Warning:} if you override the default value for your target ABI, the
10666 structures and arrays containing @code{long double} variables will change
10667 their size as well as function calling convention for function taking
10668 @code{long double} will be modified.  Hence they will not be binary
10669 compatible with arrays or structures in code compiled without that switch.
10670
10671 @item -mmlarge-data-threshold=@var{number}
10672 @opindex mlarge-data-threshold=@var{number}
10673 When @option{-mcmodel=medium} is specified, the data greater than
10674 @var{threshold} are placed in large data section.  This value must be the
10675 same across all object linked into the binary and defaults to 65535.
10676
10677 @item -mrtd
10678 @opindex mrtd
10679 Use a different function-calling convention, in which functions that
10680 take a fixed number of arguments return with the @code{ret} @var{num}
10681 instruction, which pops their arguments while returning.  This saves one
10682 instruction in the caller since there is no need to pop the arguments
10683 there.
10684
10685 You can specify that an individual function is called with this calling
10686 sequence with the function attribute @samp{stdcall}.  You can also
10687 override the @option{-mrtd} option by using the function attribute
10688 @samp{cdecl}.  @xref{Function Attributes}.
10689
10690 @strong{Warning:} this calling convention is incompatible with the one
10691 normally used on Unix, so you cannot use it if you need to call
10692 libraries compiled with the Unix compiler.
10693
10694 Also, you must provide function prototypes for all functions that
10695 take variable numbers of arguments (including @code{printf});
10696 otherwise incorrect code will be generated for calls to those
10697 functions.
10698
10699 In addition, seriously incorrect code will result if you call a
10700 function with too many arguments.  (Normally, extra arguments are
10701 harmlessly ignored.)
10702
10703 @item -mregparm=@var{num}
10704 @opindex mregparm
10705 Control how many registers are used to pass integer arguments.  By
10706 default, no registers are used to pass arguments, and at most 3
10707 registers can be used.  You can control this behavior for a specific
10708 function by using the function attribute @samp{regparm}.
10709 @xref{Function Attributes}.
10710
10711 @strong{Warning:} if you use this switch, and
10712 @var{num} is nonzero, then you must build all modules with the same
10713 value, including any libraries.  This includes the system libraries and
10714 startup modules.
10715
10716 @item -msseregparm
10717 @opindex msseregparm
10718 Use SSE register passing conventions for float and double arguments
10719 and return values.  You can control this behavior for a specific
10720 function by using the function attribute @samp{sseregparm}.
10721 @xref{Function Attributes}.
10722
10723 @strong{Warning:} if you use this switch then you must build all
10724 modules with the same value, including any libraries.  This includes
10725 the system libraries and startup modules.
10726
10727 @item -mpc32
10728 @itemx -mpc64
10729 @itemx -mpc80
10730 @opindex mpc32
10731 @opindex mpc64
10732 @opindex mpc80
10733
10734 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
10735 is specified, the significands of results of floating-point operations are
10736 rounded to 24 bits (single precision); @option{-mpc64} rounds the the
10737 significands of results of floating-point operations to 53 bits (double
10738 precision) and @option{-mpc80} rounds the significands of results of
10739 floating-point operations to 64 bits (extended double precision), which is
10740 the default.  When this option is used, floating-point operations in higher
10741 precisions are not available to the programmer without setting the FPU
10742 control word explicitly.
10743
10744 Setting the rounding of floating-point operations to less than the default
10745 80 bits can speed some programs by 2% or more.  Note that some mathematical
10746 libraries assume that extended precision (80 bit) floating-point operations
10747 are enabled by default; routines in such libraries could suffer significant
10748 loss of accuracy, typically through so-called "catastrophic cancellation",
10749 when this option is used to set the precision to less than extended precision. 
10750
10751 @item -mstackrealign
10752 @opindex mstackrealign
10753 Realign the stack at entry.  On the Intel x86, the
10754 @option{-mstackrealign} option will generate an alternate prologue and
10755 epilogue that realigns the runtime stack.  This supports mixing legacy
10756 codes that keep a 4-byte aligned stack with modern codes that keep a
10757 16-byte stack for SSE compatibility.  The alternate prologue and
10758 epilogue are slower and bigger than the regular ones, and the
10759 alternate prologue requires an extra scratch register; this lowers the
10760 number of registers available if used in conjunction with the
10761 @code{regparm} attribute.  The @option{-mstackrealign} option is
10762 incompatible with the nested function prologue; this is considered a
10763 hard error.  See also the attribute @code{force_align_arg_pointer},
10764 applicable to individual functions.
10765
10766 @item -mpreferred-stack-boundary=@var{num}
10767 @opindex mpreferred-stack-boundary
10768 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
10769 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
10770 the default is 4 (16 bytes or 128 bits).
10771
10772 On Pentium and PentiumPro, @code{double} and @code{long double} values
10773 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
10774 suffer significant run time performance penalties.  On Pentium III, the
10775 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
10776 properly if it is not 16 byte aligned.
10777
10778 To ensure proper alignment of this values on the stack, the stack boundary
10779 must be as aligned as that required by any value stored on the stack.
10780 Further, every function must be generated such that it keeps the stack
10781 aligned.  Thus calling a function compiled with a higher preferred
10782 stack boundary from a function compiled with a lower preferred stack
10783 boundary will most likely misalign the stack.  It is recommended that
10784 libraries that use callbacks always use the default setting.
10785
10786 This extra alignment does consume extra stack space, and generally
10787 increases code size.  Code that is sensitive to stack space usage, such
10788 as embedded systems and operating system kernels, may want to reduce the
10789 preferred alignment to @option{-mpreferred-stack-boundary=2}.
10790
10791 @item -mmmx
10792 @itemx -mno-mmx
10793 @itemx -msse
10794 @itemx -mno-sse
10795 @itemx -msse2
10796 @itemx -mno-sse2
10797 @itemx -msse3
10798 @itemx -mno-sse3
10799 @itemx -mssse3
10800 @itemx -mno-ssse3
10801 @itemx -msse4.1
10802 @itemx -mno-sse4.1
10803 @itemx -msse4.2
10804 @itemx -mno-sse4.2
10805 @itemx -msse4
10806 @itemx -mno-sse4
10807 @itemx -maes
10808 @itemx -mno-aes
10809 @itemx -mpclmul
10810 @itemx -mno-pclmul
10811 @itemx -msse4a
10812 @itemx -mno-sse4a
10813 @itemx -msse5
10814 @itemx -mno-sse5
10815 @itemx -m3dnow
10816 @itemx -mno-3dnow
10817 @itemx -mpopcnt
10818 @itemx -mno-popcnt
10819 @itemx -mabm
10820 @itemx -mno-abm
10821 @opindex mmmx
10822 @opindex mno-mmx
10823 @opindex msse
10824 @opindex mno-sse
10825 @opindex m3dnow
10826 @opindex mno-3dnow
10827 These switches enable or disable the use of instructions in the MMX,
10828 SSE, SSE2, SSE3, SSSE3, SSE4.1, AES, PCLMUL, SSE4A, SSE5, ABM or
10829 3DNow!@: extended instruction sets.
10830 These extensions are also available as built-in functions: see
10831 @ref{X86 Built-in Functions}, for details of the functions enabled and
10832 disabled by these switches.
10833
10834 To have SSE/SSE2 instructions generated automatically from floating-point
10835 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
10836
10837 These options will enable GCC to use these extended instructions in
10838 generated code, even without @option{-mfpmath=sse}.  Applications which
10839 perform runtime CPU detection must compile separate files for each
10840 supported architecture, using the appropriate flags.  In particular,
10841 the file containing the CPU detection code should be compiled without
10842 these options.
10843
10844 @item -mcld
10845 @opindex mcld
10846 This option instructs GCC to emit a @code{cld} instruction in the prologue
10847 of functions that use string instructions.  String instructions depend on
10848 the DF flag to select between autoincrement or autodecrement mode.  While the
10849 ABI specifies the DF flag to be cleared on function entry, some operating
10850 systems violate this specification by not clearing the DF flag in their
10851 exception dispatchers.  The exception handler can be invoked with the DF flag
10852 set which leads to wrong direction mode, when string instructions are used.
10853 This option can be enabled by default on 32-bit x86 targets by configuring
10854 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
10855 instructions can be suppressed with the @option{-mno-cld} compiler option
10856 in this case.
10857
10858 @item -mcx16
10859 @opindex mcx16
10860 This option will enable GCC to use CMPXCHG16B instruction in generated code.
10861 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
10862 data types.  This is useful for high resolution counters that could be updated
10863 by multiple processors (or cores).  This instruction is generated as part of
10864 atomic built-in functions: see @ref{Atomic Builtins} for details.
10865
10866 @item -msahf
10867 @opindex msahf
10868 This option will enable GCC to use SAHF instruction in generated 64-bit code.
10869 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
10870 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
10871 SAHF are load and store instructions, respectively, for certain status flags.
10872 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
10873 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
10874
10875 @item -mrecip
10876 @opindex mrecip
10877 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
10878 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Rhapson step
10879 to increase precision instead of DIVSS and SQRTSS (and their vectorized
10880 variants) for single precision floating point arguments.  These instructions
10881 are generated only when @option{-funsafe-math-optimizations} is enabled
10882 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
10883 Note that while the throughput of the sequence is higher than the throughput
10884 of the non-reciprocal instruction, the precision of the sequence can be
10885 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
10886
10887 @item -mveclibabi=@var{type}
10888 @opindex mveclibabi
10889 Specifies the ABI type to use for vectorizing intrinsics using an
10890 external library.  Supported types are @code{svml} for the Intel short
10891 vector math library and @code{acml} for the AMD math core library style
10892 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
10893 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
10894 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
10895 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
10896 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
10897 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
10898 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
10899 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
10900 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
10901 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
10902 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
10903 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
10904 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
10905 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
10906 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
10907 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
10908 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
10909 compatible library will have to be specified at link time.
10910
10911 @item -mpush-args
10912 @itemx -mno-push-args
10913 @opindex mpush-args
10914 @opindex mno-push-args
10915 Use PUSH operations to store outgoing parameters.  This method is shorter
10916 and usually equally fast as method using SUB/MOV operations and is enabled
10917 by default.  In some cases disabling it may improve performance because of
10918 improved scheduling and reduced dependencies.
10919
10920 @item -maccumulate-outgoing-args
10921 @opindex maccumulate-outgoing-args
10922 If enabled, the maximum amount of space required for outgoing arguments will be
10923 computed in the function prologue.  This is faster on most modern CPUs
10924 because of reduced dependencies, improved scheduling and reduced stack usage
10925 when preferred stack boundary is not equal to 2.  The drawback is a notable
10926 increase in code size.  This switch implies @option{-mno-push-args}.
10927
10928 @item -mthreads
10929 @opindex mthreads
10930 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
10931 on thread-safe exception handling must compile and link all code with the
10932 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
10933 @option{-D_MT}; when linking, it links in a special thread helper library
10934 @option{-lmingwthrd} which cleans up per thread exception handling data.
10935
10936 @item -mno-align-stringops
10937 @opindex mno-align-stringops
10938 Do not align destination of inlined string operations.  This switch reduces
10939 code size and improves performance in case the destination is already aligned,
10940 but GCC doesn't know about it.
10941
10942 @item -minline-all-stringops
10943 @opindex minline-all-stringops
10944 By default GCC inlines string operations only when destination is known to be
10945 aligned at least to 4 byte boundary.  This enables more inlining, increase code
10946 size, but may improve performance of code that depends on fast memcpy, strlen
10947 and memset for short lengths.
10948
10949 @item -minline-stringops-dynamically
10950 @opindex minline-stringops-dynamically
10951 For string operation of unknown size, inline runtime checks so for small
10952 blocks inline code is used, while for large blocks library call is used.
10953
10954 @item -mstringop-strategy=@var{alg}
10955 @opindex mstringop-strategy=@var{alg}
10956 Overwrite internal decision heuristic about particular algorithm to inline
10957 string operation with.  The allowed values are @code{rep_byte},
10958 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
10959 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
10960 expanding inline loop, @code{libcall} for always expanding library call.
10961
10962 @item -momit-leaf-frame-pointer
10963 @opindex momit-leaf-frame-pointer
10964 Don't keep the frame pointer in a register for leaf functions.  This
10965 avoids the instructions to save, set up and restore frame pointers and
10966 makes an extra register available in leaf functions.  The option
10967 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10968 which might make debugging harder.
10969
10970 @item -mtls-direct-seg-refs
10971 @itemx -mno-tls-direct-seg-refs
10972 @opindex mtls-direct-seg-refs
10973 Controls whether TLS variables may be accessed with offsets from the
10974 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
10975 or whether the thread base pointer must be added.  Whether or not this
10976 is legal depends on the operating system, and whether it maps the
10977 segment to cover the entire TLS area.
10978
10979 For systems that use GNU libc, the default is on.
10980
10981 @item -mfused-madd
10982 @itemx -mno-fused-madd
10983 @opindex mfused-madd
10984 Enable automatic generation of fused floating point multiply-add instructions
10985 if the ISA supports such instructions.  The -mfused-madd option is on by
10986 default.  The fused multiply-add instructions have a different
10987 rounding behavior compared to executing a multiply followed by an add.
10988 @end table
10989
10990 These @samp{-m} switches are supported in addition to the above
10991 on AMD x86-64 processors in 64-bit environments.
10992
10993 @table @gcctabopt
10994 @item -m32
10995 @itemx -m64
10996 @opindex m32
10997 @opindex m64
10998 Generate code for a 32-bit or 64-bit environment.
10999 The 32-bit environment sets int, long and pointer to 32 bits and
11000 generates code that runs on any i386 system.
11001 The 64-bit environment sets int to 32 bits and long and pointer
11002 to 64 bits and generates code for AMD's x86-64 architecture. For
11003 darwin only the -m64 option turns off the @option{-fno-pic} and
11004 @option{-mdynamic-no-pic} options.
11005
11006 @item -mno-red-zone
11007 @opindex no-red-zone
11008 Do not use a so called red zone for x86-64 code.  The red zone is mandated
11009 by the x86-64 ABI, it is a 128-byte area beyond the location of the
11010 stack pointer that will not be modified by signal or interrupt handlers
11011 and therefore can be used for temporary data without adjusting the stack
11012 pointer.  The flag @option{-mno-red-zone} disables this red zone.
11013
11014 @item -mcmodel=small
11015 @opindex mcmodel=small
11016 Generate code for the small code model: the program and its symbols must
11017 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
11018 Programs can be statically or dynamically linked.  This is the default
11019 code model.
11020
11021 @item -mcmodel=kernel
11022 @opindex mcmodel=kernel
11023 Generate code for the kernel code model.  The kernel runs in the
11024 negative 2 GB of the address space.
11025 This model has to be used for Linux kernel code.
11026
11027 @item -mcmodel=medium
11028 @opindex mcmodel=medium
11029 Generate code for the medium model: The program is linked in the lower 2
11030 GB of the address space but symbols can be located anywhere in the
11031 address space.  Programs can be statically or dynamically linked, but
11032 building of shared libraries are not supported with the medium model.
11033
11034 @item -mcmodel=large
11035 @opindex mcmodel=large
11036 Generate code for the large model: This model makes no assumptions
11037 about addresses and sizes of sections.
11038 @end table
11039
11040 @node IA-64 Options
11041 @subsection IA-64 Options
11042 @cindex IA-64 Options
11043
11044 These are the @samp{-m} options defined for the Intel IA-64 architecture.
11045
11046 @table @gcctabopt
11047 @item -mbig-endian
11048 @opindex mbig-endian
11049 Generate code for a big endian target.  This is the default for HP-UX@.
11050
11051 @item -mlittle-endian
11052 @opindex mlittle-endian
11053 Generate code for a little endian target.  This is the default for AIX5
11054 and GNU/Linux.
11055
11056 @item -mgnu-as
11057 @itemx -mno-gnu-as
11058 @opindex mgnu-as
11059 @opindex mno-gnu-as
11060 Generate (or don't) code for the GNU assembler.  This is the default.
11061 @c Also, this is the default if the configure option @option{--with-gnu-as}
11062 @c is used.
11063
11064 @item -mgnu-ld
11065 @itemx -mno-gnu-ld
11066 @opindex mgnu-ld
11067 @opindex mno-gnu-ld
11068 Generate (or don't) code for the GNU linker.  This is the default.
11069 @c Also, this is the default if the configure option @option{--with-gnu-ld}
11070 @c is used.
11071
11072 @item -mno-pic
11073 @opindex mno-pic
11074 Generate code that does not use a global pointer register.  The result
11075 is not position independent code, and violates the IA-64 ABI@.
11076
11077 @item -mvolatile-asm-stop
11078 @itemx -mno-volatile-asm-stop
11079 @opindex mvolatile-asm-stop
11080 @opindex mno-volatile-asm-stop
11081 Generate (or don't) a stop bit immediately before and after volatile asm
11082 statements.
11083
11084 @item -mregister-names
11085 @itemx -mno-register-names
11086 @opindex mregister-names
11087 @opindex mno-register-names
11088 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
11089 the stacked registers.  This may make assembler output more readable.
11090
11091 @item -mno-sdata
11092 @itemx -msdata
11093 @opindex mno-sdata
11094 @opindex msdata
11095 Disable (or enable) optimizations that use the small data section.  This may
11096 be useful for working around optimizer bugs.
11097
11098 @item -mconstant-gp
11099 @opindex mconstant-gp
11100 Generate code that uses a single constant global pointer value.  This is
11101 useful when compiling kernel code.
11102
11103 @item -mauto-pic
11104 @opindex mauto-pic
11105 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
11106 This is useful when compiling firmware code.
11107
11108 @item -minline-float-divide-min-latency
11109 @opindex minline-float-divide-min-latency
11110 Generate code for inline divides of floating point values
11111 using the minimum latency algorithm.
11112
11113 @item -minline-float-divide-max-throughput
11114 @opindex minline-float-divide-max-throughput
11115 Generate code for inline divides of floating point values
11116 using the maximum throughput algorithm.
11117
11118 @item -minline-int-divide-min-latency
11119 @opindex minline-int-divide-min-latency
11120 Generate code for inline divides of integer values
11121 using the minimum latency algorithm.
11122
11123 @item -minline-int-divide-max-throughput
11124 @opindex minline-int-divide-max-throughput
11125 Generate code for inline divides of integer values
11126 using the maximum throughput algorithm.
11127
11128 @item -minline-sqrt-min-latency
11129 @opindex minline-sqrt-min-latency
11130 Generate code for inline square roots
11131 using the minimum latency algorithm.
11132
11133 @item -minline-sqrt-max-throughput
11134 @opindex minline-sqrt-max-throughput
11135 Generate code for inline square roots
11136 using the maximum throughput algorithm.
11137
11138 @item -mno-dwarf2-asm
11139 @itemx -mdwarf2-asm
11140 @opindex mno-dwarf2-asm
11141 @opindex mdwarf2-asm
11142 Don't (or do) generate assembler code for the DWARF2 line number debugging
11143 info.  This may be useful when not using the GNU assembler.
11144
11145 @item -mearly-stop-bits
11146 @itemx -mno-early-stop-bits
11147 @opindex mearly-stop-bits
11148 @opindex mno-early-stop-bits
11149 Allow stop bits to be placed earlier than immediately preceding the
11150 instruction that triggered the stop bit.  This can improve instruction
11151 scheduling, but does not always do so.
11152
11153 @item -mfixed-range=@var{register-range}
11154 @opindex mfixed-range
11155 Generate code treating the given register range as fixed registers.
11156 A fixed register is one that the register allocator can not use.  This is
11157 useful when compiling kernel code.  A register range is specified as
11158 two registers separated by a dash.  Multiple register ranges can be
11159 specified separated by a comma.
11160
11161 @item -mtls-size=@var{tls-size}
11162 @opindex mtls-size
11163 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
11164 64.
11165
11166 @item -mtune=@var{cpu-type}
11167 @opindex mtune
11168 Tune the instruction scheduling for a particular CPU, Valid values are
11169 itanium, itanium1, merced, itanium2, and mckinley.
11170
11171 @item -mt
11172 @itemx -pthread
11173 @opindex mt
11174 @opindex pthread
11175 Add support for multithreading using the POSIX threads library.  This
11176 option sets flags for both the preprocessor and linker.  It does
11177 not affect the thread safety of object code produced by the compiler or
11178 that of libraries supplied with it.  These are HP-UX specific flags.
11179
11180 @item -milp32
11181 @itemx -mlp64
11182 @opindex milp32
11183 @opindex mlp64
11184 Generate code for a 32-bit or 64-bit environment.
11185 The 32-bit environment sets int, long and pointer to 32 bits.
11186 The 64-bit environment sets int to 32 bits and long and pointer
11187 to 64 bits.  These are HP-UX specific flags.
11188
11189 @item -mno-sched-br-data-spec
11190 @itemx -msched-br-data-spec
11191 @opindex mno-sched-br-data-spec
11192 @opindex msched-br-data-spec
11193 (Dis/En)able data speculative scheduling before reload.
11194 This will result in generation of the ld.a instructions and
11195 the corresponding check instructions (ld.c / chk.a).
11196 The default is 'disable'.
11197
11198 @item -msched-ar-data-spec
11199 @itemx -mno-sched-ar-data-spec
11200 @opindex msched-ar-data-spec
11201 @opindex mno-sched-ar-data-spec
11202 (En/Dis)able data speculative scheduling after reload.
11203 This will result in generation of the ld.a instructions and
11204 the corresponding check instructions (ld.c / chk.a).
11205 The default is 'enable'.
11206
11207 @item -mno-sched-control-spec
11208 @itemx -msched-control-spec
11209 @opindex mno-sched-control-spec
11210 @opindex msched-control-spec
11211 (Dis/En)able control speculative scheduling.  This feature is
11212 available only during region scheduling (i.e.@: before reload).
11213 This will result in generation of the ld.s instructions and
11214 the corresponding check instructions chk.s .
11215 The default is 'disable'.
11216
11217 @item -msched-br-in-data-spec
11218 @itemx -mno-sched-br-in-data-spec
11219 @opindex msched-br-in-data-spec
11220 @opindex mno-sched-br-in-data-spec
11221 (En/Dis)able speculative scheduling of the instructions that
11222 are dependent on the data speculative loads before reload.
11223 This is effective only with @option{-msched-br-data-spec} enabled.
11224 The default is 'enable'.
11225
11226 @item -msched-ar-in-data-spec
11227 @itemx -mno-sched-ar-in-data-spec
11228 @opindex msched-ar-in-data-spec
11229 @opindex mno-sched-ar-in-data-spec
11230 (En/Dis)able speculative scheduling of the instructions that
11231 are dependent on the data speculative loads after reload.
11232 This is effective only with @option{-msched-ar-data-spec} enabled.
11233 The default is 'enable'.
11234
11235 @item -msched-in-control-spec
11236 @itemx -mno-sched-in-control-spec
11237 @opindex msched-in-control-spec
11238 @opindex mno-sched-in-control-spec
11239 (En/Dis)able speculative scheduling of the instructions that
11240 are dependent on the control speculative loads.
11241 This is effective only with @option{-msched-control-spec} enabled.
11242 The default is 'enable'.
11243
11244 @item -msched-ldc
11245 @itemx -mno-sched-ldc
11246 @opindex msched-ldc
11247 @opindex mno-sched-ldc
11248 (En/Dis)able use of simple data speculation checks ld.c .
11249 If disabled, only chk.a instructions will be emitted to check
11250 data speculative loads.
11251 The default is 'enable'.
11252
11253 @item -mno-sched-control-ldc
11254 @itemx -msched-control-ldc
11255 @opindex mno-sched-control-ldc
11256 @opindex msched-control-ldc
11257 (Dis/En)able use of ld.c instructions to check control speculative loads.
11258 If enabled, in case of control speculative load with no speculatively
11259 scheduled dependent instructions this load will be emitted as ld.sa and
11260 ld.c will be used to check it.
11261 The default is 'disable'.
11262
11263 @item -mno-sched-spec-verbose
11264 @itemx -msched-spec-verbose
11265 @opindex mno-sched-spec-verbose
11266 @opindex msched-spec-verbose
11267 (Dis/En)able printing of the information about speculative motions.
11268
11269 @item -mno-sched-prefer-non-data-spec-insns
11270 @itemx -msched-prefer-non-data-spec-insns
11271 @opindex mno-sched-prefer-non-data-spec-insns
11272 @opindex msched-prefer-non-data-spec-insns
11273 If enabled, data speculative instructions will be chosen for schedule
11274 only if there are no other choices at the moment.  This will make
11275 the use of the data speculation much more conservative.
11276 The default is 'disable'.
11277
11278 @item -mno-sched-prefer-non-control-spec-insns
11279 @itemx -msched-prefer-non-control-spec-insns
11280 @opindex mno-sched-prefer-non-control-spec-insns
11281 @opindex msched-prefer-non-control-spec-insns
11282 If enabled, control speculative instructions will be chosen for schedule
11283 only if there are no other choices at the moment.  This will make
11284 the use of the control speculation much more conservative.
11285 The default is 'disable'.
11286
11287 @item -mno-sched-count-spec-in-critical-path
11288 @itemx -msched-count-spec-in-critical-path
11289 @opindex mno-sched-count-spec-in-critical-path
11290 @opindex msched-count-spec-in-critical-path
11291 If enabled, speculative dependencies will be considered during
11292 computation of the instructions priorities.  This will make the use of the
11293 speculation a bit more conservative.
11294 The default is 'disable'.
11295
11296 @end table
11297
11298 @node M32C Options
11299 @subsection M32C Options
11300 @cindex M32C options
11301
11302 @table @gcctabopt
11303 @item -mcpu=@var{name}
11304 @opindex mcpu=
11305 Select the CPU for which code is generated.  @var{name} may be one of
11306 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
11307 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
11308 the M32C/80 series.
11309
11310 @item -msim
11311 @opindex msim
11312 Specifies that the program will be run on the simulator.  This causes
11313 an alternate runtime library to be linked in which supports, for
11314 example, file I/O@.  You must not use this option when generating
11315 programs that will run on real hardware; you must provide your own
11316 runtime library for whatever I/O functions are needed.
11317
11318 @item -memregs=@var{number}
11319 @opindex memregs=
11320 Specifies the number of memory-based pseudo-registers GCC will use
11321 during code generation.  These pseudo-registers will be used like real
11322 registers, so there is a tradeoff between GCC's ability to fit the
11323 code into available registers, and the performance penalty of using
11324 memory instead of registers.  Note that all modules in a program must
11325 be compiled with the same value for this option.  Because of that, you
11326 must not use this option with the default runtime libraries gcc
11327 builds.
11328
11329 @end table
11330
11331 @node M32R/D Options
11332 @subsection M32R/D Options
11333 @cindex M32R/D options
11334
11335 These @option{-m} options are defined for Renesas M32R/D architectures:
11336
11337 @table @gcctabopt
11338 @item -m32r2
11339 @opindex m32r2
11340 Generate code for the M32R/2@.
11341
11342 @item -m32rx
11343 @opindex m32rx
11344 Generate code for the M32R/X@.
11345
11346 @item -m32r
11347 @opindex m32r
11348 Generate code for the M32R@.  This is the default.
11349
11350 @item -mmodel=small
11351 @opindex mmodel=small
11352 Assume all objects live in the lower 16MB of memory (so that their addresses
11353 can be loaded with the @code{ld24} instruction), and assume all subroutines
11354 are reachable with the @code{bl} instruction.
11355 This is the default.
11356
11357 The addressability of a particular object can be set with the
11358 @code{model} attribute.
11359
11360 @item -mmodel=medium
11361 @opindex mmodel=medium
11362 Assume objects may be anywhere in the 32-bit address space (the compiler
11363 will generate @code{seth/add3} instructions to load their addresses), and
11364 assume all subroutines are reachable with the @code{bl} instruction.
11365
11366 @item -mmodel=large
11367 @opindex mmodel=large
11368 Assume objects may be anywhere in the 32-bit address space (the compiler
11369 will generate @code{seth/add3} instructions to load their addresses), and
11370 assume subroutines may not be reachable with the @code{bl} instruction
11371 (the compiler will generate the much slower @code{seth/add3/jl}
11372 instruction sequence).
11373
11374 @item -msdata=none
11375 @opindex msdata=none
11376 Disable use of the small data area.  Variables will be put into
11377 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
11378 @code{section} attribute has been specified).
11379 This is the default.
11380
11381 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
11382 Objects may be explicitly put in the small data area with the
11383 @code{section} attribute using one of these sections.
11384
11385 @item -msdata=sdata
11386 @opindex msdata=sdata
11387 Put small global and static data in the small data area, but do not
11388 generate special code to reference them.
11389
11390 @item -msdata=use
11391 @opindex msdata=use
11392 Put small global and static data in the small data area, and generate
11393 special instructions to reference them.
11394
11395 @item -G @var{num}
11396 @opindex G
11397 @cindex smaller data references
11398 Put global and static objects less than or equal to @var{num} bytes
11399 into the small data or bss sections instead of the normal data or bss
11400 sections.  The default value of @var{num} is 8.
11401 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
11402 for this option to have any effect.
11403
11404 All modules should be compiled with the same @option{-G @var{num}} value.
11405 Compiling with different values of @var{num} may or may not work; if it
11406 doesn't the linker will give an error message---incorrect code will not be
11407 generated.
11408
11409 @item -mdebug
11410 @opindex mdebug
11411 Makes the M32R specific code in the compiler display some statistics
11412 that might help in debugging programs.
11413
11414 @item -malign-loops
11415 @opindex malign-loops
11416 Align all loops to a 32-byte boundary.
11417
11418 @item -mno-align-loops
11419 @opindex mno-align-loops
11420 Do not enforce a 32-byte alignment for loops.  This is the default.
11421
11422 @item -missue-rate=@var{number}
11423 @opindex missue-rate=@var{number}
11424 Issue @var{number} instructions per cycle.  @var{number} can only be 1
11425 or 2.
11426
11427 @item -mbranch-cost=@var{number}
11428 @opindex mbranch-cost=@var{number}
11429 @var{number} can only be 1 or 2.  If it is 1 then branches will be
11430 preferred over conditional code, if it is 2, then the opposite will
11431 apply.
11432
11433 @item -mflush-trap=@var{number}
11434 @opindex mflush-trap=@var{number}
11435 Specifies the trap number to use to flush the cache.  The default is
11436 12.  Valid numbers are between 0 and 15 inclusive.
11437
11438 @item -mno-flush-trap
11439 @opindex mno-flush-trap
11440 Specifies that the cache cannot be flushed by using a trap.
11441
11442 @item -mflush-func=@var{name}
11443 @opindex mflush-func=@var{name}
11444 Specifies the name of the operating system function to call to flush
11445 the cache.  The default is @emph{_flush_cache}, but a function call
11446 will only be used if a trap is not available.
11447
11448 @item -mno-flush-func
11449 @opindex mno-flush-func
11450 Indicates that there is no OS function for flushing the cache.
11451
11452 @end table
11453
11454 @node M680x0 Options
11455 @subsection M680x0 Options
11456 @cindex M680x0 options
11457
11458 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
11459 The default settings depend on which architecture was selected when
11460 the compiler was configured; the defaults for the most common choices
11461 are given below.
11462
11463 @table @gcctabopt
11464 @item -march=@var{arch}
11465 @opindex march
11466 Generate code for a specific M680x0 or ColdFire instruction set
11467 architecture.  Permissible values of @var{arch} for M680x0
11468 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
11469 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
11470 architectures are selected according to Freescale's ISA classification
11471 and the permissible values are: @samp{isaa}, @samp{isaaplus},
11472 @samp{isab} and @samp{isac}.
11473
11474 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
11475 code for a ColdFire target.  The @var{arch} in this macro is one of the
11476 @option{-march} arguments given above.
11477
11478 When used together, @option{-march} and @option{-mtune} select code
11479 that runs on a family of similar processors but that is optimized
11480 for a particular microarchitecture.
11481
11482 @item -mcpu=@var{cpu}
11483 @opindex mcpu
11484 Generate code for a specific M680x0 or ColdFire processor.
11485 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
11486 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
11487 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
11488 below, which also classifies the CPUs into families:
11489
11490 @multitable @columnfractions 0.20 0.80
11491 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
11492 @item @samp{51qe} @tab @samp{51qe}
11493 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
11494 @item @samp{5206e} @tab @samp{5206e}
11495 @item @samp{5208} @tab @samp{5207} @samp{5208}
11496 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
11497 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
11498 @item @samp{5216} @tab @samp{5214} @samp{5216}
11499 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
11500 @item @samp{5225} @tab @samp{5224} @samp{5225}
11501 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
11502 @item @samp{5249} @tab @samp{5249}
11503 @item @samp{5250} @tab @samp{5250}
11504 @item @samp{5271} @tab @samp{5270} @samp{5271}
11505 @item @samp{5272} @tab @samp{5272}
11506 @item @samp{5275} @tab @samp{5274} @samp{5275}
11507 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
11508 @item @samp{5307} @tab @samp{5307}
11509 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
11510 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
11511 @item @samp{5407} @tab @samp{5407}
11512 @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}
11513 @end multitable
11514
11515 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
11516 @var{arch} is compatible with @var{cpu}.  Other combinations of
11517 @option{-mcpu} and @option{-march} are rejected.
11518
11519 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
11520 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
11521 where the value of @var{family} is given by the table above.
11522
11523 @item -mtune=@var{tune}
11524 @opindex mtune
11525 Tune the code for a particular microarchitecture, within the
11526 constraints set by @option{-march} and @option{-mcpu}.
11527 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
11528 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11529 and @samp{cpu32}.  The ColdFire microarchitectures
11530 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11531
11532 You can also use @option{-mtune=68020-40} for code that needs
11533 to run relatively well on 68020, 68030 and 68040 targets.
11534 @option{-mtune=68020-60} is similar but includes 68060 targets
11535 as well.  These two options select the same tuning decisions as
11536 @option{-m68020-40} and @option{-m68020-60} respectively.
11537
11538 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11539 when tuning for 680x0 architecture @var{arch}.  It also defines
11540 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11541 option is used.  If gcc is tuning for a range of architectures,
11542 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11543 it defines the macros for every architecture in the range.
11544
11545 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11546 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11547 of the arguments given above.
11548
11549 @item -m68000
11550 @itemx -mc68000
11551 @opindex m68000
11552 @opindex mc68000
11553 Generate output for a 68000.  This is the default
11554 when the compiler is configured for 68000-based systems.
11555 It is equivalent to @option{-march=68000}.
11556
11557 Use this option for microcontrollers with a 68000 or EC000 core,
11558 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11559
11560 @item -m68010
11561 @opindex m68010
11562 Generate output for a 68010.  This is the default
11563 when the compiler is configured for 68010-based systems.
11564 It is equivalent to @option{-march=68010}.
11565
11566 @item -m68020
11567 @itemx -mc68020
11568 @opindex m68020
11569 @opindex mc68020
11570 Generate output for a 68020.  This is the default
11571 when the compiler is configured for 68020-based systems.
11572 It is equivalent to @option{-march=68020}.
11573
11574 @item -m68030
11575 @opindex m68030
11576 Generate output for a 68030.  This is the default when the compiler is
11577 configured for 68030-based systems.  It is equivalent to
11578 @option{-march=68030}.
11579
11580 @item -m68040
11581 @opindex m68040
11582 Generate output for a 68040.  This is the default when the compiler is
11583 configured for 68040-based systems.  It is equivalent to
11584 @option{-march=68040}.
11585
11586 This option inhibits the use of 68881/68882 instructions that have to be
11587 emulated by software on the 68040.  Use this option if your 68040 does not
11588 have code to emulate those instructions.
11589
11590 @item -m68060
11591 @opindex m68060
11592 Generate output for a 68060.  This is the default when the compiler is
11593 configured for 68060-based systems.  It is equivalent to
11594 @option{-march=68060}.
11595
11596 This option inhibits the use of 68020 and 68881/68882 instructions that
11597 have to be emulated by software on the 68060.  Use this option if your 68060
11598 does not have code to emulate those instructions.
11599
11600 @item -mcpu32
11601 @opindex mcpu32
11602 Generate output for a CPU32.  This is the default
11603 when the compiler is configured for CPU32-based systems.
11604 It is equivalent to @option{-march=cpu32}.
11605
11606 Use this option for microcontrollers with a
11607 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
11608 68336, 68340, 68341, 68349 and 68360.
11609
11610 @item -m5200
11611 @opindex m5200
11612 Generate output for a 520X ColdFire CPU@.  This is the default
11613 when the compiler is configured for 520X-based systems.
11614 It is equivalent to @option{-mcpu=5206}, and is now deprecated
11615 in favor of that option.
11616
11617 Use this option for microcontroller with a 5200 core, including
11618 the MCF5202, MCF5203, MCF5204 and MCF5206.
11619
11620 @item -m5206e
11621 @opindex m5206e
11622 Generate output for a 5206e ColdFire CPU@.  The option is now
11623 deprecated in favor of the equivalent @option{-mcpu=5206e}.
11624
11625 @item -m528x
11626 @opindex m528x
11627 Generate output for a member of the ColdFire 528X family.
11628 The option is now deprecated in favor of the equivalent
11629 @option{-mcpu=528x}.
11630
11631 @item -m5307
11632 @opindex m5307
11633 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
11634 in favor of the equivalent @option{-mcpu=5307}.
11635
11636 @item -m5407
11637 @opindex m5407
11638 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
11639 in favor of the equivalent @option{-mcpu=5407}.
11640
11641 @item -mcfv4e
11642 @opindex mcfv4e
11643 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
11644 This includes use of hardware floating point instructions.
11645 The option is equivalent to @option{-mcpu=547x}, and is now
11646 deprecated in favor of that option.
11647
11648 @item -m68020-40
11649 @opindex m68020-40
11650 Generate output for a 68040, without using any of the new instructions.
11651 This results in code which can run relatively efficiently on either a
11652 68020/68881 or a 68030 or a 68040.  The generated code does use the
11653 68881 instructions that are emulated on the 68040.
11654
11655 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
11656
11657 @item -m68020-60
11658 @opindex m68020-60
11659 Generate output for a 68060, without using any of the new instructions.
11660 This results in code which can run relatively efficiently on either a
11661 68020/68881 or a 68030 or a 68040.  The generated code does use the
11662 68881 instructions that are emulated on the 68060.
11663
11664 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
11665
11666 @item -mhard-float
11667 @itemx -m68881
11668 @opindex mhard-float
11669 @opindex m68881
11670 Generate floating-point instructions.  This is the default for 68020
11671 and above, and for ColdFire devices that have an FPU@.  It defines the
11672 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
11673 on ColdFire targets.
11674
11675 @item -msoft-float
11676 @opindex msoft-float
11677 Do not generate floating-point instructions; use library calls instead.
11678 This is the default for 68000, 68010, and 68832 targets.  It is also
11679 the default for ColdFire devices that have no FPU.
11680
11681 @item -mdiv
11682 @itemx -mno-div
11683 @opindex mdiv
11684 @opindex mno-div
11685 Generate (do not generate) ColdFire hardware divide and remainder
11686 instructions.  If @option{-march} is used without @option{-mcpu},
11687 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
11688 architectures.  Otherwise, the default is taken from the target CPU
11689 (either the default CPU, or the one specified by @option{-mcpu}).  For
11690 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
11691 @option{-mcpu=5206e}.
11692
11693 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
11694
11695 @item -mshort
11696 @opindex mshort
11697 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11698 Additionally, parameters passed on the stack are also aligned to a
11699 16-bit boundary even on targets whose API mandates promotion to 32-bit.
11700
11701 @item -mno-short
11702 @opindex mno-short
11703 Do not consider type @code{int} to be 16 bits wide.  This is the default.
11704
11705 @item -mnobitfield
11706 @itemx -mno-bitfield
11707 @opindex mnobitfield
11708 @opindex mno-bitfield
11709 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
11710 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
11711
11712 @item -mbitfield
11713 @opindex mbitfield
11714 Do use the bit-field instructions.  The @option{-m68020} option implies
11715 @option{-mbitfield}.  This is the default if you use a configuration
11716 designed for a 68020.
11717
11718 @item -mrtd
11719 @opindex mrtd
11720 Use a different function-calling convention, in which functions
11721 that take a fixed number of arguments return with the @code{rtd}
11722 instruction, which pops their arguments while returning.  This
11723 saves one instruction in the caller since there is no need to pop
11724 the arguments there.
11725
11726 This calling convention is incompatible with the one normally
11727 used on Unix, so you cannot use it if you need to call libraries
11728 compiled with the Unix compiler.
11729
11730 Also, you must provide function prototypes for all functions that
11731 take variable numbers of arguments (including @code{printf});
11732 otherwise incorrect code will be generated for calls to those
11733 functions.
11734
11735 In addition, seriously incorrect code will result if you call a
11736 function with too many arguments.  (Normally, extra arguments are
11737 harmlessly ignored.)
11738
11739 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
11740 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
11741
11742 @item -mno-rtd
11743 @opindex mno-rtd
11744 Do not use the calling conventions selected by @option{-mrtd}.
11745 This is the default.
11746
11747 @item -malign-int
11748 @itemx -mno-align-int
11749 @opindex malign-int
11750 @opindex mno-align-int
11751 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
11752 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
11753 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
11754 Aligning variables on 32-bit boundaries produces code that runs somewhat
11755 faster on processors with 32-bit busses at the expense of more memory.
11756
11757 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
11758 align structures containing the above types  differently than
11759 most published application binary interface specifications for the m68k.
11760
11761 @item -mpcrel
11762 @opindex mpcrel
11763 Use the pc-relative addressing mode of the 68000 directly, instead of
11764 using a global offset table.  At present, this option implies @option{-fpic},
11765 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
11766 not presently supported with @option{-mpcrel}, though this could be supported for
11767 68020 and higher processors.
11768
11769 @item -mno-strict-align
11770 @itemx -mstrict-align
11771 @opindex mno-strict-align
11772 @opindex mstrict-align
11773 Do not (do) assume that unaligned memory references will be handled by
11774 the system.
11775
11776 @item -msep-data
11777 Generate code that allows the data segment to be located in a different
11778 area of memory from the text segment.  This allows for execute in place in
11779 an environment without virtual memory management.  This option implies
11780 @option{-fPIC}.
11781
11782 @item -mno-sep-data
11783 Generate code that assumes that the data segment follows the text segment.
11784 This is the default.
11785
11786 @item -mid-shared-library
11787 Generate code that supports shared libraries via the library ID method.
11788 This allows for execute in place and shared libraries in an environment
11789 without virtual memory management.  This option implies @option{-fPIC}.
11790
11791 @item -mno-id-shared-library
11792 Generate code that doesn't assume ID based shared libraries are being used.
11793 This is the default.
11794
11795 @item -mshared-library-id=n
11796 Specified the identification number of the ID based shared library being
11797 compiled.  Specifying a value of 0 will generate more compact code, specifying
11798 other values will force the allocation of that number to the current
11799 library but is no more space or time efficient than omitting this option.
11800
11801 @item -mxgot
11802 @itemx -mno-xgot
11803 @opindex mxgot
11804 @opindex mno-xgot
11805 When generating position-independent code for ColdFire, generate code
11806 that works if the GOT has more than 8192 entries.  This code is
11807 larger and slower than code generated without this option.  On M680x0
11808 processors, this option is not needed; @option{-fPIC} suffices.
11809
11810 GCC normally uses a single instruction to load values from the GOT@.
11811 While this is relatively efficient, it only works if the GOT
11812 is smaller than about 64k.  Anything larger causes the linker
11813 to report an error such as:
11814
11815 @cindex relocation truncated to fit (ColdFire)
11816 @smallexample
11817 relocation truncated to fit: R_68K_GOT16O foobar
11818 @end smallexample
11819
11820 If this happens, you should recompile your code with @option{-mxgot}.
11821 It should then work with very large GOTs.  However, code generated with
11822 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
11823 the value of a global symbol.
11824
11825 Note that some linkers, including newer versions of the GNU linker,
11826 can create multiple GOTs and sort GOT entries.  If you have such a linker,
11827 you should only need to use @option{-mxgot} when compiling a single
11828 object file that accesses more than 8192 GOT entries.  Very few do.
11829
11830 These options have no effect unless GCC is generating
11831 position-independent code.
11832
11833 @end table
11834
11835 @node M68hc1x Options
11836 @subsection M68hc1x Options
11837 @cindex M68hc1x options
11838
11839 These are the @samp{-m} options defined for the 68hc11 and 68hc12
11840 microcontrollers.  The default values for these options depends on
11841 which style of microcontroller was selected when the compiler was configured;
11842 the defaults for the most common choices are given below.
11843
11844 @table @gcctabopt
11845 @item -m6811
11846 @itemx -m68hc11
11847 @opindex m6811
11848 @opindex m68hc11
11849 Generate output for a 68HC11.  This is the default
11850 when the compiler is configured for 68HC11-based systems.
11851
11852 @item -m6812
11853 @itemx -m68hc12
11854 @opindex m6812
11855 @opindex m68hc12
11856 Generate output for a 68HC12.  This is the default
11857 when the compiler is configured for 68HC12-based systems.
11858
11859 @item -m68S12
11860 @itemx -m68hcs12
11861 @opindex m68S12
11862 @opindex m68hcs12
11863 Generate output for a 68HCS12.
11864
11865 @item -mauto-incdec
11866 @opindex mauto-incdec
11867 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
11868 addressing modes.
11869
11870 @item -minmax
11871 @itemx -nominmax
11872 @opindex minmax
11873 @opindex mnominmax
11874 Enable the use of 68HC12 min and max instructions.
11875
11876 @item -mlong-calls
11877 @itemx -mno-long-calls
11878 @opindex mlong-calls
11879 @opindex mno-long-calls
11880 Treat all calls as being far away (near).  If calls are assumed to be
11881 far away, the compiler will use the @code{call} instruction to
11882 call a function and the @code{rtc} instruction for returning.
11883
11884 @item -mshort
11885 @opindex mshort
11886 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11887
11888 @item -msoft-reg-count=@var{count}
11889 @opindex msoft-reg-count
11890 Specify the number of pseudo-soft registers which are used for the
11891 code generation.  The maximum number is 32.  Using more pseudo-soft
11892 register may or may not result in better code depending on the program.
11893 The default is 4 for 68HC11 and 2 for 68HC12.
11894
11895 @end table
11896
11897 @node MCore Options
11898 @subsection MCore Options
11899 @cindex MCore options
11900
11901 These are the @samp{-m} options defined for the Motorola M*Core
11902 processors.
11903
11904 @table @gcctabopt
11905
11906 @item -mhardlit
11907 @itemx -mno-hardlit
11908 @opindex mhardlit
11909 @opindex mno-hardlit
11910 Inline constants into the code stream if it can be done in two
11911 instructions or less.
11912
11913 @item -mdiv
11914 @itemx -mno-div
11915 @opindex mdiv
11916 @opindex mno-div
11917 Use the divide instruction.  (Enabled by default).
11918
11919 @item -mrelax-immediate
11920 @itemx -mno-relax-immediate
11921 @opindex mrelax-immediate
11922 @opindex mno-relax-immediate
11923 Allow arbitrary sized immediates in bit operations.
11924
11925 @item -mwide-bitfields
11926 @itemx -mno-wide-bitfields
11927 @opindex mwide-bitfields
11928 @opindex mno-wide-bitfields
11929 Always treat bit-fields as int-sized.
11930
11931 @item -m4byte-functions
11932 @itemx -mno-4byte-functions
11933 @opindex m4byte-functions
11934 @opindex mno-4byte-functions
11935 Force all functions to be aligned to a four byte boundary.
11936
11937 @item -mcallgraph-data
11938 @itemx -mno-callgraph-data
11939 @opindex mcallgraph-data
11940 @opindex mno-callgraph-data
11941 Emit callgraph information.
11942
11943 @item -mslow-bytes
11944 @itemx -mno-slow-bytes
11945 @opindex mslow-bytes
11946 @opindex mno-slow-bytes
11947 Prefer word access when reading byte quantities.
11948
11949 @item -mlittle-endian
11950 @itemx -mbig-endian
11951 @opindex mlittle-endian
11952 @opindex mbig-endian
11953 Generate code for a little endian target.
11954
11955 @item -m210
11956 @itemx -m340
11957 @opindex m210
11958 @opindex m340
11959 Generate code for the 210 processor.
11960 @end table
11961
11962 @node MIPS Options
11963 @subsection MIPS Options
11964 @cindex MIPS options
11965
11966 @table @gcctabopt
11967
11968 @item -EB
11969 @opindex EB
11970 Generate big-endian code.
11971
11972 @item -EL
11973 @opindex EL
11974 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
11975 configurations.
11976
11977 @item -march=@var{arch}
11978 @opindex march
11979 Generate code that will run on @var{arch}, which can be the name of a
11980 generic MIPS ISA, or the name of a particular processor.
11981 The ISA names are:
11982 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
11983 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
11984 The processor names are:
11985 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
11986 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
11987 @samp{5kc}, @samp{5kf},
11988 @samp{20kc},
11989 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
11990 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
11991 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
11992 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
11993 @samp{loongson2e}, @samp{loongson2f},
11994 @samp{m4k},
11995 @samp{orion},
11996 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
11997 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
11998 @samp{rm7000}, @samp{rm9000},
11999 @samp{sb1},
12000 @samp{sr71000},
12001 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
12002 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
12003 and @samp{xlr}.
12004 The special value @samp{from-abi} selects the
12005 most compatible architecture for the selected ABI (that is,
12006 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
12007
12008 Native Linux/GNU toolchains also support the value @samp{native},
12009 which selects the best architecture option for the host processor.
12010 @option{-march=native} has no effect if GCC does not recognize
12011 the processor.
12012
12013 In processor names, a final @samp{000} can be abbreviated as @samp{k}
12014 (for example, @samp{-march=r2k}).  Prefixes are optional, and
12015 @samp{vr} may be written @samp{r}.
12016
12017 Names of the form @samp{@var{n}f2_1} refer to processors with
12018 FPUs clocked at half the rate of the core, names of the form
12019 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
12020 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
12021 processors with FPUs clocked a ratio of 3:2 with respect to the core.
12022 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
12023 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
12024 accepted as synonyms for @samp{@var{n}f1_1}.
12025
12026 GCC defines two macros based on the value of this option.  The first
12027 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
12028 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
12029 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
12030 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
12031 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
12032
12033 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
12034 above.  In other words, it will have the full prefix and will not
12035 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
12036 the macro names the resolved architecture (either @samp{"mips1"} or
12037 @samp{"mips3"}).  It names the default architecture when no
12038 @option{-march} option is given.
12039
12040 @item -mtune=@var{arch}
12041 @opindex mtune
12042 Optimize for @var{arch}.  Among other things, this option controls
12043 the way instructions are scheduled, and the perceived cost of arithmetic
12044 operations.  The list of @var{arch} values is the same as for
12045 @option{-march}.
12046
12047 When this option is not used, GCC will optimize for the processor
12048 specified by @option{-march}.  By using @option{-march} and
12049 @option{-mtune} together, it is possible to generate code that will
12050 run on a family of processors, but optimize the code for one
12051 particular member of that family.
12052
12053 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
12054 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
12055 @samp{-march} ones described above.
12056
12057 @item -mips1
12058 @opindex mips1
12059 Equivalent to @samp{-march=mips1}.
12060
12061 @item -mips2
12062 @opindex mips2
12063 Equivalent to @samp{-march=mips2}.
12064
12065 @item -mips3
12066 @opindex mips3
12067 Equivalent to @samp{-march=mips3}.
12068
12069 @item -mips4
12070 @opindex mips4
12071 Equivalent to @samp{-march=mips4}.
12072
12073 @item -mips32
12074 @opindex mips32
12075 Equivalent to @samp{-march=mips32}.
12076
12077 @item -mips32r2
12078 @opindex mips32r2
12079 Equivalent to @samp{-march=mips32r2}.
12080
12081 @item -mips64
12082 @opindex mips64
12083 Equivalent to @samp{-march=mips64}.
12084
12085 @item -mips16
12086 @itemx -mno-mips16
12087 @opindex mips16
12088 @opindex mno-mips16
12089 Generate (do not generate) MIPS16 code.  If GCC is targetting a
12090 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
12091
12092 MIPS16 code generation can also be controlled on a per-function basis
12093 by means of @code{mips16} and @code{nomips16} attributes.  
12094 @xref{Function Attributes}, for more information.
12095
12096 @item -mflip-mips16
12097 @opindex mflip-mips16
12098 Generate MIPS16 code on alternating functions.  This option is provided
12099 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
12100 not intended for ordinary use in compiling user code.
12101
12102 @item -minterlink-mips16
12103 @itemx -mno-interlink-mips16
12104 @opindex minterlink-mips16
12105 @opindex mno-interlink-mips16
12106 Require (do not require) that non-MIPS16 code be link-compatible with
12107 MIPS16 code.
12108
12109 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
12110 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
12111 therefore disables direct jumps unless GCC knows that the target of the
12112 jump is not MIPS16.
12113
12114 @item -mabi=32
12115 @itemx -mabi=o64
12116 @itemx -mabi=n32
12117 @itemx -mabi=64
12118 @itemx -mabi=eabi
12119 @opindex mabi=32
12120 @opindex mabi=o64
12121 @opindex mabi=n32
12122 @opindex mabi=64
12123 @opindex mabi=eabi
12124 Generate code for the given ABI@.
12125
12126 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
12127 generates 64-bit code when you select a 64-bit architecture, but you
12128 can use @option{-mgp32} to get 32-bit code instead.
12129
12130 For information about the O64 ABI, see
12131 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
12132
12133 GCC supports a variant of the o32 ABI in which floating-point registers
12134 are 64 rather than 32 bits wide.  You can select this combination with
12135 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
12136 and @samp{mfhc1} instructions and is therefore only supported for
12137 MIPS32R2 processors.
12138
12139 The register assignments for arguments and return values remain the
12140 same, but each scalar value is passed in a single 64-bit register
12141 rather than a pair of 32-bit registers.  For example, scalar
12142 floating-point values are returned in @samp{$f0} only, not a
12143 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
12144 remains the same, but all 64 bits are saved.
12145
12146 @item -mabicalls
12147 @itemx -mno-abicalls
12148 @opindex mabicalls
12149 @opindex mno-abicalls
12150 Generate (do not generate) code that is suitable for SVR4-style
12151 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
12152 systems.
12153
12154 @item -mshared
12155 @itemx -mno-shared
12156 Generate (do not generate) code that is fully position-independent,
12157 and that can therefore be linked into shared libraries.  This option
12158 only affects @option{-mabicalls}.
12159
12160 All @option{-mabicalls} code has traditionally been position-independent,
12161 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
12162 as an extension, the GNU toolchain allows executables to use absolute
12163 accesses for locally-binding symbols.  It can also use shorter GP
12164 initialization sequences and generate direct calls to locally-defined
12165 functions.  This mode is selected by @option{-mno-shared}.
12166
12167 @option{-mno-shared} depends on binutils 2.16 or higher and generates
12168 objects that can only be linked by the GNU linker.  However, the option
12169 does not affect the ABI of the final executable; it only affects the ABI
12170 of relocatable objects.  Using @option{-mno-shared} will generally make
12171 executables both smaller and quicker.
12172
12173 @option{-mshared} is the default.
12174
12175 @item -mxgot
12176 @itemx -mno-xgot
12177 @opindex mxgot
12178 @opindex mno-xgot
12179 Lift (do not lift) the usual restrictions on the size of the global
12180 offset table.
12181
12182 GCC normally uses a single instruction to load values from the GOT@.
12183 While this is relatively efficient, it will only work if the GOT
12184 is smaller than about 64k.  Anything larger will cause the linker
12185 to report an error such as:
12186
12187 @cindex relocation truncated to fit (MIPS)
12188 @smallexample
12189 relocation truncated to fit: R_MIPS_GOT16 foobar
12190 @end smallexample
12191
12192 If this happens, you should recompile your code with @option{-mxgot}.
12193 It should then work with very large GOTs, although it will also be
12194 less efficient, since it will take three instructions to fetch the
12195 value of a global symbol.
12196
12197 Note that some linkers can create multiple GOTs.  If you have such a
12198 linker, you should only need to use @option{-mxgot} when a single object
12199 file accesses more than 64k's worth of GOT entries.  Very few do.
12200
12201 These options have no effect unless GCC is generating position
12202 independent code.
12203
12204 @item -mgp32
12205 @opindex mgp32
12206 Assume that general-purpose registers are 32 bits wide.
12207
12208 @item -mgp64
12209 @opindex mgp64
12210 Assume that general-purpose registers are 64 bits wide.
12211
12212 @item -mfp32
12213 @opindex mfp32
12214 Assume that floating-point registers are 32 bits wide.
12215
12216 @item -mfp64
12217 @opindex mfp64
12218 Assume that floating-point registers are 64 bits wide.
12219
12220 @item -mhard-float
12221 @opindex mhard-float
12222 Use floating-point coprocessor instructions.
12223
12224 @item -msoft-float
12225 @opindex msoft-float
12226 Do not use floating-point coprocessor instructions.  Implement
12227 floating-point calculations using library calls instead.
12228
12229 @item -msingle-float
12230 @opindex msingle-float
12231 Assume that the floating-point coprocessor only supports single-precision
12232 operations.
12233
12234 @item -mdouble-float
12235 @opindex mdouble-float
12236 Assume that the floating-point coprocessor supports double-precision
12237 operations.  This is the default.
12238
12239 @item -mllsc
12240 @itemx -mno-llsc
12241 @opindex mllsc
12242 @opindex mno-llsc
12243 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
12244 implement atomic memory built-in functions.  When neither option is
12245 specified, GCC will use the instructions if the target architecture
12246 supports them.
12247
12248 @option{-mllsc} is useful if the runtime environment can emulate the
12249 instructions and @option{-mno-llsc} can be useful when compiling for
12250 nonstandard ISAs.  You can make either option the default by
12251 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
12252 respectively.  @option{--with-llsc} is the default for some
12253 configurations; see the installation documentation for details.
12254
12255 @item -mdsp
12256 @itemx -mno-dsp
12257 @opindex mdsp
12258 @opindex mno-dsp
12259 Use (do not use) revision 1 of the MIPS DSP ASE@.
12260 @xref{MIPS DSP Built-in Functions}.  This option defines the
12261 preprocessor macro @samp{__mips_dsp}.  It also defines
12262 @samp{__mips_dsp_rev} to 1.
12263
12264 @item -mdspr2
12265 @itemx -mno-dspr2
12266 @opindex mdspr2
12267 @opindex mno-dspr2
12268 Use (do not use) revision 2 of the MIPS DSP ASE@.
12269 @xref{MIPS DSP Built-in Functions}.  This option defines the
12270 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
12271 It also defines @samp{__mips_dsp_rev} to 2.
12272
12273 @item -msmartmips
12274 @itemx -mno-smartmips
12275 @opindex msmartmips
12276 @opindex mno-smartmips
12277 Use (do not use) the MIPS SmartMIPS ASE.
12278
12279 @item -mpaired-single
12280 @itemx -mno-paired-single
12281 @opindex mpaired-single
12282 @opindex mno-paired-single
12283 Use (do not use) paired-single floating-point instructions.
12284 @xref{MIPS Paired-Single Support}.  This option requires
12285 hardware floating-point support to be enabled.
12286
12287 @item -mdmx
12288 @itemx -mno-mdmx
12289 @opindex mdmx
12290 @opindex mno-mdmx
12291 Use (do not use) MIPS Digital Media Extension instructions.
12292 This option can only be used when generating 64-bit code and requires
12293 hardware floating-point support to be enabled.
12294
12295 @item -mips3d
12296 @itemx -mno-mips3d
12297 @opindex mips3d
12298 @opindex mno-mips3d
12299 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
12300 The option @option{-mips3d} implies @option{-mpaired-single}.
12301
12302 @item -mmt
12303 @itemx -mno-mt
12304 @opindex mmt
12305 @opindex mno-mt
12306 Use (do not use) MT Multithreading instructions.
12307
12308 @item -mlong64
12309 @opindex mlong64
12310 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
12311 an explanation of the default and the way that the pointer size is
12312 determined.
12313
12314 @item -mlong32
12315 @opindex mlong32
12316 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
12317
12318 The default size of @code{int}s, @code{long}s and pointers depends on
12319 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
12320 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
12321 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
12322 or the same size as integer registers, whichever is smaller.
12323
12324 @item -msym32
12325 @itemx -mno-sym32
12326 @opindex msym32
12327 @opindex mno-sym32
12328 Assume (do not assume) that all symbols have 32-bit values, regardless
12329 of the selected ABI@.  This option is useful in combination with
12330 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
12331 to generate shorter and faster references to symbolic addresses.
12332
12333 @item -G @var{num}
12334 @opindex G
12335 Put definitions of externally-visible data in a small data section
12336 if that data is no bigger than @var{num} bytes.  GCC can then access
12337 the data more efficiently; see @option{-mgpopt} for details.
12338
12339 The default @option{-G} option depends on the configuration.
12340
12341 @item -mlocal-sdata
12342 @itemx -mno-local-sdata
12343 @opindex mlocal-sdata
12344 @opindex mno-local-sdata
12345 Extend (do not extend) the @option{-G} behavior to local data too,
12346 such as to static variables in C@.  @option{-mlocal-sdata} is the
12347 default for all configurations.
12348
12349 If the linker complains that an application is using too much small data,
12350 you might want to try rebuilding the less performance-critical parts with
12351 @option{-mno-local-sdata}.  You might also want to build large
12352 libraries with @option{-mno-local-sdata}, so that the libraries leave
12353 more room for the main program.
12354
12355 @item -mextern-sdata
12356 @itemx -mno-extern-sdata
12357 @opindex mextern-sdata
12358 @opindex mno-extern-sdata
12359 Assume (do not assume) that externally-defined data will be in
12360 a small data section if that data is within the @option{-G} limit.
12361 @option{-mextern-sdata} is the default for all configurations.
12362
12363 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
12364 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
12365 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
12366 is placed in a small data section.  If @var{Var} is defined by another
12367 module, you must either compile that module with a high-enough
12368 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
12369 definition.  If @var{Var} is common, you must link the application
12370 with a high-enough @option{-G} setting.
12371
12372 The easiest way of satisfying these restrictions is to compile
12373 and link every module with the same @option{-G} option.  However,
12374 you may wish to build a library that supports several different
12375 small data limits.  You can do this by compiling the library with
12376 the highest supported @option{-G} setting and additionally using
12377 @option{-mno-extern-sdata} to stop the library from making assumptions
12378 about externally-defined data.
12379
12380 @item -mgpopt
12381 @itemx -mno-gpopt
12382 @opindex mgpopt
12383 @opindex mno-gpopt
12384 Use (do not use) GP-relative accesses for symbols that are known to be
12385 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
12386 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
12387 configurations.
12388
12389 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
12390 might not hold the value of @code{_gp}.  For example, if the code is
12391 part of a library that might be used in a boot monitor, programs that
12392 call boot monitor routines will pass an unknown value in @code{$gp}.
12393 (In such situations, the boot monitor itself would usually be compiled
12394 with @option{-G0}.)
12395
12396 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
12397 @option{-mno-extern-sdata}.
12398
12399 @item -membedded-data
12400 @itemx -mno-embedded-data
12401 @opindex membedded-data
12402 @opindex mno-embedded-data
12403 Allocate variables to the read-only data section first if possible, then
12404 next in the small data section if possible, otherwise in data.  This gives
12405 slightly slower code than the default, but reduces the amount of RAM required
12406 when executing, and thus may be preferred for some embedded systems.
12407
12408 @item -muninit-const-in-rodata
12409 @itemx -mno-uninit-const-in-rodata
12410 @opindex muninit-const-in-rodata
12411 @opindex mno-uninit-const-in-rodata
12412 Put uninitialized @code{const} variables in the read-only data section.
12413 This option is only meaningful in conjunction with @option{-membedded-data}.
12414
12415 @item -mcode-readable=@var{setting}
12416 @opindex mcode-readable
12417 Specify whether GCC may generate code that reads from executable sections.
12418 There are three possible settings:
12419
12420 @table @gcctabopt
12421 @item -mcode-readable=yes
12422 Instructions may freely access executable sections.  This is the
12423 default setting.
12424
12425 @item -mcode-readable=pcrel
12426 MIPS16 PC-relative load instructions can access executable sections,
12427 but other instructions must not do so.  This option is useful on 4KSc
12428 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
12429 It is also useful on processors that can be configured to have a dual
12430 instruction/data SRAM interface and that, like the M4K, automatically
12431 redirect PC-relative loads to the instruction RAM.
12432
12433 @item -mcode-readable=no
12434 Instructions must not access executable sections.  This option can be
12435 useful on targets that are configured to have a dual instruction/data
12436 SRAM interface but that (unlike the M4K) do not automatically redirect
12437 PC-relative loads to the instruction RAM.
12438 @end table
12439
12440 @item -msplit-addresses
12441 @itemx -mno-split-addresses
12442 @opindex msplit-addresses
12443 @opindex mno-split-addresses
12444 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
12445 relocation operators.  This option has been superseded by
12446 @option{-mexplicit-relocs} but is retained for backwards compatibility.
12447
12448 @item -mexplicit-relocs
12449 @itemx -mno-explicit-relocs
12450 @opindex mexplicit-relocs
12451 @opindex mno-explicit-relocs
12452 Use (do not use) assembler relocation operators when dealing with symbolic
12453 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
12454 is to use assembler macros instead.
12455
12456 @option{-mexplicit-relocs} is the default if GCC was configured
12457 to use an assembler that supports relocation operators.
12458
12459 @item -mcheck-zero-division
12460 @itemx -mno-check-zero-division
12461 @opindex mcheck-zero-division
12462 @opindex mno-check-zero-division
12463 Trap (do not trap) on integer division by zero.
12464
12465 The default is @option{-mcheck-zero-division}.
12466
12467 @item -mdivide-traps
12468 @itemx -mdivide-breaks
12469 @opindex mdivide-traps
12470 @opindex mdivide-breaks
12471 MIPS systems check for division by zero by generating either a
12472 conditional trap or a break instruction.  Using traps results in
12473 smaller code, but is only supported on MIPS II and later.  Also, some
12474 versions of the Linux kernel have a bug that prevents trap from
12475 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
12476 allow conditional traps on architectures that support them and
12477 @option{-mdivide-breaks} to force the use of breaks.
12478
12479 The default is usually @option{-mdivide-traps}, but this can be
12480 overridden at configure time using @option{--with-divide=breaks}.
12481 Divide-by-zero checks can be completely disabled using
12482 @option{-mno-check-zero-division}.
12483
12484 @item -mmemcpy
12485 @itemx -mno-memcpy
12486 @opindex mmemcpy
12487 @opindex mno-memcpy
12488 Force (do not force) the use of @code{memcpy()} for non-trivial block
12489 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
12490 most constant-sized copies.
12491
12492 @item -mlong-calls
12493 @itemx -mno-long-calls
12494 @opindex mlong-calls
12495 @opindex mno-long-calls
12496 Disable (do not disable) use of the @code{jal} instruction.  Calling
12497 functions using @code{jal} is more efficient but requires the caller
12498 and callee to be in the same 256 megabyte segment.
12499
12500 This option has no effect on abicalls code.  The default is
12501 @option{-mno-long-calls}.
12502
12503 @item -mmad
12504 @itemx -mno-mad
12505 @opindex mmad
12506 @opindex mno-mad
12507 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
12508 instructions, as provided by the R4650 ISA@.
12509
12510 @item -mfused-madd
12511 @itemx -mno-fused-madd
12512 @opindex mfused-madd
12513 @opindex mno-fused-madd
12514 Enable (disable) use of the floating point multiply-accumulate
12515 instructions, when they are available.  The default is
12516 @option{-mfused-madd}.
12517
12518 When multiply-accumulate instructions are used, the intermediate
12519 product is calculated to infinite precision and is not subject to
12520 the FCSR Flush to Zero bit.  This may be undesirable in some
12521 circumstances.
12522
12523 @item -nocpp
12524 @opindex nocpp
12525 Tell the MIPS assembler to not run its preprocessor over user
12526 assembler files (with a @samp{.s} suffix) when assembling them.
12527
12528 @item -mfix-r4000
12529 @itemx -mno-fix-r4000
12530 @opindex mfix-r4000
12531 @opindex mno-fix-r4000
12532 Work around certain R4000 CPU errata:
12533 @itemize @minus
12534 @item
12535 A double-word or a variable shift may give an incorrect result if executed
12536 immediately after starting an integer division.
12537 @item
12538 A double-word or a variable shift may give an incorrect result if executed
12539 while an integer multiplication is in progress.
12540 @item
12541 An integer division may give an incorrect result if started in a delay slot
12542 of a taken branch or a jump.
12543 @end itemize
12544
12545 @item -mfix-r4400
12546 @itemx -mno-fix-r4400
12547 @opindex mfix-r4400
12548 @opindex mno-fix-r4400
12549 Work around certain R4400 CPU errata:
12550 @itemize @minus
12551 @item
12552 A double-word or a variable shift may give an incorrect result if executed
12553 immediately after starting an integer division.
12554 @end itemize
12555
12556 @item -mfix-vr4120
12557 @itemx -mno-fix-vr4120
12558 @opindex mfix-vr4120
12559 Work around certain VR4120 errata:
12560 @itemize @minus
12561 @item
12562 @code{dmultu} does not always produce the correct result.
12563 @item
12564 @code{div} and @code{ddiv} do not always produce the correct result if one
12565 of the operands is negative.
12566 @end itemize
12567 The workarounds for the division errata rely on special functions in
12568 @file{libgcc.a}.  At present, these functions are only provided by
12569 the @code{mips64vr*-elf} configurations.
12570
12571 Other VR4120 errata require a nop to be inserted between certain pairs of
12572 instructions.  These errata are handled by the assembler, not by GCC itself.
12573
12574 @item -mfix-vr4130
12575 @opindex mfix-vr4130
12576 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
12577 workarounds are implemented by the assembler rather than by GCC,
12578 although GCC will avoid using @code{mflo} and @code{mfhi} if the
12579 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
12580 instructions are available instead.
12581
12582 @item -mfix-sb1
12583 @itemx -mno-fix-sb1
12584 @opindex mfix-sb1
12585 Work around certain SB-1 CPU core errata.
12586 (This flag currently works around the SB-1 revision 2
12587 ``F1'' and ``F2'' floating point errata.)
12588
12589 @item -mflush-func=@var{func}
12590 @itemx -mno-flush-func
12591 @opindex mflush-func
12592 Specifies the function to call to flush the I and D caches, or to not
12593 call any such function.  If called, the function must take the same
12594 arguments as the common @code{_flush_func()}, that is, the address of the
12595 memory range for which the cache is being flushed, the size of the
12596 memory range, and the number 3 (to flush both caches).  The default
12597 depends on the target GCC was configured for, but commonly is either
12598 @samp{_flush_func} or @samp{__cpu_flush}.
12599
12600 @item mbranch-cost=@var{num}
12601 @opindex mbranch-cost
12602 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12603 This cost is only a heuristic and is not guaranteed to produce
12604 consistent results across releases.  A zero cost redundantly selects
12605 the default, which is based on the @option{-mtune} setting.
12606
12607 @item -mbranch-likely
12608 @itemx -mno-branch-likely
12609 @opindex mbranch-likely
12610 @opindex mno-branch-likely
12611 Enable or disable use of Branch Likely instructions, regardless of the
12612 default for the selected architecture.  By default, Branch Likely
12613 instructions may be generated if they are supported by the selected
12614 architecture.  An exception is for the MIPS32 and MIPS64 architectures
12615 and processors which implement those architectures; for those, Branch
12616 Likely instructions will not be generated by default because the MIPS32
12617 and MIPS64 architectures specifically deprecate their use.
12618
12619 @item -mfp-exceptions
12620 @itemx -mno-fp-exceptions
12621 @opindex mfp-exceptions
12622 Specifies whether FP exceptions are enabled.  This affects how we schedule
12623 FP instructions for some processors.  The default is that FP exceptions are
12624 enabled.
12625
12626 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
12627 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
12628 FP pipe.
12629
12630 @item -mvr4130-align
12631 @itemx -mno-vr4130-align
12632 @opindex mvr4130-align
12633 The VR4130 pipeline is two-way superscalar, but can only issue two
12634 instructions together if the first one is 8-byte aligned.  When this
12635 option is enabled, GCC will align pairs of instructions that it
12636 thinks should execute in parallel.
12637
12638 This option only has an effect when optimizing for the VR4130.
12639 It normally makes code faster, but at the expense of making it bigger.
12640 It is enabled by default at optimization level @option{-O3}.
12641 @end table
12642
12643 @node MMIX Options
12644 @subsection MMIX Options
12645 @cindex MMIX Options
12646
12647 These options are defined for the MMIX:
12648
12649 @table @gcctabopt
12650 @item -mlibfuncs
12651 @itemx -mno-libfuncs
12652 @opindex mlibfuncs
12653 @opindex mno-libfuncs
12654 Specify that intrinsic library functions are being compiled, passing all
12655 values in registers, no matter the size.
12656
12657 @item -mepsilon
12658 @itemx -mno-epsilon
12659 @opindex mepsilon
12660 @opindex mno-epsilon
12661 Generate floating-point comparison instructions that compare with respect
12662 to the @code{rE} epsilon register.
12663
12664 @item -mabi=mmixware
12665 @itemx -mabi=gnu
12666 @opindex mabi-mmixware
12667 @opindex mabi=gnu
12668 Generate code that passes function parameters and return values that (in
12669 the called function) are seen as registers @code{$0} and up, as opposed to
12670 the GNU ABI which uses global registers @code{$231} and up.
12671
12672 @item -mzero-extend
12673 @itemx -mno-zero-extend
12674 @opindex mzero-extend
12675 @opindex mno-zero-extend
12676 When reading data from memory in sizes shorter than 64 bits, use (do not
12677 use) zero-extending load instructions by default, rather than
12678 sign-extending ones.
12679
12680 @item -mknuthdiv
12681 @itemx -mno-knuthdiv
12682 @opindex mknuthdiv
12683 @opindex mno-knuthdiv
12684 Make the result of a division yielding a remainder have the same sign as
12685 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
12686 remainder follows the sign of the dividend.  Both methods are
12687 arithmetically valid, the latter being almost exclusively used.
12688
12689 @item -mtoplevel-symbols
12690 @itemx -mno-toplevel-symbols
12691 @opindex mtoplevel-symbols
12692 @opindex mno-toplevel-symbols
12693 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
12694 code can be used with the @code{PREFIX} assembly directive.
12695
12696 @item -melf
12697 @opindex melf
12698 Generate an executable in the ELF format, rather than the default
12699 @samp{mmo} format used by the @command{mmix} simulator.
12700
12701 @item -mbranch-predict
12702 @itemx -mno-branch-predict
12703 @opindex mbranch-predict
12704 @opindex mno-branch-predict
12705 Use (do not use) the probable-branch instructions, when static branch
12706 prediction indicates a probable branch.
12707
12708 @item -mbase-addresses
12709 @itemx -mno-base-addresses
12710 @opindex mbase-addresses
12711 @opindex mno-base-addresses
12712 Generate (do not generate) code that uses @emph{base addresses}.  Using a
12713 base address automatically generates a request (handled by the assembler
12714 and the linker) for a constant to be set up in a global register.  The
12715 register is used for one or more base address requests within the range 0
12716 to 255 from the value held in the register.  The generally leads to short
12717 and fast code, but the number of different data items that can be
12718 addressed is limited.  This means that a program that uses lots of static
12719 data may require @option{-mno-base-addresses}.
12720
12721 @item -msingle-exit
12722 @itemx -mno-single-exit
12723 @opindex msingle-exit
12724 @opindex mno-single-exit
12725 Force (do not force) generated code to have a single exit point in each
12726 function.
12727 @end table
12728
12729 @node MN10300 Options
12730 @subsection MN10300 Options
12731 @cindex MN10300 options
12732
12733 These @option{-m} options are defined for Matsushita MN10300 architectures:
12734
12735 @table @gcctabopt
12736 @item -mmult-bug
12737 @opindex mmult-bug
12738 Generate code to avoid bugs in the multiply instructions for the MN10300
12739 processors.  This is the default.
12740
12741 @item -mno-mult-bug
12742 @opindex mno-mult-bug
12743 Do not generate code to avoid bugs in the multiply instructions for the
12744 MN10300 processors.
12745
12746 @item -mam33
12747 @opindex mam33
12748 Generate code which uses features specific to the AM33 processor.
12749
12750 @item -mno-am33
12751 @opindex mno-am33
12752 Do not generate code which uses features specific to the AM33 processor.  This
12753 is the default.
12754
12755 @item -mreturn-pointer-on-d0
12756 @opindex mreturn-pointer-on-d0
12757 When generating a function which returns a pointer, return the pointer
12758 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
12759 only in a0, and attempts to call such functions without a prototype
12760 would result in errors.  Note that this option is on by default; use
12761 @option{-mno-return-pointer-on-d0} to disable it.
12762
12763 @item -mno-crt0
12764 @opindex mno-crt0
12765 Do not link in the C run-time initialization object file.
12766
12767 @item -mrelax
12768 @opindex mrelax
12769 Indicate to the linker that it should perform a relaxation optimization pass
12770 to shorten branches, calls and absolute memory addresses.  This option only
12771 has an effect when used on the command line for the final link step.
12772
12773 This option makes symbolic debugging impossible.
12774 @end table
12775
12776 @node PDP-11 Options
12777 @subsection PDP-11 Options
12778 @cindex PDP-11 Options
12779
12780 These options are defined for the PDP-11:
12781
12782 @table @gcctabopt
12783 @item -mfpu
12784 @opindex mfpu
12785 Use hardware FPP floating point.  This is the default.  (FIS floating
12786 point on the PDP-11/40 is not supported.)
12787
12788 @item -msoft-float
12789 @opindex msoft-float
12790 Do not use hardware floating point.
12791
12792 @item -mac0
12793 @opindex mac0
12794 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
12795
12796 @item -mno-ac0
12797 @opindex mno-ac0
12798 Return floating-point results in memory.  This is the default.
12799
12800 @item -m40
12801 @opindex m40
12802 Generate code for a PDP-11/40.
12803
12804 @item -m45
12805 @opindex m45
12806 Generate code for a PDP-11/45.  This is the default.
12807
12808 @item -m10
12809 @opindex m10
12810 Generate code for a PDP-11/10.
12811
12812 @item -mbcopy-builtin
12813 @opindex bcopy-builtin
12814 Use inline @code{movmemhi} patterns for copying memory.  This is the
12815 default.
12816
12817 @item -mbcopy
12818 @opindex mbcopy
12819 Do not use inline @code{movmemhi} patterns for copying memory.
12820
12821 @item -mint16
12822 @itemx -mno-int32
12823 @opindex mint16
12824 @opindex mno-int32
12825 Use 16-bit @code{int}.  This is the default.
12826
12827 @item -mint32
12828 @itemx -mno-int16
12829 @opindex mint32
12830 @opindex mno-int16
12831 Use 32-bit @code{int}.
12832
12833 @item -mfloat64
12834 @itemx -mno-float32
12835 @opindex mfloat64
12836 @opindex mno-float32
12837 Use 64-bit @code{float}.  This is the default.
12838
12839 @item -mfloat32
12840 @itemx -mno-float64
12841 @opindex mfloat32
12842 @opindex mno-float64
12843 Use 32-bit @code{float}.
12844
12845 @item -mabshi
12846 @opindex mabshi
12847 Use @code{abshi2} pattern.  This is the default.
12848
12849 @item -mno-abshi
12850 @opindex mno-abshi
12851 Do not use @code{abshi2} pattern.
12852
12853 @item -mbranch-expensive
12854 @opindex mbranch-expensive
12855 Pretend that branches are expensive.  This is for experimenting with
12856 code generation only.
12857
12858 @item -mbranch-cheap
12859 @opindex mbranch-cheap
12860 Do not pretend that branches are expensive.  This is the default.
12861
12862 @item -msplit
12863 @opindex msplit
12864 Generate code for a system with split I&D@.
12865
12866 @item -mno-split
12867 @opindex mno-split
12868 Generate code for a system without split I&D@.  This is the default.
12869
12870 @item -munix-asm
12871 @opindex munix-asm
12872 Use Unix assembler syntax.  This is the default when configured for
12873 @samp{pdp11-*-bsd}.
12874
12875 @item -mdec-asm
12876 @opindex mdec-asm
12877 Use DEC assembler syntax.  This is the default when configured for any
12878 PDP-11 target other than @samp{pdp11-*-bsd}.
12879 @end table
12880
12881 @node PowerPC Options
12882 @subsection PowerPC Options
12883 @cindex PowerPC options
12884
12885 These are listed under @xref{RS/6000 and PowerPC Options}.
12886
12887 @node RS/6000 and PowerPC Options
12888 @subsection IBM RS/6000 and PowerPC Options
12889 @cindex RS/6000 and PowerPC Options
12890 @cindex IBM RS/6000 and PowerPC Options
12891
12892 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
12893 @table @gcctabopt
12894 @item -mpower
12895 @itemx -mno-power
12896 @itemx -mpower2
12897 @itemx -mno-power2
12898 @itemx -mpowerpc
12899 @itemx -mno-powerpc
12900 @itemx -mpowerpc-gpopt
12901 @itemx -mno-powerpc-gpopt
12902 @itemx -mpowerpc-gfxopt
12903 @itemx -mno-powerpc-gfxopt
12904 @itemx -mpowerpc64
12905 @itemx -mno-powerpc64
12906 @itemx -mmfcrf
12907 @itemx -mno-mfcrf
12908 @itemx -mpopcntb
12909 @itemx -mno-popcntb
12910 @itemx -mfprnd
12911 @itemx -mno-fprnd
12912 @itemx -mcmpb
12913 @itemx -mno-cmpb
12914 @itemx -mmfpgpr
12915 @itemx -mno-mfpgpr
12916 @itemx -mhard-dfp
12917 @itemx -mno-hard-dfp
12918 @opindex mpower
12919 @opindex mno-power
12920 @opindex mpower2
12921 @opindex mno-power2
12922 @opindex mpowerpc
12923 @opindex mno-powerpc
12924 @opindex mpowerpc-gpopt
12925 @opindex mno-powerpc-gpopt
12926 @opindex mpowerpc-gfxopt
12927 @opindex mno-powerpc-gfxopt
12928 @opindex mpowerpc64
12929 @opindex mno-powerpc64
12930 @opindex mmfcrf
12931 @opindex mno-mfcrf
12932 @opindex mpopcntb
12933 @opindex mno-popcntb
12934 @opindex mfprnd
12935 @opindex mno-fprnd
12936 @opindex mcmpb
12937 @opindex mno-cmpb
12938 @opindex mmfpgpr
12939 @opindex mno-mfpgpr
12940 @opindex mhard-dfp
12941 @opindex mno-hard-dfp
12942 GCC supports two related instruction set architectures for the
12943 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
12944 instructions supported by the @samp{rios} chip set used in the original
12945 RS/6000 systems and the @dfn{PowerPC} instruction set is the
12946 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
12947 the IBM 4xx, 6xx, and follow-on microprocessors.
12948
12949 Neither architecture is a subset of the other.  However there is a
12950 large common subset of instructions supported by both.  An MQ
12951 register is included in processors supporting the POWER architecture.
12952
12953 You use these options to specify which instructions are available on the
12954 processor you are using.  The default value of these options is
12955 determined when configuring GCC@.  Specifying the
12956 @option{-mcpu=@var{cpu_type}} overrides the specification of these
12957 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
12958 rather than the options listed above.
12959
12960 The @option{-mpower} option allows GCC to generate instructions that
12961 are found only in the POWER architecture and to use the MQ register.
12962 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
12963 to generate instructions that are present in the POWER2 architecture but
12964 not the original POWER architecture.
12965
12966 The @option{-mpowerpc} option allows GCC to generate instructions that
12967 are found only in the 32-bit subset of the PowerPC architecture.
12968 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
12969 GCC to use the optional PowerPC architecture instructions in the
12970 General Purpose group, including floating-point square root.  Specifying
12971 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
12972 use the optional PowerPC architecture instructions in the Graphics
12973 group, including floating-point select.
12974
12975 The @option{-mmfcrf} option allows GCC to generate the move from
12976 condition register field instruction implemented on the POWER4
12977 processor and other processors that support the PowerPC V2.01
12978 architecture.
12979 The @option{-mpopcntb} option allows GCC to generate the popcount and
12980 double precision FP reciprocal estimate instruction implemented on the
12981 POWER5 processor and other processors that support the PowerPC V2.02
12982 architecture.
12983 The @option{-mfprnd} option allows GCC to generate the FP round to
12984 integer instructions implemented on the POWER5+ processor and other
12985 processors that support the PowerPC V2.03 architecture.
12986 The @option{-mcmpb} option allows GCC to generate the compare bytes
12987 instruction implemented on the POWER6 processor and other processors
12988 that support the PowerPC V2.05 architecture.
12989 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
12990 general purpose register instructions implemented on the POWER6X
12991 processor and other processors that support the extended PowerPC V2.05
12992 architecture.
12993 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
12994 point instructions implemented on some POWER processors.
12995
12996 The @option{-mpowerpc64} option allows GCC to generate the additional
12997 64-bit instructions that are found in the full PowerPC64 architecture
12998 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
12999 @option{-mno-powerpc64}.
13000
13001 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
13002 will use only the instructions in the common subset of both
13003 architectures plus some special AIX common-mode calls, and will not use
13004 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
13005 permits GCC to use any instruction from either architecture and to
13006 allow use of the MQ register; specify this for the Motorola MPC601.
13007
13008 @item -mnew-mnemonics
13009 @itemx -mold-mnemonics
13010 @opindex mnew-mnemonics
13011 @opindex mold-mnemonics
13012 Select which mnemonics to use in the generated assembler code.  With
13013 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
13014 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
13015 assembler mnemonics defined for the POWER architecture.  Instructions
13016 defined in only one architecture have only one mnemonic; GCC uses that
13017 mnemonic irrespective of which of these options is specified.
13018
13019 GCC defaults to the mnemonics appropriate for the architecture in
13020 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
13021 value of these option.  Unless you are building a cross-compiler, you
13022 should normally not specify either @option{-mnew-mnemonics} or
13023 @option{-mold-mnemonics}, but should instead accept the default.
13024
13025 @item -mcpu=@var{cpu_type}
13026 @opindex mcpu
13027 Set architecture type, register usage, choice of mnemonics, and
13028 instruction scheduling parameters for machine type @var{cpu_type}.
13029 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
13030 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
13031 @samp{505}, @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
13032 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
13033 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
13034 @samp{860}, @samp{970}, @samp{8540}, @samp{e300c2}, @samp{e300c3},
13035 @samp{e500mc}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
13036 @samp{power}, @samp{power2}, @samp{power3}, @samp{power4},
13037 @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
13038 @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
13039 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
13040
13041 @option{-mcpu=common} selects a completely generic processor.  Code
13042 generated under this option will run on any POWER or PowerPC processor.
13043 GCC will use only the instructions in the common subset of both
13044 architectures, and will not use the MQ register.  GCC assumes a generic
13045 processor model for scheduling purposes.
13046
13047 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
13048 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
13049 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
13050 types, with an appropriate, generic processor model assumed for
13051 scheduling purposes.
13052
13053 The other options specify a specific processor.  Code generated under
13054 those options will run best on that processor, and may not run at all on
13055 others.
13056
13057 The @option{-mcpu} options automatically enable or disable the
13058 following options:
13059
13060 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
13061 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
13062 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
13063
13064 The particular options set for any particular CPU will vary between
13065 compiler versions, depending on what setting seems to produce optimal
13066 code for that CPU; it doesn't necessarily reflect the actual hardware's
13067 capabilities.  If you wish to set an individual option to a particular
13068 value, you may specify it after the @option{-mcpu} option, like
13069 @samp{-mcpu=970 -mno-altivec}.
13070
13071 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
13072 not enabled or disabled by the @option{-mcpu} option at present because
13073 AIX does not have full support for these options.  You may still
13074 enable or disable them individually if you're sure it'll work in your
13075 environment.
13076
13077 @item -mtune=@var{cpu_type}
13078 @opindex mtune
13079 Set the instruction scheduling parameters for machine type
13080 @var{cpu_type}, but do not set the architecture type, register usage, or
13081 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
13082 values for @var{cpu_type} are used for @option{-mtune} as for
13083 @option{-mcpu}.  If both are specified, the code generated will use the
13084 architecture, registers, and mnemonics set by @option{-mcpu}, but the
13085 scheduling parameters set by @option{-mtune}.
13086
13087 @item -mswdiv
13088 @itemx -mno-swdiv
13089 @opindex mswdiv
13090 @opindex mno-swdiv
13091 Generate code to compute division as reciprocal estimate and iterative
13092 refinement, creating opportunities for increased throughput.  This
13093 feature requires: optional PowerPC Graphics instruction set for single
13094 precision and FRE instruction for double precision, assuming divides
13095 cannot generate user-visible traps, and the domain values not include
13096 Infinities, denormals or zero denominator.
13097
13098 @item -maltivec
13099 @itemx -mno-altivec
13100 @opindex maltivec
13101 @opindex mno-altivec
13102 Generate code that uses (does not use) AltiVec instructions, and also
13103 enable the use of built-in functions that allow more direct access to
13104 the AltiVec instruction set.  You may also need to set
13105 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
13106 enhancements.
13107
13108 @item -mvrsave
13109 @itemx -mno-vrsave
13110 @opindex mvrsave
13111 @opindex mno-vrsave
13112 Generate VRSAVE instructions when generating AltiVec code.
13113
13114 @item -msecure-plt
13115 @opindex msecure-plt
13116 Generate code that allows ld and ld.so to build executables and shared
13117 libraries with non-exec .plt and .got sections.  This is a PowerPC
13118 32-bit SYSV ABI option.
13119
13120 @item -mbss-plt
13121 @opindex mbss-plt
13122 Generate code that uses a BSS .plt section that ld.so fills in, and
13123 requires .plt and .got sections that are both writable and executable.
13124 This is a PowerPC 32-bit SYSV ABI option.
13125
13126 @item -misel
13127 @itemx -mno-isel
13128 @opindex misel
13129 @opindex mno-isel
13130 This switch enables or disables the generation of ISEL instructions.
13131
13132 @item -misel=@var{yes/no}
13133 This switch has been deprecated.  Use @option{-misel} and
13134 @option{-mno-isel} instead.
13135
13136 @item -mspe
13137 @itemx -mno-spe
13138 @opindex mspe
13139 @opindex mno-spe
13140 This switch enables or disables the generation of SPE simd
13141 instructions.
13142
13143 @item -mpaired
13144 @itemx -mno-paired
13145 @opindex mpaired
13146 @opindex mno-paired
13147 This switch enables or disables the generation of PAIRED simd
13148 instructions.
13149
13150 @item -mspe=@var{yes/no}
13151 This option has been deprecated.  Use @option{-mspe} and
13152 @option{-mno-spe} instead.
13153
13154 @item -mfloat-gprs=@var{yes/single/double/no}
13155 @itemx -mfloat-gprs
13156 @opindex mfloat-gprs
13157 This switch enables or disables the generation of floating point
13158 operations on the general purpose registers for architectures that
13159 support it.
13160
13161 The argument @var{yes} or @var{single} enables the use of
13162 single-precision floating point operations.
13163
13164 The argument @var{double} enables the use of single and
13165 double-precision floating point operations.
13166
13167 The argument @var{no} disables floating point operations on the
13168 general purpose registers.
13169
13170 This option is currently only available on the MPC854x.
13171
13172 @item -m32
13173 @itemx -m64
13174 @opindex m32
13175 @opindex m64
13176 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
13177 targets (including GNU/Linux).  The 32-bit environment sets int, long
13178 and pointer to 32 bits and generates code that runs on any PowerPC
13179 variant.  The 64-bit environment sets int to 32 bits and long and
13180 pointer to 64 bits, and generates code for PowerPC64, as for
13181 @option{-mpowerpc64}.
13182
13183 @item -mfull-toc
13184 @itemx -mno-fp-in-toc
13185 @itemx -mno-sum-in-toc
13186 @itemx -mminimal-toc
13187 @opindex mfull-toc
13188 @opindex mno-fp-in-toc
13189 @opindex mno-sum-in-toc
13190 @opindex mminimal-toc
13191 Modify generation of the TOC (Table Of Contents), which is created for
13192 every executable file.  The @option{-mfull-toc} option is selected by
13193 default.  In that case, GCC will allocate at least one TOC entry for
13194 each unique non-automatic variable reference in your program.  GCC
13195 will also place floating-point constants in the TOC@.  However, only
13196 16,384 entries are available in the TOC@.
13197
13198 If you receive a linker error message that saying you have overflowed
13199 the available TOC space, you can reduce the amount of TOC space used
13200 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
13201 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
13202 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
13203 generate code to calculate the sum of an address and a constant at
13204 run-time instead of putting that sum into the TOC@.  You may specify one
13205 or both of these options.  Each causes GCC to produce very slightly
13206 slower and larger code at the expense of conserving TOC space.
13207
13208 If you still run out of space in the TOC even when you specify both of
13209 these options, specify @option{-mminimal-toc} instead.  This option causes
13210 GCC to make only one TOC entry for every file.  When you specify this
13211 option, GCC will produce code that is slower and larger but which
13212 uses extremely little TOC space.  You may wish to use this option
13213 only on files that contain less frequently executed code.
13214
13215 @item -maix64
13216 @itemx -maix32
13217 @opindex maix64
13218 @opindex maix32
13219 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
13220 @code{long} type, and the infrastructure needed to support them.
13221 Specifying @option{-maix64} implies @option{-mpowerpc64} and
13222 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
13223 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
13224
13225 @item -mxl-compat
13226 @itemx -mno-xl-compat
13227 @opindex mxl-compat
13228 @opindex mno-xl-compat
13229 Produce code that conforms more closely to IBM XL compiler semantics
13230 when using AIX-compatible ABI@.  Pass floating-point arguments to
13231 prototyped functions beyond the register save area (RSA) on the stack
13232 in addition to argument FPRs.  Do not assume that most significant
13233 double in 128-bit long double value is properly rounded when comparing
13234 values and converting to double.  Use XL symbol names for long double
13235 support routines.
13236
13237 The AIX calling convention was extended but not initially documented to
13238 handle an obscure K&R C case of calling a function that takes the
13239 address of its arguments with fewer arguments than declared.  IBM XL
13240 compilers access floating point arguments which do not fit in the
13241 RSA from the stack when a subroutine is compiled without
13242 optimization.  Because always storing floating-point arguments on the
13243 stack is inefficient and rarely needed, this option is not enabled by
13244 default and only is necessary when calling subroutines compiled by IBM
13245 XL compilers without optimization.
13246
13247 @item -mpe
13248 @opindex mpe
13249 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
13250 application written to use message passing with special startup code to
13251 enable the application to run.  The system must have PE installed in the
13252 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
13253 must be overridden with the @option{-specs=} option to specify the
13254 appropriate directory location.  The Parallel Environment does not
13255 support threads, so the @option{-mpe} option and the @option{-pthread}
13256 option are incompatible.
13257
13258 @item -malign-natural
13259 @itemx -malign-power
13260 @opindex malign-natural
13261 @opindex malign-power
13262 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
13263 @option{-malign-natural} overrides the ABI-defined alignment of larger
13264 types, such as floating-point doubles, on their natural size-based boundary.
13265 The option @option{-malign-power} instructs GCC to follow the ABI-specified
13266 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
13267
13268 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
13269 is not supported.
13270
13271 @item -msoft-float
13272 @itemx -mhard-float
13273 @opindex msoft-float
13274 @opindex mhard-float
13275 Generate code that does not use (uses) the floating-point register set.
13276 Software floating point emulation is provided if you use the
13277 @option{-msoft-float} option, and pass the option to GCC when linking.
13278
13279 @item -mmultiple
13280 @itemx -mno-multiple
13281 @opindex mmultiple
13282 @opindex mno-multiple
13283 Generate code that uses (does not use) the load multiple word
13284 instructions and the store multiple word instructions.  These
13285 instructions are generated by default on POWER systems, and not
13286 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
13287 endian PowerPC systems, since those instructions do not work when the
13288 processor is in little endian mode.  The exceptions are PPC740 and
13289 PPC750 which permit the instructions usage in little endian mode.
13290
13291 @item -mstring
13292 @itemx -mno-string
13293 @opindex mstring
13294 @opindex mno-string
13295 Generate code that uses (does not use) the load string instructions
13296 and the store string word instructions to save multiple registers and
13297 do small block moves.  These instructions are generated by default on
13298 POWER systems, and not generated on PowerPC systems.  Do not use
13299 @option{-mstring} on little endian PowerPC systems, since those
13300 instructions do not work when the processor is in little endian mode.
13301 The exceptions are PPC740 and PPC750 which permit the instructions
13302 usage in little endian mode.
13303
13304 @item -mupdate
13305 @itemx -mno-update
13306 @opindex mupdate
13307 @opindex mno-update
13308 Generate code that uses (does not use) the load or store instructions
13309 that update the base register to the address of the calculated memory
13310 location.  These instructions are generated by default.  If you use
13311 @option{-mno-update}, there is a small window between the time that the
13312 stack pointer is updated and the address of the previous frame is
13313 stored, which means code that walks the stack frame across interrupts or
13314 signals may get corrupted data.
13315
13316 @item -mfused-madd
13317 @itemx -mno-fused-madd
13318 @opindex mfused-madd
13319 @opindex mno-fused-madd
13320 Generate code that uses (does not use) the floating point multiply and
13321 accumulate instructions.  These instructions are generated by default if
13322 hardware floating is used.
13323
13324 @item -mmulhw
13325 @itemx -mno-mulhw
13326 @opindex mmulhw
13327 @opindex mno-mulhw
13328 Generate code that uses (does not use) the half-word multiply and
13329 multiply-accumulate instructions on the IBM 405, 440 and 464 processors.
13330 These instructions are generated by default when targetting those
13331 processors.
13332
13333 @item -mdlmzb
13334 @itemx -mno-dlmzb
13335 @opindex mdlmzb
13336 @opindex mno-dlmzb
13337 Generate code that uses (does not use) the string-search @samp{dlmzb}
13338 instruction on the IBM 405, 440 and 464 processors.  This instruction is
13339 generated by default when targetting those processors.
13340
13341 @item -mno-bit-align
13342 @itemx -mbit-align
13343 @opindex mno-bit-align
13344 @opindex mbit-align
13345 On System V.4 and embedded PowerPC systems do not (do) force structures
13346 and unions that contain bit-fields to be aligned to the base type of the
13347 bit-field.
13348
13349 For example, by default a structure containing nothing but 8
13350 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
13351 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
13352 the structure would be aligned to a 1 byte boundary and be one byte in
13353 size.
13354
13355 @item -mno-strict-align
13356 @itemx -mstrict-align
13357 @opindex mno-strict-align
13358 @opindex mstrict-align
13359 On System V.4 and embedded PowerPC systems do not (do) assume that
13360 unaligned memory references will be handled by the system.
13361
13362 @item -mrelocatable
13363 @itemx -mno-relocatable
13364 @opindex mrelocatable
13365 @opindex mno-relocatable
13366 On embedded PowerPC systems generate code that allows (does not allow)
13367 the program to be relocated to a different address at runtime.  If you
13368 use @option{-mrelocatable} on any module, all objects linked together must
13369 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
13370
13371 @item -mrelocatable-lib
13372 @itemx -mno-relocatable-lib
13373 @opindex mrelocatable-lib
13374 @opindex mno-relocatable-lib
13375 On embedded PowerPC systems generate code that allows (does not allow)
13376 the program to be relocated to a different address at runtime.  Modules
13377 compiled with @option{-mrelocatable-lib} can be linked with either modules
13378 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
13379 with modules compiled with the @option{-mrelocatable} options.
13380
13381 @item -mno-toc
13382 @itemx -mtoc
13383 @opindex mno-toc
13384 @opindex mtoc
13385 On System V.4 and embedded PowerPC systems do not (do) assume that
13386 register 2 contains a pointer to a global area pointing to the addresses
13387 used in the program.
13388
13389 @item -mlittle
13390 @itemx -mlittle-endian
13391 @opindex mlittle
13392 @opindex mlittle-endian
13393 On System V.4 and embedded PowerPC systems compile code for the
13394 processor in little endian mode.  The @option{-mlittle-endian} option is
13395 the same as @option{-mlittle}.
13396
13397 @item -mbig
13398 @itemx -mbig-endian
13399 @opindex mbig
13400 @opindex mbig-endian
13401 On System V.4 and embedded PowerPC systems compile code for the
13402 processor in big endian mode.  The @option{-mbig-endian} option is
13403 the same as @option{-mbig}.
13404
13405 @item -mdynamic-no-pic
13406 @opindex mdynamic-no-pic
13407 On Darwin and Mac OS X systems, compile code so that it is not
13408 relocatable, but that its external references are relocatable.  The
13409 resulting code is suitable for applications, but not shared
13410 libraries.
13411
13412 @item -mprioritize-restricted-insns=@var{priority}
13413 @opindex mprioritize-restricted-insns
13414 This option controls the priority that is assigned to
13415 dispatch-slot restricted instructions during the second scheduling
13416 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
13417 @var{no/highest/second-highest} priority to dispatch slot restricted
13418 instructions.
13419
13420 @item -msched-costly-dep=@var{dependence_type}
13421 @opindex msched-costly-dep
13422 This option controls which dependences are considered costly
13423 by the target during instruction scheduling.  The argument
13424 @var{dependence_type} takes one of the following values:
13425 @var{no}: no dependence is costly,
13426 @var{all}: all dependences are costly,
13427 @var{true_store_to_load}: a true dependence from store to load is costly,
13428 @var{store_to_load}: any dependence from store to load is costly,
13429 @var{number}: any dependence which latency >= @var{number} is costly.
13430
13431 @item -minsert-sched-nops=@var{scheme}
13432 @opindex minsert-sched-nops
13433 This option controls which nop insertion scheme will be used during
13434 the second scheduling pass.  The argument @var{scheme} takes one of the
13435 following values:
13436 @var{no}: Don't insert nops.
13437 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
13438 according to the scheduler's grouping.
13439 @var{regroup_exact}: Insert nops to force costly dependent insns into
13440 separate groups.  Insert exactly as many nops as needed to force an insn
13441 to a new group, according to the estimated processor grouping.
13442 @var{number}: Insert nops to force costly dependent insns into
13443 separate groups.  Insert @var{number} nops to force an insn to a new group.
13444
13445 @item -mcall-sysv
13446 @opindex mcall-sysv
13447 On System V.4 and embedded PowerPC systems compile code using calling
13448 conventions that adheres to the March 1995 draft of the System V
13449 Application Binary Interface, PowerPC processor supplement.  This is the
13450 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
13451
13452 @item -mcall-sysv-eabi
13453 @opindex mcall-sysv-eabi
13454 Specify both @option{-mcall-sysv} and @option{-meabi} options.
13455
13456 @item -mcall-sysv-noeabi
13457 @opindex mcall-sysv-noeabi
13458 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
13459
13460 @item -mcall-solaris
13461 @opindex mcall-solaris
13462 On System V.4 and embedded PowerPC systems compile code for the Solaris
13463 operating system.
13464
13465 @item -mcall-linux
13466 @opindex mcall-linux
13467 On System V.4 and embedded PowerPC systems compile code for the
13468 Linux-based GNU system.
13469
13470 @item -mcall-gnu
13471 @opindex mcall-gnu
13472 On System V.4 and embedded PowerPC systems compile code for the
13473 Hurd-based GNU system.
13474
13475 @item -mcall-netbsd
13476 @opindex mcall-netbsd
13477 On System V.4 and embedded PowerPC systems compile code for the
13478 NetBSD operating system.
13479
13480 @item -maix-struct-return
13481 @opindex maix-struct-return
13482 Return all structures in memory (as specified by the AIX ABI)@.
13483
13484 @item -msvr4-struct-return
13485 @opindex msvr4-struct-return
13486 Return structures smaller than 8 bytes in registers (as specified by the
13487 SVR4 ABI)@.
13488
13489 @item -mabi=@var{abi-type}
13490 @opindex mabi
13491 Extend the current ABI with a particular extension, or remove such extension.
13492 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
13493 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
13494
13495 @item -mabi=spe
13496 @opindex mabi=spe
13497 Extend the current ABI with SPE ABI extensions.  This does not change
13498 the default ABI, instead it adds the SPE ABI extensions to the current
13499 ABI@.
13500
13501 @item -mabi=no-spe
13502 @opindex mabi=no-spe
13503 Disable Booke SPE ABI extensions for the current ABI@.
13504
13505 @item -mabi=ibmlongdouble
13506 @opindex mabi=ibmlongdouble
13507 Change the current ABI to use IBM extended precision long double.
13508 This is a PowerPC 32-bit SYSV ABI option.
13509
13510 @item -mabi=ieeelongdouble
13511 @opindex mabi=ieeelongdouble
13512 Change the current ABI to use IEEE extended precision long double.
13513 This is a PowerPC 32-bit Linux ABI option.
13514
13515 @item -mprototype
13516 @itemx -mno-prototype
13517 @opindex mprototype
13518 @opindex mno-prototype
13519 On System V.4 and embedded PowerPC systems assume that all calls to
13520 variable argument functions are properly prototyped.  Otherwise, the
13521 compiler must insert an instruction before every non prototyped call to
13522 set or clear bit 6 of the condition code register (@var{CR}) to
13523 indicate whether floating point values were passed in the floating point
13524 registers in case the function takes a variable arguments.  With
13525 @option{-mprototype}, only calls to prototyped variable argument functions
13526 will set or clear the bit.
13527
13528 @item -msim
13529 @opindex msim
13530 On embedded PowerPC systems, assume that the startup module is called
13531 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
13532 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
13533 configurations.
13534
13535 @item -mmvme
13536 @opindex mmvme
13537 On embedded PowerPC systems, assume that the startup module is called
13538 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
13539 @file{libc.a}.
13540
13541 @item -mads
13542 @opindex mads
13543 On embedded PowerPC systems, assume that the startup module is called
13544 @file{crt0.o} and the standard C libraries are @file{libads.a} and
13545 @file{libc.a}.
13546
13547 @item -myellowknife
13548 @opindex myellowknife
13549 On embedded PowerPC systems, assume that the startup module is called
13550 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
13551 @file{libc.a}.
13552
13553 @item -mvxworks
13554 @opindex mvxworks
13555 On System V.4 and embedded PowerPC systems, specify that you are
13556 compiling for a VxWorks system.
13557
13558 @item -memb
13559 @opindex memb
13560 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
13561 header to indicate that @samp{eabi} extended relocations are used.
13562
13563 @item -meabi
13564 @itemx -mno-eabi
13565 @opindex meabi
13566 @opindex mno-eabi
13567 On System V.4 and embedded PowerPC systems do (do not) adhere to the
13568 Embedded Applications Binary Interface (eabi) which is a set of
13569 modifications to the System V.4 specifications.  Selecting @option{-meabi}
13570 means that the stack is aligned to an 8 byte boundary, a function
13571 @code{__eabi} is called to from @code{main} to set up the eabi
13572 environment, and the @option{-msdata} option can use both @code{r2} and
13573 @code{r13} to point to two separate small data areas.  Selecting
13574 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
13575 do not call an initialization function from @code{main}, and the
13576 @option{-msdata} option will only use @code{r13} to point to a single
13577 small data area.  The @option{-meabi} option is on by default if you
13578 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
13579
13580 @item -msdata=eabi
13581 @opindex msdata=eabi
13582 On System V.4 and embedded PowerPC systems, put small initialized
13583 @code{const} global and static data in the @samp{.sdata2} section, which
13584 is pointed to by register @code{r2}.  Put small initialized
13585 non-@code{const} global and static data in the @samp{.sdata} section,
13586 which is pointed to by register @code{r13}.  Put small uninitialized
13587 global and static data in the @samp{.sbss} section, which is adjacent to
13588 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
13589 incompatible with the @option{-mrelocatable} option.  The
13590 @option{-msdata=eabi} option also sets the @option{-memb} option.
13591
13592 @item -msdata=sysv
13593 @opindex msdata=sysv
13594 On System V.4 and embedded PowerPC systems, put small global and static
13595 data in the @samp{.sdata} section, which is pointed to by register
13596 @code{r13}.  Put small uninitialized global and static data in the
13597 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
13598 The @option{-msdata=sysv} option is incompatible with the
13599 @option{-mrelocatable} option.
13600
13601 @item -msdata=default
13602 @itemx -msdata
13603 @opindex msdata=default
13604 @opindex msdata
13605 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
13606 compile code the same as @option{-msdata=eabi}, otherwise compile code the
13607 same as @option{-msdata=sysv}.
13608
13609 @item -msdata-data
13610 @opindex msdata-data
13611 On System V.4 and embedded PowerPC systems, put small global
13612 data in the @samp{.sdata} section.  Put small uninitialized global
13613 data in the @samp{.sbss} section.  Do not use register @code{r13}
13614 to address small data however.  This is the default behavior unless
13615 other @option{-msdata} options are used.
13616
13617 @item -msdata=none
13618 @itemx -mno-sdata
13619 @opindex msdata=none
13620 @opindex mno-sdata
13621 On embedded PowerPC systems, put all initialized global and static data
13622 in the @samp{.data} section, and all uninitialized data in the
13623 @samp{.bss} section.
13624
13625 @item -G @var{num}
13626 @opindex G
13627 @cindex smaller data references (PowerPC)
13628 @cindex .sdata/.sdata2 references (PowerPC)
13629 On embedded PowerPC systems, put global and static items less than or
13630 equal to @var{num} bytes into the small data or bss sections instead of
13631 the normal data or bss section.  By default, @var{num} is 8.  The
13632 @option{-G @var{num}} switch is also passed to the linker.
13633 All modules should be compiled with the same @option{-G @var{num}} value.
13634
13635 @item -mregnames
13636 @itemx -mno-regnames
13637 @opindex mregnames
13638 @opindex mno-regnames
13639 On System V.4 and embedded PowerPC systems do (do not) emit register
13640 names in the assembly language output using symbolic forms.
13641
13642 @item -mlongcall
13643 @itemx -mno-longcall
13644 @opindex mlongcall
13645 @opindex mno-longcall
13646 By default assume that all calls are far away so that a longer more
13647 expensive calling sequence is required.  This is required for calls
13648 further than 32 megabytes (33,554,432 bytes) from the current location.
13649 A short call will be generated if the compiler knows
13650 the call cannot be that far away.  This setting can be overridden by
13651 the @code{shortcall} function attribute, or by @code{#pragma
13652 longcall(0)}.
13653
13654 Some linkers are capable of detecting out-of-range calls and generating
13655 glue code on the fly.  On these systems, long calls are unnecessary and
13656 generate slower code.  As of this writing, the AIX linker can do this,
13657 as can the GNU linker for PowerPC/64.  It is planned to add this feature
13658 to the GNU linker for 32-bit PowerPC systems as well.
13659
13660 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
13661 callee, L42'', plus a ``branch island'' (glue code).  The two target
13662 addresses represent the callee and the ``branch island''.  The
13663 Darwin/PPC linker will prefer the first address and generate a ``bl
13664 callee'' if the PPC ``bl'' instruction will reach the callee directly;
13665 otherwise, the linker will generate ``bl L42'' to call the ``branch
13666 island''.  The ``branch island'' is appended to the body of the
13667 calling function; it computes the full 32-bit address of the callee
13668 and jumps to it.
13669
13670 On Mach-O (Darwin) systems, this option directs the compiler emit to
13671 the glue for every direct call, and the Darwin linker decides whether
13672 to use or discard it.
13673
13674 In the future, we may cause GCC to ignore all longcall specifications
13675 when the linker is known to generate glue.
13676
13677 @item -pthread
13678 @opindex pthread
13679 Adds support for multithreading with the @dfn{pthreads} library.
13680 This option sets flags for both the preprocessor and linker.
13681
13682 @end table
13683
13684 @node S/390 and zSeries Options
13685 @subsection S/390 and zSeries Options
13686 @cindex S/390 and zSeries Options
13687
13688 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
13689
13690 @table @gcctabopt
13691 @item -mhard-float
13692 @itemx -msoft-float
13693 @opindex mhard-float
13694 @opindex msoft-float
13695 Use (do not use) the hardware floating-point instructions and registers
13696 for floating-point operations.  When @option{-msoft-float} is specified,
13697 functions in @file{libgcc.a} will be used to perform floating-point
13698 operations.  When @option{-mhard-float} is specified, the compiler
13699 generates IEEE floating-point instructions.  This is the default.
13700
13701 @item -mlong-double-64
13702 @itemx -mlong-double-128
13703 @opindex mlong-double-64
13704 @opindex mlong-double-128
13705 These switches control the size of @code{long double} type. A size
13706 of 64bit makes the @code{long double} type equivalent to the @code{double}
13707 type. This is the default.
13708
13709 @item -mbackchain
13710 @itemx -mno-backchain
13711 @opindex mbackchain
13712 @opindex mno-backchain
13713 Store (do not store) the address of the caller's frame as backchain pointer
13714 into the callee's stack frame.
13715 A backchain may be needed to allow debugging using tools that do not understand
13716 DWARF-2 call frame information.
13717 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
13718 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
13719 the backchain is placed into the topmost word of the 96/160 byte register
13720 save area.
13721
13722 In general, code compiled with @option{-mbackchain} is call-compatible with
13723 code compiled with @option{-mmo-backchain}; however, use of the backchain
13724 for debugging purposes usually requires that the whole binary is built with
13725 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
13726 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13727 to build a linux kernel use @option{-msoft-float}.
13728
13729 The default is to not maintain the backchain.
13730
13731 @item -mpacked-stack
13732 @itemx -mno-packed-stack
13733 @opindex mpacked-stack
13734 @opindex mno-packed-stack
13735 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
13736 specified, the compiler uses the all fields of the 96/160 byte register save
13737 area only for their default purpose; unused fields still take up stack space.
13738 When @option{-mpacked-stack} is specified, register save slots are densely
13739 packed at the top of the register save area; unused space is reused for other
13740 purposes, allowing for more efficient use of the available stack space.
13741 However, when @option{-mbackchain} is also in effect, the topmost word of
13742 the save area is always used to store the backchain, and the return address
13743 register is always saved two words below the backchain.
13744
13745 As long as the stack frame backchain is not used, code generated with
13746 @option{-mpacked-stack} is call-compatible with code generated with
13747 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
13748 S/390 or zSeries generated code that uses the stack frame backchain at run
13749 time, not just for debugging purposes.  Such code is not call-compatible
13750 with code compiled with @option{-mpacked-stack}.  Also, note that the
13751 combination of @option{-mbackchain},
13752 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13753 to build a linux kernel use @option{-msoft-float}.
13754
13755 The default is to not use the packed stack layout.
13756
13757 @item -msmall-exec
13758 @itemx -mno-small-exec
13759 @opindex msmall-exec
13760 @opindex mno-small-exec
13761 Generate (or do not generate) code using the @code{bras} instruction
13762 to do subroutine calls.
13763 This only works reliably if the total executable size does not
13764 exceed 64k.  The default is to use the @code{basr} instruction instead,
13765 which does not have this limitation.
13766
13767 @item -m64
13768 @itemx -m31
13769 @opindex m64
13770 @opindex m31
13771 When @option{-m31} is specified, generate code compliant to the
13772 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
13773 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
13774 particular to generate 64-bit instructions.  For the @samp{s390}
13775 targets, the default is @option{-m31}, while the @samp{s390x}
13776 targets default to @option{-m64}.
13777
13778 @item -mzarch
13779 @itemx -mesa
13780 @opindex mzarch
13781 @opindex mesa
13782 When @option{-mzarch} is specified, generate code using the
13783 instructions available on z/Architecture.
13784 When @option{-mesa} is specified, generate code using the
13785 instructions available on ESA/390.  Note that @option{-mesa} is
13786 not possible with @option{-m64}.
13787 When generating code compliant to the GNU/Linux for S/390 ABI,
13788 the default is @option{-mesa}.  When generating code compliant
13789 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
13790
13791 @item -mmvcle
13792 @itemx -mno-mvcle
13793 @opindex mmvcle
13794 @opindex mno-mvcle
13795 Generate (or do not generate) code using the @code{mvcle} instruction
13796 to perform block moves.  When @option{-mno-mvcle} is specified,
13797 use a @code{mvc} loop instead.  This is the default unless optimizing for
13798 size.
13799
13800 @item -mdebug
13801 @itemx -mno-debug
13802 @opindex mdebug
13803 @opindex mno-debug
13804 Print (or do not print) additional debug information when compiling.
13805 The default is to not print debug information.
13806
13807 @item -march=@var{cpu-type}
13808 @opindex march
13809 Generate code that will run on @var{cpu-type}, which is the name of a system
13810 representing a certain processor type.  Possible values for
13811 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
13812 When generating code using the instructions available on z/Architecture,
13813 the default is @option{-march=z900}.  Otherwise, the default is
13814 @option{-march=g5}.
13815
13816 @item -mtune=@var{cpu-type}
13817 @opindex mtune
13818 Tune to @var{cpu-type} everything applicable about the generated code,
13819 except for the ABI and the set of available instructions.
13820 The list of @var{cpu-type} values is the same as for @option{-march}.
13821 The default is the value used for @option{-march}.
13822
13823 @item -mtpf-trace
13824 @itemx -mno-tpf-trace
13825 @opindex mtpf-trace
13826 @opindex mno-tpf-trace
13827 Generate code that adds (does not add) in TPF OS specific branches to trace
13828 routines in the operating system.  This option is off by default, even
13829 when compiling for the TPF OS@.
13830
13831 @item -mfused-madd
13832 @itemx -mno-fused-madd
13833 @opindex mfused-madd
13834 @opindex mno-fused-madd
13835 Generate code that uses (does not use) the floating point multiply and
13836 accumulate instructions.  These instructions are generated by default if
13837 hardware floating point is used.
13838
13839 @item -mwarn-framesize=@var{framesize}
13840 @opindex mwarn-framesize
13841 Emit a warning if the current function exceeds the given frame size.  Because
13842 this is a compile time check it doesn't need to be a real problem when the program
13843 runs.  It is intended to identify functions which most probably cause
13844 a stack overflow.  It is useful to be used in an environment with limited stack
13845 size e.g.@: the linux kernel.
13846
13847 @item -mwarn-dynamicstack
13848 @opindex mwarn-dynamicstack
13849 Emit a warning if the function calls alloca or uses dynamically
13850 sized arrays.  This is generally a bad idea with a limited stack size.
13851
13852 @item -mstack-guard=@var{stack-guard}
13853 @itemx -mstack-size=@var{stack-size}
13854 @opindex mstack-guard
13855 @opindex mstack-size
13856 If these options are provided the s390 back end emits additional instructions in
13857 the function prologue which trigger a trap if the stack size is @var{stack-guard}
13858 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
13859 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
13860 the frame size of the compiled function is chosen.
13861 These options are intended to be used to help debugging stack overflow problems.
13862 The additionally emitted code causes only little overhead and hence can also be
13863 used in production like systems without greater performance degradation.  The given
13864 values have to be exact powers of 2 and @var{stack-size} has to be greater than
13865 @var{stack-guard} without exceeding 64k.
13866 In order to be efficient the extra code makes the assumption that the stack starts
13867 at an address aligned to the value given by @var{stack-size}.
13868 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
13869 @end table
13870
13871 @node Score Options
13872 @subsection Score Options
13873 @cindex Score Options
13874
13875 These options are defined for Score implementations:
13876
13877 @table @gcctabopt
13878 @item -meb
13879 @opindex meb
13880 Compile code for big endian mode.  This is the default.
13881
13882 @item -mel
13883 @opindex mel
13884 Compile code for little endian mode. 
13885
13886 @item -mnhwloop
13887 @opindex mnhwloop
13888 Disable generate bcnz instruction.
13889
13890 @item -muls
13891 @opindex muls
13892 Enable generate unaligned load and store instruction.
13893
13894 @item -mmac
13895 @opindex mmac
13896 Enable the use of multiply-accumulate instructions. Disabled by default. 
13897
13898 @item -mscore5
13899 @opindex mscore5
13900 Specify the SCORE5 as the target architecture.
13901
13902 @item -mscore5u
13903 @opindex mscore5u
13904 Specify the SCORE5U of the target architecture.
13905
13906 @item -mscore7
13907 @opindex mscore7
13908 Specify the SCORE7 as the target architecture. This is the default.
13909
13910 @item -mscore7d
13911 @opindex mscore7d
13912 Specify the SCORE7D as the target architecture.
13913 @end table
13914
13915 @node SH Options
13916 @subsection SH Options
13917
13918 These @samp{-m} options are defined for the SH implementations:
13919
13920 @table @gcctabopt
13921 @item -m1
13922 @opindex m1
13923 Generate code for the SH1.
13924
13925 @item -m2
13926 @opindex m2
13927 Generate code for the SH2.
13928
13929 @item -m2e
13930 Generate code for the SH2e.
13931
13932 @item -m3
13933 @opindex m3
13934 Generate code for the SH3.
13935
13936 @item -m3e
13937 @opindex m3e
13938 Generate code for the SH3e.
13939
13940 @item -m4-nofpu
13941 @opindex m4-nofpu
13942 Generate code for the SH4 without a floating-point unit.
13943
13944 @item -m4-single-only
13945 @opindex m4-single-only
13946 Generate code for the SH4 with a floating-point unit that only
13947 supports single-precision arithmetic.
13948
13949 @item -m4-single
13950 @opindex m4-single
13951 Generate code for the SH4 assuming the floating-point unit is in
13952 single-precision mode by default.
13953
13954 @item -m4
13955 @opindex m4
13956 Generate code for the SH4.
13957
13958 @item -m4a-nofpu
13959 @opindex m4a-nofpu
13960 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
13961 floating-point unit is not used.
13962
13963 @item -m4a-single-only
13964 @opindex m4a-single-only
13965 Generate code for the SH4a, in such a way that no double-precision
13966 floating point operations are used.
13967
13968 @item -m4a-single
13969 @opindex m4a-single
13970 Generate code for the SH4a assuming the floating-point unit is in
13971 single-precision mode by default.
13972
13973 @item -m4a
13974 @opindex m4a
13975 Generate code for the SH4a.
13976
13977 @item -m4al
13978 @opindex m4al
13979 Same as @option{-m4a-nofpu}, except that it implicitly passes
13980 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
13981 instructions at the moment.
13982
13983 @item -mb
13984 @opindex mb
13985 Compile code for the processor in big endian mode.
13986
13987 @item -ml
13988 @opindex ml
13989 Compile code for the processor in little endian mode.
13990
13991 @item -mdalign
13992 @opindex mdalign
13993 Align doubles at 64-bit boundaries.  Note that this changes the calling
13994 conventions, and thus some functions from the standard C library will
13995 not work unless you recompile it first with @option{-mdalign}.
13996
13997 @item -mrelax
13998 @opindex mrelax
13999 Shorten some address references at link time, when possible; uses the
14000 linker option @option{-relax}.
14001
14002 @item -mbigtable
14003 @opindex mbigtable
14004 Use 32-bit offsets in @code{switch} tables.  The default is to use
14005 16-bit offsets.
14006
14007 @item -mbitops
14008 @opindex mbitops
14009 Enable the use of bit manipulation instructions on SH2A.
14010
14011 @item -mfmovd
14012 @opindex mfmovd
14013 Enable the use of the instruction @code{fmovd}.
14014
14015 @item -mhitachi
14016 @opindex mhitachi
14017 Comply with the calling conventions defined by Renesas.
14018
14019 @item -mrenesas
14020 @opindex mhitachi
14021 Comply with the calling conventions defined by Renesas.
14022
14023 @item -mno-renesas
14024 @opindex mhitachi
14025 Comply with the calling conventions defined for GCC before the Renesas
14026 conventions were available.  This option is the default for all
14027 targets of the SH toolchain except for @samp{sh-symbianelf}.
14028
14029 @item -mnomacsave
14030 @opindex mnomacsave
14031 Mark the @code{MAC} register as call-clobbered, even if
14032 @option{-mhitachi} is given.
14033
14034 @item -mieee
14035 @opindex mieee
14036 Increase IEEE-compliance of floating-point code.
14037 At the moment, this is equivalent to @option{-fno-finite-math-only}.
14038 When generating 16 bit SH opcodes, getting IEEE-conforming results for
14039 comparisons of NANs / infinities incurs extra overhead in every
14040 floating point comparison, therefore the default is set to
14041 @option{-ffinite-math-only}.
14042
14043 @item -minline-ic_invalidate
14044 @opindex minline-ic_invalidate
14045 Inline code to invalidate instruction cache entries after setting up
14046 nested function trampolines.
14047 This option has no effect if -musermode is in effect and the selected
14048 code generation option (e.g. -m4) does not allow the use of the icbi
14049 instruction.
14050 If the selected code generation option does not allow the use of the icbi
14051 instruction, and -musermode is not in effect, the inlined code will
14052 manipulate the instruction cache address array directly with an associative
14053 write.  This not only requires privileged mode, but it will also
14054 fail if the cache line had been mapped via the TLB and has become unmapped.
14055
14056 @item -misize
14057 @opindex misize
14058 Dump instruction size and location in the assembly code.
14059
14060 @item -mpadstruct
14061 @opindex mpadstruct
14062 This option is deprecated.  It pads structures to multiple of 4 bytes,
14063 which is incompatible with the SH ABI@.
14064
14065 @item -mspace
14066 @opindex mspace
14067 Optimize for space instead of speed.  Implied by @option{-Os}.
14068
14069 @item -mprefergot
14070 @opindex mprefergot
14071 When generating position-independent code, emit function calls using
14072 the Global Offset Table instead of the Procedure Linkage Table.
14073
14074 @item -musermode
14075 @opindex musermode
14076 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
14077 if the inlined code would not work in user mode.
14078 This is the default when the target is @code{sh-*-linux*}.
14079
14080 @item -multcost=@var{number}
14081 @opindex multcost=@var{number}
14082 Set the cost to assume for a multiply insn.
14083
14084 @item -mdiv=@var{strategy}
14085 @opindex mdiv=@var{strategy}
14086 Set the division strategy to use for SHmedia code.  @var{strategy} must be
14087 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
14088 inv:call2, inv:fp .
14089 "fp" performs the operation in floating point.  This has a very high latency,
14090 but needs only a few instructions, so it might be a good choice if
14091 your code has enough easily exploitable ILP to allow the compiler to
14092 schedule the floating point instructions together with other instructions.
14093 Division by zero causes a floating point exception.
14094 "inv" uses integer operations to calculate the inverse of the divisor,
14095 and then multiplies the dividend with the inverse.  This strategy allows
14096 cse and hoisting of the inverse calculation.  Division by zero calculates
14097 an unspecified result, but does not trap.
14098 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
14099 have been found, or if the entire operation has been hoisted to the same
14100 place, the last stages of the inverse calculation are intertwined with the
14101 final multiply to reduce the overall latency, at the expense of using a few
14102 more instructions, and thus offering fewer scheduling opportunities with
14103 other code.
14104 "call" calls a library function that usually implements the inv:minlat
14105 strategy.
14106 This gives high code density for m5-*media-nofpu compilations.
14107 "call2" uses a different entry point of the same library function, where it
14108 assumes that a pointer to a lookup table has already been set up, which
14109 exposes the pointer load to cse / code hoisting optimizations.
14110 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
14111 code generation, but if the code stays unoptimized, revert to the "call",
14112 "call2", or "fp" strategies, respectively.  Note that the
14113 potentially-trapping side effect of division by zero is carried by a
14114 separate instruction, so it is possible that all the integer instructions
14115 are hoisted out, but the marker for the side effect stays where it is.
14116 A recombination to fp operations or a call is not possible in that case.
14117 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
14118 that the inverse calculation was nor separated from the multiply, they speed
14119 up division where the dividend fits into 20 bits (plus sign where applicable),
14120 by inserting a test to skip a number of operations in this case; this test
14121 slows down the case of larger dividends.  inv20u assumes the case of a such
14122 a small dividend to be unlikely, and inv20l assumes it to be likely.
14123
14124 @item -mdivsi3_libfunc=@var{name}
14125 @opindex mdivsi3_libfunc=@var{name}
14126 Set the name of the library function used for 32 bit signed division to
14127 @var{name}.  This only affect the name used in the call and inv:call
14128 division strategies, and the compiler will still expect the same
14129 sets of input/output/clobbered registers as if this option was not present.
14130
14131 @item -mfixed-range=@var{register-range}
14132 @opindex mfixed-range
14133 Generate code treating the given register range as fixed registers.
14134 A fixed register is one that the register allocator can not use.  This is
14135 useful when compiling kernel code.  A register range is specified as
14136 two registers separated by a dash.  Multiple register ranges can be
14137 specified separated by a comma.
14138
14139 @item -madjust-unroll
14140 @opindex madjust-unroll
14141 Throttle unrolling to avoid thrashing target registers.
14142 This option only has an effect if the gcc code base supports the
14143 TARGET_ADJUST_UNROLL_MAX target hook.
14144
14145 @item -mindexed-addressing
14146 @opindex mindexed-addressing
14147 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
14148 This is only safe if the hardware and/or OS implement 32 bit wrap-around
14149 semantics for the indexed addressing mode.  The architecture allows the
14150 implementation of processors with 64 bit MMU, which the OS could use to
14151 get 32 bit addressing, but since no current hardware implementation supports
14152 this or any other way to make the indexed addressing mode safe to use in
14153 the 32 bit ABI, the default is -mno-indexed-addressing.
14154
14155 @item -mgettrcost=@var{number}
14156 @opindex mgettrcost=@var{number}
14157 Set the cost assumed for the gettr instruction to @var{number}.
14158 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
14159
14160 @item -mpt-fixed
14161 @opindex mpt-fixed
14162 Assume pt* instructions won't trap.  This will generally generate better
14163 scheduled code, but is unsafe on current hardware.  The current architecture
14164 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
14165 This has the unintentional effect of making it unsafe to schedule ptabs /
14166 ptrel before a branch, or hoist it out of a loop.  For example,
14167 __do_global_ctors, a part of libgcc that runs constructors at program
14168 startup, calls functions in a list which is delimited by @minus{}1.  With the
14169 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
14170 That means that all the constructors will be run a bit quicker, but when
14171 the loop comes to the end of the list, the program crashes because ptabs
14172 loads @minus{}1 into a target register.  Since this option is unsafe for any
14173 hardware implementing the current architecture specification, the default
14174 is -mno-pt-fixed.  Unless the user specifies a specific cost with
14175 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
14176 this deters register allocation using target registers for storing
14177 ordinary integers.
14178
14179 @item -minvalid-symbols
14180 @opindex minvalid-symbols
14181 Assume symbols might be invalid.  Ordinary function symbols generated by
14182 the compiler will always be valid to load with movi/shori/ptabs or
14183 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
14184 to generate symbols that will cause ptabs / ptrel to trap.
14185 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
14186 It will then prevent cross-basic-block cse, hoisting and most scheduling
14187 of symbol loads.  The default is @option{-mno-invalid-symbols}.
14188 @end table
14189
14190 @node SPARC Options
14191 @subsection SPARC Options
14192 @cindex SPARC options
14193
14194 These @samp{-m} options are supported on the SPARC:
14195
14196 @table @gcctabopt
14197 @item -mno-app-regs
14198 @itemx -mapp-regs
14199 @opindex mno-app-regs
14200 @opindex mapp-regs
14201 Specify @option{-mapp-regs} to generate output using the global registers
14202 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
14203 is the default.
14204
14205 To be fully SVR4 ABI compliant at the cost of some performance loss,
14206 specify @option{-mno-app-regs}.  You should compile libraries and system
14207 software with this option.
14208
14209 @item -mfpu
14210 @itemx -mhard-float
14211 @opindex mfpu
14212 @opindex mhard-float
14213 Generate output containing floating point instructions.  This is the
14214 default.
14215
14216 @item -mno-fpu
14217 @itemx -msoft-float
14218 @opindex mno-fpu
14219 @opindex msoft-float
14220 Generate output containing library calls for floating point.
14221 @strong{Warning:} the requisite libraries are not available for all SPARC
14222 targets.  Normally the facilities of the machine's usual C compiler are
14223 used, but this cannot be done directly in cross-compilation.  You must make
14224 your own arrangements to provide suitable library functions for
14225 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
14226 @samp{sparclite-*-*} do provide software floating point support.
14227
14228 @option{-msoft-float} changes the calling convention in the output file;
14229 therefore, it is only useful if you compile @emph{all} of a program with
14230 this option.  In particular, you need to compile @file{libgcc.a}, the
14231 library that comes with GCC, with @option{-msoft-float} in order for
14232 this to work.
14233
14234 @item -mhard-quad-float
14235 @opindex mhard-quad-float
14236 Generate output containing quad-word (long double) floating point
14237 instructions.
14238
14239 @item -msoft-quad-float
14240 @opindex msoft-quad-float
14241 Generate output containing library calls for quad-word (long double)
14242 floating point instructions.  The functions called are those specified
14243 in the SPARC ABI@.  This is the default.
14244
14245 As of this writing, there are no SPARC implementations that have hardware
14246 support for the quad-word floating point instructions.  They all invoke
14247 a trap handler for one of these instructions, and then the trap handler
14248 emulates the effect of the instruction.  Because of the trap handler overhead,
14249 this is much slower than calling the ABI library routines.  Thus the
14250 @option{-msoft-quad-float} option is the default.
14251
14252 @item -mno-unaligned-doubles
14253 @itemx -munaligned-doubles
14254 @opindex mno-unaligned-doubles
14255 @opindex munaligned-doubles
14256 Assume that doubles have 8 byte alignment.  This is the default.
14257
14258 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
14259 alignment only if they are contained in another type, or if they have an
14260 absolute address.  Otherwise, it assumes they have 4 byte alignment.
14261 Specifying this option avoids some rare compatibility problems with code
14262 generated by other compilers.  It is not the default because it results
14263 in a performance loss, especially for floating point code.
14264
14265 @item -mno-faster-structs
14266 @itemx -mfaster-structs
14267 @opindex mno-faster-structs
14268 @opindex mfaster-structs
14269 With @option{-mfaster-structs}, the compiler assumes that structures
14270 should have 8 byte alignment.  This enables the use of pairs of
14271 @code{ldd} and @code{std} instructions for copies in structure
14272 assignment, in place of twice as many @code{ld} and @code{st} pairs.
14273 However, the use of this changed alignment directly violates the SPARC
14274 ABI@.  Thus, it's intended only for use on targets where the developer
14275 acknowledges that their resulting code will not be directly in line with
14276 the rules of the ABI@.
14277
14278 @item -mimpure-text
14279 @opindex mimpure-text
14280 @option{-mimpure-text}, used in addition to @option{-shared}, tells
14281 the compiler to not pass @option{-z text} to the linker when linking a
14282 shared object.  Using this option, you can link position-dependent
14283 code into a shared object.
14284
14285 @option{-mimpure-text} suppresses the ``relocations remain against
14286 allocatable but non-writable sections'' linker error message.
14287 However, the necessary relocations will trigger copy-on-write, and the
14288 shared object is not actually shared across processes.  Instead of
14289 using @option{-mimpure-text}, you should compile all source code with
14290 @option{-fpic} or @option{-fPIC}.
14291
14292 This option is only available on SunOS and Solaris.
14293
14294 @item -mcpu=@var{cpu_type}
14295 @opindex mcpu
14296 Set the instruction set, register set, and instruction scheduling parameters
14297 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
14298 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
14299 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
14300 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
14301 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
14302
14303 Default instruction scheduling parameters are used for values that select
14304 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
14305 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
14306
14307 Here is a list of each supported architecture and their supported
14308 implementations.
14309
14310 @smallexample
14311     v7:             cypress
14312     v8:             supersparc, hypersparc
14313     sparclite:      f930, f934, sparclite86x
14314     sparclet:       tsc701
14315     v9:             ultrasparc, ultrasparc3, niagara, niagara2
14316 @end smallexample
14317
14318 By default (unless configured otherwise), GCC generates code for the V7
14319 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
14320 additionally optimizes it for the Cypress CY7C602 chip, as used in the
14321 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
14322 SPARCStation 1, 2, IPX etc.
14323
14324 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
14325 architecture.  The only difference from V7 code is that the compiler emits
14326 the integer multiply and integer divide instructions which exist in SPARC-V8
14327 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
14328 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
14329 2000 series.
14330
14331 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
14332 the SPARC architecture.  This adds the integer multiply, integer divide step
14333 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
14334 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
14335 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
14336 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
14337 MB86934 chip, which is the more recent SPARClite with FPU@.
14338
14339 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
14340 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
14341 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
14342 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
14343 optimizes it for the TEMIC SPARClet chip.
14344
14345 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
14346 architecture.  This adds 64-bit integer and floating-point move instructions,
14347 3 additional floating-point condition code registers and conditional move
14348 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
14349 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
14350 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
14351 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
14352 @option{-mcpu=niagara}, the compiler additionally optimizes it for
14353 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
14354 additionally optimizes it for Sun UltraSPARC T2 chips.
14355
14356 @item -mtune=@var{cpu_type}
14357 @opindex mtune
14358 Set the instruction scheduling parameters for machine type
14359 @var{cpu_type}, but do not set the instruction set or register set that the
14360 option @option{-mcpu=@var{cpu_type}} would.
14361
14362 The same values for @option{-mcpu=@var{cpu_type}} can be used for
14363 @option{-mtune=@var{cpu_type}}, but the only useful values are those
14364 that select a particular cpu implementation.  Those are @samp{cypress},
14365 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
14366 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
14367 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
14368
14369 @item -mv8plus
14370 @itemx -mno-v8plus
14371 @opindex mv8plus
14372 @opindex mno-v8plus
14373 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
14374 difference from the V8 ABI is that the global and out registers are
14375 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
14376 mode for all SPARC-V9 processors.
14377
14378 @item -mvis
14379 @itemx -mno-vis
14380 @opindex mvis
14381 @opindex mno-vis
14382 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
14383 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
14384 @end table
14385
14386 These @samp{-m} options are supported in addition to the above
14387 on SPARC-V9 processors in 64-bit environments:
14388
14389 @table @gcctabopt
14390 @item -mlittle-endian
14391 @opindex mlittle-endian
14392 Generate code for a processor running in little-endian mode.  It is only
14393 available for a few configurations and most notably not on Solaris and Linux.
14394
14395 @item -m32
14396 @itemx -m64
14397 @opindex m32
14398 @opindex m64
14399 Generate code for a 32-bit or 64-bit environment.
14400 The 32-bit environment sets int, long and pointer to 32 bits.
14401 The 64-bit environment sets int to 32 bits and long and pointer
14402 to 64 bits.
14403
14404 @item -mcmodel=medlow
14405 @opindex mcmodel=medlow
14406 Generate code for the Medium/Low code model: 64-bit addresses, programs
14407 must be linked in the low 32 bits of memory.  Programs can be statically
14408 or dynamically linked.
14409
14410 @item -mcmodel=medmid
14411 @opindex mcmodel=medmid
14412 Generate code for the Medium/Middle code model: 64-bit addresses, programs
14413 must be linked in the low 44 bits of memory, the text and data segments must
14414 be less than 2GB in size and the data segment must be located within 2GB of
14415 the text segment.
14416
14417 @item -mcmodel=medany
14418 @opindex mcmodel=medany
14419 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
14420 may be linked anywhere in memory, the text and data segments must be less
14421 than 2GB in size and the data segment must be located within 2GB of the
14422 text segment.
14423
14424 @item -mcmodel=embmedany
14425 @opindex mcmodel=embmedany
14426 Generate code for the Medium/Anywhere code model for embedded systems:
14427 64-bit addresses, the text and data segments must be less than 2GB in
14428 size, both starting anywhere in memory (determined at link time).  The
14429 global register %g4 points to the base of the data segment.  Programs
14430 are statically linked and PIC is not supported.
14431
14432 @item -mstack-bias
14433 @itemx -mno-stack-bias
14434 @opindex mstack-bias
14435 @opindex mno-stack-bias
14436 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
14437 frame pointer if present, are offset by @minus{}2047 which must be added back
14438 when making stack frame references.  This is the default in 64-bit mode.
14439 Otherwise, assume no such offset is present.
14440 @end table
14441
14442 These switches are supported in addition to the above on Solaris:
14443
14444 @table @gcctabopt
14445 @item -threads
14446 @opindex threads
14447 Add support for multithreading using the Solaris threads library.  This
14448 option sets flags for both the preprocessor and linker.  This option does
14449 not affect the thread safety of object code produced by the compiler or
14450 that of libraries supplied with it.
14451
14452 @item -pthreads
14453 @opindex pthreads
14454 Add support for multithreading using the POSIX threads library.  This
14455 option sets flags for both the preprocessor and linker.  This option does
14456 not affect the thread safety of object code produced  by the compiler or
14457 that of libraries supplied with it.
14458
14459 @item -pthread
14460 @opindex pthread
14461 This is a synonym for @option{-pthreads}.
14462 @end table
14463
14464 @node SPU Options
14465 @subsection SPU Options
14466 @cindex SPU options
14467
14468 These @samp{-m} options are supported on the SPU:
14469
14470 @table @gcctabopt
14471 @item -mwarn-reloc
14472 @itemx -merror-reloc
14473 @opindex mwarn-reloc
14474 @opindex merror-reloc
14475
14476 The loader for SPU does not handle dynamic relocations.  By default, GCC
14477 will give an error when it generates code that requires a dynamic
14478 relocation.  @option{-mno-error-reloc} disables the error,
14479 @option{-mwarn-reloc} will generate a warning instead.
14480
14481 @item -msafe-dma
14482 @itemx -munsafe-dma
14483 @opindex msafe-dma
14484 @opindex munsafe-dma
14485
14486 Instructions which initiate or test completion of DMA must not be
14487 reordered with respect to loads and stores of the memory which is being
14488 accessed.  Users typically address this problem using the volatile
14489 keyword, but that can lead to inefficient code in places where the
14490 memory is known to not change.  Rather than mark the memory as volatile
14491 we treat the DMA instructions as potentially effecting all memory.  With
14492 @option{-munsafe-dma} users must use the volatile keyword to protect
14493 memory accesses.
14494
14495 @item -mbranch-hints
14496 @opindex mbranch-hints
14497
14498 By default, GCC will generate a branch hint instruction to avoid
14499 pipeline stalls for always taken or probably taken branches.  A hint
14500 will not be generated closer than 8 instructions away from its branch.
14501 There is little reason to disable them, except for debugging purposes,
14502 or to make an object a little bit smaller.
14503
14504 @item -msmall-mem
14505 @itemx -mlarge-mem
14506 @opindex msmall-mem
14507 @opindex mlarge-mem
14508
14509 By default, GCC generates code assuming that addresses are never larger
14510 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
14511 a full 32 bit address.
14512
14513 @item -mstdmain
14514 @opindex mstdmain
14515
14516 By default, GCC links against startup code that assumes the SPU-style
14517 main function interface (which has an unconventional parameter list).
14518 With @option{-mstdmain}, GCC will link your program against startup
14519 code that assumes a C99-style interface to @code{main}, including a
14520 local copy of @code{argv} strings.
14521
14522 @item -mfixed-range=@var{register-range}
14523 @opindex mfixed-range
14524 Generate code treating the given register range as fixed registers.
14525 A fixed register is one that the register allocator can not use.  This is
14526 useful when compiling kernel code.  A register range is specified as
14527 two registers separated by a dash.  Multiple register ranges can be
14528 specified separated by a comma.
14529
14530 @end table
14531
14532 @node System V Options
14533 @subsection Options for System V
14534
14535 These additional options are available on System V Release 4 for
14536 compatibility with other compilers on those systems:
14537
14538 @table @gcctabopt
14539 @item -G
14540 @opindex G
14541 Create a shared object.
14542 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
14543
14544 @item -Qy
14545 @opindex Qy
14546 Identify the versions of each tool used by the compiler, in a
14547 @code{.ident} assembler directive in the output.
14548
14549 @item -Qn
14550 @opindex Qn
14551 Refrain from adding @code{.ident} directives to the output file (this is
14552 the default).
14553
14554 @item -YP,@var{dirs}
14555 @opindex YP
14556 Search the directories @var{dirs}, and no others, for libraries
14557 specified with @option{-l}.
14558
14559 @item -Ym,@var{dir}
14560 @opindex Ym
14561 Look in the directory @var{dir} to find the M4 preprocessor.
14562 The assembler uses this option.
14563 @c This is supposed to go with a -Yd for predefined M4 macro files, but
14564 @c the generic assembler that comes with Solaris takes just -Ym.
14565 @end table
14566
14567 @node V850 Options
14568 @subsection V850 Options
14569 @cindex V850 Options
14570
14571 These @samp{-m} options are defined for V850 implementations:
14572
14573 @table @gcctabopt
14574 @item -mlong-calls
14575 @itemx -mno-long-calls
14576 @opindex mlong-calls
14577 @opindex mno-long-calls
14578 Treat all calls as being far away (near).  If calls are assumed to be
14579 far away, the compiler will always load the functions address up into a
14580 register, and call indirect through the pointer.
14581
14582 @item -mno-ep
14583 @itemx -mep
14584 @opindex mno-ep
14585 @opindex mep
14586 Do not optimize (do optimize) basic blocks that use the same index
14587 pointer 4 or more times to copy pointer into the @code{ep} register, and
14588 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
14589 option is on by default if you optimize.
14590
14591 @item -mno-prolog-function
14592 @itemx -mprolog-function
14593 @opindex mno-prolog-function
14594 @opindex mprolog-function
14595 Do not use (do use) external functions to save and restore registers
14596 at the prologue and epilogue of a function.  The external functions
14597 are slower, but use less code space if more than one function saves
14598 the same number of registers.  The @option{-mprolog-function} option
14599 is on by default if you optimize.
14600
14601 @item -mspace
14602 @opindex mspace
14603 Try to make the code as small as possible.  At present, this just turns
14604 on the @option{-mep} and @option{-mprolog-function} options.
14605
14606 @item -mtda=@var{n}
14607 @opindex mtda
14608 Put static or global variables whose size is @var{n} bytes or less into
14609 the tiny data area that register @code{ep} points to.  The tiny data
14610 area can hold up to 256 bytes in total (128 bytes for byte references).
14611
14612 @item -msda=@var{n}
14613 @opindex msda
14614 Put static or global variables whose size is @var{n} bytes or less into
14615 the small data area that register @code{gp} points to.  The small data
14616 area can hold up to 64 kilobytes.
14617
14618 @item -mzda=@var{n}
14619 @opindex mzda
14620 Put static or global variables whose size is @var{n} bytes or less into
14621 the first 32 kilobytes of memory.
14622
14623 @item -mv850
14624 @opindex mv850
14625 Specify that the target processor is the V850.
14626
14627 @item -mbig-switch
14628 @opindex mbig-switch
14629 Generate code suitable for big switch tables.  Use this option only if
14630 the assembler/linker complain about out of range branches within a switch
14631 table.
14632
14633 @item -mapp-regs
14634 @opindex mapp-regs
14635 This option will cause r2 and r5 to be used in the code generated by
14636 the compiler.  This setting is the default.
14637
14638 @item -mno-app-regs
14639 @opindex mno-app-regs
14640 This option will cause r2 and r5 to be treated as fixed registers.
14641
14642 @item -mv850e1
14643 @opindex mv850e1
14644 Specify that the target processor is the V850E1.  The preprocessor
14645 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
14646 this option is used.
14647
14648 @item -mv850e
14649 @opindex mv850e
14650 Specify that the target processor is the V850E@.  The preprocessor
14651 constant @samp{__v850e__} will be defined if this option is used.
14652
14653 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
14654 are defined then a default target processor will be chosen and the
14655 relevant @samp{__v850*__} preprocessor constant will be defined.
14656
14657 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
14658 defined, regardless of which processor variant is the target.
14659
14660 @item -mdisable-callt
14661 @opindex mdisable-callt
14662 This option will suppress generation of the CALLT instruction for the
14663 v850e and v850e1 flavors of the v850 architecture.  The default is
14664 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
14665
14666 @end table
14667
14668 @node VAX Options
14669 @subsection VAX Options
14670 @cindex VAX options
14671
14672 These @samp{-m} options are defined for the VAX:
14673
14674 @table @gcctabopt
14675 @item -munix
14676 @opindex munix
14677 Do not output certain jump instructions (@code{aobleq} and so on)
14678 that the Unix assembler for the VAX cannot handle across long
14679 ranges.
14680
14681 @item -mgnu
14682 @opindex mgnu
14683 Do output those jump instructions, on the assumption that you
14684 will assemble with the GNU assembler.
14685
14686 @item -mg
14687 @opindex mg
14688 Output code for g-format floating point numbers instead of d-format.
14689 @end table
14690
14691 @node VxWorks Options
14692 @subsection VxWorks Options
14693 @cindex VxWorks Options
14694
14695 The options in this section are defined for all VxWorks targets.
14696 Options specific to the target hardware are listed with the other
14697 options for that target.
14698
14699 @table @gcctabopt
14700 @item -mrtp
14701 @opindex mrtp
14702 GCC can generate code for both VxWorks kernels and real time processes
14703 (RTPs).  This option switches from the former to the latter.  It also
14704 defines the preprocessor macro @code{__RTP__}.
14705
14706 @item -non-static
14707 @opindex non-static
14708 Link an RTP executable against shared libraries rather than static
14709 libraries.  The options @option{-static} and @option{-shared} can
14710 also be used for RTPs (@pxref{Link Options}); @option{-static}
14711 is the default.
14712
14713 @item -Bstatic
14714 @itemx -Bdynamic
14715 @opindex Bstatic
14716 @opindex Bdynamic
14717 These options are passed down to the linker.  They are defined for
14718 compatibility with Diab.
14719
14720 @item -Xbind-lazy
14721 @opindex Xbind-lazy
14722 Enable lazy binding of function calls.  This option is equivalent to
14723 @option{-Wl,-z,now} and is defined for compatibility with Diab.
14724
14725 @item -Xbind-now
14726 @opindex Xbind-now
14727 Disable lazy binding of function calls.  This option is the default and
14728 is defined for compatibility with Diab.
14729 @end table
14730
14731 @node x86-64 Options
14732 @subsection x86-64 Options
14733 @cindex x86-64 options
14734
14735 These are listed under @xref{i386 and x86-64 Options}.
14736
14737 @node Xstormy16 Options
14738 @subsection Xstormy16 Options
14739 @cindex Xstormy16 Options
14740
14741 These options are defined for Xstormy16:
14742
14743 @table @gcctabopt
14744 @item -msim
14745 @opindex msim
14746 Choose startup files and linker script suitable for the simulator.
14747 @end table
14748
14749 @node Xtensa Options
14750 @subsection Xtensa Options
14751 @cindex Xtensa Options
14752
14753 These options are supported for Xtensa targets:
14754
14755 @table @gcctabopt
14756 @item -mconst16
14757 @itemx -mno-const16
14758 @opindex mconst16
14759 @opindex mno-const16
14760 Enable or disable use of @code{CONST16} instructions for loading
14761 constant values.  The @code{CONST16} instruction is currently not a
14762 standard option from Tensilica.  When enabled, @code{CONST16}
14763 instructions are always used in place of the standard @code{L32R}
14764 instructions.  The use of @code{CONST16} is enabled by default only if
14765 the @code{L32R} instruction is not available.
14766
14767 @item -mfused-madd
14768 @itemx -mno-fused-madd
14769 @opindex mfused-madd
14770 @opindex mno-fused-madd
14771 Enable or disable use of fused multiply/add and multiply/subtract
14772 instructions in the floating-point option.  This has no effect if the
14773 floating-point option is not also enabled.  Disabling fused multiply/add
14774 and multiply/subtract instructions forces the compiler to use separate
14775 instructions for the multiply and add/subtract operations.  This may be
14776 desirable in some cases where strict IEEE 754-compliant results are
14777 required: the fused multiply add/subtract instructions do not round the
14778 intermediate result, thereby producing results with @emph{more} bits of
14779 precision than specified by the IEEE standard.  Disabling fused multiply
14780 add/subtract instructions also ensures that the program output is not
14781 sensitive to the compiler's ability to combine multiply and add/subtract
14782 operations.
14783
14784 @item -mserialize-volatile
14785 @itemx -mno-serialize-volatile
14786 @opindex mserialize-volatile
14787 @opindex mno-serialize-volatile
14788 When this option is enabled, GCC inserts @code{MEMW} instructions before
14789 @code{volatile} memory references to guarantee sequential consistency.
14790 The default is @option{-mserialize-volatile}.  Use
14791 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
14792
14793 @item -mtext-section-literals
14794 @itemx -mno-text-section-literals
14795 @opindex mtext-section-literals
14796 @opindex mno-text-section-literals
14797 Control the treatment of literal pools.  The default is
14798 @option{-mno-text-section-literals}, which places literals in a separate
14799 section in the output file.  This allows the literal pool to be placed
14800 in a data RAM/ROM, and it also allows the linker to combine literal
14801 pools from separate object files to remove redundant literals and
14802 improve code size.  With @option{-mtext-section-literals}, the literals
14803 are interspersed in the text section in order to keep them as close as
14804 possible to their references.  This may be necessary for large assembly
14805 files.
14806
14807 @item -mtarget-align
14808 @itemx -mno-target-align
14809 @opindex mtarget-align
14810 @opindex mno-target-align
14811 When this option is enabled, GCC instructs the assembler to
14812 automatically align instructions to reduce branch penalties at the
14813 expense of some code density.  The assembler attempts to widen density
14814 instructions to align branch targets and the instructions following call
14815 instructions.  If there are not enough preceding safe density
14816 instructions to align a target, no widening will be performed.  The
14817 default is @option{-mtarget-align}.  These options do not affect the
14818 treatment of auto-aligned instructions like @code{LOOP}, which the
14819 assembler will always align, either by widening density instructions or
14820 by inserting no-op instructions.
14821
14822 @item -mlongcalls
14823 @itemx -mno-longcalls
14824 @opindex mlongcalls
14825 @opindex mno-longcalls
14826 When this option is enabled, GCC instructs the assembler to translate
14827 direct calls to indirect calls unless it can determine that the target
14828 of a direct call is in the range allowed by the call instruction.  This
14829 translation typically occurs for calls to functions in other source
14830 files.  Specifically, the assembler translates a direct @code{CALL}
14831 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
14832 The default is @option{-mno-longcalls}.  This option should be used in
14833 programs where the call target can potentially be out of range.  This
14834 option is implemented in the assembler, not the compiler, so the
14835 assembly code generated by GCC will still show direct call
14836 instructions---look at the disassembled object code to see the actual
14837 instructions.  Note that the assembler will use an indirect call for
14838 every cross-file call, not just those that really will be out of range.
14839 @end table
14840
14841 @node zSeries Options
14842 @subsection zSeries Options
14843 @cindex zSeries options
14844
14845 These are listed under @xref{S/390 and zSeries Options}.
14846
14847 @node Code Gen Options
14848 @section Options for Code Generation Conventions
14849 @cindex code generation conventions
14850 @cindex options, code generation
14851 @cindex run-time options
14852
14853 These machine-independent options control the interface conventions
14854 used in code generation.
14855
14856 Most of them have both positive and negative forms; the negative form
14857 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
14858 one of the forms is listed---the one which is not the default.  You
14859 can figure out the other form by either removing @samp{no-} or adding
14860 it.
14861
14862 @table @gcctabopt
14863 @item -fbounds-check
14864 @opindex fbounds-check
14865 For front-ends that support it, generate additional code to check that
14866 indices used to access arrays are within the declared range.  This is
14867 currently only supported by the Java and Fortran front-ends, where
14868 this option defaults to true and false respectively.
14869
14870 @item -ftrapv
14871 @opindex ftrapv
14872 This option generates traps for signed overflow on addition, subtraction,
14873 multiplication operations.
14874
14875 @item -fwrapv
14876 @opindex fwrapv
14877 This option instructs the compiler to assume that signed arithmetic
14878 overflow of addition, subtraction and multiplication wraps around
14879 using twos-complement representation.  This flag enables some optimizations
14880 and disables others.  This option is enabled by default for the Java
14881 front-end, as required by the Java language specification.
14882
14883 @item -fexceptions
14884 @opindex fexceptions
14885 Enable exception handling.  Generates extra code needed to propagate
14886 exceptions.  For some targets, this implies GCC will generate frame
14887 unwind information for all functions, which can produce significant data
14888 size overhead, although it does not affect execution.  If you do not
14889 specify this option, GCC will enable it by default for languages like
14890 C++ which normally require exception handling, and disable it for
14891 languages like C that do not normally require it.  However, you may need
14892 to enable this option when compiling C code that needs to interoperate
14893 properly with exception handlers written in C++.  You may also wish to
14894 disable this option if you are compiling older C++ programs that don't
14895 use exception handling.
14896
14897 @item -fnon-call-exceptions
14898 @opindex fnon-call-exceptions
14899 Generate code that allows trapping instructions to throw exceptions.
14900 Note that this requires platform-specific runtime support that does
14901 not exist everywhere.  Moreover, it only allows @emph{trapping}
14902 instructions to throw exceptions, i.e.@: memory references or floating
14903 point instructions.  It does not allow exceptions to be thrown from
14904 arbitrary signal handlers such as @code{SIGALRM}.
14905
14906 @item -funwind-tables
14907 @opindex funwind-tables
14908 Similar to @option{-fexceptions}, except that it will just generate any needed
14909 static data, but will not affect the generated code in any other way.
14910 You will normally not enable this option; instead, a language processor
14911 that needs this handling would enable it on your behalf.
14912
14913 @item -fasynchronous-unwind-tables
14914 @opindex fasynchronous-unwind-tables
14915 Generate unwind table in dwarf2 format, if supported by target machine.  The
14916 table is exact at each instruction boundary, so it can be used for stack
14917 unwinding from asynchronous events (such as debugger or garbage collector).
14918
14919 @item -fpcc-struct-return
14920 @opindex fpcc-struct-return
14921 Return ``short'' @code{struct} and @code{union} values in memory like
14922 longer ones, rather than in registers.  This convention is less
14923 efficient, but it has the advantage of allowing intercallability between
14924 GCC-compiled files and files compiled with other compilers, particularly
14925 the Portable C Compiler (pcc).
14926
14927 The precise convention for returning structures in memory depends
14928 on the target configuration macros.
14929
14930 Short structures and unions are those whose size and alignment match
14931 that of some integer type.
14932
14933 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
14934 switch is not binary compatible with code compiled with the
14935 @option{-freg-struct-return} switch.
14936 Use it to conform to a non-default application binary interface.
14937
14938 @item -freg-struct-return
14939 @opindex freg-struct-return
14940 Return @code{struct} and @code{union} values in registers when possible.
14941 This is more efficient for small structures than
14942 @option{-fpcc-struct-return}.
14943
14944 If you specify neither @option{-fpcc-struct-return} nor
14945 @option{-freg-struct-return}, GCC defaults to whichever convention is
14946 standard for the target.  If there is no standard convention, GCC
14947 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
14948 the principal compiler.  In those cases, we can choose the standard, and
14949 we chose the more efficient register return alternative.
14950
14951 @strong{Warning:} code compiled with the @option{-freg-struct-return}
14952 switch is not binary compatible with code compiled with the
14953 @option{-fpcc-struct-return} switch.
14954 Use it to conform to a non-default application binary interface.
14955
14956 @item -fshort-enums
14957 @opindex fshort-enums
14958 Allocate to an @code{enum} type only as many bytes as it needs for the
14959 declared range of possible values.  Specifically, the @code{enum} type
14960 will be equivalent to the smallest integer type which has enough room.
14961
14962 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
14963 code that is not binary compatible with code generated without that switch.
14964 Use it to conform to a non-default application binary interface.
14965
14966 @item -fshort-double
14967 @opindex fshort-double
14968 Use the same size for @code{double} as for @code{float}.
14969
14970 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
14971 code that is not binary compatible with code generated without that switch.
14972 Use it to conform to a non-default application binary interface.
14973
14974 @item -fshort-wchar
14975 @opindex fshort-wchar
14976 Override the underlying type for @samp{wchar_t} to be @samp{short
14977 unsigned int} instead of the default for the target.  This option is
14978 useful for building programs to run under WINE@.
14979
14980 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
14981 code that is not binary compatible with code generated without that switch.
14982 Use it to conform to a non-default application binary interface.
14983
14984 @item -fno-common
14985 @opindex fno-common
14986 In C, allocate even uninitialized global variables in the data section of the
14987 object file, rather than generating them as common blocks.  This has the
14988 effect that if the same variable is declared (without @code{extern}) in
14989 two different compilations, you will get an error when you link them.
14990 The only reason this might be useful is if you wish to verify that the
14991 program will work on other systems which always work this way.
14992
14993 @item -fno-ident
14994 @opindex fno-ident
14995 Ignore the @samp{#ident} directive.
14996
14997 @item -finhibit-size-directive
14998 @opindex finhibit-size-directive
14999 Don't output a @code{.size} assembler directive, or anything else that
15000 would cause trouble if the function is split in the middle, and the
15001 two halves are placed at locations far apart in memory.  This option is
15002 used when compiling @file{crtstuff.c}; you should not need to use it
15003 for anything else.
15004
15005 @item -fverbose-asm
15006 @opindex fverbose-asm
15007 Put extra commentary information in the generated assembly code to
15008 make it more readable.  This option is generally only of use to those
15009 who actually need to read the generated assembly code (perhaps while
15010 debugging the compiler itself).
15011
15012 @option{-fno-verbose-asm}, the default, causes the
15013 extra information to be omitted and is useful when comparing two assembler
15014 files.
15015
15016 @item -frecord-gcc-switches
15017 @opindex frecord-gcc-switches
15018 This switch causes the command line that was used to invoke the
15019 compiler to be recorded into the object file that is being created.
15020 This switch is only implemented on some targets and the exact format
15021 of the recording is target and binary file format dependent, but it
15022 usually takes the form of a section containing ASCII text.  This
15023 switch is related to the @option{-fverbose-asm} switch, but that
15024 switch only records information in the assembler output file as
15025 comments, so it never reaches the object file.
15026
15027 @item -fpic
15028 @opindex fpic
15029 @cindex global offset table
15030 @cindex PIC
15031 Generate position-independent code (PIC) suitable for use in a shared
15032 library, if supported for the target machine.  Such code accesses all
15033 constant addresses through a global offset table (GOT)@.  The dynamic
15034 loader resolves the GOT entries when the program starts (the dynamic
15035 loader is not part of GCC; it is part of the operating system).  If
15036 the GOT size for the linked executable exceeds a machine-specific
15037 maximum size, you get an error message from the linker indicating that
15038 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
15039 instead.  (These maximums are 8k on the SPARC and 32k
15040 on the m68k and RS/6000.  The 386 has no such limit.)
15041
15042 Position-independent code requires special support, and therefore works
15043 only on certain machines.  For the 386, GCC supports PIC for System V
15044 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
15045 position-independent.
15046
15047 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15048 are defined to 1.
15049
15050 @item -fPIC
15051 @opindex fPIC
15052 If supported for the target machine, emit position-independent code,
15053 suitable for dynamic linking and avoiding any limit on the size of the
15054 global offset table.  This option makes a difference on the m68k,
15055 PowerPC and SPARC@.
15056
15057 Position-independent code requires special support, and therefore works
15058 only on certain machines.
15059
15060 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15061 are defined to 2.
15062
15063 @item -fpie
15064 @itemx -fPIE
15065 @opindex fpie
15066 @opindex fPIE
15067 These options are similar to @option{-fpic} and @option{-fPIC}, but
15068 generated position independent code can be only linked into executables.
15069 Usually these options are used when @option{-pie} GCC option will be
15070 used during linking.
15071
15072 @option{-fpie} and @option{-fPIE} both define the macros
15073 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
15074 for @option{-fpie} and 2 for @option{-fPIE}.
15075
15076 @item -fno-jump-tables
15077 @opindex fno-jump-tables
15078 Do not use jump tables for switch statements even where it would be
15079 more efficient than other code generation strategies.  This option is
15080 of use in conjunction with @option{-fpic} or @option{-fPIC} for
15081 building code which forms part of a dynamic linker and cannot
15082 reference the address of a jump table.  On some targets, jump tables
15083 do not require a GOT and this option is not needed.
15084
15085 @item -ffixed-@var{reg}
15086 @opindex ffixed
15087 Treat the register named @var{reg} as a fixed register; generated code
15088 should never refer to it (except perhaps as a stack pointer, frame
15089 pointer or in some other fixed role).
15090
15091 @var{reg} must be the name of a register.  The register names accepted
15092 are machine-specific and are defined in the @code{REGISTER_NAMES}
15093 macro in the machine description macro file.
15094
15095 This flag does not have a negative form, because it specifies a
15096 three-way choice.
15097
15098 @item -fcall-used-@var{reg}
15099 @opindex fcall-used
15100 Treat the register named @var{reg} as an allocable register that is
15101 clobbered by function calls.  It may be allocated for temporaries or
15102 variables that do not live across a call.  Functions compiled this way
15103 will not save and restore the register @var{reg}.
15104
15105 It is an error to used this flag with the frame pointer or stack pointer.
15106 Use of this flag for other registers that have fixed pervasive roles in
15107 the machine's execution model will produce disastrous results.
15108
15109 This flag does not have a negative form, because it specifies a
15110 three-way choice.
15111
15112 @item -fcall-saved-@var{reg}
15113 @opindex fcall-saved
15114 Treat the register named @var{reg} as an allocable register saved by
15115 functions.  It may be allocated even for temporaries or variables that
15116 live across a call.  Functions compiled this way will save and restore
15117 the register @var{reg} if they use it.
15118
15119 It is an error to used this flag with the frame pointer or stack pointer.
15120 Use of this flag for other registers that have fixed pervasive roles in
15121 the machine's execution model will produce disastrous results.
15122
15123 A different sort of disaster will result from the use of this flag for
15124 a register in which function values may be returned.
15125
15126 This flag does not have a negative form, because it specifies a
15127 three-way choice.
15128
15129 @item -fpack-struct[=@var{n}]
15130 @opindex fpack-struct
15131 Without a value specified, pack all structure members together without
15132 holes.  When a value is specified (which must be a small power of two), pack
15133 structure members according to this value, representing the maximum
15134 alignment (that is, objects with default alignment requirements larger than
15135 this will be output potentially unaligned at the next fitting location.
15136
15137 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
15138 code that is not binary compatible with code generated without that switch.
15139 Additionally, it makes the code suboptimal.
15140 Use it to conform to a non-default application binary interface.
15141
15142 @item -finstrument-functions
15143 @opindex finstrument-functions
15144 Generate instrumentation calls for entry and exit to functions.  Just
15145 after function entry and just before function exit, the following
15146 profiling functions will be called with the address of the current
15147 function and its call site.  (On some platforms,
15148 @code{__builtin_return_address} does not work beyond the current
15149 function, so the call site information may not be available to the
15150 profiling functions otherwise.)
15151
15152 @smallexample
15153 void __cyg_profile_func_enter (void *this_fn,
15154                                void *call_site);
15155 void __cyg_profile_func_exit  (void *this_fn,
15156                                void *call_site);
15157 @end smallexample
15158
15159 The first argument is the address of the start of the current function,
15160 which may be looked up exactly in the symbol table.
15161
15162 This instrumentation is also done for functions expanded inline in other
15163 functions.  The profiling calls will indicate where, conceptually, the
15164 inline function is entered and exited.  This means that addressable
15165 versions of such functions must be available.  If all your uses of a
15166 function are expanded inline, this may mean an additional expansion of
15167 code size.  If you use @samp{extern inline} in your C code, an
15168 addressable version of such functions must be provided.  (This is
15169 normally the case anyways, but if you get lucky and the optimizer always
15170 expands the functions inline, you might have gotten away without
15171 providing static copies.)
15172
15173 A function may be given the attribute @code{no_instrument_function}, in
15174 which case this instrumentation will not be done.  This can be used, for
15175 example, for the profiling functions listed above, high-priority
15176 interrupt routines, and any functions from which the profiling functions
15177 cannot safely be called (perhaps signal handlers, if the profiling
15178 routines generate output or allocate memory).
15179
15180 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
15181 @opindex finstrument-functions-exclude-file-list
15182
15183 Set the list of functions that are excluded from instrumentation (see
15184 the description of @code{-finstrument-functions}).  If the file that
15185 contains a function definition matches with one of @var{file}, then
15186 that function is not instrumented.  The match is done on substrings:
15187 if the @var{file} parameter is a substring of the file name, it is
15188 considered to be a match.
15189
15190 For example,
15191 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
15192 will exclude any inline function defined in files whose pathnames
15193 contain @code{/bits/stl} or @code{include/sys}.
15194
15195 If, for some reason, you want to include letter @code{','} in one of
15196 @var{sym}, write @code{'\,'}. For example,
15197 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
15198 (note the single quote surrounding the option).
15199
15200 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
15201 @opindex finstrument-functions-exclude-function-list
15202
15203 This is similar to @code{-finstrument-functions-exclude-file-list},
15204 but this option sets the list of function names to be excluded from
15205 instrumentation.  The function name to be matched is its user-visible
15206 name, such as @code{vector<int> blah(const vector<int> &)}, not the
15207 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
15208 match is done on substrings: if the @var{sym} parameter is a substring
15209 of the function name, it is considered to be a match.
15210
15211 @item -fstack-check
15212 @opindex fstack-check
15213 Generate code to verify that you do not go beyond the boundary of the
15214 stack.  You should specify this flag if you are running in an
15215 environment with multiple threads, but only rarely need to specify it in
15216 a single-threaded environment since stack overflow is automatically
15217 detected on nearly all systems if there is only one stack.
15218
15219 Note that this switch does not actually cause checking to be done; the
15220 operating system must do that.  The switch causes generation of code
15221 to ensure that the operating system sees the stack being extended.
15222
15223 @item -fstack-limit-register=@var{reg}
15224 @itemx -fstack-limit-symbol=@var{sym}
15225 @itemx -fno-stack-limit
15226 @opindex fstack-limit-register
15227 @opindex fstack-limit-symbol
15228 @opindex fno-stack-limit
15229 Generate code to ensure that the stack does not grow beyond a certain value,
15230 either the value of a register or the address of a symbol.  If the stack
15231 would grow beyond the value, a signal is raised.  For most targets,
15232 the signal is raised before the stack overruns the boundary, so
15233 it is possible to catch the signal without taking special precautions.
15234
15235 For instance, if the stack starts at absolute address @samp{0x80000000}
15236 and grows downwards, you can use the flags
15237 @option{-fstack-limit-symbol=__stack_limit} and
15238 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
15239 of 128KB@.  Note that this may only work with the GNU linker.
15240
15241 @cindex aliasing of parameters
15242 @cindex parameters, aliased
15243 @item -fargument-alias
15244 @itemx -fargument-noalias
15245 @itemx -fargument-noalias-global
15246 @itemx -fargument-noalias-anything
15247 @opindex fargument-alias
15248 @opindex fargument-noalias
15249 @opindex fargument-noalias-global
15250 @opindex fargument-noalias-anything
15251 Specify the possible relationships among parameters and between
15252 parameters and global data.
15253
15254 @option{-fargument-alias} specifies that arguments (parameters) may
15255 alias each other and may alias global storage.@*
15256 @option{-fargument-noalias} specifies that arguments do not alias
15257 each other, but may alias global storage.@*
15258 @option{-fargument-noalias-global} specifies that arguments do not
15259 alias each other and do not alias global storage.
15260 @option{-fargument-noalias-anything} specifies that arguments do not
15261 alias any other storage.
15262
15263 Each language will automatically use whatever option is required by
15264 the language standard.  You should not need to use these options yourself.
15265
15266 @item -fleading-underscore
15267 @opindex fleading-underscore
15268 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
15269 change the way C symbols are represented in the object file.  One use
15270 is to help link with legacy assembly code.
15271
15272 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
15273 generate code that is not binary compatible with code generated without that
15274 switch.  Use it to conform to a non-default application binary interface.
15275 Not all targets provide complete support for this switch.
15276
15277 @item -ftls-model=@var{model}
15278 @opindex ftls-model
15279 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
15280 The @var{model} argument should be one of @code{global-dynamic},
15281 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
15282
15283 The default without @option{-fpic} is @code{initial-exec}; with
15284 @option{-fpic} the default is @code{global-dynamic}.
15285
15286 @item -fvisibility=@var{default|internal|hidden|protected}
15287 @opindex fvisibility
15288 Set the default ELF image symbol visibility to the specified option---all
15289 symbols will be marked with this unless overridden within the code.
15290 Using this feature can very substantially improve linking and
15291 load times of shared object libraries, produce more optimized
15292 code, provide near-perfect API export and prevent symbol clashes.
15293 It is @strong{strongly} recommended that you use this in any shared objects
15294 you distribute.
15295
15296 Despite the nomenclature, @code{default} always means public ie;
15297 available to be linked against from outside the shared object.
15298 @code{protected} and @code{internal} are pretty useless in real-world
15299 usage so the only other commonly used option will be @code{hidden}.
15300 The default if @option{-fvisibility} isn't specified is
15301 @code{default}, i.e., make every
15302 symbol public---this causes the same behavior as previous versions of
15303 GCC@.
15304
15305 A good explanation of the benefits offered by ensuring ELF
15306 symbols have the correct visibility is given by ``How To Write
15307 Shared Libraries'' by Ulrich Drepper (which can be found at
15308 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
15309 solution made possible by this option to marking things hidden when
15310 the default is public is to make the default hidden and mark things
15311 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
15312 and @code{__attribute__ ((visibility("default")))} instead of
15313 @code{__declspec(dllexport)} you get almost identical semantics with
15314 identical syntax.  This is a great boon to those working with
15315 cross-platform projects.
15316
15317 For those adding visibility support to existing code, you may find
15318 @samp{#pragma GCC visibility} of use.  This works by you enclosing
15319 the declarations you wish to set visibility for with (for example)
15320 @samp{#pragma GCC visibility push(hidden)} and
15321 @samp{#pragma GCC visibility pop}.
15322 Bear in mind that symbol visibility should be viewed @strong{as
15323 part of the API interface contract} and thus all new code should
15324 always specify visibility when it is not the default ie; declarations
15325 only for use within the local DSO should @strong{always} be marked explicitly
15326 as hidden as so to avoid PLT indirection overheads---making this
15327 abundantly clear also aids readability and self-documentation of the code.
15328 Note that due to ISO C++ specification requirements, operator new and
15329 operator delete must always be of default visibility.
15330
15331 Be aware that headers from outside your project, in particular system
15332 headers and headers from any other library you use, may not be
15333 expecting to be compiled with visibility other than the default.  You
15334 may need to explicitly say @samp{#pragma GCC visibility push(default)}
15335 before including any such headers.
15336
15337 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
15338 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
15339 no modifications.  However, this means that calls to @samp{extern}
15340 functions with no explicit visibility will use the PLT, so it is more
15341 effective to use @samp{__attribute ((visibility))} and/or
15342 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
15343 declarations should be treated as hidden.
15344
15345 Note that @samp{-fvisibility} does affect C++ vague linkage
15346 entities. This means that, for instance, an exception class that will
15347 be thrown between DSOs must be explicitly marked with default
15348 visibility so that the @samp{type_info} nodes will be unified between
15349 the DSOs.
15350
15351 An overview of these techniques, their benefits and how to use them
15352 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
15353
15354 @end table
15355
15356 @c man end
15357
15358 @node Environment Variables
15359 @section Environment Variables Affecting GCC
15360 @cindex environment variables
15361
15362 @c man begin ENVIRONMENT
15363 This section describes several environment variables that affect how GCC
15364 operates.  Some of them work by specifying directories or prefixes to use
15365 when searching for various kinds of files.  Some are used to specify other
15366 aspects of the compilation environment.
15367
15368 Note that you can also specify places to search using options such as
15369 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
15370 take precedence over places specified using environment variables, which
15371 in turn take precedence over those specified by the configuration of GCC@.
15372 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
15373 GNU Compiler Collection (GCC) Internals}.
15374
15375 @table @env
15376 @item LANG
15377 @itemx LC_CTYPE
15378 @c @itemx LC_COLLATE
15379 @itemx LC_MESSAGES
15380 @c @itemx LC_MONETARY
15381 @c @itemx LC_NUMERIC
15382 @c @itemx LC_TIME
15383 @itemx LC_ALL
15384 @findex LANG
15385 @findex LC_CTYPE
15386 @c @findex LC_COLLATE
15387 @findex LC_MESSAGES
15388 @c @findex LC_MONETARY
15389 @c @findex LC_NUMERIC
15390 @c @findex LC_TIME
15391 @findex LC_ALL
15392 @cindex locale
15393 These environment variables control the way that GCC uses
15394 localization information that allow GCC to work with different
15395 national conventions.  GCC inspects the locale categories
15396 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
15397 so.  These locale categories can be set to any value supported by your
15398 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
15399 Kingdom encoded in UTF-8.
15400
15401 The @env{LC_CTYPE} environment variable specifies character
15402 classification.  GCC uses it to determine the character boundaries in
15403 a string; this is needed for some multibyte encodings that contain quote
15404 and escape characters that would otherwise be interpreted as a string
15405 end or escape.
15406
15407 The @env{LC_MESSAGES} environment variable specifies the language to
15408 use in diagnostic messages.
15409
15410 If the @env{LC_ALL} environment variable is set, it overrides the value
15411 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
15412 and @env{LC_MESSAGES} default to the value of the @env{LANG}
15413 environment variable.  If none of these variables are set, GCC
15414 defaults to traditional C English behavior.
15415
15416 @item TMPDIR
15417 @findex TMPDIR
15418 If @env{TMPDIR} is set, it specifies the directory to use for temporary
15419 files.  GCC uses temporary files to hold the output of one stage of
15420 compilation which is to be used as input to the next stage: for example,
15421 the output of the preprocessor, which is the input to the compiler
15422 proper.
15423
15424 @item GCC_EXEC_PREFIX
15425 @findex GCC_EXEC_PREFIX
15426 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
15427 names of the subprograms executed by the compiler.  No slash is added
15428 when this prefix is combined with the name of a subprogram, but you can
15429 specify a prefix that ends with a slash if you wish.
15430
15431 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
15432 an appropriate prefix to use based on the pathname it was invoked with.
15433
15434 If GCC cannot find the subprogram using the specified prefix, it
15435 tries looking in the usual places for the subprogram.
15436
15437 The default value of @env{GCC_EXEC_PREFIX} is
15438 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
15439 the installed compiler. In many cases @var{prefix} is the value
15440 of @code{prefix} when you ran the @file{configure} script.
15441
15442 Other prefixes specified with @option{-B} take precedence over this prefix.
15443
15444 This prefix is also used for finding files such as @file{crt0.o} that are
15445 used for linking.
15446
15447 In addition, the prefix is used in an unusual way in finding the
15448 directories to search for header files.  For each of the standard
15449 directories whose name normally begins with @samp{/usr/local/lib/gcc}
15450 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
15451 replacing that beginning with the specified prefix to produce an
15452 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
15453 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
15454 These alternate directories are searched first; the standard directories
15455 come next. If a standard directory begins with the configured
15456 @var{prefix} then the value of @var{prefix} is replaced by
15457 @env{GCC_EXEC_PREFIX} when looking for header files.
15458
15459 @item COMPILER_PATH
15460 @findex COMPILER_PATH
15461 The value of @env{COMPILER_PATH} is a colon-separated list of
15462 directories, much like @env{PATH}.  GCC tries the directories thus
15463 specified when searching for subprograms, if it can't find the
15464 subprograms using @env{GCC_EXEC_PREFIX}.
15465
15466 @item LIBRARY_PATH
15467 @findex LIBRARY_PATH
15468 The value of @env{LIBRARY_PATH} is a colon-separated list of
15469 directories, much like @env{PATH}.  When configured as a native compiler,
15470 GCC tries the directories thus specified when searching for special
15471 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
15472 using GCC also uses these directories when searching for ordinary
15473 libraries for the @option{-l} option (but directories specified with
15474 @option{-L} come first).
15475
15476 @item LANG
15477 @findex LANG
15478 @cindex locale definition
15479 This variable is used to pass locale information to the compiler.  One way in
15480 which this information is used is to determine the character set to be used
15481 when character literals, string literals and comments are parsed in C and C++.
15482 When the compiler is configured to allow multibyte characters,
15483 the following values for @env{LANG} are recognized:
15484
15485 @table @samp
15486 @item C-JIS
15487 Recognize JIS characters.
15488 @item C-SJIS
15489 Recognize SJIS characters.
15490 @item C-EUCJP
15491 Recognize EUCJP characters.
15492 @end table
15493
15494 If @env{LANG} is not defined, or if it has some other value, then the
15495 compiler will use mblen and mbtowc as defined by the default locale to
15496 recognize and translate multibyte characters.
15497 @end table
15498
15499 @noindent
15500 Some additional environments variables affect the behavior of the
15501 preprocessor.
15502
15503 @include cppenv.texi
15504
15505 @c man end
15506
15507 @node Precompiled Headers
15508 @section Using Precompiled Headers
15509 @cindex precompiled headers
15510 @cindex speed of compilation
15511
15512 Often large projects have many header files that are included in every
15513 source file.  The time the compiler takes to process these header files
15514 over and over again can account for nearly all of the time required to
15515 build the project.  To make builds faster, GCC allows users to
15516 `precompile' a header file; then, if builds can use the precompiled
15517 header file they will be much faster.
15518
15519 To create a precompiled header file, simply compile it as you would any
15520 other file, if necessary using the @option{-x} option to make the driver
15521 treat it as a C or C++ header file.  You will probably want to use a
15522 tool like @command{make} to keep the precompiled header up-to-date when
15523 the headers it contains change.
15524
15525 A precompiled header file will be searched for when @code{#include} is
15526 seen in the compilation.  As it searches for the included file
15527 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
15528 compiler looks for a precompiled header in each directory just before it
15529 looks for the include file in that directory.  The name searched for is
15530 the name specified in the @code{#include} with @samp{.gch} appended.  If
15531 the precompiled header file can't be used, it is ignored.
15532
15533 For instance, if you have @code{#include "all.h"}, and you have
15534 @file{all.h.gch} in the same directory as @file{all.h}, then the
15535 precompiled header file will be used if possible, and the original
15536 header will be used otherwise.
15537
15538 Alternatively, you might decide to put the precompiled header file in a
15539 directory and use @option{-I} to ensure that directory is searched
15540 before (or instead of) the directory containing the original header.
15541 Then, if you want to check that the precompiled header file is always
15542 used, you can put a file of the same name as the original header in this
15543 directory containing an @code{#error} command.
15544
15545 This also works with @option{-include}.  So yet another way to use
15546 precompiled headers, good for projects not designed with precompiled
15547 header files in mind, is to simply take most of the header files used by
15548 a project, include them from another header file, precompile that header
15549 file, and @option{-include} the precompiled header.  If the header files
15550 have guards against multiple inclusion, they will be skipped because
15551 they've already been included (in the precompiled header).
15552
15553 If you need to precompile the same header file for different
15554 languages, targets, or compiler options, you can instead make a
15555 @emph{directory} named like @file{all.h.gch}, and put each precompiled
15556 header in the directory, perhaps using @option{-o}.  It doesn't matter
15557 what you call the files in the directory, every precompiled header in
15558 the directory will be considered.  The first precompiled header
15559 encountered in the directory that is valid for this compilation will
15560 be used; they're searched in no particular order.
15561
15562 There are many other possibilities, limited only by your imagination,
15563 good sense, and the constraints of your build system.
15564
15565 A precompiled header file can be used only when these conditions apply:
15566
15567 @itemize
15568 @item
15569 Only one precompiled header can be used in a particular compilation.
15570
15571 @item
15572 A precompiled header can't be used once the first C token is seen.  You
15573 can have preprocessor directives before a precompiled header; you can
15574 even include a precompiled header from inside another header, so long as
15575 there are no C tokens before the @code{#include}.
15576
15577 @item
15578 The precompiled header file must be produced for the same language as
15579 the current compilation.  You can't use a C precompiled header for a C++
15580 compilation.
15581
15582 @item
15583 The precompiled header file must have been produced by the same compiler
15584 binary as the current compilation is using.
15585
15586 @item
15587 Any macros defined before the precompiled header is included must
15588 either be defined in the same way as when the precompiled header was
15589 generated, or must not affect the precompiled header, which usually
15590 means that they don't appear in the precompiled header at all.
15591
15592 The @option{-D} option is one way to define a macro before a
15593 precompiled header is included; using a @code{#define} can also do it.
15594 There are also some options that define macros implicitly, like
15595 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
15596 defined this way.
15597
15598 @item If debugging information is output when using the precompiled
15599 header, using @option{-g} or similar, the same kind of debugging information
15600 must have been output when building the precompiled header.  However,
15601 a precompiled header built using @option{-g} can be used in a compilation
15602 when no debugging information is being output.
15603
15604 @item The same @option{-m} options must generally be used when building
15605 and using the precompiled header.  @xref{Submodel Options},
15606 for any cases where this rule is relaxed.
15607
15608 @item Each of the following options must be the same when building and using
15609 the precompiled header:
15610
15611 @gccoptlist{-fexceptions -funit-at-a-time}
15612
15613 @item
15614 Some other command-line options starting with @option{-f},
15615 @option{-p}, or @option{-O} must be defined in the same way as when
15616 the precompiled header was generated.  At present, it's not clear
15617 which options are safe to change and which are not; the safest choice
15618 is to use exactly the same options when generating and using the
15619 precompiled header.  The following are known to be safe:
15620
15621 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
15622 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
15623 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
15624 -pedantic-errors}
15625
15626 @end itemize
15627
15628 For all of these except the last, the compiler will automatically
15629 ignore the precompiled header if the conditions aren't met.  If you
15630 find an option combination that doesn't work and doesn't cause the
15631 precompiled header to be ignored, please consider filing a bug report,
15632 see @ref{Bugs}.
15633
15634 If you do use differing options when generating and using the
15635 precompiled header, the actual behavior will be a mixture of the
15636 behavior for the options.  For instance, if you use @option{-g} to
15637 generate the precompiled header but not when using it, you may or may
15638 not get debugging information for routines in the precompiled header.
15639
15640 @node Running Protoize
15641 @section Running Protoize
15642
15643 The program @code{protoize} is an optional part of GCC@.  You can use
15644 it to add prototypes to a program, thus converting the program to ISO
15645 C in one respect.  The companion program @code{unprotoize} does the
15646 reverse: it removes argument types from any prototypes that are found.
15647
15648 When you run these programs, you must specify a set of source files as
15649 command line arguments.  The conversion programs start out by compiling
15650 these files to see what functions they define.  The information gathered
15651 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
15652
15653 After scanning comes actual conversion.  The specified files are all
15654 eligible to be converted; any files they include (whether sources or
15655 just headers) are eligible as well.
15656
15657 But not all the eligible files are converted.  By default,
15658 @code{protoize} and @code{unprotoize} convert only source and header
15659 files in the current directory.  You can specify additional directories
15660 whose files should be converted with the @option{-d @var{directory}}
15661 option.  You can also specify particular files to exclude with the
15662 @option{-x @var{file}} option.  A file is converted if it is eligible, its
15663 directory name matches one of the specified directory names, and its
15664 name within the directory has not been excluded.
15665
15666 Basic conversion with @code{protoize} consists of rewriting most
15667 function definitions and function declarations to specify the types of
15668 the arguments.  The only ones not rewritten are those for varargs
15669 functions.
15670
15671 @code{protoize} optionally inserts prototype declarations at the
15672 beginning of the source file, to make them available for any calls that
15673 precede the function's definition.  Or it can insert prototype
15674 declarations with block scope in the blocks where undeclared functions
15675 are called.
15676
15677 Basic conversion with @code{unprotoize} consists of rewriting most
15678 function declarations to remove any argument types, and rewriting
15679 function definitions to the old-style pre-ISO form.
15680
15681 Both conversion programs print a warning for any function declaration or
15682 definition that they can't convert.  You can suppress these warnings
15683 with @option{-q}.
15684
15685 The output from @code{protoize} or @code{unprotoize} replaces the
15686 original source file.  The original file is renamed to a name ending
15687 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
15688 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
15689 for DOS) file already exists, then the source file is simply discarded.
15690
15691 @code{protoize} and @code{unprotoize} both depend on GCC itself to
15692 scan the program and collect information about the functions it uses.
15693 So neither of these programs will work until GCC is installed.
15694
15695 Here is a table of the options you can use with @code{protoize} and
15696 @code{unprotoize}.  Each option works with both programs unless
15697 otherwise stated.
15698
15699 @table @code
15700 @item -B @var{directory}
15701 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
15702 usual directory (normally @file{/usr/local/lib}).  This file contains
15703 prototype information about standard system functions.  This option
15704 applies only to @code{protoize}.
15705
15706 @item -c @var{compilation-options}
15707 Use @var{compilation-options} as the options when running @command{gcc} to
15708 produce the @samp{.X} files.  The special option @option{-aux-info} is
15709 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
15710
15711 Note that the compilation options must be given as a single argument to
15712 @code{protoize} or @code{unprotoize}.  If you want to specify several
15713 @command{gcc} options, you must quote the entire set of compilation options
15714 to make them a single word in the shell.
15715
15716 There are certain @command{gcc} arguments that you cannot use, because they
15717 would produce the wrong kind of output.  These include @option{-g},
15718 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
15719 the @var{compilation-options}, they are ignored.
15720
15721 @item -C
15722 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
15723 systems) instead of @samp{.c}.  This is convenient if you are converting
15724 a C program to C++.  This option applies only to @code{protoize}.
15725
15726 @item -g
15727 Add explicit global declarations.  This means inserting explicit
15728 declarations at the beginning of each source file for each function
15729 that is called in the file and was not declared.  These declarations
15730 precede the first function definition that contains a call to an
15731 undeclared function.  This option applies only to @code{protoize}.
15732
15733 @item -i @var{string}
15734 Indent old-style parameter declarations with the string @var{string}.
15735 This option applies only to @code{protoize}.
15736
15737 @code{unprotoize} converts prototyped function definitions to old-style
15738 function definitions, where the arguments are declared between the
15739 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
15740 uses five spaces as the indentation.  If you want to indent with just
15741 one space instead, use @option{-i " "}.
15742
15743 @item -k
15744 Keep the @samp{.X} files.  Normally, they are deleted after conversion
15745 is finished.
15746
15747 @item -l
15748 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
15749 a prototype declaration for each function in each block which calls the
15750 function without any declaration.  This option applies only to
15751 @code{protoize}.
15752
15753 @item -n
15754 Make no real changes.  This mode just prints information about the conversions
15755 that would have been done without @option{-n}.
15756
15757 @item -N
15758 Make no @samp{.save} files.  The original files are simply deleted.
15759 Use this option with caution.
15760
15761 @item -p @var{program}
15762 Use the program @var{program} as the compiler.  Normally, the name
15763 @file{gcc} is used.
15764
15765 @item -q
15766 Work quietly.  Most warnings are suppressed.
15767
15768 @item -v
15769 Print the version number, just like @option{-v} for @command{gcc}.
15770 @end table
15771
15772 If you need special compiler options to compile one of your program's
15773 source files, then you should generate that file's @samp{.X} file
15774 specially, by running @command{gcc} on that source file with the
15775 appropriate options and the option @option{-aux-info}.  Then run
15776 @code{protoize} on the entire set of files.  @code{protoize} will use
15777 the existing @samp{.X} file because it is newer than the source file.
15778 For example:
15779
15780 @smallexample
15781 gcc -Dfoo=bar file1.c -aux-info file1.X
15782 protoize *.c
15783 @end smallexample
15784
15785 @noindent
15786 You need to include the special files along with the rest in the
15787 @code{protoize} command, even though their @samp{.X} files already
15788 exist, because otherwise they won't get converted.
15789
15790 @xref{Protoize Caveats}, for more information on how to use
15791 @code{protoize} successfully.