OSDN Git Service

c147219ad1b9e820b0b00e4759c331ab2fb7356f
[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++  -Wno-deprecated  -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-declarations @gol
234 -Wdisabled-optimization  -Wno-div-by-zero  @gol
235 -Wempty-body  -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 -Wimport  -Wno-import  -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-tree-all @gol
280 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
281 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
282 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
283 -fdump-tree-ch @gol
284 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
285 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
286 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
289 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-nrv -fdump-tree-vect @gol
293 -fdump-tree-sink @gol
294 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-salias @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-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 -ftree-ccp @gol
356 -ftree-ch -ftree-copy-prop -ftree-copyrename -ftree-dce @gol
357 -ftree-dominator-opts -ftree-dse -ftree-fre -ftree-loop-im @gol
358 -ftree-loop-distribution @gol
359 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
360 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-reassoc -ftree-salias @gol
361 -ftree-sink -ftree-sra -ftree-store-ccp -ftree-ter @gol
362 -ftree-vect-loop-version -ftree-vectorize -ftree-vrp -funit-at-a-time @gol
363 -funroll-all-loops -funroll-loops -funsafe-loop-optimizations @gol
364 -funsafe-math-optimizations -funswitch-loops @gol
365 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
366 -fwhole-program @gol
367 --param @var{name}=@var{value}
368 -O  -O0  -O1  -O2  -O3  -Os}
369
370 @item Preprocessor Options
371 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
372 @gccoptlist{-A@var{question}=@var{answer} @gol
373 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
374 -C  -dD  -dI  -dM  -dN @gol
375 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
376 -idirafter @var{dir} @gol
377 -include @var{file}  -imacros @var{file} @gol
378 -iprefix @var{file}  -iwithprefix @var{dir} @gol
379 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
380 -imultilib @var{dir} -isysroot @var{dir} @gol
381 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
382 -P  -fworking-directory  -remap @gol
383 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
384 -Xpreprocessor @var{option}}
385
386 @item Assembler Option
387 @xref{Assembler Options,,Passing Options to the Assembler}.
388 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
389
390 @item Linker Options
391 @xref{Link Options,,Options for Linking}.
392 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
393 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
394 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
395 -Wl,@var{option}  -Xlinker @var{option} @gol
396 -u @var{symbol}}
397
398 @item Directory Options
399 @xref{Directory Options,,Options for Directory Search}.
400 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
401 -specs=@var{file}  -I- --sysroot=@var{dir}}
402
403 @item Target Options
404 @c I wrote this xref this way to avoid overfull hbox. -- rms
405 @xref{Target Options}.
406 @gccoptlist{-V @var{version}  -b @var{machine}}
407
408 @item Machine Dependent Options
409 @xref{Submodel Options,,Hardware Models and Configurations}.
410 @c This list is ordered alphanumerically by subsection name.
411 @c Try and put the significant identifier (CPU or system) first,
412 @c so users have a clue at guessing where the ones they want will be.
413
414 @emph{ARC Options}
415 @gccoptlist{-EB  -EL @gol
416 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
417 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
418
419 @emph{ARM Options}
420 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
421 -mabi=@var{name} @gol
422 -mapcs-stack-check  -mno-apcs-stack-check @gol
423 -mapcs-float  -mno-apcs-float @gol
424 -mapcs-reentrant  -mno-apcs-reentrant @gol
425 -msched-prolog  -mno-sched-prolog @gol
426 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
427 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
428 -mthumb-interwork  -mno-thumb-interwork @gol
429 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
430 -mstructure-size-boundary=@var{n} @gol
431 -mabort-on-noreturn @gol
432 -mlong-calls  -mno-long-calls @gol
433 -msingle-pic-base  -mno-single-pic-base @gol
434 -mpic-register=@var{reg} @gol
435 -mnop-fun-dllimport @gol
436 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
437 -mpoke-function-name @gol
438 -mthumb  -marm @gol
439 -mtpcs-frame  -mtpcs-leaf-frame @gol
440 -mcaller-super-interworking  -mcallee-super-interworking @gol
441 -mtp=@var{name}}
442
443 @emph{AVR Options}
444 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
445 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
446
447 @emph{Blackfin Options}
448 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
449 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
450 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
451 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
452 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
453 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
454 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
455 -mfast-fp -minline-plt}
456
457 @emph{CRIS Options}
458 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
459 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
460 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
461 -mstack-align  -mdata-align  -mconst-align @gol
462 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
463 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
464 -mmul-bug-workaround  -mno-mul-bug-workaround}
465
466 @emph{CRX Options}
467 @gccoptlist{-mmac -mpush-args}
468
469 @emph{Darwin Options}
470 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
471 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
472 -client_name  -compatibility_version  -current_version @gol
473 -dead_strip @gol
474 -dependency-file  -dylib_file  -dylinker_install_name @gol
475 -dynamic  -dynamiclib  -exported_symbols_list @gol
476 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
477 -force_flat_namespace  -headerpad_max_install_names @gol
478 -iframework @gol
479 -image_base  -init  -install_name  -keep_private_externs @gol
480 -multi_module  -multiply_defined  -multiply_defined_unused @gol
481 -noall_load   -no_dead_strip_inits_and_terms @gol
482 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
483 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
484 -private_bundle  -read_only_relocs  -sectalign @gol
485 -sectobjectsymbols  -whyload  -seg1addr @gol
486 -sectcreate  -sectobjectsymbols  -sectorder @gol
487 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
488 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
489 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
490 -single_module  -static  -sub_library  -sub_umbrella @gol
491 -twolevel_namespace  -umbrella  -undefined @gol
492 -unexported_symbols_list  -weak_reference_mismatches @gol
493 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
494 -mkernel -mone-byte-bool}
495
496 @emph{DEC Alpha Options}
497 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
498 -mieee  -mieee-with-inexact  -mieee-conformant @gol
499 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
500 -mtrap-precision=@var{mode}  -mbuild-constants @gol
501 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
502 -mbwx  -mmax  -mfix  -mcix @gol
503 -mfloat-vax  -mfloat-ieee @gol
504 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
505 -msmall-text  -mlarge-text @gol
506 -mmemory-latency=@var{time}}
507
508 @emph{DEC Alpha/VMS Options}
509 @gccoptlist{-mvms-return-codes}
510
511 @emph{FRV Options}
512 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
513 -mhard-float  -msoft-float @gol
514 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
515 -mdouble  -mno-double @gol
516 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
517 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
518 -mlinked-fp  -mlong-calls  -malign-labels @gol
519 -mlibrary-pic  -macc-4  -macc-8 @gol
520 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
521 -moptimize-membar -mno-optimize-membar @gol
522 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
523 -mvliw-branch  -mno-vliw-branch @gol
524 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
525 -mno-nested-cond-exec  -mtomcat-stats @gol
526 -mTLS -mtls @gol
527 -mcpu=@var{cpu}}
528
529 @emph{GNU/Linux Options}
530 @gccoptlist{-muclibc}
531
532 @emph{H8/300 Options}
533 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
534
535 @emph{HPPA Options}
536 @gccoptlist{-march=@var{architecture-type} @gol
537 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
538 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
539 -mfixed-range=@var{register-range} @gol
540 -mjump-in-delay -mlinker-opt -mlong-calls @gol
541 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
542 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
543 -mno-jump-in-delay  -mno-long-load-store @gol
544 -mno-portable-runtime  -mno-soft-float @gol
545 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
546 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
547 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
548 -munix=@var{unix-std}  -nolibdld  -static  -threads}
549
550 @emph{i386 and x86-64 Options}
551 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
552 -mfpmath=@var{unit} @gol
553 -masm=@var{dialect}  -mno-fancy-math-387 @gol
554 -mno-fp-ret-in-387  -msoft-float @gol
555 -mno-wide-multiply  -mrtd  -malign-double @gol
556 -mpreferred-stack-boundary=@var{num} -mcx16 -msahf -mrecip @gol
557 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 @gol
558 -maes -mpclmul @gol
559 -msse4a -m3dnow -mpopcnt -mabm -msse5 @gol
560 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
561 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
562 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
563 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
564 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
565 -mcmodel=@var{code-model} @gol
566 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
567 -mfused-madd -mno-fused-madd}
568
569 @emph{IA-64 Options}
570 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
571 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
572 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
573 -minline-float-divide-max-throughput @gol
574 -minline-int-divide-min-latency @gol
575 -minline-int-divide-max-throughput  @gol
576 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
577 -mno-dwarf2-asm -mearly-stop-bits @gol
578 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
579 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
580 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
581 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
582 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
583 -mno-sched-prefer-non-data-spec-insns @gol
584 -mno-sched-prefer-non-control-spec-insns @gol
585 -mno-sched-count-spec-in-critical-path}
586
587 @emph{M32R/D Options}
588 @gccoptlist{-m32r2 -m32rx -m32r @gol
589 -mdebug @gol
590 -malign-loops -mno-align-loops @gol
591 -missue-rate=@var{number} @gol
592 -mbranch-cost=@var{number} @gol
593 -mmodel=@var{code-size-model-type} @gol
594 -msdata=@var{sdata-type} @gol
595 -mno-flush-func -mflush-func=@var{name} @gol
596 -mno-flush-trap -mflush-trap=@var{number} @gol
597 -G @var{num}}
598
599 @emph{M32C Options}
600 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
601
602 @emph{M680x0 Options}
603 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
604 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
605 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
606 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
607 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
608 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
609 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
610 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
611
612 @emph{M68hc1x Options}
613 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
614 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
615 -msoft-reg-count=@var{count}}
616
617 @emph{MCore Options}
618 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
619 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
620 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
621 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
622 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
623
624 @emph{MIPS Options}
625 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
626 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
627 -mips16  -mno-mips16  -mflip-mips16 @gol
628 -minterlink-mips16  -mno-interlink-mips16 @gol
629 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
630 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64 @gol
631 -mfp32  -mfp64  -mhard-float  -msoft-float @gol
632 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
633 -msmartmips  -mno-smartmips @gol
634 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
635 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
636 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
637 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
638 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
639 -membedded-data  -mno-embedded-data @gol
640 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
641 -mcode-readable=@var{setting} @gol
642 -msplit-addresses  -mno-split-addresses @gol
643 -mexplicit-relocs  -mno-explicit-relocs @gol
644 -mcheck-zero-division  -mno-check-zero-division @gol
645 -mdivide-traps  -mdivide-breaks @gol
646 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
647 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
648 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
649 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130  -mno-fix-vr4130 @gol
650 -mfix-sb1  -mno-fix-sb1 @gol
651 -mflush-func=@var{func}  -mno-flush-func @gol
652 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
653 -mfp-exceptions -mno-fp-exceptions @gol
654 -mvr4130-align -mno-vr4130-align}
655
656 @emph{MMIX Options}
657 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
658 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
659 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
660 -mno-base-addresses  -msingle-exit  -mno-single-exit}
661
662 @emph{MN10300 Options}
663 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
664 -mam33  -mno-am33 @gol
665 -mam33-2  -mno-am33-2 @gol
666 -mreturn-pointer-on-d0 @gol
667 -mno-crt0  -mrelax}
668
669 @emph{MT Options}
670 @gccoptlist{-mno-crt0 -mbacc -msim @gol
671 -march=@var{cpu-type} }
672
673 @emph{PDP-11 Options}
674 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
675 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
676 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
677 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
678 -mbranch-expensive  -mbranch-cheap @gol
679 -msplit  -mno-split  -munix-asm  -mdec-asm}
680
681 @emph{PowerPC Options}
682 See RS/6000 and PowerPC Options.
683
684 @emph{RS/6000 and PowerPC Options}
685 @gccoptlist{-mcpu=@var{cpu-type} @gol
686 -mtune=@var{cpu-type} @gol
687 -mpower  -mno-power  -mpower2  -mno-power2 @gol
688 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
689 -maltivec  -mno-altivec @gol
690 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
691 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
692 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
693 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
694 -mnew-mnemonics  -mold-mnemonics @gol
695 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
696 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
697 -malign-power  -malign-natural @gol
698 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
699 -mstring  -mno-string  -mupdate  -mno-update @gol
700 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
701 -mstrict-align  -mno-strict-align  -mrelocatable @gol
702 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
703 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
704 -mdynamic-no-pic  -maltivec  -mswdiv @gol
705 -mprioritize-restricted-insns=@var{priority} @gol
706 -msched-costly-dep=@var{dependence_type} @gol
707 -minsert-sched-nops=@var{scheme} @gol
708 -mcall-sysv  -mcall-netbsd @gol
709 -maix-struct-return  -msvr4-struct-return @gol
710 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
711 -misel -mno-isel @gol
712 -misel=yes  -misel=no @gol
713 -mspe -mno-spe @gol
714 -mspe=yes  -mspe=no @gol
715 -mpaired @gol
716 -mvrsave -mno-vrsave @gol
717 -mmulhw -mno-mulhw @gol
718 -mdlmzb -mno-dlmzb @gol
719 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
720 -mprototype  -mno-prototype @gol
721 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
722 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
723
724 @emph{S/390 and zSeries Options}
725 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
726 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
727 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
728 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
729 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
730 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
731 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
732
733 @emph{Score Options}
734 @gccoptlist{-meb -mel @gol
735 -mnhwloop @gol
736 -muls @gol
737 -mmac @gol
738 -mscore5 -mscore5u -mscore7 -mscore7d}
739
740 @emph{SH Options}
741 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
742 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
743 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
744 -m5-64media  -m5-64media-nofpu @gol
745 -m5-32media  -m5-32media-nofpu @gol
746 -m5-compact  -m5-compact-nofpu @gol
747 -mb  -ml  -mdalign  -mrelax @gol
748 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
749 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
750 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
751 -mdivsi3_libfunc=@var{name}  @gol
752 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
753  -minvalid-symbols}
754
755 @emph{SPARC Options}
756 @gccoptlist{-mcpu=@var{cpu-type} @gol
757 -mtune=@var{cpu-type} @gol
758 -mcmodel=@var{code-model} @gol
759 -m32  -m64  -mapp-regs  -mno-app-regs @gol
760 -mfaster-structs  -mno-faster-structs @gol
761 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
762 -mhard-quad-float  -msoft-quad-float @gol
763 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
764 -mstack-bias  -mno-stack-bias @gol
765 -munaligned-doubles  -mno-unaligned-doubles @gol
766 -mv8plus  -mno-v8plus  -mvis  -mno-vis
767 -threads -pthreads -pthread}
768
769 @emph{SPU Options}
770 @gccoptlist{-mwarn-reloc -merror-reloc @gol
771 -msafe-dma -munsafe-dma @gol
772 -mbranch-hints @gol
773 -msmall-mem -mlarge-mem -mstdmain @gol
774 -mfixed-range=@var{register-range}}
775
776 @emph{System V Options}
777 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
778
779 @emph{V850 Options}
780 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
781 -mprolog-function  -mno-prolog-function  -mspace @gol
782 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
783 -mapp-regs  -mno-app-regs @gol
784 -mdisable-callt  -mno-disable-callt @gol
785 -mv850e1 @gol
786 -mv850e @gol
787 -mv850  -mbig-switch}
788
789 @emph{VAX Options}
790 @gccoptlist{-mg  -mgnu  -munix}
791
792 @emph{VxWorks Options}
793 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
794 -Xbind-lazy  -Xbind-now}
795
796 @emph{x86-64 Options}
797 See i386 and x86-64 Options.
798
799 @emph{Xstormy16 Options}
800 @gccoptlist{-msim}
801
802 @emph{Xtensa Options}
803 @gccoptlist{-mconst16 -mno-const16 @gol
804 -mfused-madd  -mno-fused-madd @gol
805 -mserialize-volatile  -mno-serialize-volatile @gol
806 -mtext-section-literals  -mno-text-section-literals @gol
807 -mtarget-align  -mno-target-align @gol
808 -mlongcalls  -mno-longcalls}
809
810 @emph{zSeries Options}
811 See S/390 and zSeries Options.
812
813 @item Code Generation Options
814 @xref{Code Gen Options,,Options for Code Generation Conventions}.
815 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
816 -ffixed-@var{reg}  -fexceptions @gol
817 -fnon-call-exceptions  -funwind-tables @gol
818 -fasynchronous-unwind-tables @gol
819 -finhibit-size-directive  -finstrument-functions @gol
820 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
821 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
822 -fno-common  -fno-ident @gol
823 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
824 -fno-jump-tables @gol
825 -frecord-gcc-switches @gol
826 -freg-struct-return  -fshort-enums @gol
827 -fshort-double  -fshort-wchar @gol
828 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
829 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
830 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
831 -fargument-noalias-global  -fargument-noalias-anything @gol
832 -fleading-underscore  -ftls-model=@var{model} @gol
833 -ftrapv  -fwrapv  -fbounds-check @gol
834 -fvisibility}
835 @end table
836
837 @menu
838 * Overall Options::     Controlling the kind of output:
839                         an executable, object files, assembler files,
840                         or preprocessed source.
841 * C Dialect Options::   Controlling the variant of C language compiled.
842 * C++ Dialect Options:: Variations on C++.
843 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
844                         and Objective-C++.
845 * Language Independent Options:: Controlling how diagnostics should be
846                         formatted.
847 * Warning Options::     How picky should the compiler be?
848 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
849 * Optimize Options::    How much optimization?
850 * Preprocessor Options:: Controlling header files and macro definitions.
851                          Also, getting dependency information for Make.
852 * Assembler Options::   Passing options to the assembler.
853 * Link Options::        Specifying libraries and so on.
854 * Directory Options::   Where to find header files and libraries.
855                         Where to find the compiler executable files.
856 * Spec Files::          How to pass switches to sub-processes.
857 * Target Options::      Running a cross-compiler, or an old version of GCC.
858 @end menu
859
860 @node Overall Options
861 @section Options Controlling the Kind of Output
862
863 Compilation can involve up to four stages: preprocessing, compilation
864 proper, assembly and linking, always in that order.  GCC is capable of
865 preprocessing and compiling several files either into several
866 assembler input files, or into one assembler input file; then each
867 assembler input file produces an object file, and linking combines all
868 the object files (those newly compiled, and those specified as input)
869 into an executable file.
870
871 @cindex file name suffix
872 For any given input file, the file name suffix determines what kind of
873 compilation is done:
874
875 @table @gcctabopt
876 @item @var{file}.c
877 C source code which must be preprocessed.
878
879 @item @var{file}.i
880 C source code which should not be preprocessed.
881
882 @item @var{file}.ii
883 C++ source code which should not be preprocessed.
884
885 @item @var{file}.m
886 Objective-C source code.  Note that you must link with the @file{libobjc}
887 library to make an Objective-C program work.
888
889 @item @var{file}.mi
890 Objective-C source code which should not be preprocessed.
891
892 @item @var{file}.mm
893 @itemx @var{file}.M
894 Objective-C++ source code.  Note that you must link with the @file{libobjc}
895 library to make an Objective-C++ program work.  Note that @samp{.M} refers
896 to a literal capital M@.
897
898 @item @var{file}.mii
899 Objective-C++ source code which should not be preprocessed.
900
901 @item @var{file}.h
902 C, C++, Objective-C or Objective-C++ header file to be turned into a
903 precompiled header.
904
905 @item @var{file}.cc
906 @itemx @var{file}.cp
907 @itemx @var{file}.cxx
908 @itemx @var{file}.cpp
909 @itemx @var{file}.CPP
910 @itemx @var{file}.c++
911 @itemx @var{file}.C
912 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
913 the last two letters must both be literally @samp{x}.  Likewise,
914 @samp{.C} refers to a literal capital C@.
915
916 @item @var{file}.mm
917 @itemx @var{file}.M
918 Objective-C++ source code which must be preprocessed.
919
920 @item @var{file}.mii
921 Objective-C++ source code which should not be preprocessed.
922
923 @item @var{file}.hh
924 @itemx @var{file}.H
925 @itemx @var{file}.hp
926 @itemx @var{file}.hxx
927 @itemx @var{file}.hpp
928 @itemx @var{file}.HPP
929 @itemx @var{file}.h++
930 @itemx @var{file}.tcc
931 C++ header file to be turned into a precompiled header.
932
933 @item @var{file}.f
934 @itemx @var{file}.for
935 @itemx @var{file}.ftn
936 Fixed form Fortran source code which should not be preprocessed.
937
938 @item @var{file}.F
939 @itemx @var{file}.FOR
940 @itemx @var{file}.fpp
941 @itemx @var{file}.FPP
942 @itemx @var{file}.FTN
943 Fixed form Fortran source code which must be preprocessed (with the traditional
944 preprocessor).
945
946 @item @var{file}.f90
947 @itemx @var{file}.f95
948 @itemx @var{file}.f03
949 @itemx @var{file}.f08
950 Free form Fortran source code which should not be preprocessed.
951
952 @item @var{file}.F90
953 @itemx @var{file}.F95
954 @itemx @var{file}.F03
955 @itemx @var{file}.F08
956 Free form Fortran source code which must be preprocessed (with the
957 traditional preprocessor).
958
959 @c FIXME: Descriptions of Java file types.
960 @c @var{file}.java
961 @c @var{file}.class
962 @c @var{file}.zip
963 @c @var{file}.jar
964
965 @item @var{file}.ads
966 Ada source code file which contains a library unit declaration (a
967 declaration of a package, subprogram, or generic, or a generic
968 instantiation), or a library unit renaming declaration (a package,
969 generic, or subprogram renaming declaration).  Such files are also
970 called @dfn{specs}.
971
972 @item @var{file}.adb
973 Ada source code file containing a library unit body (a subprogram or
974 package body).  Such files are also called @dfn{bodies}.
975
976 @c GCC also knows about some suffixes for languages not yet included:
977 @c Pascal:
978 @c @var{file}.p
979 @c @var{file}.pas
980 @c Ratfor:
981 @c @var{file}.r
982
983 @item @var{file}.s
984 Assembler code.
985
986 @item @var{file}.S
987 @itemx @var{file}.sx
988 Assembler code which must be preprocessed.
989
990 @item @var{other}
991 An object file to be fed straight into linking.
992 Any file name with no recognized suffix is treated this way.
993 @end table
994
995 @opindex x
996 You can specify the input language explicitly with the @option{-x} option:
997
998 @table @gcctabopt
999 @item -x @var{language}
1000 Specify explicitly the @var{language} for the following input files
1001 (rather than letting the compiler choose a default based on the file
1002 name suffix).  This option applies to all following input files until
1003 the next @option{-x} option.  Possible values for @var{language} are:
1004 @smallexample
1005 c  c-header  c-cpp-output
1006 c++  c++-header  c++-cpp-output
1007 objective-c  objective-c-header  objective-c-cpp-output
1008 objective-c++ objective-c++-header objective-c++-cpp-output
1009 assembler  assembler-with-cpp
1010 ada
1011 f95  f95-cpp-input
1012 java
1013 @end smallexample
1014
1015 @item -x none
1016 Turn off any specification of a language, so that subsequent files are
1017 handled according to their file name suffixes (as they are if @option{-x}
1018 has not been used at all).
1019
1020 @item -pass-exit-codes
1021 @opindex pass-exit-codes
1022 Normally the @command{gcc} program will exit with the code of 1 if any
1023 phase of the compiler returns a non-success return code.  If you specify
1024 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1025 numerically highest error produced by any phase that returned an error
1026 indication.  The C, C++, and Fortran frontends return 4, if an internal
1027 compiler error is encountered.
1028 @end table
1029
1030 If you only want some of the stages of compilation, you can use
1031 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1032 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1033 @command{gcc} is to stop.  Note that some combinations (for example,
1034 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1035
1036 @table @gcctabopt
1037 @item -c
1038 @opindex c
1039 Compile or assemble the source files, but do not link.  The linking
1040 stage simply is not done.  The ultimate output is in the form of an
1041 object file for each source file.
1042
1043 By default, the object file name for a source file is made by replacing
1044 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1045
1046 Unrecognized input files, not requiring compilation or assembly, are
1047 ignored.
1048
1049 @item -S
1050 @opindex S
1051 Stop after the stage of compilation proper; do not assemble.  The output
1052 is in the form of an assembler code file for each non-assembler input
1053 file specified.
1054
1055 By default, the assembler file name for a source file is made by
1056 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1057
1058 Input files that don't require compilation are ignored.
1059
1060 @item -E
1061 @opindex E
1062 Stop after the preprocessing stage; do not run the compiler proper.  The
1063 output is in the form of preprocessed source code, which is sent to the
1064 standard output.
1065
1066 Input files which don't require preprocessing are ignored.
1067
1068 @cindex output file option
1069 @item -o @var{file}
1070 @opindex o
1071 Place output in file @var{file}.  This applies regardless to whatever
1072 sort of output is being produced, whether it be an executable file,
1073 an object file, an assembler file or preprocessed C code.
1074
1075 If @option{-o} is not specified, the default is to put an executable
1076 file in @file{a.out}, the object file for
1077 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1078 assembler file in @file{@var{source}.s}, a precompiled header file in
1079 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1080 standard output.
1081
1082 @item -v
1083 @opindex v
1084 Print (on standard error output) the commands executed to run the stages
1085 of compilation.  Also print the version number of the compiler driver
1086 program and of the preprocessor and the compiler proper.
1087
1088 @item -###
1089 @opindex ###
1090 Like @option{-v} except the commands are not executed and all command
1091 arguments are quoted.  This is useful for shell scripts to capture the
1092 driver-generated command lines.
1093
1094 @item -pipe
1095 @opindex pipe
1096 Use pipes rather than temporary files for communication between the
1097 various stages of compilation.  This fails to work on some systems where
1098 the assembler is unable to read from a pipe; but the GNU assembler has
1099 no trouble.
1100
1101 @item -combine
1102 @opindex combine
1103 If you are compiling multiple source files, this option tells the driver
1104 to pass all the source files to the compiler at once (for those
1105 languages for which the compiler can handle this).  This will allow
1106 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1107 language for which this is supported is C@.  If you pass source files for
1108 multiple languages to the driver, using this option, the driver will invoke
1109 the compiler(s) that support IMA once each, passing each compiler all the
1110 source files appropriate for it.  For those languages that do not support
1111 IMA this option will be ignored, and the compiler will be invoked once for
1112 each source file in that language.  If you use this option in conjunction
1113 with @option{-save-temps}, the compiler will generate multiple
1114 pre-processed files
1115 (one for each source file), but only one (combined) @file{.o} or
1116 @file{.s} file.
1117
1118 @item --help
1119 @opindex help
1120 Print (on the standard output) a description of the command line options
1121 understood by @command{gcc}.  If the @option{-v} option is also specified
1122 then @option{--help} will also be passed on to the various processes
1123 invoked by @command{gcc}, so that they can display the command line options
1124 they accept.  If the @option{-Wextra} option has also been specified
1125 (prior to the @option{--help} option), then command line options which
1126 have no documentation associated with them will also be displayed.
1127
1128 @item --target-help
1129 @opindex target-help
1130 Print (on the standard output) a description of target-specific command
1131 line options for each tool.  For some targets extra target-specific
1132 information may also be printed.
1133
1134 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
1135 Print (on the standard output) a description of the command line
1136 options understood by the compiler that fit into a specific class.
1137 The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
1138 @samp{params}, or @var{language}:
1139
1140 @table @asis
1141 @item @samp{optimizers}
1142 This will display all of the optimization options supported by the
1143 compiler.
1144
1145 @item @samp{warnings}
1146 This will display all of the options controlling warning messages
1147 produced by the compiler.
1148
1149 @item @samp{target}
1150 This will display target-specific options.  Unlike the
1151 @option{--target-help} option however, target-specific options of the
1152 linker and assembler will not be displayed.  This is because those
1153 tools do not currently support the extended @option{--help=} syntax.
1154
1155 @item @samp{params}
1156 This will display the values recognized by the @option{--param}
1157 option.
1158
1159 @item @var{language}
1160 This will display the options supported for @var{language}, where 
1161 @var{language} is the name of one of the languages supported in this 
1162 version of GCC.
1163
1164 @item @samp{common}
1165 This will display the options that are common to all languages.
1166 @end table
1167
1168 It is possible to further refine the output of the @option{--help=}
1169 option by adding a comma separated list of qualifiers after the
1170 class.  These can be any from the following list:
1171
1172 @table @asis
1173 @item @samp{undocumented}
1174 Display only those options which are undocumented.
1175
1176 @item @samp{joined}
1177 Display options which take an argument that appears after an equal
1178 sign in the same continuous piece of text, such as:
1179 @samp{--help=target}.
1180
1181 @item @samp{separate}
1182 Display options which take an argument that appears as a separate word
1183 following the original option, such as: @samp{-o output-file}.
1184 @end table
1185
1186 Thus for example to display all the undocumented target-specific
1187 switches supported by the compiler the following can be used:
1188
1189 @smallexample
1190 --help=target,undocumented
1191 @end smallexample
1192
1193 The sense of a qualifier can be inverted by prefixing it with the
1194 @var{^} character, so for example to display all binary warning
1195 options (i.e., ones that are either on or off and that do not take an
1196 argument), which have a description the following can be used:
1197
1198 @smallexample
1199 --help=warnings,^joined,^undocumented
1200 @end smallexample
1201
1202 A class can also be used as a qualifier, although this usually
1203 restricts the output by so much that there is nothing to display.  One
1204 case where it does work however is when one of the classes is
1205 @var{target}.  So for example to display all the target-specific
1206 optimization options the following can be used:
1207
1208 @smallexample
1209 --help=target,optimizers
1210 @end smallexample
1211
1212 The @option{--help=} option can be repeated on the command line.  Each
1213 successive use will display its requested class of options, skipping
1214 those that have already been displayed.
1215
1216 If the @option{-Q} option appears on the command line before the
1217 @option{--help=} option, then the descriptive text displayed by
1218 @option{--help=} is changed.  Instead of describing the displayed
1219 options, an indication is given as to whether the option is enabled,
1220 disabled or set to a specific value (assuming that the compiler
1221 knows this at the point where the @option{--help=} option is used).
1222
1223 Here is a truncated example from the ARM port of @command{gcc}:
1224
1225 @smallexample
1226   % gcc -Q -mabi=2 --help=target -c
1227   The following options are target specific:
1228   -mabi=                                2
1229   -mabort-on-noreturn                   [disabled]
1230   -mapcs                                [disabled]
1231 @end smallexample
1232
1233 The output is sensitive to the effects of previous command line
1234 options, so for example it is possible to find out which optimizations
1235 are enabled at @option{-O2} by using:
1236
1237 @smallexample
1238 -O2 --help=optimizers
1239 @end smallexample
1240
1241 Alternatively you can discover which binary optimizations are enabled
1242 by @option{-O3} by using:
1243
1244 @smallexample
1245 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1246 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1247 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1248 @end smallexample
1249
1250 @item --version
1251 @opindex version
1252 Display the version number and copyrights of the invoked GCC@.
1253
1254 @item -wrapper
1255 @opindex wrapper
1256 Invoke all subcommands under a wrapper program. It takes a single
1257 comma separated list as an argument, which will be used to invoke
1258 the wrapper:
1259
1260 @smallexample
1261 gcc -c t.c -wrapper gdb,--args
1262 @end smallexample
1263
1264 This will invoke all subprograms of gcc under "gdb --args",
1265 thus cc1 invocation will be "gdb --args cc1 ...".
1266
1267 @include @value{srcdir}/../libiberty/at-file.texi
1268 @end table
1269
1270 @node Invoking G++
1271 @section Compiling C++ Programs
1272
1273 @cindex suffixes for C++ source
1274 @cindex C++ source file suffixes
1275 C++ source files conventionally use one of the suffixes @samp{.C},
1276 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1277 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1278 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1279 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1280 files with these names and compiles them as C++ programs even if you
1281 call the compiler the same way as for compiling C programs (usually
1282 with the name @command{gcc}).
1283
1284 @findex g++
1285 @findex c++
1286 However, the use of @command{gcc} does not add the C++ library.
1287 @command{g++} is a program that calls GCC and treats @samp{.c},
1288 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1289 files unless @option{-x} is used, and automatically specifies linking
1290 against the C++ library.  This program is also useful when
1291 precompiling a C header file with a @samp{.h} extension for use in C++
1292 compilations.  On many systems, @command{g++} is also installed with
1293 the name @command{c++}.
1294
1295 @cindex invoking @command{g++}
1296 When you compile C++ programs, you may specify many of the same
1297 command-line options that you use for compiling programs in any
1298 language; or command-line options meaningful for C and related
1299 languages; or options that are meaningful only for C++ programs.
1300 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1301 explanations of options for languages related to C@.
1302 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1303 explanations of options that are meaningful only for C++ programs.
1304
1305 @node C Dialect Options
1306 @section Options Controlling C Dialect
1307 @cindex dialect options
1308 @cindex language dialect options
1309 @cindex options, dialect
1310
1311 The following options control the dialect of C (or languages derived
1312 from C, such as C++, Objective-C and Objective-C++) that the compiler
1313 accepts:
1314
1315 @table @gcctabopt
1316 @cindex ANSI support
1317 @cindex ISO support
1318 @item -ansi
1319 @opindex ansi
1320 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1321 equivalent to @samp{-std=c++98}.
1322
1323 This turns off certain features of GCC that are incompatible with ISO
1324 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1325 such as the @code{asm} and @code{typeof} keywords, and
1326 predefined macros such as @code{unix} and @code{vax} that identify the
1327 type of system you are using.  It also enables the undesirable and
1328 rarely used ISO trigraph feature.  For the C compiler,
1329 it disables recognition of C++ style @samp{//} comments as well as
1330 the @code{inline} keyword.
1331
1332 The alternate keywords @code{__asm__}, @code{__extension__},
1333 @code{__inline__} and @code{__typeof__} continue to work despite
1334 @option{-ansi}.  You would not want to use them in an ISO C program, of
1335 course, but it is useful to put them in header files that might be included
1336 in compilations done with @option{-ansi}.  Alternate predefined macros
1337 such as @code{__unix__} and @code{__vax__} are also available, with or
1338 without @option{-ansi}.
1339
1340 The @option{-ansi} option does not cause non-ISO programs to be
1341 rejected gratuitously.  For that, @option{-pedantic} is required in
1342 addition to @option{-ansi}.  @xref{Warning Options}.
1343
1344 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1345 option is used.  Some header files may notice this macro and refrain
1346 from declaring certain functions or defining certain macros that the
1347 ISO standard doesn't call for; this is to avoid interfering with any
1348 programs that might use these names for other things.
1349
1350 Functions that would normally be built in but do not have semantics
1351 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1352 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1353 built-in functions provided by GCC}, for details of the functions
1354 affected.
1355
1356 @item -std=
1357 @opindex std
1358 Determine the language standard. @xref{Standards,,Language Standards
1359 Supported by GCC}, for details of these standard versions.  This option
1360 is currently only supported when compiling C or C++. 
1361
1362 The compiler can accept several base standards, such as @samp{c89} or
1363 @samp{c++98}, and GNU dialects of those standards, such as
1364 @samp{gnu89} or @samp{gnu++98}.  By specifing a base standard, the
1365 compiler will accept all programs following that standard and those
1366 using GNU extensions that do not contradict it.  For example,
1367 @samp{-std=c89} turns off certain features of GCC that are
1368 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1369 keywords, but not other GNU extensions that do not have a meaning in
1370 ISO C90, such as omitting the middle term of a @code{?:}
1371 expression. On the other hand, by specifing a GNU dialect of a
1372 standard, all features the compiler support are enabled, even when
1373 those features change the meaning of the base standard and some
1374 strict-conforming programs may be rejected.  The particular standard
1375 is used by @option{-pedantic} to identify which features are GNU
1376 extensions given that version of the standard. For example
1377 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1378 comments, while @samp{-std=gnu99 -pedantic} would not.
1379
1380 A value for this option must be provided; possible values are
1381
1382 @table @samp
1383 @item c89
1384 @itemx iso9899:1990
1385 Support all ISO C90 programs (certain GNU extensions that conflict
1386 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1387
1388 @item iso9899:199409
1389 ISO C90 as modified in amendment 1.
1390
1391 @item c99
1392 @itemx c9x
1393 @itemx iso9899:1999
1394 @itemx iso9899:199x
1395 ISO C99.  Note that this standard is not yet fully supported; see
1396 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1397 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1398
1399 @item gnu89
1400 GNU dialect of ISO C90 (including some C99 features). This
1401 is the default for C code.
1402
1403 @item gnu99
1404 @itemx gnu9x
1405 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1406 this will become the default.  The name @samp{gnu9x} is deprecated.
1407
1408 @item c++98
1409 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1410 C++ code.
1411
1412 @item gnu++98
1413 GNU dialect of @option{-std=c++98}.  This is the default for
1414 C++ code.
1415
1416 @item c++0x
1417 The working draft of the upcoming ISO C++0x standard. This option
1418 enables experimental features that are likely to be included in
1419 C++0x. The working draft is constantly changing, and any feature that is
1420 enabled by this flag may be removed from future versions of GCC if it is
1421 not part of the C++0x standard.
1422
1423 @item gnu++0x
1424 GNU dialect of @option{-std=c++0x}. This option enables
1425 experimental features that may be removed in future versions of GCC.
1426 @end table
1427
1428 @item -fgnu89-inline
1429 @opindex fgnu89-inline
1430 The option @option{-fgnu89-inline} tells GCC to use the traditional
1431 GNU semantics for @code{inline} functions when in C99 mode.
1432 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1433 is accepted and ignored by GCC versions 4.1.3 up to but not including
1434 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1435 C99 mode.  Using this option is roughly equivalent to adding the
1436 @code{gnu_inline} function attribute to all inline functions
1437 (@pxref{Function Attributes}).
1438
1439 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1440 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1441 specifies the default behavior).  This option was first supported in
1442 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1443
1444 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1445 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1446 in effect for @code{inline} functions.  @xref{Common Predefined
1447 Macros,,,cpp,The C Preprocessor}.
1448
1449 @item -aux-info @var{filename}
1450 @opindex aux-info
1451 Output to the given filename prototyped declarations for all functions
1452 declared and/or defined in a translation unit, including those in header
1453 files.  This option is silently ignored in any language other than C@.
1454
1455 Besides declarations, the file indicates, in comments, the origin of
1456 each declaration (source file and line), whether the declaration was
1457 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1458 @samp{O} for old, respectively, in the first character after the line
1459 number and the colon), and whether it came from a declaration or a
1460 definition (@samp{C} or @samp{F}, respectively, in the following
1461 character).  In the case of function definitions, a K&R-style list of
1462 arguments followed by their declarations is also provided, inside
1463 comments, after the declaration.
1464
1465 @item -fno-asm
1466 @opindex fno-asm
1467 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1468 keyword, so that code can use these words as identifiers.  You can use
1469 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1470 instead.  @option{-ansi} implies @option{-fno-asm}.
1471
1472 In C++, this switch only affects the @code{typeof} keyword, since
1473 @code{asm} and @code{inline} are standard keywords.  You may want to
1474 use the @option{-fno-gnu-keywords} flag instead, which has the same
1475 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1476 switch only affects the @code{asm} and @code{typeof} keywords, since
1477 @code{inline} is a standard keyword in ISO C99.
1478
1479 @item -fno-builtin
1480 @itemx -fno-builtin-@var{function}
1481 @opindex fno-builtin
1482 @cindex built-in functions
1483 Don't recognize built-in functions that do not begin with
1484 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1485 functions provided by GCC}, for details of the functions affected,
1486 including those which are not built-in functions when @option{-ansi} or
1487 @option{-std} options for strict ISO C conformance are used because they
1488 do not have an ISO standard meaning.
1489
1490 GCC normally generates special code to handle certain built-in functions
1491 more efficiently; for instance, calls to @code{alloca} may become single
1492 instructions that adjust the stack directly, and calls to @code{memcpy}
1493 may become inline copy loops.  The resulting code is often both smaller
1494 and faster, but since the function calls no longer appear as such, you
1495 cannot set a breakpoint on those calls, nor can you change the behavior
1496 of the functions by linking with a different library.  In addition,
1497 when a function is recognized as a built-in function, GCC may use
1498 information about that function to warn about problems with calls to
1499 that function, or to generate more efficient code, even if the
1500 resulting code still contains calls to that function.  For example,
1501 warnings are given with @option{-Wformat} for bad calls to
1502 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1503 known not to modify global memory.
1504
1505 With the @option{-fno-builtin-@var{function}} option
1506 only the built-in function @var{function} is
1507 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1508 function is named this is not built-in in this version of GCC, this
1509 option is ignored.  There is no corresponding
1510 @option{-fbuiltin-@var{function}} option; if you wish to enable
1511 built-in functions selectively when using @option{-fno-builtin} or
1512 @option{-ffreestanding}, you may define macros such as:
1513
1514 @smallexample
1515 #define abs(n)          __builtin_abs ((n))
1516 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1517 @end smallexample
1518
1519 @item -fhosted
1520 @opindex fhosted
1521 @cindex hosted environment
1522
1523 Assert that compilation takes place in a hosted environment.  This implies
1524 @option{-fbuiltin}.  A hosted environment is one in which the
1525 entire standard library is available, and in which @code{main} has a return
1526 type of @code{int}.  Examples are nearly everything except a kernel.
1527 This is equivalent to @option{-fno-freestanding}.
1528
1529 @item -ffreestanding
1530 @opindex ffreestanding
1531 @cindex hosted environment
1532
1533 Assert that compilation takes place in a freestanding environment.  This
1534 implies @option{-fno-builtin}.  A freestanding environment
1535 is one in which the standard library may not exist, and program startup may
1536 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1537 This is equivalent to @option{-fno-hosted}.
1538
1539 @xref{Standards,,Language Standards Supported by GCC}, for details of
1540 freestanding and hosted environments.
1541
1542 @item -fopenmp
1543 @opindex fopenmp
1544 @cindex openmp parallel
1545 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1546 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1547 compiler generates parallel code according to the OpenMP Application
1548 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.  This option
1549 implies @option{-pthread}, and thus is only supported on targets that
1550 have support for @option{-pthread}.
1551
1552 @item -fms-extensions
1553 @opindex fms-extensions
1554 Accept some non-standard constructs used in Microsoft header files.
1555
1556 Some cases of unnamed fields in structures and unions are only
1557 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1558 fields within structs/unions}, for details.
1559
1560 @item -trigraphs
1561 @opindex trigraphs
1562 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1563 options for strict ISO C conformance) implies @option{-trigraphs}.
1564
1565 @item -no-integrated-cpp
1566 @opindex no-integrated-cpp
1567 Performs a compilation in two passes: preprocessing and compiling.  This
1568 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1569 @option{-B} option.  The user supplied compilation step can then add in
1570 an additional preprocessing step after normal preprocessing but before
1571 compiling.  The default is to use the integrated cpp (internal cpp)
1572
1573 The semantics of this option will change if "cc1", "cc1plus", and
1574 "cc1obj" are merged.
1575
1576 @cindex traditional C language
1577 @cindex C language, traditional
1578 @item -traditional
1579 @itemx -traditional-cpp
1580 @opindex traditional-cpp
1581 @opindex traditional
1582 Formerly, these options caused GCC to attempt to emulate a pre-standard
1583 C compiler.  They are now only supported with the @option{-E} switch.
1584 The preprocessor continues to support a pre-standard mode.  See the GNU
1585 CPP manual for details.
1586
1587 @item -fcond-mismatch
1588 @opindex fcond-mismatch
1589 Allow conditional expressions with mismatched types in the second and
1590 third arguments.  The value of such an expression is void.  This option
1591 is not supported for C++.
1592
1593 @item -flax-vector-conversions
1594 @opindex flax-vector-conversions
1595 Allow implicit conversions between vectors with differing numbers of
1596 elements and/or incompatible element types.  This option should not be
1597 used for new code.
1598
1599 @item -funsigned-char
1600 @opindex funsigned-char
1601 Let the type @code{char} be unsigned, like @code{unsigned char}.
1602
1603 Each kind of machine has a default for what @code{char} should
1604 be.  It is either like @code{unsigned char} by default or like
1605 @code{signed char} by default.
1606
1607 Ideally, a portable program should always use @code{signed char} or
1608 @code{unsigned char} when it depends on the signedness of an object.
1609 But many programs have been written to use plain @code{char} and
1610 expect it to be signed, or expect it to be unsigned, depending on the
1611 machines they were written for.  This option, and its inverse, let you
1612 make such a program work with the opposite default.
1613
1614 The type @code{char} is always a distinct type from each of
1615 @code{signed char} or @code{unsigned char}, even though its behavior
1616 is always just like one of those two.
1617
1618 @item -fsigned-char
1619 @opindex fsigned-char
1620 Let the type @code{char} be signed, like @code{signed char}.
1621
1622 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1623 the negative form of @option{-funsigned-char}.  Likewise, the option
1624 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1625
1626 @item -fsigned-bitfields
1627 @itemx -funsigned-bitfields
1628 @itemx -fno-signed-bitfields
1629 @itemx -fno-unsigned-bitfields
1630 @opindex fsigned-bitfields
1631 @opindex funsigned-bitfields
1632 @opindex fno-signed-bitfields
1633 @opindex fno-unsigned-bitfields
1634 These options control whether a bit-field is signed or unsigned, when the
1635 declaration does not use either @code{signed} or @code{unsigned}.  By
1636 default, such a bit-field is signed, because this is consistent: the
1637 basic integer types such as @code{int} are signed types.
1638 @end table
1639
1640 @node C++ Dialect Options
1641 @section Options Controlling C++ Dialect
1642
1643 @cindex compiler options, C++
1644 @cindex C++ options, command line
1645 @cindex options, C++
1646 This section describes the command-line options that are only meaningful
1647 for C++ programs; but you can also use most of the GNU compiler options
1648 regardless of what language your program is in.  For example, you
1649 might compile a file @code{firstClass.C} like this:
1650
1651 @smallexample
1652 g++ -g -frepo -O -c firstClass.C
1653 @end smallexample
1654
1655 @noindent
1656 In this example, only @option{-frepo} is an option meant
1657 only for C++ programs; you can use the other options with any
1658 language supported by GCC@.
1659
1660 Here is a list of options that are @emph{only} for compiling C++ programs:
1661
1662 @table @gcctabopt
1663
1664 @item -fabi-version=@var{n}
1665 @opindex fabi-version
1666 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1667 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1668 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1669 the version that conforms most closely to the C++ ABI specification.
1670 Therefore, the ABI obtained using version 0 will change as ABI bugs
1671 are fixed.
1672
1673 The default is version 2.
1674
1675 @item -fno-access-control
1676 @opindex fno-access-control
1677 Turn off all access checking.  This switch is mainly useful for working
1678 around bugs in the access control code.
1679
1680 @item -fcheck-new
1681 @opindex fcheck-new
1682 Check that the pointer returned by @code{operator new} is non-null
1683 before attempting to modify the storage allocated.  This check is
1684 normally unnecessary because the C++ standard specifies that
1685 @code{operator new} will only return @code{0} if it is declared
1686 @samp{throw()}, in which case the compiler will always check the
1687 return value even without this option.  In all other cases, when
1688 @code{operator new} has a non-empty exception specification, memory
1689 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1690 @samp{new (nothrow)}.
1691
1692 @item -fconserve-space
1693 @opindex fconserve-space
1694 Put uninitialized or runtime-initialized global variables into the
1695 common segment, as C does.  This saves space in the executable at the
1696 cost of not diagnosing duplicate definitions.  If you compile with this
1697 flag and your program mysteriously crashes after @code{main()} has
1698 completed, you may have an object that is being destroyed twice because
1699 two definitions were merged.
1700
1701 This option is no longer useful on most targets, now that support has
1702 been added for putting variables into BSS without making them common.
1703
1704 @item -ffriend-injection
1705 @opindex ffriend-injection
1706 Inject friend functions into the enclosing namespace, so that they are
1707 visible outside the scope of the class in which they are declared.
1708 Friend functions were documented to work this way in the old Annotated
1709 C++ Reference Manual, and versions of G++ before 4.1 always worked
1710 that way.  However, in ISO C++ a friend function which is not declared
1711 in an enclosing scope can only be found using argument dependent
1712 lookup.  This option causes friends to be injected as they were in
1713 earlier releases.
1714
1715 This option is for compatibility, and may be removed in a future
1716 release of G++.
1717
1718 @item -fno-elide-constructors
1719 @opindex fno-elide-constructors
1720 The C++ standard allows an implementation to omit creating a temporary
1721 which is only used to initialize another object of the same type.
1722 Specifying this option disables that optimization, and forces G++ to
1723 call the copy constructor in all cases.
1724
1725 @item -fno-enforce-eh-specs
1726 @opindex fno-enforce-eh-specs
1727 Don't generate code to check for violation of exception specifications
1728 at runtime.  This option violates the C++ standard, but may be useful
1729 for reducing code size in production builds, much like defining
1730 @samp{NDEBUG}.  This does not give user code permission to throw
1731 exceptions in violation of the exception specifications; the compiler
1732 will still optimize based on the specifications, so throwing an
1733 unexpected exception will result in undefined behavior.
1734
1735 @item -ffor-scope
1736 @itemx -fno-for-scope
1737 @opindex ffor-scope
1738 @opindex fno-for-scope
1739 If @option{-ffor-scope} is specified, the scope of variables declared in
1740 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1741 as specified by the C++ standard.
1742 If @option{-fno-for-scope} is specified, the scope of variables declared in
1743 a @i{for-init-statement} extends to the end of the enclosing scope,
1744 as was the case in old versions of G++, and other (traditional)
1745 implementations of C++.
1746
1747 The default if neither flag is given to follow the standard,
1748 but to allow and give a warning for old-style code that would
1749 otherwise be invalid, or have different behavior.
1750
1751 @item -fno-gnu-keywords
1752 @opindex fno-gnu-keywords
1753 Do not recognize @code{typeof} as a keyword, so that code can use this
1754 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1755 @option{-ansi} implies @option{-fno-gnu-keywords}.
1756
1757 @item -fno-implicit-templates
1758 @opindex fno-implicit-templates
1759 Never emit code for non-inline templates which are instantiated
1760 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1761 @xref{Template Instantiation}, for more information.
1762
1763 @item -fno-implicit-inline-templates
1764 @opindex fno-implicit-inline-templates
1765 Don't emit code for implicit instantiations of inline templates, either.
1766 The default is to handle inlines differently so that compiles with and
1767 without optimization will need the same set of explicit instantiations.
1768
1769 @item -fno-implement-inlines
1770 @opindex fno-implement-inlines
1771 To save space, do not emit out-of-line copies of inline functions
1772 controlled by @samp{#pragma implementation}.  This will cause linker
1773 errors if these functions are not inlined everywhere they are called.
1774
1775 @item -fms-extensions
1776 @opindex fms-extensions
1777 Disable pedantic warnings about constructs used in MFC, such as implicit
1778 int and getting a pointer to member function via non-standard syntax.
1779
1780 @item -fno-nonansi-builtins
1781 @opindex fno-nonansi-builtins
1782 Disable built-in declarations of functions that are not mandated by
1783 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1784 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1785
1786 @item -fno-operator-names
1787 @opindex fno-operator-names
1788 Do not treat the operator name keywords @code{and}, @code{bitand},
1789 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1790 synonyms as keywords.
1791
1792 @item -fno-optional-diags
1793 @opindex fno-optional-diags
1794 Disable diagnostics that the standard says a compiler does not need to
1795 issue.  Currently, the only such diagnostic issued by G++ is the one for
1796 a name having multiple meanings within a class.
1797
1798 @item -fpermissive
1799 @opindex fpermissive
1800 Downgrade some diagnostics about nonconformant code from errors to
1801 warnings.  Thus, using @option{-fpermissive} will allow some
1802 nonconforming code to compile.
1803
1804 @item -frepo
1805 @opindex frepo
1806 Enable automatic template instantiation at link time.  This option also
1807 implies @option{-fno-implicit-templates}.  @xref{Template
1808 Instantiation}, for more information.
1809
1810 @item -fno-rtti
1811 @opindex fno-rtti
1812 Disable generation of information about every class with virtual
1813 functions for use by the C++ runtime type identification features
1814 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1815 of the language, you can save some space by using this flag.  Note that
1816 exception handling uses the same information, but it will generate it as
1817 needed. The @samp{dynamic_cast} operator can still be used for casts that
1818 do not require runtime type information, i.e.@: casts to @code{void *} or to
1819 unambiguous base classes.
1820
1821 @item -fstats
1822 @opindex fstats
1823 Emit statistics about front-end processing at the end of the compilation.
1824 This information is generally only useful to the G++ development team.
1825
1826 @item -ftemplate-depth-@var{n}
1827 @opindex ftemplate-depth
1828 Set the maximum instantiation depth for template classes to @var{n}.
1829 A limit on the template instantiation depth is needed to detect
1830 endless recursions during template class instantiation.  ANSI/ISO C++
1831 conforming programs must not rely on a maximum depth greater than 17.
1832
1833 @item -fno-threadsafe-statics
1834 @opindex fno-threadsafe-statics
1835 Do not emit the extra code to use the routines specified in the C++
1836 ABI for thread-safe initialization of local statics.  You can use this
1837 option to reduce code size slightly in code that doesn't need to be
1838 thread-safe.
1839
1840 @item -fuse-cxa-atexit
1841 @opindex fuse-cxa-atexit
1842 Register destructors for objects with static storage duration with the
1843 @code{__cxa_atexit} function rather than the @code{atexit} function.
1844 This option is required for fully standards-compliant handling of static
1845 destructors, but will only work if your C library supports
1846 @code{__cxa_atexit}.
1847
1848 @item -fno-use-cxa-get-exception-ptr
1849 @opindex fno-use-cxa-get-exception-ptr
1850 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1851 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1852 if the runtime routine is not available.
1853
1854 @item -fvisibility-inlines-hidden
1855 @opindex fvisibility-inlines-hidden
1856 This switch declares that the user does not attempt to compare
1857 pointers to inline methods where the addresses of the two functions
1858 were taken in different shared objects.
1859
1860 The effect of this is that GCC may, effectively, mark inline methods with
1861 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1862 appear in the export table of a DSO and do not require a PLT indirection
1863 when used within the DSO@.  Enabling this option can have a dramatic effect
1864 on load and link times of a DSO as it massively reduces the size of the
1865 dynamic export table when the library makes heavy use of templates.
1866
1867 The behavior of this switch is not quite the same as marking the
1868 methods as hidden directly, because it does not affect static variables
1869 local to the function or cause the compiler to deduce that
1870 the function is defined in only one shared object.
1871
1872 You may mark a method as having a visibility explicitly to negate the
1873 effect of the switch for that method.  For example, if you do want to
1874 compare pointers to a particular inline method, you might mark it as
1875 having default visibility.  Marking the enclosing class with explicit
1876 visibility will have no effect.
1877
1878 Explicitly instantiated inline methods are unaffected by this option
1879 as their linkage might otherwise cross a shared library boundary.
1880 @xref{Template Instantiation}.
1881
1882 @item -fvisibility-ms-compat
1883 @opindex fvisibility-ms-compat
1884 This flag attempts to use visibility settings to make GCC's C++
1885 linkage model compatible with that of Microsoft Visual Studio.
1886
1887 The flag makes these changes to GCC's linkage model:
1888
1889 @enumerate
1890 @item
1891 It sets the default visibility to @code{hidden}, like
1892 @option{-fvisibility=hidden}.
1893
1894 @item
1895 Types, but not their members, are not hidden by default.
1896
1897 @item
1898 The One Definition Rule is relaxed for types without explicit
1899 visibility specifications which are defined in more than one different
1900 shared object: those declarations are permitted if they would have
1901 been permitted when this option was not used.
1902 @end enumerate
1903
1904 In new code it is better to use @option{-fvisibility=hidden} and
1905 export those classes which are intended to be externally visible.
1906 Unfortunately it is possible for code to rely, perhaps accidentally,
1907 on the Visual Studio behavior.
1908
1909 Among the consequences of these changes are that static data members
1910 of the same type with the same name but defined in different shared
1911 objects will be different, so changing one will not change the other;
1912 and that pointers to function members defined in different shared
1913 objects may not compare equal.  When this flag is given, it is a
1914 violation of the ODR to define types with the same name differently.
1915
1916 @item -fno-weak
1917 @opindex fno-weak
1918 Do not use weak symbol support, even if it is provided by the linker.
1919 By default, G++ will use weak symbols if they are available.  This
1920 option exists only for testing, and should not be used by end-users;
1921 it will result in inferior code and has no benefits.  This option may
1922 be removed in a future release of G++.
1923
1924 @item -nostdinc++
1925 @opindex nostdinc++
1926 Do not search for header files in the standard directories specific to
1927 C++, but do still search the other standard directories.  (This option
1928 is used when building the C++ library.)
1929 @end table
1930
1931 In addition, these optimization, warning, and code generation options
1932 have meanings only for C++ programs:
1933
1934 @table @gcctabopt
1935 @item -fno-default-inline
1936 @opindex fno-default-inline
1937 Do not assume @samp{inline} for functions defined inside a class scope.
1938 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1939 functions will have linkage like inline functions; they just won't be
1940 inlined by default.
1941
1942 @item -Wabi @r{(C++ and Objective-C++ only)}
1943 @opindex Wabi
1944 @opindex Wno-abi
1945 Warn when G++ generates code that is probably not compatible with the
1946 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1947 all such cases, there are probably some cases that are not warned about,
1948 even though G++ is generating incompatible code.  There may also be
1949 cases where warnings are emitted even though the code that is generated
1950 will be compatible.
1951
1952 You should rewrite your code to avoid these warnings if you are
1953 concerned about the fact that code generated by G++ may not be binary
1954 compatible with code generated by other compilers.
1955
1956 The known incompatibilities at this point include:
1957
1958 @itemize @bullet
1959
1960 @item
1961 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1962 pack data into the same byte as a base class.  For example:
1963
1964 @smallexample
1965 struct A @{ virtual void f(); int f1 : 1; @};
1966 struct B : public A @{ int f2 : 1; @};
1967 @end smallexample
1968
1969 @noindent
1970 In this case, G++ will place @code{B::f2} into the same byte
1971 as@code{A::f1}; other compilers will not.  You can avoid this problem
1972 by explicitly padding @code{A} so that its size is a multiple of the
1973 byte size on your platform; that will cause G++ and other compilers to
1974 layout @code{B} identically.
1975
1976 @item
1977 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1978 tail padding when laying out virtual bases.  For example:
1979
1980 @smallexample
1981 struct A @{ virtual void f(); char c1; @};
1982 struct B @{ B(); char c2; @};
1983 struct C : public A, public virtual B @{@};
1984 @end smallexample
1985
1986 @noindent
1987 In this case, G++ will not place @code{B} into the tail-padding for
1988 @code{A}; other compilers will.  You can avoid this problem by
1989 explicitly padding @code{A} so that its size is a multiple of its
1990 alignment (ignoring virtual base classes); that will cause G++ and other
1991 compilers to layout @code{C} identically.
1992
1993 @item
1994 Incorrect handling of bit-fields with declared widths greater than that
1995 of their underlying types, when the bit-fields appear in a union.  For
1996 example:
1997
1998 @smallexample
1999 union U @{ int i : 4096; @};
2000 @end smallexample
2001
2002 @noindent
2003 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2004 union too small by the number of bits in an @code{int}.
2005
2006 @item
2007 Empty classes can be placed at incorrect offsets.  For example:
2008
2009 @smallexample
2010 struct A @{@};
2011
2012 struct B @{
2013   A a;
2014   virtual void f ();
2015 @};
2016
2017 struct C : public B, public A @{@};
2018 @end smallexample
2019
2020 @noindent
2021 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2022 it should be placed at offset zero.  G++ mistakenly believes that the
2023 @code{A} data member of @code{B} is already at offset zero.
2024
2025 @item
2026 Names of template functions whose types involve @code{typename} or
2027 template template parameters can be mangled incorrectly.
2028
2029 @smallexample
2030 template <typename Q>
2031 void f(typename Q::X) @{@}
2032
2033 template <template <typename> class Q>
2034 void f(typename Q<int>::X) @{@}
2035 @end smallexample
2036
2037 @noindent
2038 Instantiations of these templates may be mangled incorrectly.
2039
2040 @end itemize
2041
2042 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2043 @opindex Wctor-dtor-privacy
2044 @opindex Wno-ctor-dtor-privacy
2045 Warn when a class seems unusable because all the constructors or
2046 destructors in that class are private, and it has neither friends nor
2047 public static member functions.
2048
2049 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2050 @opindex Wnon-virtual-dtor
2051 @opindex Wno-non-virtual-dtor
2052 Warn when a class has virtual functions and accessible non-virtual
2053 destructor, in which case it would be possible but unsafe to delete
2054 an instance of a derived class through a pointer to the base class.
2055 This warning is also enabled if -Weffc++ is specified.
2056
2057 @item -Wreorder @r{(C++ and Objective-C++ only)}
2058 @opindex Wreorder
2059 @opindex Wno-reorder
2060 @cindex reordering, warning
2061 @cindex warning for reordering of member initializers
2062 Warn when the order of member initializers given in the code does not
2063 match the order in which they must be executed.  For instance:
2064
2065 @smallexample
2066 struct A @{
2067   int i;
2068   int j;
2069   A(): j (0), i (1) @{ @}
2070 @};
2071 @end smallexample
2072
2073 The compiler will rearrange the member initializers for @samp{i}
2074 and @samp{j} to match the declaration order of the members, emitting
2075 a warning to that effect.  This warning is enabled by @option{-Wall}.
2076 @end table
2077
2078 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2079
2080 @table @gcctabopt
2081 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2082 @opindex Weffc++
2083 @opindex Wno-effc++
2084 Warn about violations of the following style guidelines from Scott Meyers'
2085 @cite{Effective C++} book:
2086
2087 @itemize @bullet
2088 @item
2089 Item 11:  Define a copy constructor and an assignment operator for classes
2090 with dynamically allocated memory.
2091
2092 @item
2093 Item 12:  Prefer initialization to assignment in constructors.
2094
2095 @item
2096 Item 14:  Make destructors virtual in base classes.
2097
2098 @item
2099 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2100
2101 @item
2102 Item 23:  Don't try to return a reference when you must return an object.
2103
2104 @end itemize
2105
2106 Also warn about violations of the following style guidelines from
2107 Scott Meyers' @cite{More Effective C++} book:
2108
2109 @itemize @bullet
2110 @item
2111 Item 6:  Distinguish between prefix and postfix forms of increment and
2112 decrement operators.
2113
2114 @item
2115 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2116
2117 @end itemize
2118
2119 When selecting this option, be aware that the standard library
2120 headers do not obey all of these guidelines; use @samp{grep -v}
2121 to filter out those warnings.
2122
2123 @item -Wno-deprecated @r{(C++ and Objective-C++ only)}
2124 @opindex Wno-deprecated
2125 @opindex Wdeprecated
2126 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
2127
2128 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2129 @opindex Wstrict-null-sentinel
2130 @opindex Wno-strict-null-sentinel
2131 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2132 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2133 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2134 it is guaranteed to of the same size as a pointer.  But this use is
2135 not portable across different compilers.
2136
2137 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2138 @opindex Wno-non-template-friend
2139 @opindex Wnon-template-friend
2140 Disable warnings when non-templatized friend functions are declared
2141 within a template.  Since the advent of explicit template specification
2142 support in G++, if the name of the friend is an unqualified-id (i.e.,
2143 @samp{friend foo(int)}), the C++ language specification demands that the
2144 friend declare or define an ordinary, nontemplate function.  (Section
2145 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2146 could be interpreted as a particular specialization of a templatized
2147 function.  Because this non-conforming behavior is no longer the default
2148 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2149 check existing code for potential trouble spots and is on by default.
2150 This new compiler behavior can be turned off with
2151 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2152 but disables the helpful warning.
2153
2154 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2155 @opindex Wold-style-cast
2156 @opindex Wno-old-style-cast
2157 Warn if an old-style (C-style) cast to a non-void type is used within
2158 a C++ program.  The new-style casts (@samp{dynamic_cast},
2159 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2160 less vulnerable to unintended effects and much easier to search for.
2161
2162 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2163 @opindex Woverloaded-virtual
2164 @opindex Wno-overloaded-virtual
2165 @cindex overloaded virtual fn, warning
2166 @cindex warning for overloaded virtual fn
2167 Warn when a function declaration hides virtual functions from a
2168 base class.  For example, in:
2169
2170 @smallexample
2171 struct A @{
2172   virtual void f();
2173 @};
2174
2175 struct B: public A @{
2176   void f(int);
2177 @};
2178 @end smallexample
2179
2180 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2181 like:
2182
2183 @smallexample
2184 B* b;
2185 b->f();
2186 @end smallexample
2187
2188 will fail to compile.
2189
2190 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2191 @opindex Wno-pmf-conversions
2192 @opindex Wpmf-conversions
2193 Disable the diagnostic for converting a bound pointer to member function
2194 to a plain pointer.
2195
2196 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2197 @opindex Wsign-promo
2198 @opindex Wno-sign-promo
2199 Warn when overload resolution chooses a promotion from unsigned or
2200 enumerated type to a signed type, over a conversion to an unsigned type of
2201 the same size.  Previous versions of G++ would try to preserve
2202 unsignedness, but the standard mandates the current behavior.
2203
2204 @smallexample
2205 struct A @{
2206   operator int ();
2207   A& operator = (int);
2208 @};
2209
2210 main ()
2211 @{
2212   A a,b;
2213   a = b;
2214 @}
2215 @end smallexample
2216
2217 In this example, G++ will synthesize a default @samp{A& operator =
2218 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2219 @end table
2220
2221 @node Objective-C and Objective-C++ Dialect Options
2222 @section Options Controlling Objective-C and Objective-C++ Dialects
2223
2224 @cindex compiler options, Objective-C and Objective-C++
2225 @cindex Objective-C and Objective-C++ options, command line
2226 @cindex options, Objective-C and Objective-C++
2227 (NOTE: This manual does not describe the Objective-C and Objective-C++
2228 languages themselves.  See @xref{Standards,,Language Standards
2229 Supported by GCC}, for references.)
2230
2231 This section describes the command-line options that are only meaningful
2232 for Objective-C and Objective-C++ programs, but you can also use most of
2233 the language-independent GNU compiler options.
2234 For example, you might compile a file @code{some_class.m} like this:
2235
2236 @smallexample
2237 gcc -g -fgnu-runtime -O -c some_class.m
2238 @end smallexample
2239
2240 @noindent
2241 In this example, @option{-fgnu-runtime} is an option meant only for
2242 Objective-C and Objective-C++ programs; you can use the other options with
2243 any language supported by GCC@.
2244
2245 Note that since Objective-C is an extension of the C language, Objective-C
2246 compilations may also use options specific to the C front-end (e.g.,
2247 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2248 C++-specific options (e.g., @option{-Wabi}).
2249
2250 Here is a list of options that are @emph{only} for compiling Objective-C
2251 and Objective-C++ programs:
2252
2253 @table @gcctabopt
2254 @item -fconstant-string-class=@var{class-name}
2255 @opindex fconstant-string-class
2256 Use @var{class-name} as the name of the class to instantiate for each
2257 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2258 class name is @code{NXConstantString} if the GNU runtime is being used, and
2259 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2260 @option{-fconstant-cfstrings} option, if also present, will override the
2261 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2262 to be laid out as constant CoreFoundation strings.
2263
2264 @item -fgnu-runtime
2265 @opindex fgnu-runtime
2266 Generate object code compatible with the standard GNU Objective-C
2267 runtime.  This is the default for most types of systems.
2268
2269 @item -fnext-runtime
2270 @opindex fnext-runtime
2271 Generate output compatible with the NeXT runtime.  This is the default
2272 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2273 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2274 used.
2275
2276 @item -fno-nil-receivers
2277 @opindex fno-nil-receivers
2278 Assume that all Objective-C message dispatches (e.g.,
2279 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2280 is not @code{nil}.  This allows for more efficient entry points in the runtime
2281 to be used.  Currently, this option is only available in conjunction with
2282 the NeXT runtime on Mac OS X 10.3 and later.
2283
2284 @item -fobjc-call-cxx-cdtors
2285 @opindex fobjc-call-cxx-cdtors
2286 For each Objective-C class, check if any of its instance variables is a
2287 C++ object with a non-trivial default constructor.  If so, synthesize a
2288 special @code{- (id) .cxx_construct} instance method that will run
2289 non-trivial default constructors on any such instance variables, in order,
2290 and then return @code{self}.  Similarly, check if any instance variable
2291 is a C++ object with a non-trivial destructor, and if so, synthesize a
2292 special @code{- (void) .cxx_destruct} method that will run
2293 all such default destructors, in reverse order.
2294
2295 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2296 thusly generated will only operate on instance variables declared in the
2297 current Objective-C class, and not those inherited from superclasses.  It
2298 is the responsibility of the Objective-C runtime to invoke all such methods
2299 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2300 will be invoked by the runtime immediately after a new object
2301 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2302 be invoked immediately before the runtime deallocates an object instance.
2303
2304 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2305 support for invoking the @code{- (id) .cxx_construct} and
2306 @code{- (void) .cxx_destruct} methods.
2307
2308 @item -fobjc-direct-dispatch
2309 @opindex fobjc-direct-dispatch
2310 Allow fast jumps to the message dispatcher.  On Darwin this is
2311 accomplished via the comm page.
2312
2313 @item -fobjc-exceptions
2314 @opindex fobjc-exceptions
2315 Enable syntactic support for structured exception handling in Objective-C,
2316 similar to what is offered by C++ and Java.  This option is
2317 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2318 earlier.
2319
2320 @smallexample
2321   @@try @{
2322     @dots{}
2323        @@throw expr;
2324     @dots{}
2325   @}
2326   @@catch (AnObjCClass *exc) @{
2327     @dots{}
2328       @@throw expr;
2329     @dots{}
2330       @@throw;
2331     @dots{}
2332   @}
2333   @@catch (AnotherClass *exc) @{
2334     @dots{}
2335   @}
2336   @@catch (id allOthers) @{
2337     @dots{}
2338   @}
2339   @@finally @{
2340     @dots{}
2341       @@throw expr;
2342     @dots{}
2343   @}
2344 @end smallexample
2345
2346 The @code{@@throw} statement may appear anywhere in an Objective-C or
2347 Objective-C++ program; when used inside of a @code{@@catch} block, the
2348 @code{@@throw} may appear without an argument (as shown above), in which case
2349 the object caught by the @code{@@catch} will be rethrown.
2350
2351 Note that only (pointers to) Objective-C objects may be thrown and
2352 caught using this scheme.  When an object is thrown, it will be caught
2353 by the nearest @code{@@catch} clause capable of handling objects of that type,
2354 analogously to how @code{catch} blocks work in C++ and Java.  A
2355 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2356 any and all Objective-C exceptions not caught by previous @code{@@catch}
2357 clauses (if any).
2358
2359 The @code{@@finally} clause, if present, will be executed upon exit from the
2360 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2361 regardless of whether any exceptions are thrown, caught or rethrown
2362 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2363 of the @code{finally} clause in Java.
2364
2365 There are several caveats to using the new exception mechanism:
2366
2367 @itemize @bullet
2368 @item
2369 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2370 idioms provided by the @code{NSException} class, the new
2371 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2372 systems, due to additional functionality needed in the (NeXT) Objective-C
2373 runtime.
2374
2375 @item
2376 As mentioned above, the new exceptions do not support handling
2377 types other than Objective-C objects.   Furthermore, when used from
2378 Objective-C++, the Objective-C exception model does not interoperate with C++
2379 exceptions at this time.  This means you cannot @code{@@throw} an exception
2380 from Objective-C and @code{catch} it in C++, or vice versa
2381 (i.e., @code{throw @dots{} @@catch}).
2382 @end itemize
2383
2384 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2385 blocks for thread-safe execution:
2386
2387 @smallexample
2388   @@synchronized (ObjCClass *guard) @{
2389     @dots{}
2390   @}
2391 @end smallexample
2392
2393 Upon entering the @code{@@synchronized} block, a thread of execution shall
2394 first check whether a lock has been placed on the corresponding @code{guard}
2395 object by another thread.  If it has, the current thread shall wait until
2396 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2397 the current thread will place its own lock on it, execute the code contained in
2398 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2399 making @code{guard} available to other threads).
2400
2401 Unlike Java, Objective-C does not allow for entire methods to be marked
2402 @code{@@synchronized}.  Note that throwing exceptions out of
2403 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2404 to be unlocked properly.
2405
2406 @item -fobjc-gc
2407 @opindex fobjc-gc
2408 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2409
2410 @item -freplace-objc-classes
2411 @opindex freplace-objc-classes
2412 Emit a special marker instructing @command{ld(1)} not to statically link in
2413 the resulting object file, and allow @command{dyld(1)} to load it in at
2414 run time instead.  This is used in conjunction with the Fix-and-Continue
2415 debugging mode, where the object file in question may be recompiled and
2416 dynamically reloaded in the course of program execution, without the need
2417 to restart the program itself.  Currently, Fix-and-Continue functionality
2418 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2419 and later.
2420
2421 @item -fzero-link
2422 @opindex fzero-link
2423 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2424 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2425 compile time) with static class references that get initialized at load time,
2426 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2427 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2428 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2429 for individual class implementations to be modified during program execution.
2430
2431 @item -gen-decls
2432 @opindex gen-decls
2433 Dump interface declarations for all classes seen in the source file to a
2434 file named @file{@var{sourcename}.decl}.
2435
2436 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2437 @opindex Wassign-intercept
2438 @opindex Wno-assign-intercept
2439 Warn whenever an Objective-C assignment is being intercepted by the
2440 garbage collector.
2441
2442 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2443 @opindex Wno-protocol
2444 @opindex Wprotocol
2445 If a class is declared to implement a protocol, a warning is issued for
2446 every method in the protocol that is not implemented by the class.  The
2447 default behavior is to issue a warning for every method not explicitly
2448 implemented in the class, even if a method implementation is inherited
2449 from the superclass.  If you use the @option{-Wno-protocol} option, then
2450 methods inherited from the superclass are considered to be implemented,
2451 and no warning is issued for them.
2452
2453 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2454 @opindex Wselector
2455 @opindex Wno-selector
2456 Warn if multiple methods of different types for the same selector are
2457 found during compilation.  The check is performed on the list of methods
2458 in the final stage of compilation.  Additionally, a check is performed
2459 for each selector appearing in a @code{@@selector(@dots{})}
2460 expression, and a corresponding method for that selector has been found
2461 during compilation.  Because these checks scan the method table only at
2462 the end of compilation, these warnings are not produced if the final
2463 stage of compilation is not reached, for example because an error is
2464 found during compilation, or because the @option{-fsyntax-only} option is
2465 being used.
2466
2467 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2468 @opindex Wstrict-selector-match
2469 @opindex Wno-strict-selector-match
2470 Warn if multiple methods with differing argument and/or return types are
2471 found for a given selector when attempting to send a message using this
2472 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2473 is off (which is the default behavior), the compiler will omit such warnings
2474 if any differences found are confined to types which share the same size
2475 and alignment.
2476
2477 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2478 @opindex Wundeclared-selector
2479 @opindex Wno-undeclared-selector
2480 Warn if a @code{@@selector(@dots{})} expression referring to an
2481 undeclared selector is found.  A selector is considered undeclared if no
2482 method with that name has been declared before the
2483 @code{@@selector(@dots{})} expression, either explicitly in an
2484 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2485 an @code{@@implementation} section.  This option always performs its
2486 checks as soon as a @code{@@selector(@dots{})} expression is found,
2487 while @option{-Wselector} only performs its checks in the final stage of
2488 compilation.  This also enforces the coding style convention
2489 that methods and selectors must be declared before being used.
2490
2491 @item -print-objc-runtime-info
2492 @opindex print-objc-runtime-info
2493 Generate C header describing the largest structure that is passed by
2494 value, if any.
2495
2496 @end table
2497
2498 @node Language Independent Options
2499 @section Options to Control Diagnostic Messages Formatting
2500 @cindex options to control diagnostics formatting
2501 @cindex diagnostic messages
2502 @cindex message formatting
2503
2504 Traditionally, diagnostic messages have been formatted irrespective of
2505 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2506 below can be used to control the diagnostic messages formatting
2507 algorithm, e.g.@: how many characters per line, how often source location
2508 information should be reported.  Right now, only the C++ front end can
2509 honor these options.  However it is expected, in the near future, that
2510 the remaining front ends would be able to digest them correctly.
2511
2512 @table @gcctabopt
2513 @item -fmessage-length=@var{n}
2514 @opindex fmessage-length
2515 Try to format error messages so that they fit on lines of about @var{n}
2516 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2517 the front ends supported by GCC@.  If @var{n} is zero, then no
2518 line-wrapping will be done; each error message will appear on a single
2519 line.
2520
2521 @opindex fdiagnostics-show-location
2522 @item -fdiagnostics-show-location=once
2523 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2524 reporter to emit @emph{once} source location information; that is, in
2525 case the message is too long to fit on a single physical line and has to
2526 be wrapped, the source location won't be emitted (as prefix) again,
2527 over and over, in subsequent continuation lines.  This is the default
2528 behavior.
2529
2530 @item -fdiagnostics-show-location=every-line
2531 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2532 messages reporter to emit the same source location information (as
2533 prefix) for physical lines that result from the process of breaking
2534 a message which is too long to fit on a single line.
2535
2536 @item -fdiagnostics-show-option
2537 @opindex fdiagnostics-show-option
2538 This option instructs the diagnostic machinery to add text to each
2539 diagnostic emitted, which indicates which command line option directly
2540 controls that diagnostic, when such an option is known to the
2541 diagnostic machinery.
2542
2543 @item -Wcoverage-mismatch
2544 @opindex Wcoverage-mismatch
2545 Warn if feedback profiles do not match when using the
2546 @option{-fprofile-use} option.
2547 If a source file was changed between @option{-fprofile-gen} and
2548 @option{-fprofile-use}, the files with the profile feedback can fail
2549 to match the source file and GCC can not use the profile feedback
2550 information.  By default, GCC emits an error message in this case.
2551 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2552 error.  GCC does not use appropriate feedback profiles, so using this
2553 option can result in poorly optimized code.  This option is useful
2554 only in the case of very minor changes such as bug fixes to an
2555 existing code-base.
2556
2557 @end table
2558
2559 @node Warning Options
2560 @section Options to Request or Suppress Warnings
2561 @cindex options to control warnings
2562 @cindex warning messages
2563 @cindex messages, warning
2564 @cindex suppressing warnings
2565
2566 Warnings are diagnostic messages that report constructions which
2567 are not inherently erroneous but which are risky or suggest there
2568 may have been an error.
2569
2570 The following language-independent options do not enable specific
2571 warnings but control the kinds of diagnostics produced by GCC.
2572
2573 @table @gcctabopt
2574 @cindex syntax checking
2575 @item -fsyntax-only
2576 @opindex fsyntax-only
2577 Check the code for syntax errors, but don't do anything beyond that.
2578
2579 @item -w
2580 @opindex w
2581 Inhibit all warning messages.
2582
2583 @item -Werror
2584 @opindex Werror
2585 @opindex Wno-error
2586 Make all warnings into errors.
2587
2588 @item -Werror=
2589 @opindex Werror=
2590 @opindex Wno-error=
2591 Make the specified warning into an error.  The specifier for a warning
2592 is appended, for example @option{-Werror=switch} turns the warnings
2593 controlled by @option{-Wswitch} into errors.  This switch takes a
2594 negative form, to be used to negate @option{-Werror} for specific
2595 warnings, for example @option{-Wno-error=switch} makes
2596 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2597 is in effect.  You can use the @option{-fdiagnostics-show-option}
2598 option to have each controllable warning amended with the option which
2599 controls it, to determine what to use with this option.
2600
2601 Note that specifying @option{-Werror=}@var{foo} automatically implies
2602 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2603 imply anything.
2604
2605 @item -Wfatal-errors
2606 @opindex Wfatal-errors
2607 @opindex Wno-fatal-errors
2608 This option causes the compiler to abort compilation on the first error
2609 occurred rather than trying to keep going and printing further error
2610 messages.
2611
2612 @end table
2613
2614 You can request many specific warnings with options beginning
2615 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2616 implicit declarations.  Each of these specific warning options also
2617 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2618 example, @option{-Wno-implicit}.  This manual lists only one of the
2619 two forms, whichever is not the default.  For further,
2620 language-specific options also refer to @ref{C++ Dialect Options} and
2621 @ref{Objective-C and Objective-C++ Dialect Options}.
2622
2623 @table @gcctabopt
2624 @item -pedantic
2625 @opindex pedantic
2626 Issue all the warnings demanded by strict ISO C and ISO C++;
2627 reject all programs that use forbidden extensions, and some other
2628 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2629 version of the ISO C standard specified by any @option{-std} option used.
2630
2631 Valid ISO C and ISO C++ programs should compile properly with or without
2632 this option (though a rare few will require @option{-ansi} or a
2633 @option{-std} option specifying the required version of ISO C)@.  However,
2634 without this option, certain GNU extensions and traditional C and C++
2635 features are supported as well.  With this option, they are rejected.
2636
2637 @option{-pedantic} does not cause warning messages for use of the
2638 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2639 warnings are also disabled in the expression that follows
2640 @code{__extension__}.  However, only system header files should use
2641 these escape routes; application programs should avoid them.
2642 @xref{Alternate Keywords}.
2643
2644 Some users try to use @option{-pedantic} to check programs for strict ISO
2645 C conformance.  They soon find that it does not do quite what they want:
2646 it finds some non-ISO practices, but not all---only those for which
2647 ISO C @emph{requires} a diagnostic, and some others for which
2648 diagnostics have been added.
2649
2650 A feature to report any failure to conform to ISO C might be useful in
2651 some instances, but would require considerable additional work and would
2652 be quite different from @option{-pedantic}.  We don't have plans to
2653 support such a feature in the near future.
2654
2655 Where the standard specified with @option{-std} represents a GNU
2656 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2657 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2658 extended dialect is based.  Warnings from @option{-pedantic} are given
2659 where they are required by the base standard.  (It would not make sense
2660 for such warnings to be given only for features not in the specified GNU
2661 C dialect, since by definition the GNU dialects of C include all
2662 features the compiler supports with the given option, and there would be
2663 nothing to warn about.)
2664
2665 @item -pedantic-errors
2666 @opindex pedantic-errors
2667 Like @option{-pedantic}, except that errors are produced rather than
2668 warnings.
2669
2670 @item -Wall
2671 @opindex Wall
2672 @opindex Wno-all
2673 This enables all the warnings about constructions that some users
2674 consider questionable, and that are easy to avoid (or modify to
2675 prevent the warning), even in conjunction with macros.  This also
2676 enables some language-specific warnings described in @ref{C++ Dialect
2677 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2678
2679 @option{-Wall} turns on the following warning flags:
2680
2681 @gccoptlist{-Waddress   @gol
2682 -Warray-bounds @r{(some checks, but more complete with} @option{-O2}@r{)}  @gol
2683 -Wc++0x-compat  @gol
2684 -Wchar-subscripts  @gol
2685 -Wimplicit-int  @gol
2686 -Wimplicit-function-declaration  @gol
2687 -Wcomment  @gol
2688 -Wformat   @gol
2689 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2690 -Wmissing-braces  @gol
2691 -Wnonnull  @gol
2692 -Wparentheses  @gol
2693 -Wpointer-sign  @gol
2694 -Wreorder   @gol
2695 -Wreturn-type  @gol
2696 -Wsequence-point  @gol
2697 -Wsign-compare @r{(only in C++)}  @gol
2698 -Wstrict-aliasing  @gol
2699 -Wstrict-overflow=1  @gol
2700 -Wswitch  @gol
2701 -Wtrigraphs  @gol
2702 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2703 -Wunknown-pragmas  @gol
2704 -Wunused-function  @gol
2705 -Wunused-label     @gol
2706 -Wunused-value     @gol
2707 -Wunused-variable  @gol
2708 -Wvolatile-register-var @gol
2709 }
2710
2711 Note that some warning flags are not implied by @option{-Wall}.  Some of
2712 them warn about constructions that users generally do not consider
2713 questionable, but which occasionally you might wish to check for;
2714 others warn about constructions that are necessary or hard to avoid in
2715 some cases, and there is no simple way to modify the code to suppress
2716 the warning. Some of them are enabled by @option{-Wextra} but many of
2717 them must be enabled individually.
2718
2719 @item -Wextra
2720 @opindex W
2721 @opindex Wextra
2722 @opindex Wno-extra
2723 This enables some extra warning flags that are not enabled by
2724 @option{-Wall}. (This option used to be called @option{-W}.  The older
2725 name is still supported, but the newer name is more descriptive.)
2726
2727 @gccoptlist{-Wclobbered  @gol
2728 -Wempty-body  @gol
2729 -Wignored-qualifiers @gol
2730 -Wmissing-field-initializers  @gol
2731 -Wmissing-parameter-type @r{(C only)}  @gol
2732 -Wold-style-declaration @r{(C only)}  @gol
2733 -Woverride-init  @gol
2734 -Wsign-compare  @gol
2735 -Wtype-limits  @gol
2736 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2737 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2738 }
2739
2740 The option @option{-Wextra} also prints warning messages for the
2741 following cases:
2742
2743 @itemize @bullet
2744
2745 @item
2746 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2747 @samp{>}, or @samp{>=}.
2748
2749 @item 
2750 (C++ only) An enumerator and a non-enumerator both appear in a
2751 conditional expression.
2752
2753 @item 
2754 (C++ only) A non-static reference or non-static @samp{const} member
2755 appears in a class without constructors.
2756
2757 @item 
2758 (C++ only) Ambiguous virtual bases.
2759
2760 @item 
2761 (C++ only) Subscripting an array which has been declared @samp{register}.
2762
2763 @item 
2764 (C++ only) Taking the address of a variable which has been declared
2765 @samp{register}.
2766
2767 @item 
2768 (C++ only) A base class is not initialized in a derived class' copy
2769 constructor.
2770
2771 @end itemize
2772
2773 @item -Wno-import
2774 @opindex Wno-import
2775 @opindex Wimport
2776 Inhibit warning messages about the use of @samp{#import}.
2777
2778 @item -Wchar-subscripts
2779 @opindex Wchar-subscripts
2780 @opindex Wno-char-subscripts
2781 Warn if an array subscript has type @code{char}.  This is a common cause
2782 of error, as programmers often forget that this type is signed on some
2783 machines.
2784 This warning is enabled by @option{-Wall}.
2785
2786 @item -Wcomment
2787 @opindex Wcomment
2788 @opindex Wno-comment
2789 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2790 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2791 This warning is enabled by @option{-Wall}.
2792
2793 @item -Wformat
2794 @opindex Wformat
2795 @opindex Wno-format
2796 @opindex ffreestanding
2797 @opindex fno-builtin
2798 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2799 the arguments supplied have types appropriate to the format string
2800 specified, and that the conversions specified in the format string make
2801 sense.  This includes standard functions, and others specified by format
2802 attributes (@pxref{Function Attributes}), in the @code{printf},
2803 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2804 not in the C standard) families (or other target-specific families).
2805 Which functions are checked without format attributes having been
2806 specified depends on the standard version selected, and such checks of
2807 functions without the attribute specified are disabled by
2808 @option{-ffreestanding} or @option{-fno-builtin}.
2809
2810 The formats are checked against the format features supported by GNU
2811 libc version 2.2.  These include all ISO C90 and C99 features, as well
2812 as features from the Single Unix Specification and some BSD and GNU
2813 extensions.  Other library implementations may not support all these
2814 features; GCC does not support warning about features that go beyond a
2815 particular library's limitations.  However, if @option{-pedantic} is used
2816 with @option{-Wformat}, warnings will be given about format features not
2817 in the selected standard version (but not for @code{strfmon} formats,
2818 since those are not in any version of the C standard).  @xref{C Dialect
2819 Options,,Options Controlling C Dialect}.
2820
2821 Since @option{-Wformat} also checks for null format arguments for
2822 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2823
2824 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2825 aspects of format checking, the options @option{-Wformat-y2k},
2826 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2827 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2828 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2829
2830 @item -Wformat-y2k
2831 @opindex Wformat-y2k
2832 @opindex Wno-format-y2k
2833 If @option{-Wformat} is specified, also warn about @code{strftime}
2834 formats which may yield only a two-digit year.
2835
2836 @item -Wno-format-contains-nul
2837 @opindex Wno-format-contains-nul
2838 @opindex Wformat-contains-nul
2839 If @option{-Wformat} is specified, do not warn about format strings that
2840 contain NUL bytes.
2841
2842 @item -Wno-format-extra-args
2843 @opindex Wno-format-extra-args
2844 @opindex Wformat-extra-args
2845 If @option{-Wformat} is specified, do not warn about excess arguments to a
2846 @code{printf} or @code{scanf} format function.  The C standard specifies
2847 that such arguments are ignored.
2848
2849 Where the unused arguments lie between used arguments that are
2850 specified with @samp{$} operand number specifications, normally
2851 warnings are still given, since the implementation could not know what
2852 type to pass to @code{va_arg} to skip the unused arguments.  However,
2853 in the case of @code{scanf} formats, this option will suppress the
2854 warning if the unused arguments are all pointers, since the Single
2855 Unix Specification says that such unused arguments are allowed.
2856
2857 @item -Wno-format-zero-length @r{(C and Objective-C only)}
2858 @opindex Wno-format-zero-length
2859 @opindex Wformat-zero-length
2860 If @option{-Wformat} is specified, do not warn about zero-length formats.
2861 The C standard specifies that zero-length formats are allowed.
2862
2863 @item -Wformat-nonliteral
2864 @opindex Wformat-nonliteral
2865 @opindex Wno-format-nonliteral
2866 If @option{-Wformat} is specified, also warn if the format string is not a
2867 string literal and so cannot be checked, unless the format function
2868 takes its format arguments as a @code{va_list}.
2869
2870 @item -Wformat-security
2871 @opindex Wformat-security
2872 @opindex Wno-format-security
2873 If @option{-Wformat} is specified, also warn about uses of format
2874 functions that represent possible security problems.  At present, this
2875 warns about calls to @code{printf} and @code{scanf} functions where the
2876 format string is not a string literal and there are no format arguments,
2877 as in @code{printf (foo);}.  This may be a security hole if the format
2878 string came from untrusted input and contains @samp{%n}.  (This is
2879 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2880 in future warnings may be added to @option{-Wformat-security} that are not
2881 included in @option{-Wformat-nonliteral}.)
2882
2883 @item -Wformat=2
2884 @opindex Wformat=2
2885 @opindex Wno-format=2
2886 Enable @option{-Wformat} plus format checks not included in
2887 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2888 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2889
2890 @item -Wnonnull @r{(C and Objective-C only)}
2891 @opindex Wnonnull
2892 @opindex Wno-nonnull
2893 Warn about passing a null pointer for arguments marked as
2894 requiring a non-null value by the @code{nonnull} function attribute.
2895
2896 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2897 can be disabled with the @option{-Wno-nonnull} option.
2898
2899 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2900 @opindex Winit-self
2901 @opindex Wno-init-self
2902 Warn about uninitialized variables which are initialized with themselves.
2903 Note this option can only be used with the @option{-Wuninitialized} option,
2904 which in turn only works with @option{-O1} and above.
2905
2906 For example, GCC will warn about @code{i} being uninitialized in the
2907 following snippet only when @option{-Winit-self} has been specified:
2908 @smallexample
2909 @group
2910 int f()
2911 @{
2912   int i = i;
2913   return i;
2914 @}
2915 @end group
2916 @end smallexample
2917
2918 @item -Wimplicit-int @r{(C and Objective-C only)}
2919 @opindex Wimplicit-int
2920 @opindex Wno-implicit-int
2921 Warn when a declaration does not specify a type.
2922 This warning is enabled by @option{-Wall}.
2923
2924 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
2925 @opindex Wimplicit-function-declaration
2926 @opindex Wno-implicit-function-declaration
2927 Give a warning whenever a function is used before being declared. In
2928 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
2929 enabled by default and it is made into an error by
2930 @option{-pedantic-errors}. This warning is also enabled by
2931 @option{-Wall}.
2932
2933 @item -Wimplicit
2934 @opindex Wimplicit
2935 @opindex Wno-implicit
2936 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2937 This warning is enabled by @option{-Wall}.
2938
2939 @item -Wignored-qualifiers @r{(C and C++ only)}
2940 @opindex Wignored-qualifiers
2941 @opindex Wno-ignored-qualifiers
2942 Warn if the return type of a function has a type qualifier
2943 such as @code{const}.  For ISO C such a type qualifier has no effect,
2944 since the value returned by a function is not an lvalue.
2945 For C++, the warning is only emitted for scalar types or @code{void}.
2946 ISO C prohibits qualified @code{void} return types on function
2947 definitions, so such return types always receive a warning
2948 even without this option.
2949
2950 This warning is also enabled by @option{-Wextra}.
2951
2952 @item -Wmain
2953 @opindex Wmain
2954 @opindex Wno-main
2955 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2956 function with external linkage, returning int, taking either zero
2957 arguments, two, or three arguments of appropriate types.
2958 This warning is enabled by @option{-Wall}.
2959
2960 @item -Wmissing-braces
2961 @opindex Wmissing-braces
2962 @opindex Wno-missing-braces
2963 Warn if an aggregate or union initializer is not fully bracketed.  In
2964 the following example, the initializer for @samp{a} is not fully
2965 bracketed, but that for @samp{b} is fully bracketed.
2966
2967 @smallexample
2968 int a[2][2] = @{ 0, 1, 2, 3 @};
2969 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2970 @end smallexample
2971
2972 This warning is enabled by @option{-Wall}.
2973
2974 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2975 @opindex Wmissing-include-dirs
2976 @opindex Wno-missing-include-dirs
2977 Warn if a user-supplied include directory does not exist.
2978
2979 @item -Wparentheses
2980 @opindex Wparentheses
2981 @opindex Wno-parentheses
2982 Warn if parentheses are omitted in certain contexts, such
2983 as when there is an assignment in a context where a truth value
2984 is expected, or when operators are nested whose precedence people
2985 often get confused about.
2986
2987 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2988 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2989 interpretation from that of ordinary mathematical notation.
2990
2991 Also warn about constructions where there may be confusion to which
2992 @code{if} statement an @code{else} branch belongs.  Here is an example of
2993 such a case:
2994
2995 @smallexample
2996 @group
2997 @{
2998   if (a)
2999     if (b)
3000       foo ();
3001   else
3002     bar ();
3003 @}
3004 @end group
3005 @end smallexample
3006
3007 In C/C++, every @code{else} branch belongs to the innermost possible
3008 @code{if} statement, which in this example is @code{if (b)}.  This is
3009 often not what the programmer expected, as illustrated in the above
3010 example by indentation the programmer chose.  When there is the
3011 potential for this confusion, GCC will issue a warning when this flag
3012 is specified.  To eliminate the warning, add explicit braces around
3013 the innermost @code{if} statement so there is no way the @code{else}
3014 could belong to the enclosing @code{if}.  The resulting code would
3015 look like this:
3016
3017 @smallexample
3018 @group
3019 @{
3020   if (a)
3021     @{
3022       if (b)
3023         foo ();
3024       else
3025         bar ();
3026     @}
3027 @}
3028 @end group
3029 @end smallexample
3030
3031 This warning is enabled by @option{-Wall}.
3032
3033 @item -Wsequence-point
3034 @opindex Wsequence-point
3035 @opindex Wno-sequence-point
3036 Warn about code that may have undefined semantics because of violations
3037 of sequence point rules in the C and C++ standards.
3038
3039 The C and C++ standards defines the order in which expressions in a C/C++
3040 program are evaluated in terms of @dfn{sequence points}, which represent
3041 a partial ordering between the execution of parts of the program: those
3042 executed before the sequence point, and those executed after it.  These
3043 occur after the evaluation of a full expression (one which is not part
3044 of a larger expression), after the evaluation of the first operand of a
3045 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3046 function is called (but after the evaluation of its arguments and the
3047 expression denoting the called function), and in certain other places.
3048 Other than as expressed by the sequence point rules, the order of
3049 evaluation of subexpressions of an expression is not specified.  All
3050 these rules describe only a partial order rather than a total order,
3051 since, for example, if two functions are called within one expression
3052 with no sequence point between them, the order in which the functions
3053 are called is not specified.  However, the standards committee have
3054 ruled that function calls do not overlap.
3055
3056 It is not specified when between sequence points modifications to the
3057 values of objects take effect.  Programs whose behavior depends on this
3058 have undefined behavior; the C and C++ standards specify that ``Between
3059 the previous and next sequence point an object shall have its stored
3060 value modified at most once by the evaluation of an expression.
3061 Furthermore, the prior value shall be read only to determine the value
3062 to be stored.''.  If a program breaks these rules, the results on any
3063 particular implementation are entirely unpredictable.
3064
3065 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3066 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3067 diagnosed by this option, and it may give an occasional false positive
3068 result, but in general it has been found fairly effective at detecting
3069 this sort of problem in programs.
3070
3071 The standard is worded confusingly, therefore there is some debate
3072 over the precise meaning of the sequence point rules in subtle cases.
3073 Links to discussions of the problem, including proposed formal
3074 definitions, may be found on the GCC readings page, at
3075 @w{@uref{http://gcc.gnu.org/readings.html}}.
3076
3077 This warning is enabled by @option{-Wall} for C and C++.
3078
3079 @item -Wreturn-type
3080 @opindex Wreturn-type
3081 @opindex Wno-return-type
3082 Warn whenever a function is defined with a return-type that defaults
3083 to @code{int}.  Also warn about any @code{return} statement with no
3084 return-value in a function whose return-type is not @code{void}
3085 (falling off the end of the function body is considered returning
3086 without a value), and about a @code{return} statement with a
3087 expression in a function whose return-type is @code{void}.
3088
3089 For C++, a function without return type always produces a diagnostic
3090 message, even when @option{-Wno-return-type} is specified.  The only
3091 exceptions are @samp{main} and functions defined in system headers.
3092
3093 This warning is enabled by @option{-Wall}.
3094
3095 @item -Wswitch
3096 @opindex Wswitch
3097 @opindex Wno-switch
3098 Warn whenever a @code{switch} statement has an index of enumerated type
3099 and lacks a @code{case} for one or more of the named codes of that
3100 enumeration.  (The presence of a @code{default} label prevents this
3101 warning.)  @code{case} labels outside the enumeration range also
3102 provoke warnings when this option is used.
3103 This warning is enabled by @option{-Wall}.
3104
3105 @item -Wswitch-default
3106 @opindex Wswitch-default
3107 @opindex Wno-switch-default
3108 Warn whenever a @code{switch} statement does not have a @code{default}
3109 case.
3110
3111 @item -Wswitch-enum
3112 @opindex Wswitch-enum
3113 @opindex Wno-switch-enum
3114 Warn whenever a @code{switch} statement has an index of enumerated type
3115 and lacks a @code{case} for one or more of the named codes of that
3116 enumeration.  @code{case} labels outside the enumeration range also
3117 provoke warnings when this option is used.
3118
3119 @item -Wtrigraphs
3120 @opindex Wtrigraphs
3121 @opindex Wno-trigraphs
3122 Warn if any trigraphs are encountered that might change the meaning of
3123 the program (trigraphs within comments are not warned about).
3124 This warning is enabled by @option{-Wall}.
3125
3126 @item -Wunused-function
3127 @opindex Wunused-function
3128 @opindex Wno-unused-function
3129 Warn whenever a static function is declared but not defined or a
3130 non-inline static function is unused.
3131 This warning is enabled by @option{-Wall}.
3132
3133 @item -Wunused-label
3134 @opindex Wunused-label
3135 @opindex Wno-unused-label
3136 Warn whenever a label is declared but not used.
3137 This warning is enabled by @option{-Wall}.
3138
3139 To suppress this warning use the @samp{unused} attribute
3140 (@pxref{Variable Attributes}).
3141
3142 @item -Wunused-parameter
3143 @opindex Wunused-parameter
3144 @opindex Wno-unused-parameter
3145 Warn whenever a function parameter is unused aside from its declaration.
3146
3147 To suppress this warning use the @samp{unused} attribute
3148 (@pxref{Variable Attributes}).
3149
3150 @item -Wunused-variable
3151 @opindex Wunused-variable
3152 @opindex Wno-unused-variable
3153 Warn whenever a local variable or non-constant static variable is unused
3154 aside from its declaration.
3155 This warning is enabled by @option{-Wall}.
3156
3157 To suppress this warning use the @samp{unused} attribute
3158 (@pxref{Variable Attributes}).
3159
3160 @item -Wunused-value
3161 @opindex Wunused-value
3162 @opindex Wno-unused-value
3163 Warn whenever a statement computes a result that is explicitly not
3164 used. To suppress this warning cast the unused expression to
3165 @samp{void}. This includes an expression-statement or the left-hand
3166 side of a comma expression that contains no side effects. For example,
3167 an expression such as @samp{x[i,j]} will cause a warning, while
3168 @samp{x[(void)i,j]} will not.
3169
3170 This warning is enabled by @option{-Wall}.
3171
3172 @item -Wunused
3173 @opindex Wunused
3174 @opindex Wno-unused
3175 All the above @option{-Wunused} options combined.
3176
3177 In order to get a warning about an unused function parameter, you must
3178 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3179 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3180
3181 @item -Wuninitialized
3182 @opindex Wuninitialized
3183 @opindex Wno-uninitialized
3184 Warn if an automatic variable is used without first being initialized or
3185 if a variable may be clobbered by a @code{setjmp} call.
3186
3187 These warnings are possible only in optimizing compilation,
3188 because they require data flow information that is computed only
3189 when optimizing.  If you do not specify @option{-O}, you will not get
3190 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
3191 requiring @option{-O}.
3192
3193 If you want to warn about code which uses the uninitialized value of the
3194 variable in its own initializer, use the @option{-Winit-self} option.
3195
3196 These warnings occur for individual uninitialized or clobbered
3197 elements of structure, union or array variables as well as for
3198 variables which are uninitialized or clobbered as a whole.  They do
3199 not occur for variables or elements declared @code{volatile}.  Because
3200 these warnings depend on optimization, the exact variables or elements
3201 for which there are warnings will depend on the precise optimization
3202 options and version of GCC used.
3203
3204 Note that there may be no warning about a variable that is used only
3205 to compute a value that itself is never used, because such
3206 computations may be deleted by data flow analysis before the warnings
3207 are printed.
3208
3209 These warnings are made optional because GCC is not smart
3210 enough to see all the reasons why the code might be correct
3211 despite appearing to have an error.  Here is one example of how
3212 this can happen:
3213
3214 @smallexample
3215 @group
3216 @{
3217   int x;
3218   switch (y)
3219     @{
3220     case 1: x = 1;
3221       break;
3222     case 2: x = 4;
3223       break;
3224     case 3: x = 5;
3225     @}
3226   foo (x);
3227 @}
3228 @end group
3229 @end smallexample
3230
3231 @noindent
3232 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3233 always initialized, but GCC doesn't know this.  Here is
3234 another common case:
3235
3236 @smallexample
3237 @{
3238   int save_y;
3239   if (change_y) save_y = y, y = new_y;
3240   @dots{}
3241   if (change_y) y = save_y;
3242 @}
3243 @end smallexample
3244
3245 @noindent
3246 This has no bug because @code{save_y} is used only if it is set.
3247
3248 @cindex @code{longjmp} warnings
3249 This option also warns when a non-volatile automatic variable might be
3250 changed by a call to @code{longjmp}.  These warnings as well are possible
3251 only in optimizing compilation.
3252
3253 The compiler sees only the calls to @code{setjmp}.  It cannot know
3254 where @code{longjmp} will be called; in fact, a signal handler could
3255 call it at any point in the code.  As a result, you may get a warning
3256 even when there is in fact no problem because @code{longjmp} cannot
3257 in fact be called at the place which would cause a problem.
3258
3259 Some spurious warnings can be avoided if you declare all the functions
3260 you use that never return as @code{noreturn}.  @xref{Function
3261 Attributes}.
3262
3263 This warning is enabled by @option{-Wall} or @option{-Wextra} in
3264 optimizing compilations (@option{-O1} and above).
3265
3266 @item -Wunknown-pragmas
3267 @opindex Wunknown-pragmas
3268 @opindex Wno-unknown-pragmas
3269 @cindex warning for unknown pragmas
3270 @cindex unknown pragmas, warning
3271 @cindex pragmas, warning of unknown
3272 Warn when a #pragma directive is encountered which is not understood by
3273 GCC@.  If this command line option is used, warnings will even be issued
3274 for unknown pragmas in system header files.  This is not the case if
3275 the warnings were only enabled by the @option{-Wall} command line option.
3276
3277 @item -Wno-pragmas
3278 @opindex Wno-pragmas
3279 @opindex Wpragmas
3280 Do not warn about misuses of pragmas, such as incorrect parameters,
3281 invalid syntax, or conflicts between pragmas.  See also
3282 @samp{-Wunknown-pragmas}.
3283
3284 @item -Wstrict-aliasing
3285 @opindex Wstrict-aliasing
3286 @opindex Wno-strict-aliasing
3287 This option is only active when @option{-fstrict-aliasing} is active.
3288 It warns about code which might break the strict aliasing rules that the
3289 compiler is using for optimization.  The warning does not catch all
3290 cases, but does attempt to catch the more common pitfalls.  It is
3291 included in @option{-Wall}.
3292 It is equivalent to @option{-Wstrict-aliasing=3}
3293
3294 @item -Wstrict-aliasing=n
3295 @opindex Wstrict-aliasing=n
3296 @opindex Wno-strict-aliasing=n
3297 This option is only active when @option{-fstrict-aliasing} is active.
3298 It warns about code which might break the strict aliasing rules that the
3299 compiler is using for optimization.
3300 Higher levels correspond to higher accuracy (fewer false positives).
3301 Higher levels also correspond to more effort, similar to the way -O works.
3302 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3303 with n=3.
3304
3305 Level 1: Most aggressive, quick, least accurate.
3306 Possibly useful when higher levels
3307 do not warn but -fstrict-aliasing still breaks the code, as it has very few 
3308 false negatives.  However, it has many false positives.
3309 Warns for all pointer conversions between possibly incompatible types, 
3310 even if never dereferenced.  Runs in the frontend only.
3311
3312 Level 2: Aggressive, quick, not too precise.
3313 May still have many false positives (not as many as level 1 though),
3314 and few false negatives (but possibly more than level 1).
3315 Unlike level 1, it only warns when an address is taken.  Warns about
3316 incomplete types.  Runs in the frontend only.
3317
3318 Level 3 (default for @option{-Wstrict-aliasing}): 
3319 Should have very few false positives and few false 
3320 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3321 Takes care of the common punn+dereference pattern in the frontend:
3322 @code{*(int*)&some_float}.
3323 If optimization is enabled, it also runs in the backend, where it deals 
3324 with multiple statement cases using flow-sensitive points-to information.
3325 Only warns when the converted pointer is dereferenced.
3326 Does not warn about incomplete types.
3327
3328 @item -Wstrict-overflow
3329 @itemx -Wstrict-overflow=@var{n}
3330 @opindex Wstrict-overflow
3331 @opindex Wno-strict-overflow
3332 This option is only active when @option{-fstrict-overflow} is active.
3333 It warns about cases where the compiler optimizes based on the
3334 assumption that signed overflow does not occur.  Note that it does not
3335 warn about all cases where the code might overflow: it only warns
3336 about cases where the compiler implements some optimization.  Thus
3337 this warning depends on the optimization level.
3338
3339 An optimization which assumes that signed overflow does not occur is
3340 perfectly safe if the values of the variables involved are such that
3341 overflow never does, in fact, occur.  Therefore this warning can
3342 easily give a false positive: a warning about code which is not
3343 actually a problem.  To help focus on important issues, several
3344 warning levels are defined.  No warnings are issued for the use of
3345 undefined signed overflow when estimating how many iterations a loop
3346 will require, in particular when determining whether a loop will be
3347 executed at all.
3348
3349 @table @gcctabopt
3350 @item -Wstrict-overflow=1
3351 Warn about cases which are both questionable and easy to avoid.  For
3352 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3353 compiler will simplify this to @code{1}.  This level of
3354 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3355 are not, and must be explicitly requested.
3356
3357 @item -Wstrict-overflow=2
3358 Also warn about other cases where a comparison is simplified to a
3359 constant.  For example: @code{abs (x) >= 0}.  This can only be
3360 simplified when @option{-fstrict-overflow} is in effect, because
3361 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3362 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3363 @option{-Wstrict-overflow=2}.
3364
3365 @item -Wstrict-overflow=3
3366 Also warn about other cases where a comparison is simplified.  For
3367 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3368
3369 @item -Wstrict-overflow=4
3370 Also warn about other simplifications not covered by the above cases.
3371 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3372
3373 @item -Wstrict-overflow=5
3374 Also warn about cases where the compiler reduces the magnitude of a
3375 constant involved in a comparison.  For example: @code{x + 2 > y} will
3376 be simplified to @code{x + 1 >= y}.  This is reported only at the
3377 highest warning level because this simplification applies to many
3378 comparisons, so this warning level will give a very large number of
3379 false positives.
3380 @end table
3381
3382 @item -Warray-bounds
3383 @opindex Wno-array-bounds
3384 @opindex Warray-bounds
3385 This option detects some cases of out-of-bounds accesses in unoptimized
3386 compilations.  More cases are detected when @option{-ftree-vrp} is enabled.
3387 (The @option{-ftree-vrp} option is enabled automatically when compiling with
3388 @option{-O2} or higher optimization options.)
3389
3390 @item -Wno-div-by-zero
3391 @opindex Wno-div-by-zero
3392 @opindex Wdiv-by-zero
3393 Do not warn about compile-time integer division by zero.  Floating point
3394 division by zero is not warned about, as it can be a legitimate way of
3395 obtaining infinities and NaNs.
3396
3397 @item -Wsystem-headers
3398 @opindex Wsystem-headers
3399 @opindex Wno-system-headers
3400 @cindex warnings from system headers
3401 @cindex system headers, warnings from
3402 Print warning messages for constructs found in system header files.
3403 Warnings from system headers are normally suppressed, on the assumption
3404 that they usually do not indicate real problems and would only make the
3405 compiler output harder to read.  Using this command line option tells
3406 GCC to emit warnings from system headers as if they occurred in user
3407 code.  However, note that using @option{-Wall} in conjunction with this
3408 option will @emph{not} warn about unknown pragmas in system
3409 headers---for that, @option{-Wunknown-pragmas} must also be used.
3410
3411 @item -Wfloat-equal
3412 @opindex Wfloat-equal
3413 @opindex Wno-float-equal
3414 Warn if floating point values are used in equality comparisons.
3415
3416 The idea behind this is that sometimes it is convenient (for the
3417 programmer) to consider floating-point values as approximations to
3418 infinitely precise real numbers.  If you are doing this, then you need
3419 to compute (by analyzing the code, or in some other way) the maximum or
3420 likely maximum error that the computation introduces, and allow for it
3421 when performing comparisons (and when producing output, but that's a
3422 different problem).  In particular, instead of testing for equality, you
3423 would check to see whether the two values have ranges that overlap; and
3424 this is done with the relational operators, so equality comparisons are
3425 probably mistaken.
3426
3427 @item -Wtraditional @r{(C and Objective-C only)}
3428 @opindex Wtraditional
3429 @opindex Wno-traditional
3430 Warn about certain constructs that behave differently in traditional and
3431 ISO C@.  Also warn about ISO C constructs that have no traditional C
3432 equivalent, and/or problematic constructs which should be avoided.
3433
3434 @itemize @bullet
3435 @item
3436 Macro parameters that appear within string literals in the macro body.
3437 In traditional C macro replacement takes place within string literals,
3438 but does not in ISO C@.
3439
3440 @item
3441 In traditional C, some preprocessor directives did not exist.
3442 Traditional preprocessors would only consider a line to be a directive
3443 if the @samp{#} appeared in column 1 on the line.  Therefore
3444 @option{-Wtraditional} warns about directives that traditional C
3445 understands but would ignore because the @samp{#} does not appear as the
3446 first character on the line.  It also suggests you hide directives like
3447 @samp{#pragma} not understood by traditional C by indenting them.  Some
3448 traditional implementations would not recognize @samp{#elif}, so it
3449 suggests avoiding it altogether.
3450
3451 @item
3452 A function-like macro that appears without arguments.
3453
3454 @item
3455 The unary plus operator.
3456
3457 @item
3458 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3459 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3460 constants.)  Note, these suffixes appear in macros defined in the system
3461 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3462 Use of these macros in user code might normally lead to spurious
3463 warnings, however GCC's integrated preprocessor has enough context to
3464 avoid warning in these cases.
3465
3466 @item
3467 A function declared external in one block and then used after the end of
3468 the block.
3469
3470 @item
3471 A @code{switch} statement has an operand of type @code{long}.
3472
3473 @item
3474 A non-@code{static} function declaration follows a @code{static} one.
3475 This construct is not accepted by some traditional C compilers.
3476
3477 @item
3478 The ISO type of an integer constant has a different width or
3479 signedness from its traditional type.  This warning is only issued if
3480 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3481 typically represent bit patterns, are not warned about.
3482
3483 @item
3484 Usage of ISO string concatenation is detected.
3485
3486 @item
3487 Initialization of automatic aggregates.
3488
3489 @item
3490 Identifier conflicts with labels.  Traditional C lacks a separate
3491 namespace for labels.
3492
3493 @item
3494 Initialization of unions.  If the initializer is zero, the warning is
3495 omitted.  This is done under the assumption that the zero initializer in
3496 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3497 initializer warnings and relies on default initialization to zero in the
3498 traditional C case.
3499
3500 @item
3501 Conversions by prototypes between fixed/floating point values and vice
3502 versa.  The absence of these prototypes when compiling with traditional
3503 C would cause serious problems.  This is a subset of the possible
3504 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3505
3506 @item
3507 Use of ISO C style function definitions.  This warning intentionally is
3508 @emph{not} issued for prototype declarations or variadic functions
3509 because these ISO C features will appear in your code when using
3510 libiberty's traditional C compatibility macros, @code{PARAMS} and
3511 @code{VPARAMS}.  This warning is also bypassed for nested functions
3512 because that feature is already a GCC extension and thus not relevant to
3513 traditional C compatibility.
3514 @end itemize
3515
3516 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3517 @opindex Wtraditional-conversion
3518 @opindex Wno-traditional-conversion
3519 Warn if a prototype causes a type conversion that is different from what
3520 would happen to the same argument in the absence of a prototype.  This
3521 includes conversions of fixed point to floating and vice versa, and
3522 conversions changing the width or signedness of a fixed point argument
3523 except when the same as the default promotion.
3524
3525 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3526 @opindex Wdeclaration-after-statement
3527 @opindex Wno-declaration-after-statement
3528 Warn when a declaration is found after a statement in a block.  This
3529 construct, known from C++, was introduced with ISO C99 and is by default
3530 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3531 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3532
3533 @item -Wundef
3534 @opindex Wundef
3535 @opindex Wno-undef
3536 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3537
3538 @item -Wno-endif-labels
3539 @opindex Wno-endif-labels
3540 @opindex Wendif-labels
3541 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3542
3543 @item -Wshadow
3544 @opindex Wshadow
3545 @opindex Wno-shadow
3546 Warn whenever a local variable shadows another local variable, parameter or
3547 global variable or whenever a built-in function is shadowed.
3548
3549 @item -Wlarger-than=@var{len}
3550 @opindex Wlarger-than=@var{len}
3551 @opindex Wlarger-than-@var{len}
3552 Warn whenever an object of larger than @var{len} bytes is defined.
3553
3554 @item -Wframe-larger-than=@var{len}
3555 @opindex Wframe-larger-than
3556 Warn whenever the size of a function frame is larger than @var{len} bytes.
3557
3558 @item -Wunsafe-loop-optimizations
3559 @opindex Wunsafe-loop-optimizations
3560 @opindex Wno-unsafe-loop-optimizations
3561 Warn if the loop cannot be optimized because the compiler could not
3562 assume anything on the bounds of the loop indices.  With
3563 @option{-funsafe-loop-optimizations} warn if the compiler made
3564 such assumptions.
3565
3566 @item -Wpointer-arith
3567 @opindex Wpointer-arith
3568 @opindex Wno-pointer-arith
3569 Warn about anything that depends on the ``size of'' a function type or
3570 of @code{void}.  GNU C assigns these types a size of 1, for
3571 convenience in calculations with @code{void *} pointers and pointers
3572 to functions.  In C++, warn also when an arithmetic operation involves
3573 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3574
3575 @item -Wtype-limits
3576 @opindex Wtype-limits
3577 @opindex Wno-type-limits
3578 Warn if a comparison is always true or always false due to the limited
3579 range of the data type, but do not warn for constant expressions.  For
3580 example, warn if an unsigned variable is compared against zero with
3581 @samp{<} or @samp{>=}.  This warning is also enabled by
3582 @option{-Wextra}.
3583
3584 @item -Wbad-function-cast @r{(C and Objective-C only)}
3585 @opindex Wbad-function-cast
3586 @opindex Wno-bad-function-cast
3587 Warn whenever a function call is cast to a non-matching type.
3588 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3589
3590 @item -Wc++-compat @r{(C and Objective-C only)}
3591 Warn about ISO C constructs that are outside of the common subset of
3592 ISO C and ISO C++, e.g.@: request for implicit conversion from
3593 @code{void *} to a pointer to non-@code{void} type.
3594
3595 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3596 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3597 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3598 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3599
3600 @item -Wcast-qual
3601 @opindex Wcast-qual
3602 @opindex Wno-cast-qual
3603 Warn whenever a pointer is cast so as to remove a type qualifier from
3604 the target type.  For example, warn if a @code{const char *} is cast
3605 to an ordinary @code{char *}.
3606
3607 @item -Wcast-align
3608 @opindex Wcast-align
3609 @opindex Wno-cast-align
3610 Warn whenever a pointer is cast such that the required alignment of the
3611 target is increased.  For example, warn if a @code{char *} is cast to
3612 an @code{int *} on machines where integers can only be accessed at
3613 two- or four-byte boundaries.
3614
3615 @item -Wwrite-strings
3616 @opindex Wwrite-strings
3617 @opindex Wno-write-strings
3618 When compiling C, give string constants the type @code{const
3619 char[@var{length}]} so that
3620 copying the address of one into a non-@code{const} @code{char *}
3621 pointer will get a warning; when compiling C++, warn about the
3622 deprecated conversion from string literals to @code{char *}.  This
3623 warning, by default, is enabled for C++ programs.
3624 These warnings will help you find at
3625 compile time code that can try to write into a string constant, but
3626 only if you have been very careful about using @code{const} in
3627 declarations and prototypes.  Otherwise, it will just be a nuisance;
3628 this is why we did not make @option{-Wall} request these warnings.
3629
3630 @item -Wclobbered
3631 @opindex Wclobbered
3632 @opindex Wno-clobbered
3633 Warn for variables that might be changed by @samp{longjmp} or
3634 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3635
3636 @item -Wconversion
3637 @opindex Wconversion
3638 @opindex Wno-conversion
3639 Warn for implicit conversions that may alter a value. This includes
3640 conversions between real and integer, like @code{abs (x)} when
3641 @code{x} is @code{double}; conversions between signed and unsigned,
3642 like @code{unsigned ui = -1}; and conversions to smaller types, like
3643 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3644 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3645 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3646 conversions between signed and unsigned integers can be disabled by
3647 using @option{-Wno-sign-conversion}.
3648
3649 For C++, also warn for conversions between @code{NULL} and non-pointer
3650 types; confusing overload resolution for user-defined conversions; and
3651 conversions that will never use a type conversion operator:
3652 conversions to @code{void}, the same type, a base class or a reference
3653 to them. Warnings about conversions between signed and unsigned
3654 integers are disabled by default in C++ unless
3655 @option{-Wsign-conversion} is explicitly enabled.
3656
3657 @item -Wempty-body
3658 @opindex Wempty-body
3659 @opindex Wno-empty-body
3660 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3661 while} statement.  Additionally, in C++, warn when an empty body occurs
3662 in a @samp{while} or @samp{for} statement with no whitespacing before
3663 the semicolon.  This warning is also enabled by @option{-Wextra}.
3664
3665 @item -Wsign-compare
3666 @opindex Wsign-compare
3667 @opindex Wno-sign-compare
3668 @cindex warning for comparison of signed and unsigned values
3669 @cindex comparison of signed and unsigned values, warning
3670 @cindex signed and unsigned values, comparison warning
3671 Warn when a comparison between signed and unsigned values could produce
3672 an incorrect result when the signed value is converted to unsigned.
3673 This warning is also enabled by @option{-Wextra}; to get the other warnings
3674 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3675
3676 @item -Wsign-conversion
3677 @opindex Wsign-conversion
3678 @opindex Wno-sign-conversion
3679 Warn for implicit conversions that may change the sign of an integer
3680 value, like assigning a signed integer expression to an unsigned
3681 integer variable. An explicit cast silences the warning. In C, this
3682 option is enabled also by @option{-Wconversion}.
3683
3684 @item -Waddress
3685 @opindex Waddress
3686 @opindex Wno-address
3687 Warn about suspicious uses of memory addresses. These include using
3688 the address of a function in a conditional expression, such as
3689 @code{void func(void); if (func)}, and comparisons against the memory
3690 address of a string literal, such as @code{if (x == "abc")}.  Such
3691 uses typically indicate a programmer error: the address of a function
3692 always evaluates to true, so their use in a conditional usually
3693 indicate that the programmer forgot the parentheses in a function
3694 call; and comparisons against string literals result in unspecified
3695 behavior and are not portable in C, so they usually indicate that the
3696 programmer intended to use @code{strcmp}.  This warning is enabled by
3697 @option{-Wall}.
3698
3699 @item -Wlogical-op
3700 @opindex Wlogical-op
3701 @opindex Wno-logical-op
3702 Warn about suspicious uses of logical operators in expressions.
3703 This includes using logical operators in contexts where a
3704 bit-wise operator is likely to be expected.
3705
3706 @item -Waggregate-return
3707 @opindex Waggregate-return
3708 @opindex Wno-aggregate-return
3709 Warn if any functions that return structures or unions are defined or
3710 called.  (In languages where you can return an array, this also elicits
3711 a warning.)
3712
3713 @item -Wno-attributes
3714 @opindex Wno-attributes
3715 @opindex Wattributes
3716 Do not warn if an unexpected @code{__attribute__} is used, such as
3717 unrecognized attributes, function attributes applied to variables,
3718 etc.  This will not stop errors for incorrect use of supported
3719 attributes.
3720
3721 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3722 @opindex Wstrict-prototypes
3723 @opindex Wno-strict-prototypes
3724 Warn if a function is declared or defined without specifying the
3725 argument types.  (An old-style function definition is permitted without
3726 a warning if preceded by a declaration which specifies the argument
3727 types.)
3728
3729 @item -Wold-style-declaration @r{(C and Objective-C only)}
3730 @opindex Wold-style-declaration
3731 @opindex Wno-old-style-declaration
3732 Warn for obsolescent usages, according to the C Standard, in a
3733 declaration. For example, warn if storage-class specifiers like
3734 @code{static} are not the first things in a declaration.  This warning
3735 is also enabled by @option{-Wextra}.
3736
3737 @item -Wold-style-definition @r{(C and Objective-C only)}
3738 @opindex Wold-style-definition
3739 @opindex Wno-old-style-definition
3740 Warn if an old-style function definition is used.  A warning is given
3741 even if there is a previous prototype.
3742
3743 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3744 @opindex Wmissing-parameter-type
3745 @opindex Wno-missing-parameter-type
3746 A function parameter is declared without a type specifier in K&R-style
3747 functions:
3748
3749 @smallexample
3750 void foo(bar) @{ @}
3751 @end smallexample
3752
3753 This warning is also enabled by @option{-Wextra}.
3754
3755 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3756 @opindex Wmissing-prototypes
3757 @opindex Wno-missing-prototypes
3758 Warn if a global function is defined without a previous prototype
3759 declaration.  This warning is issued even if the definition itself
3760 provides a prototype.  The aim is to detect global functions that fail
3761 to be declared in header files.
3762
3763 @item -Wmissing-declarations
3764 @opindex Wmissing-declarations
3765 @opindex Wno-missing-declarations
3766 Warn if a global function is defined without a previous declaration.
3767 Do so even if the definition itself provides a prototype.
3768 Use this option to detect global functions that are not declared in
3769 header files.  In C++, no warnings are issued for function templates,
3770 or for inline functions, or for functions in anonymous namespaces.
3771
3772 @item -Wmissing-field-initializers
3773 @opindex Wmissing-field-initializers
3774 @opindex Wno-missing-field-initializers
3775 @opindex W
3776 @opindex Wextra
3777 @opindex Wno-extra
3778 Warn if a structure's initializer has some fields missing.  For
3779 example, the following code would cause such a warning, because
3780 @code{x.h} is implicitly zero:
3781
3782 @smallexample
3783 struct s @{ int f, g, h; @};
3784 struct s x = @{ 3, 4 @};
3785 @end smallexample
3786
3787 This option does not warn about designated initializers, so the following
3788 modification would not trigger a warning:
3789
3790 @smallexample
3791 struct s @{ int f, g, h; @};
3792 struct s x = @{ .f = 3, .g = 4 @};
3793 @end smallexample
3794
3795 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3796 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3797
3798 @item -Wmissing-noreturn
3799 @opindex Wmissing-noreturn
3800 @opindex Wno-missing-noreturn
3801 Warn about functions which might be candidates for attribute @code{noreturn}.
3802 Note these are only possible candidates, not absolute ones.  Care should
3803 be taken to manually verify functions actually do not ever return before
3804 adding the @code{noreturn} attribute, otherwise subtle code generation
3805 bugs could be introduced.  You will not get a warning for @code{main} in
3806 hosted C environments.
3807
3808 @item -Wmissing-format-attribute
3809 @opindex Wmissing-format-attribute
3810 @opindex Wno-missing-format-attribute
3811 @opindex Wformat
3812 @opindex Wno-format
3813 Warn about function pointers which might be candidates for @code{format}
3814 attributes.  Note these are only possible candidates, not absolute ones.
3815 GCC will guess that function pointers with @code{format} attributes that
3816 are used in assignment, initialization, parameter passing or return
3817 statements should have a corresponding @code{format} attribute in the
3818 resulting type.  I.e.@: the left-hand side of the assignment or
3819 initialization, the type of the parameter variable, or the return type
3820 of the containing function respectively should also have a @code{format}
3821 attribute to avoid the warning.
3822
3823 GCC will also warn about function definitions which might be
3824 candidates for @code{format} attributes.  Again, these are only
3825 possible candidates.  GCC will guess that @code{format} attributes
3826 might be appropriate for any function that calls a function like
3827 @code{vprintf} or @code{vscanf}, but this might not always be the
3828 case, and some functions for which @code{format} attributes are
3829 appropriate may not be detected.
3830
3831 @item -Wno-multichar
3832 @opindex Wno-multichar
3833 @opindex Wmultichar
3834 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3835 Usually they indicate a typo in the user's code, as they have
3836 implementation-defined values, and should not be used in portable code.
3837
3838 @item -Wnormalized=<none|id|nfc|nfkc>
3839 @opindex Wnormalized=
3840 @cindex NFC
3841 @cindex NFKC
3842 @cindex character set, input normalization
3843 In ISO C and ISO C++, two identifiers are different if they are
3844 different sequences of characters.  However, sometimes when characters
3845 outside the basic ASCII character set are used, you can have two
3846 different character sequences that look the same.  To avoid confusion,
3847 the ISO 10646 standard sets out some @dfn{normalization rules} which
3848 when applied ensure that two sequences that look the same are turned into
3849 the same sequence.  GCC can warn you if you are using identifiers which
3850 have not been normalized; this option controls that warning.
3851
3852 There are four levels of warning that GCC supports.  The default is
3853 @option{-Wnormalized=nfc}, which warns about any identifier which is
3854 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3855 recommended form for most uses.
3856
3857 Unfortunately, there are some characters which ISO C and ISO C++ allow
3858 in identifiers that when turned into NFC aren't allowable as
3859 identifiers.  That is, there's no way to use these symbols in portable
3860 ISO C or C++ and have all your identifiers in NFC@.
3861 @option{-Wnormalized=id} suppresses the warning for these characters.
3862 It is hoped that future versions of the standards involved will correct
3863 this, which is why this option is not the default.
3864
3865 You can switch the warning off for all characters by writing
3866 @option{-Wnormalized=none}.  You would only want to do this if you
3867 were using some other normalization scheme (like ``D''), because
3868 otherwise you can easily create bugs that are literally impossible to see.
3869
3870 Some characters in ISO 10646 have distinct meanings but look identical
3871 in some fonts or display methodologies, especially once formatting has
3872 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3873 LETTER N'', will display just like a regular @code{n} which has been
3874 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3875 normalization scheme to convert all these into a standard form as
3876 well, and GCC will warn if your code is not in NFKC if you use
3877 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3878 about every identifier that contains the letter O because it might be
3879 confused with the digit 0, and so is not the default, but may be
3880 useful as a local coding convention if the programming environment is
3881 unable to be fixed to display these characters distinctly.
3882
3883 @item -Wno-deprecated-declarations
3884 @opindex Wno-deprecated-declarations
3885 @opindex Wdeprecated-declarations
3886 Do not warn about uses of functions (@pxref{Function Attributes}),
3887 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3888 Attributes}) marked as deprecated by using the @code{deprecated}
3889 attribute.
3890
3891 @item -Wno-overflow
3892 @opindex Wno-overflow
3893 @opindex Woverflow
3894 Do not warn about compile-time overflow in constant expressions.
3895
3896 @item -Woverride-init @r{(C and Objective-C only)}
3897 @opindex Woverride-init
3898 @opindex Wno-override-init
3899 @opindex W
3900 @opindex Wextra
3901 @opindex Wno-extra
3902 Warn if an initialized field without side effects is overridden when
3903 using designated initializers (@pxref{Designated Inits, , Designated
3904 Initializers}).
3905
3906 This warning is included in @option{-Wextra}.  To get other
3907 @option{-Wextra} warnings without this one, use @samp{-Wextra
3908 -Wno-override-init}.
3909
3910 @item -Wpacked
3911 @opindex Wpacked
3912 @opindex Wno-packed
3913 Warn if a structure is given the packed attribute, but the packed
3914 attribute has no effect on the layout or size of the structure.
3915 Such structures may be mis-aligned for little benefit.  For
3916 instance, in this code, the variable @code{f.x} in @code{struct bar}
3917 will be misaligned even though @code{struct bar} does not itself
3918 have the packed attribute:
3919
3920 @smallexample
3921 @group
3922 struct foo @{
3923   int x;
3924   char a, b, c, d;
3925 @} __attribute__((packed));
3926 struct bar @{
3927   char z;
3928   struct foo f;
3929 @};
3930 @end group
3931 @end smallexample
3932
3933 @item -Wpadded
3934 @opindex Wpadded
3935 @opindex Wno-padded
3936 Warn if padding is included in a structure, either to align an element
3937 of the structure or to align the whole structure.  Sometimes when this
3938 happens it is possible to rearrange the fields of the structure to
3939 reduce the padding and so make the structure smaller.
3940
3941 @item -Wredundant-decls
3942 @opindex Wredundant-decls
3943 @opindex Wno-redundant-decls
3944 Warn if anything is declared more than once in the same scope, even in
3945 cases where multiple declaration is valid and changes nothing.
3946
3947 @item -Wnested-externs @r{(C and Objective-C only)}
3948 @opindex Wnested-externs
3949 @opindex Wno-nested-externs
3950 Warn if an @code{extern} declaration is encountered within a function.
3951
3952 @item -Wunreachable-code
3953 @opindex Wunreachable-code
3954 @opindex Wno-unreachable-code
3955 Warn if the compiler detects that code will never be executed.
3956
3957 This option is intended to warn when the compiler detects that at
3958 least a whole line of source code will never be executed, because
3959 some condition is never satisfied or because it is after a
3960 procedure that never returns.
3961
3962 It is possible for this option to produce a warning even though there
3963 are circumstances under which part of the affected line can be executed,
3964 so care should be taken when removing apparently-unreachable code.
3965
3966 For instance, when a function is inlined, a warning may mean that the
3967 line is unreachable in only one inlined copy of the function.
3968
3969 This option is not made part of @option{-Wall} because in a debugging
3970 version of a program there is often substantial code which checks
3971 correct functioning of the program and is, hopefully, unreachable
3972 because the program does work.  Another common use of unreachable
3973 code is to provide behavior which is selectable at compile-time.
3974
3975 @item -Winline
3976 @opindex Winline
3977 @opindex Wno-inline
3978 Warn if a function can not be inlined and it was declared as inline.
3979 Even with this option, the compiler will not warn about failures to
3980 inline functions declared in system headers.
3981
3982 The compiler uses a variety of heuristics to determine whether or not
3983 to inline a function.  For example, the compiler takes into account
3984 the size of the function being inlined and the amount of inlining
3985 that has already been done in the current function.  Therefore,
3986 seemingly insignificant changes in the source program can cause the
3987 warnings produced by @option{-Winline} to appear or disappear.
3988
3989 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
3990 @opindex Wno-invalid-offsetof
3991 @opindex Winvalid-offsetof
3992 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3993 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3994 to a non-POD type is undefined.  In existing C++ implementations,
3995 however, @samp{offsetof} typically gives meaningful results even when
3996 applied to certain kinds of non-POD types. (Such as a simple
3997 @samp{struct} that fails to be a POD type only by virtue of having a
3998 constructor.)  This flag is for users who are aware that they are
3999 writing nonportable code and who have deliberately chosen to ignore the
4000 warning about it.
4001
4002 The restrictions on @samp{offsetof} may be relaxed in a future version
4003 of the C++ standard.
4004
4005 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4006 @opindex Wno-int-to-pointer-cast
4007 @opindex Wint-to-pointer-cast
4008 Suppress warnings from casts to pointer type of an integer of a
4009 different size.
4010
4011 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4012 @opindex Wno-pointer-to-int-cast
4013 @opindex Wpointer-to-int-cast
4014 Suppress warnings from casts from a pointer to an integer type of a
4015 different size.
4016
4017 @item -Winvalid-pch
4018 @opindex Winvalid-pch
4019 @opindex Wno-invalid-pch
4020 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4021 the search path but can't be used.
4022
4023 @item -Wlong-long
4024 @opindex Wlong-long
4025 @opindex Wno-long-long
4026 Warn if @samp{long long} type is used.  This is default.  To inhibit
4027 the warning messages, use @option{-Wno-long-long}.  Flags
4028 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
4029 only when @option{-pedantic} flag is used.
4030
4031 @item -Wvariadic-macros
4032 @opindex Wvariadic-macros
4033 @opindex Wno-variadic-macros
4034 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4035 alternate syntax when in pedantic ISO C99 mode.  This is default.
4036 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4037
4038 @item -Wvla
4039 @opindex Wvla
4040 @opindex Wno-vla
4041 Warn if variable length array is used in the code.
4042 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4043 the variable length array.
4044
4045 @item -Wvolatile-register-var
4046 @opindex Wvolatile-register-var
4047 @opindex Wno-volatile-register-var
4048 Warn if a register variable is declared volatile.  The volatile
4049 modifier does not inhibit all optimizations that may eliminate reads
4050 and/or writes to register variables.  This warning is enabled by
4051 @option{-Wall}.
4052
4053 @item -Wdisabled-optimization
4054 @opindex Wdisabled-optimization
4055 @opindex Wno-disabled-optimization
4056 Warn if a requested optimization pass is disabled.  This warning does
4057 not generally indicate that there is anything wrong with your code; it
4058 merely indicates that GCC's optimizers were unable to handle the code
4059 effectively.  Often, the problem is that your code is too big or too
4060 complex; GCC will refuse to optimize programs when the optimization
4061 itself is likely to take inordinate amounts of time.
4062
4063 @item -Wpointer-sign @r{(C and Objective-C only)}
4064 @opindex Wpointer-sign
4065 @opindex Wno-pointer-sign
4066 Warn for pointer argument passing or assignment with different signedness.
4067 This option is only supported for C and Objective-C@.  It is implied by
4068 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4069 @option{-Wno-pointer-sign}.
4070
4071 @item -Wstack-protector
4072 @opindex Wstack-protector
4073 @opindex Wno-stack-protector
4074 This option is only active when @option{-fstack-protector} is active.  It
4075 warns about functions that will not be protected against stack smashing.
4076
4077 @item -Wno-mudflap
4078 @opindex Wno-mudflap
4079 Suppress warnings about constructs that cannot be instrumented by
4080 @option{-fmudflap}.
4081
4082 @item -Woverlength-strings
4083 @opindex Woverlength-strings
4084 @opindex Wno-overlength-strings
4085 Warn about string constants which are longer than the ``minimum
4086 maximum'' length specified in the C standard.  Modern compilers
4087 generally allow string constants which are much longer than the
4088 standard's minimum limit, but very portable programs should avoid
4089 using longer strings.
4090
4091 The limit applies @emph{after} string constant concatenation, and does
4092 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4093 C99, it was raised to 4095.  C++98 does not specify a normative
4094 minimum maximum, so we do not diagnose overlength strings in C++@.
4095
4096 This option is implied by @option{-pedantic}, and can be disabled with
4097 @option{-Wno-overlength-strings}.
4098 @end table
4099
4100 @node Debugging Options
4101 @section Options for Debugging Your Program or GCC
4102 @cindex options, debugging
4103 @cindex debugging information options
4104
4105 GCC has various special options that are used for debugging
4106 either your program or GCC:
4107
4108 @table @gcctabopt
4109 @item -g
4110 @opindex g
4111 Produce debugging information in the operating system's native format
4112 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4113 information.
4114
4115 On most systems that use stabs format, @option{-g} enables use of extra
4116 debugging information that only GDB can use; this extra information
4117 makes debugging work better in GDB but will probably make other debuggers
4118 crash or
4119 refuse to read the program.  If you want to control for certain whether
4120 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4121 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4122
4123 GCC allows you to use @option{-g} with
4124 @option{-O}.  The shortcuts taken by optimized code may occasionally
4125 produce surprising results: some variables you declared may not exist
4126 at all; flow of control may briefly move where you did not expect it;
4127 some statements may not be executed because they compute constant
4128 results or their values were already at hand; some statements may
4129 execute in different places because they were moved out of loops.
4130
4131 Nevertheless it proves possible to debug optimized output.  This makes
4132 it reasonable to use the optimizer for programs that might have bugs.
4133
4134 The following options are useful when GCC is generated with the
4135 capability for more than one debugging format.
4136
4137 @item -ggdb
4138 @opindex ggdb
4139 Produce debugging information for use by GDB@.  This means to use the
4140 most expressive format available (DWARF 2, stabs, or the native format
4141 if neither of those are supported), including GDB extensions if at all
4142 possible.
4143
4144 @item -gstabs
4145 @opindex gstabs
4146 Produce debugging information in stabs format (if that is supported),
4147 without GDB extensions.  This is the format used by DBX on most BSD
4148 systems.  On MIPS, Alpha and System V Release 4 systems this option
4149 produces stabs debugging output which is not understood by DBX or SDB@.
4150 On System V Release 4 systems this option requires the GNU assembler.
4151
4152 @item -feliminate-unused-debug-symbols
4153 @opindex feliminate-unused-debug-symbols
4154 Produce debugging information in stabs format (if that is supported),
4155 for only symbols that are actually used.
4156
4157 @item -femit-class-debug-always
4158 Instead of emitting debugging information for a C++ class in only one
4159 object file, emit it in all object files using the class.  This option
4160 should be used only with debuggers that are unable to handle the way GCC
4161 normally emits debugging information for classes because using this
4162 option will increase the size of debugging information by as much as a
4163 factor of two.
4164
4165 @item -gstabs+
4166 @opindex gstabs+
4167 Produce debugging information in stabs format (if that is supported),
4168 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4169 use of these extensions is likely to make other debuggers crash or
4170 refuse to read the program.
4171
4172 @item -gcoff
4173 @opindex gcoff
4174 Produce debugging information in COFF format (if that is supported).
4175 This is the format used by SDB on most System V systems prior to
4176 System V Release 4.
4177
4178 @item -gxcoff
4179 @opindex gxcoff
4180 Produce debugging information in XCOFF format (if that is supported).
4181 This is the format used by the DBX debugger on IBM RS/6000 systems.
4182
4183 @item -gxcoff+
4184 @opindex gxcoff+
4185 Produce debugging information in XCOFF format (if that is supported),
4186 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4187 use of these extensions is likely to make other debuggers crash or
4188 refuse to read the program, and may cause assemblers other than the GNU
4189 assembler (GAS) to fail with an error.
4190
4191 @item -gdwarf-2
4192 @opindex gdwarf-2
4193 Produce debugging information in DWARF version 2 format (if that is
4194 supported).  This is the format used by DBX on IRIX 6.  With this
4195 option, GCC uses features of DWARF version 3 when they are useful;
4196 version 3 is upward compatible with version 2, but may still cause
4197 problems for older debuggers.
4198
4199 @item -gvms
4200 @opindex gvms
4201 Produce debugging information in VMS debug format (if that is
4202 supported).  This is the format used by DEBUG on VMS systems.
4203
4204 @item -g@var{level}
4205 @itemx -ggdb@var{level}
4206 @itemx -gstabs@var{level}
4207 @itemx -gcoff@var{level}
4208 @itemx -gxcoff@var{level}
4209 @itemx -gvms@var{level}
4210 Request debugging information and also use @var{level} to specify how
4211 much information.  The default level is 2.
4212
4213 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4214 @option{-g}.
4215
4216 Level 1 produces minimal information, enough for making backtraces in
4217 parts of the program that you don't plan to debug.  This includes
4218 descriptions of functions and external variables, but no information
4219 about local variables and no line numbers.
4220
4221 Level 3 includes extra information, such as all the macro definitions
4222 present in the program.  Some debuggers support macro expansion when
4223 you use @option{-g3}.
4224
4225 @option{-gdwarf-2} does not accept a concatenated debug level, because
4226 GCC used to support an option @option{-gdwarf} that meant to generate
4227 debug information in version 1 of the DWARF format (which is very
4228 different from version 2), and it would have been too confusing.  That
4229 debug format is long obsolete, but the option cannot be changed now.
4230 Instead use an additional @option{-g@var{level}} option to change the
4231 debug level for DWARF2.
4232
4233 @item -feliminate-dwarf2-dups
4234 @opindex feliminate-dwarf2-dups
4235 Compress DWARF2 debugging information by eliminating duplicated
4236 information about each symbol.  This option only makes sense when
4237 generating DWARF2 debugging information with @option{-gdwarf-2}.
4238
4239 @item -femit-struct-debug-baseonly
4240 Emit debug information for struct-like types
4241 only when the base name of the compilation source file
4242 matches the base name of file in which the struct was defined.
4243
4244 This option substantially reduces the size of debugging information,
4245 but at significant potential loss in type information to the debugger.
4246 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4247 See @option{-femit-struct-debug-detailed} for more detailed control.
4248
4249 This option works only with DWARF 2.
4250
4251 @item -femit-struct-debug-reduced
4252 Emit debug information for struct-like types
4253 only when the base name of the compilation source file
4254 matches the base name of file in which the type was defined,
4255 unless the struct is a template or defined in a system header.
4256
4257 This option significantly reduces the size of debugging information,
4258 with some potential loss in type information to the debugger.
4259 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4260 See @option{-femit-struct-debug-detailed} for more detailed control.
4261
4262 This option works only with DWARF 2.
4263
4264 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4265 Specify the struct-like types
4266 for which the compiler will generate debug information.
4267 The intent is to reduce duplicate struct debug information
4268 between different object files within the same program.
4269
4270 This option is a detailed version of
4271 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4272 which will serve for most needs.
4273
4274 A specification has the syntax
4275 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4276
4277 The optional first word limits the specification to
4278 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4279 A struct type is used directly when it is the type of a variable, member.
4280 Indirect uses arise through pointers to structs.
4281 That is, when use of an incomplete struct would be legal, the use is indirect.
4282 An example is
4283 @samp{struct one direct; struct two * indirect;}.
4284
4285 The optional second word limits the specification to
4286 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4287 Generic structs are a bit complicated to explain.
4288 For C++, these are non-explicit specializations of template classes,
4289 or non-template classes within the above.
4290 Other programming languages have generics,
4291 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4292
4293 The third word specifies the source files for those
4294 structs for which the compiler will emit debug information.
4295 The values @samp{none} and @samp{any} have the normal meaning.
4296 The value @samp{base} means that
4297 the base of name of the file in which the type declaration appears
4298 must match the base of the name of the main compilation file.
4299 In practice, this means that
4300 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4301 but types declared in other header will not.
4302 The value @samp{sys} means those types satisfying @samp{base}
4303 or declared in system or compiler headers.
4304
4305 You may need to experiment to determine the best settings for your application.
4306
4307 The default is @samp{-femit-struct-debug-detailed=all}.
4308
4309 This option works only with DWARF 2.
4310
4311 @item -fno-merge-debug-strings
4312 @opindex fmerge-debug-strings
4313 @opindex fno-merge-debug-strings
4314 Direct the linker to merge together strings which are identical in
4315 different object files.  This is not supported by all assemblers or
4316 linker.  This decreases the size of the debug information in the
4317 output file at the cost of increasing link processing time.  This is
4318 on by default.
4319
4320 @item -fdebug-prefix-map=@var{old}=@var{new}
4321 @opindex fdebug-prefix-map
4322 When compiling files in directory @file{@var{old}}, record debugging
4323 information describing them as in @file{@var{new}} instead.
4324
4325 @cindex @command{prof}
4326 @item -p
4327 @opindex p
4328 Generate extra code to write profile information suitable for the
4329 analysis program @command{prof}.  You must use this option when compiling
4330 the source files you want data about, and you must also use it when
4331 linking.
4332
4333 @cindex @command{gprof}
4334 @item -pg
4335 @opindex pg
4336 Generate extra code to write profile information suitable for the
4337 analysis program @command{gprof}.  You must use this option when compiling
4338 the source files you want data about, and you must also use it when
4339 linking.
4340
4341 @item -Q
4342 @opindex Q
4343 Makes the compiler print out each function name as it is compiled, and
4344 print some statistics about each pass when it finishes.
4345
4346 @item -ftime-report
4347 @opindex ftime-report
4348 Makes the compiler print some statistics about the time consumed by each
4349 pass when it finishes.
4350
4351 @item -fmem-report
4352 @opindex fmem-report
4353 Makes the compiler print some statistics about permanent memory
4354 allocation when it finishes.
4355
4356 @item -fpre-ipa-mem-report
4357 @opindex fpre-ipa-mem-report
4358 @item -fpost-ipa-mem-report
4359 @opindex fpost-ipa-mem-report
4360 Makes the compiler print some statistics about permanent memory
4361 allocation before or after interprocedural optimization.
4362
4363 @item -fprofile-arcs
4364 @opindex fprofile-arcs
4365 Add code so that program flow @dfn{arcs} are instrumented.  During
4366 execution the program records how many times each branch and call is
4367 executed and how many times it is taken or returns.  When the compiled
4368 program exits it saves this data to a file called
4369 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4370 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4371 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4372 @var{auxname} is generated from the name of the output file, if
4373 explicitly specified and it is not the final executable, otherwise it is
4374 the basename of the source file.  In both cases any suffix is removed
4375 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4376 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4377 @xref{Cross-profiling}.
4378
4379 @cindex @command{gcov}
4380 @item --coverage
4381 @opindex coverage
4382
4383 This option is used to compile and link code instrumented for coverage
4384 analysis.  The option is a synonym for @option{-fprofile-arcs}
4385 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4386 linking).  See the documentation for those options for more details.
4387
4388 @itemize
4389
4390 @item
4391 Compile the source files with @option{-fprofile-arcs} plus optimization
4392 and code generation options.  For test coverage analysis, use the
4393 additional @option{-ftest-coverage} option.  You do not need to profile
4394 every source file in a program.
4395
4396 @item
4397 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4398 (the latter implies the former).
4399
4400 @item
4401 Run the program on a representative workload to generate the arc profile
4402 information.  This may be repeated any number of times.  You can run
4403 concurrent instances of your program, and provided that the file system
4404 supports locking, the data files will be correctly updated.  Also
4405 @code{fork} calls are detected and correctly handled (double counting
4406 will not happen).
4407
4408 @item
4409 For profile-directed optimizations, compile the source files again with
4410 the same optimization and code generation options plus
4411 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4412 Control Optimization}).
4413
4414 @item
4415 For test coverage analysis, use @command{gcov} to produce human readable
4416 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4417 @command{gcov} documentation for further information.
4418
4419 @end itemize
4420
4421 With @option{-fprofile-arcs}, for each function of your program GCC
4422 creates a program flow graph, then finds a spanning tree for the graph.
4423 Only arcs that are not on the spanning tree have to be instrumented: the
4424 compiler adds code to count the number of times that these arcs are
4425 executed.  When an arc is the only exit or only entrance to a block, the
4426 instrumentation code can be added to the block; otherwise, a new basic
4427 block must be created to hold the instrumentation code.
4428
4429 @need 2000
4430 @item -ftest-coverage
4431 @opindex ftest-coverage
4432 Produce a notes file that the @command{gcov} code-coverage utility
4433 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4434 show program coverage.  Each source file's note file is called
4435 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4436 above for a description of @var{auxname} and instructions on how to
4437 generate test coverage data.  Coverage data will match the source files
4438 more closely, if you do not optimize.
4439
4440 @item -fdbg-cnt-list
4441 @opindex fdbg-cnt-list
4442 Print the name and the counter upperbound for all debug counters.
4443
4444 @item -fdbg-cnt=@var{counter-value-list}
4445 @opindex fdbg-cnt
4446 Set the internal debug counter upperbound. @var{counter-value-list} 
4447 is a comma-separated list of @var{name}:@var{value} pairs
4448 which sets the upperbound of each debug counter @var{name} to @var{value}.
4449 All debug counters have the initial upperbound of @var{UINT_MAX},
4450 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4451 e.g. With -fdbg-cnt=dce:10,tail_call:0
4452 dbg_cnt(dce) will return true only for first 10 invocations
4453 and dbg_cnt(tail_call) will return false always.
4454
4455 @item -d@var{letters}
4456 @itemx -fdump-rtl-@var{pass}
4457 @opindex d
4458 Says to make debugging dumps during compilation at times specified by
4459 @var{letters}.    This is used for debugging the RTL-based passes of the
4460 compiler.  The file names for most of the dumps are made by appending a
4461 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
4462 from the name of the output file, if explicitly specified and it is not
4463 an executable, otherwise it is the basename of the source file. These
4464 switches may have different effects when @option{-E} is used for
4465 preprocessing.
4466
4467 Most debug dumps can be enabled either passing a letter to the @option{-d}
4468 option, or with a long @option{-fdump-rtl} switch; here are the possible
4469 letters for use in @var{letters} and @var{pass}, and their meanings:
4470
4471 @table @gcctabopt
4472 @item -dA
4473 @opindex dA
4474 Annotate the assembler output with miscellaneous debugging information.
4475
4476 @item -fdump-rtl-bbro
4477 @opindex fdump-rtl-bbro
4478 Dump after block reordering, to @file{@var{file}.148r.bbro}.
4479
4480 @item -fdump-rtl-combine
4481 @opindex fdump-rtl-combine
4482 Dump after the RTL instruction combination pass, to the file
4483 @file{@var{file}.129r.combine}.
4484
4485 @item -fdump-rtl-ce1
4486 @itemx -fdump-rtl-ce2
4487 @opindex fdump-rtl-ce1
4488 @opindex fdump-rtl-ce2
4489 @option{-fdump-rtl-ce1} enable dumping after the
4490 first if conversion, to the file @file{@var{file}.117r.ce1}. 
4491 @option{-fdump-rtl-ce2} enable dumping after the second if
4492 conversion, to the file @file{@var{file}.130r.ce2}.
4493
4494 @item -fdump-rtl-btl
4495 @itemx -fdump-rtl-dbr
4496 @opindex fdump-rtl-btl
4497 @opindex fdump-rtl-dbr
4498 @option{-fdump-rtl-btl} enable dumping after branch
4499 target load optimization, to @file{@var{file}.31.btl}.  
4500 @option{-fdump-rtl-dbr} enable dumping after delayed branch
4501 scheduling, to @file{@var{file}.36.dbr}.
4502
4503 @item -dD
4504 @opindex dD
4505 Dump all macro definitions, at the end of preprocessing, in addition to
4506 normal output.
4507
4508 @item -fdump-rtl-ce3
4509 @opindex fdump-rtl-ce3
4510 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
4511
4512 @item -fdump-rtl-cfg
4513 @itemx -fdump-rtl-life
4514 @opindex fdump-rtl-cfg
4515 @opindex fdump-rtl-life
4516 @option{-fdump-rtl-cfg} enable dumping after control
4517 and data flow analysis, to @file{@var{file}.116r.cfg}.  
4518 @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
4519 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
4520
4521 @item -fdump-rtl-greg
4522 @opindex fdump-rtl-greg
4523 Dump after global register allocation, to @file{@var{file}.139r.greg}.
4524
4525 @item -fdump-rtl-gcse
4526 @itemx -fdump-rtl-bypass
4527 @opindex fdump-rtl-gcse
4528 @opindex fdump-rtl-bypass
4529 @option{-fdump-rtl-gcse} enable dumping after GCSE, to
4530 @file{@var{file}.114r.gcse}.  @option{-fdump-rtl-bypass}
4531 enable dumping after jump bypassing and control flow optimizations, to
4532 @file{@var{file}.115r.bypass}.
4533
4534 @item -fdump-rtl-eh
4535 @opindex fdump-rtl-eh
4536 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
4537
4538 @item -fdump-rtl-sibling
4539 @opindex fdump-rtl-sibling
4540 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
4541
4542 @item -fdump-rtl-jump
4543 @opindex fdump-rtl-jump
4544 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
4545
4546 @item -fdump-rtl-stack
4547 @opindex fdump-rtl-stack
4548 Dump after conversion from GCC's "flat register file" registers to the
4549 x87's stack-like registers, to @file{@var{file}.152r.stack}.
4550
4551 @item -fdump-rtl-lreg
4552 @opindex fdump-rtl-lreg
4553 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
4554
4555 @item -fdump-rtl-loop2
4556 @opindex fdump-rtl-loop2
4557 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
4558 loop optimization pass, to @file{@var{file}.119r.loop2},
4559 @file{@var{file}.120r.loop2_init},
4560 @file{@var{file}.121r.loop2_invariant}, and
4561 @file{@var{file}.125r.loop2_done}.
4562
4563 @item -fdump-rtl-sms
4564 @opindex fdump-rtl-sms
4565 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4566
4567 @item -fdump-rtl-mach
4568 @opindex fdump-rtl-mach
4569 Dump after performing the machine dependent reorganization pass, to
4570 @file{@var{file}.155r.mach} if that pass exists.
4571
4572 @item -fdump-rtl-rnreg
4573 @opindex fdump-rtl-rnreg
4574 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4575
4576 @item -fdump-rtl-regmove
4577 @opindex fdump-rtl-regmove
4578 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4579
4580 @item -fdump-rtl-postreload
4581 @opindex fdump-rtl-postreload
4582 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4583
4584 @item -fdump-rtl-expand
4585 @opindex fdump-rtl-expand
4586 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4587
4588 @item -fdump-rtl-sched2
4589 @opindex fdump-rtl-sched2
4590 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4591
4592 @item -fdump-rtl-cse
4593 @opindex fdump-rtl-cse
4594 Dump after CSE (including the jump optimization that sometimes follows
4595 CSE), to @file{@var{file}.113r.cse}.
4596
4597 @item -fdump-rtl-sched1
4598 @opindex fdump-rtl-sched1
4599 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4600
4601 @item -fdump-rtl-cse2
4602 @opindex fdump-rtl-cse2
4603 Dump after the second CSE pass (including the jump optimization that
4604 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4605
4606 @item -fdump-rtl-tracer
4607 @opindex fdump-rtl-tracer
4608 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4609
4610 @item -fdump-rtl-vpt
4611 @itemx -fdump-rtl-vartrack
4612 @opindex fdump-rtl-vpt
4613 @opindex fdump-rtl-vartrack
4614 @option{-fdump-rtl-vpt} enable dumping after the value
4615 profile transformations, to @file{@var{file}.10.vpt}.
4616 @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4617 to @file{@var{file}.154r.vartrack}.
4618
4619 @item -fdump-rtl-flow2
4620 @opindex fdump-rtl-flow2
4621 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4622
4623 @item -fdump-rtl-peephole2
4624 @opindex fdump-rtl-peephole2
4625 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4626
4627 @item -fdump-rtl-web
4628 @opindex fdump-rtl-web
4629 Dump after live range splitting, to @file{@var{file}.126r.web}.
4630
4631 @item -fdump-rtl-all
4632 @opindex fdump-rtl-all
4633 Produce all the dumps listed above.
4634
4635 @item -dH
4636 @opindex dH
4637 Produce a core dump whenever an error occurs.
4638
4639 @item -dm
4640 @opindex dm
4641 Print statistics on memory usage, at the end of the run, to
4642 standard error.
4643
4644 @item -dp
4645 @opindex dp
4646 Annotate the assembler output with a comment indicating which
4647 pattern and alternative was used.  The length of each instruction is
4648 also printed.
4649
4650 @item -dP
4651 @opindex dP
4652 Dump the RTL in the assembler output as a comment before each instruction.
4653 Also turns on @option{-dp} annotation.
4654
4655 @item -dv
4656 @opindex dv
4657 For each of the other indicated dump files (either with @option{-d} or
4658 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4659 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4660
4661 @item -dx
4662 @opindex dx
4663 Just generate RTL for a function instead of compiling it.  Usually used
4664 with @samp{r} (@option{-fdump-rtl-expand}).
4665
4666 @item -dy
4667 @opindex dy
4668 Dump debugging information during parsing, to standard error.
4669 @end table
4670
4671 @item -fdump-noaddr
4672 @opindex fdump-noaddr
4673 When doing debugging dumps (see @option{-d} option above), suppress
4674 address output.  This makes it more feasible to use diff on debugging
4675 dumps for compiler invocations with different compiler binaries and/or
4676 different text / bss / data / heap / stack / dso start locations.
4677
4678 @item -fdump-unnumbered
4679 @opindex fdump-unnumbered
4680 When doing debugging dumps (see @option{-d} option above), suppress instruction
4681 numbers and address output.  This makes it more feasible to
4682 use diff on debugging dumps for compiler invocations with different
4683 options, in particular with and without @option{-g}.
4684
4685 @item -fdump-translation-unit @r{(C++ only)}
4686 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4687 @opindex fdump-translation-unit
4688 Dump a representation of the tree structure for the entire translation
4689 unit to a file.  The file name is made by appending @file{.tu} to the
4690 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4691 controls the details of the dump as described for the
4692 @option{-fdump-tree} options.
4693
4694 @item -fdump-class-hierarchy @r{(C++ only)}
4695 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4696 @opindex fdump-class-hierarchy
4697 Dump a representation of each class's hierarchy and virtual function
4698 table layout to a file.  The file name is made by appending @file{.class}
4699 to the source file name.  If the @samp{-@var{options}} form is used,
4700 @var{options} controls the details of the dump as described for the
4701 @option{-fdump-tree} options.
4702
4703 @item -fdump-ipa-@var{switch}
4704 @opindex fdump-ipa
4705 Control the dumping at various stages of inter-procedural analysis
4706 language tree to a file.  The file name is generated by appending a switch
4707 specific suffix to the source file name.  The following dumps are possible:
4708
4709 @table @samp
4710 @item all
4711 Enables all inter-procedural analysis dumps.
4712
4713 @item cgraph
4714 Dumps information about call-graph optimization, unused function removal,
4715 and inlining decisions.
4716
4717 @item inline
4718 Dump after function inlining.
4719
4720 @end table
4721
4722 @item -fdump-tree-@var{switch}
4723 @itemx -fdump-tree-@var{switch}-@var{options}
4724 @opindex fdump-tree
4725 Control the dumping at various stages of processing the intermediate
4726 language tree to a file.  The file name is generated by appending a switch
4727 specific suffix to the source file name.  If the @samp{-@var{options}}
4728 form is used, @var{options} is a list of @samp{-} separated options that
4729 control the details of the dump.  Not all options are applicable to all
4730 dumps, those which are not meaningful will be ignored.  The following
4731 options are available
4732
4733 @table @samp
4734 @item address
4735 Print the address of each node.  Usually this is not meaningful as it
4736 changes according to the environment and source file.  Its primary use
4737 is for tying up a dump file with a debug environment.
4738 @item slim
4739 Inhibit dumping of members of a scope or body of a function merely
4740 because that scope has been reached.  Only dump such items when they
4741 are directly reachable by some other path.  When dumping pretty-printed
4742 trees, this option inhibits dumping the bodies of control structures.
4743 @item raw
4744 Print a raw representation of the tree.  By default, trees are
4745 pretty-printed into a C-like representation.
4746 @item details
4747 Enable more detailed dumps (not honored by every dump option).
4748 @item stats
4749 Enable dumping various statistics about the pass (not honored by every dump
4750 option).
4751 @item blocks
4752 Enable showing basic block boundaries (disabled in raw dumps).
4753 @item vops
4754 Enable showing virtual operands for every statement.
4755 @item lineno
4756 Enable showing line numbers for statements.
4757 @item uid
4758 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4759 @item all
4760 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4761 @end table
4762
4763 The following tree dumps are possible:
4764 @table @samp
4765
4766 @item original
4767 Dump before any tree based optimization, to @file{@var{file}.original}.
4768
4769 @item optimized
4770 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4771
4772 @item gimple
4773 @opindex fdump-tree-gimple
4774 Dump each function before and after the gimplification pass to a file.  The
4775 file name is made by appending @file{.gimple} to the source file name.
4776
4777 @item cfg
4778 @opindex fdump-tree-cfg
4779 Dump the control flow graph of each function to a file.  The file name is
4780 made by appending @file{.cfg} to the source file name.
4781
4782 @item vcg
4783 @opindex fdump-tree-vcg
4784 Dump the control flow graph of each function to a file in VCG format.  The
4785 file name is made by appending @file{.vcg} to the source file name.  Note
4786 that if the file contains more than one function, the generated file cannot
4787 be used directly by VCG@.  You will need to cut and paste each function's
4788 graph into its own separate file first.
4789
4790 @item ch
4791 @opindex fdump-tree-ch
4792 Dump each function after copying loop headers.  The file name is made by
4793 appending @file{.ch} to the source file name.
4794
4795 @item ssa
4796 @opindex fdump-tree-ssa
4797 Dump SSA related information to a file.  The file name is made by appending
4798 @file{.ssa} to the source file name.
4799
4800 @item salias
4801 @opindex fdump-tree-salias
4802 Dump structure aliasing variable information to a file.  This file name
4803 is made by appending @file{.salias} to the source file name.
4804
4805 @item alias
4806 @opindex fdump-tree-alias
4807 Dump aliasing information for each function.  The file name is made by
4808 appending @file{.alias} to the source file name.
4809
4810 @item ccp
4811 @opindex fdump-tree-ccp
4812 Dump each function after CCP@.  The file name is made by appending
4813 @file{.ccp} to the source file name.
4814
4815 @item storeccp
4816 @opindex fdump-tree-storeccp
4817 Dump each function after STORE-CCP@.  The file name is made by appending
4818 @file{.storeccp} to the source file name.
4819
4820 @item pre
4821 @opindex fdump-tree-pre
4822 Dump trees after partial redundancy elimination.  The file name is made
4823 by appending @file{.pre} to the source file name.
4824
4825 @item fre
4826 @opindex fdump-tree-fre
4827 Dump trees after full redundancy elimination.  The file name is made
4828 by appending @file{.fre} to the source file name.
4829
4830 @item copyprop
4831 @opindex fdump-tree-copyprop
4832 Dump trees after copy propagation.  The file name is made
4833 by appending @file{.copyprop} to the source file name.
4834
4835 @item store_copyprop
4836 @opindex fdump-tree-store_copyprop
4837 Dump trees after store copy-propagation.  The file name is made
4838 by appending @file{.store_copyprop} to the source file name.
4839
4840 @item dce
4841 @opindex fdump-tree-dce
4842 Dump each function after dead code elimination.  The file name is made by
4843 appending @file{.dce} to the source file name.
4844
4845 @item mudflap
4846 @opindex fdump-tree-mudflap
4847 Dump each function after adding mudflap instrumentation.  The file name is
4848 made by appending @file{.mudflap} to the source file name.
4849
4850 @item sra
4851 @opindex fdump-tree-sra
4852 Dump each function after performing scalar replacement of aggregates.  The
4853 file name is made by appending @file{.sra} to the source file name.
4854
4855 @item sink
4856 @opindex fdump-tree-sink
4857 Dump each function after performing code sinking.  The file name is made
4858 by appending @file{.sink} to the source file name.
4859
4860 @item dom
4861 @opindex fdump-tree-dom
4862 Dump each function after applying dominator tree optimizations.  The file
4863 name is made by appending @file{.dom} to the source file name.
4864
4865 @item dse
4866 @opindex fdump-tree-dse
4867 Dump each function after applying dead store elimination.  The file
4868 name is made by appending @file{.dse} to the source file name.
4869
4870 @item phiopt
4871 @opindex fdump-tree-phiopt
4872 Dump each function after optimizing PHI nodes into straightline code.  The file
4873 name is made by appending @file{.phiopt} to the source file name.
4874
4875 @item forwprop
4876 @opindex fdump-tree-forwprop
4877 Dump each function after forward propagating single use variables.  The file
4878 name is made by appending @file{.forwprop} to the source file name.
4879
4880 @item copyrename
4881 @opindex fdump-tree-copyrename
4882 Dump each function after applying the copy rename optimization.  The file
4883 name is made by appending @file{.copyrename} to the source file name.
4884
4885 @item nrv
4886 @opindex fdump-tree-nrv
4887 Dump each function after applying the named return value optimization on
4888 generic trees.  The file name is made by appending @file{.nrv} to the source
4889 file name.
4890
4891 @item vect
4892 @opindex fdump-tree-vect
4893 Dump each function after applying vectorization of loops.  The file name is
4894 made by appending @file{.vect} to the source file name.
4895
4896 @item vrp
4897 @opindex fdump-tree-vrp
4898 Dump each function after Value Range Propagation (VRP).  The file name
4899 is made by appending @file{.vrp} to the source file name.
4900
4901 @item all
4902 @opindex fdump-tree-all
4903 Enable all the available tree dumps with the flags provided in this option.
4904 @end table
4905
4906 @item -ftree-vectorizer-verbose=@var{n}
4907 @opindex ftree-vectorizer-verbose
4908 This option controls the amount of debugging output the vectorizer prints.
4909 This information is written to standard error, unless
4910 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4911 in which case it is output to the usual dump listing file, @file{.vect}.
4912 For @var{n}=0 no diagnostic information is reported.
4913 If @var{n}=1 the vectorizer reports each loop that got vectorized,
4914 and the total number of loops that got vectorized.
4915 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4916 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
4917 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
4918 level that @option{-fdump-tree-vect-stats} uses.
4919 Higher verbosity levels mean either more information dumped for each
4920 reported loop, or same amount of information reported for more loops:
4921 If @var{n}=3, alignment related information is added to the reports.
4922 If @var{n}=4, data-references related information (e.g.@: memory dependences,
4923 memory access-patterns) is added to the reports.
4924 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4925 that did not pass the first analysis phase (i.e., may not be countable, or
4926 may have complicated control-flow).
4927 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4928 For @var{n}=7, all the information the vectorizer generates during its
4929 analysis and transformation is reported.  This is the same verbosity level
4930 that @option{-fdump-tree-vect-details} uses.
4931
4932 @item -frandom-seed=@var{string}
4933 @opindex frandom-string
4934 This option provides a seed that GCC uses when it would otherwise use
4935 random numbers.  It is used to generate certain symbol names
4936 that have to be different in every compiled file.  It is also used to
4937 place unique stamps in coverage data files and the object files that
4938 produce them.  You can use the @option{-frandom-seed} option to produce
4939 reproducibly identical object files.
4940
4941 The @var{string} should be different for every file you compile.
4942
4943 @item -fsched-verbose=@var{n}
4944 @opindex fsched-verbose
4945 On targets that use instruction scheduling, this option controls the
4946 amount of debugging output the scheduler prints.  This information is
4947 written to standard error, unless @option{-dS} or @option{-dR} is
4948 specified, in which case it is output to the usual dump
4949 listing file, @file{.sched} or @file{.sched2} respectively.  However
4950 for @var{n} greater than nine, the output is always printed to standard
4951 error.
4952
4953 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4954 same information as @option{-dRS}.  For @var{n} greater than one, it
4955 also output basic block probabilities, detailed ready list information
4956 and unit/insn info.  For @var{n} greater than two, it includes RTL
4957 at abort point, control-flow and regions info.  And for @var{n} over
4958 four, @option{-fsched-verbose} also includes dependence info.
4959
4960 @item -save-temps
4961 @opindex save-temps
4962 Store the usual ``temporary'' intermediate files permanently; place them
4963 in the current directory and name them based on the source file.  Thus,
4964 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4965 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4966 preprocessed @file{foo.i} output file even though the compiler now
4967 normally uses an integrated preprocessor.
4968
4969 When used in combination with the @option{-x} command line option,
4970 @option{-save-temps} is sensible enough to avoid over writing an
4971 input source file with the same extension as an intermediate file.
4972 The corresponding intermediate file may be obtained by renaming the
4973 source file before using @option{-save-temps}.
4974
4975 @item -time
4976 @opindex time
4977 Report the CPU time taken by each subprocess in the compilation
4978 sequence.  For C source files, this is the compiler proper and assembler
4979 (plus the linker if linking is done).  The output looks like this:
4980
4981 @smallexample
4982 # cc1 0.12 0.01
4983 # as 0.00 0.01
4984 @end smallexample
4985
4986 The first number on each line is the ``user time'', that is time spent
4987 executing the program itself.  The second number is ``system time'',
4988 time spent executing operating system routines on behalf of the program.
4989 Both numbers are in seconds.
4990
4991 @item -fvar-tracking
4992 @opindex fvar-tracking
4993 Run variable tracking pass.  It computes where variables are stored at each
4994 position in code.  Better debugging information is then generated
4995 (if the debugging information format supports this information).
4996
4997 It is enabled by default when compiling with optimization (@option{-Os},
4998 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
4999 the debug info format supports it.
5000
5001 @item -print-file-name=@var{library}
5002 @opindex print-file-name
5003 Print the full absolute name of the library file @var{library} that
5004 would be used when linking---and don't do anything else.  With this
5005 option, GCC does not compile or link anything; it just prints the
5006 file name.
5007
5008 @item -print-multi-directory
5009 @opindex print-multi-directory
5010 Print the directory name corresponding to the multilib selected by any
5011 other switches present in the command line.  This directory is supposed
5012 to exist in @env{GCC_EXEC_PREFIX}.
5013
5014 @item -print-multi-lib
5015 @opindex print-multi-lib
5016 Print the mapping from multilib directory names to compiler switches
5017 that enable them.  The directory name is separated from the switches by
5018 @samp{;}, and each switch starts with an @samp{@@} instead of the
5019 @samp{-}, without spaces between multiple switches.  This is supposed to
5020 ease shell-processing.
5021
5022 @item -print-prog-name=@var{program}
5023 @opindex print-prog-name
5024 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5025
5026 @item -print-libgcc-file-name
5027 @opindex print-libgcc-file-name
5028 Same as @option{-print-file-name=libgcc.a}.
5029
5030 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5031 but you do want to link with @file{libgcc.a}.  You can do
5032
5033 @smallexample
5034 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5035 @end smallexample
5036
5037 @item -print-search-dirs
5038 @opindex print-search-dirs
5039 Print the name of the configured installation directory and a list of
5040 program and library directories @command{gcc} will search---and don't do anything else.
5041
5042 This is useful when @command{gcc} prints the error message
5043 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5044 To resolve this you either need to put @file{cpp0} and the other compiler
5045 components where @command{gcc} expects to find them, or you can set the environment
5046 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5047 Don't forget the trailing @samp{/}.
5048 @xref{Environment Variables}.
5049
5050 @item -print-sysroot-headers-suffix
5051 @opindex print-sysroot-headers-suffix
5052 Print the suffix added to the target sysroot when searching for
5053 headers, or give an error if the compiler is not configured with such
5054 a suffix---and don't do anything else.
5055
5056 @item -dumpmachine
5057 @opindex dumpmachine
5058 Print the compiler's target machine (for example,
5059 @samp{i686-pc-linux-gnu})---and don't do anything else.
5060
5061 @item -dumpversion
5062 @opindex dumpversion
5063 Print the compiler version (for example, @samp{3.0})---and don't do
5064 anything else.
5065
5066 @item -dumpspecs
5067 @opindex dumpspecs
5068 Print the compiler's built-in specs---and don't do anything else.  (This
5069 is used when GCC itself is being built.)  @xref{Spec Files}.
5070
5071 @item -feliminate-unused-debug-types
5072 @opindex feliminate-unused-debug-types
5073 Normally, when producing DWARF2 output, GCC will emit debugging
5074 information for all types declared in a compilation
5075 unit, regardless of whether or not they are actually used
5076 in that compilation unit.  Sometimes this is useful, such as
5077 if, in the debugger, you want to cast a value to a type that is
5078 not actually used in your program (but is declared).  More often,
5079 however, this results in a significant amount of wasted space.
5080 With this option, GCC will avoid producing debug symbol output
5081 for types that are nowhere used in the source file being compiled.
5082 @end table
5083
5084 @node Optimize Options
5085 @section Options That Control Optimization
5086 @cindex optimize options
5087 @cindex options, optimization
5088
5089 These options control various sorts of optimizations.
5090
5091 Without any optimization option, the compiler's goal is to reduce the
5092 cost of compilation and to make debugging produce the expected
5093 results.  Statements are independent: if you stop the program with a
5094 breakpoint between statements, you can then assign a new value to any
5095 variable or change the program counter to any other statement in the
5096 function and get exactly the results you would expect from the source
5097 code.
5098
5099 Turning on optimization flags makes the compiler attempt to improve
5100 the performance and/or code size at the expense of compilation time
5101 and possibly the ability to debug the program.
5102
5103 The compiler performs optimization based on the knowledge it has of
5104 the program.  Optimization levels @option{-O} and above, in
5105 particular, enable @emph{unit-at-a-time} mode, which allows the
5106 compiler to consider information gained from later functions in
5107 the file when compiling a function.  Compiling multiple files at
5108 once to a single output file in @emph{unit-at-a-time} mode allows
5109 the compiler to use information gained from all of the files when
5110 compiling each of them.
5111
5112 Not all optimizations are controlled directly by a flag.  Only
5113 optimizations that have a flag are listed.
5114
5115 @table @gcctabopt
5116 @item -O
5117 @itemx -O1
5118 @opindex O
5119 @opindex O1
5120 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5121 more memory for a large function.
5122
5123 With @option{-O}, the compiler tries to reduce code size and execution
5124 time, without performing any optimizations that take a great deal of
5125 compilation time.
5126
5127 @option{-O} turns on the following optimization flags:
5128 @gccoptlist{
5129 -fauto-inc-dec @gol
5130 -fcprop-registers @gol
5131 -fdce @gol
5132 -fdefer-pop @gol
5133 -fdelayed-branch @gol
5134 -fdse @gol
5135 -fguess-branch-probability @gol
5136 -fif-conversion2 @gol
5137 -fif-conversion @gol
5138 -finline-small-functions @gol
5139 -fipa-pure-const @gol
5140 -fipa-reference @gol
5141 -fmerge-constants
5142 -fsplit-wide-types @gol
5143 -ftree-ccp @gol
5144 -ftree-ch @gol
5145 -ftree-copyrename @gol
5146 -ftree-dce @gol
5147 -ftree-dominator-opts @gol
5148 -ftree-dse @gol
5149 -ftree-fre @gol
5150 -ftree-sra @gol
5151 -ftree-ter @gol
5152 -funit-at-a-time}
5153
5154 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5155 where doing so does not interfere with debugging.
5156
5157 @item -O2
5158 @opindex O2
5159 Optimize even more.  GCC performs nearly all supported optimizations
5160 that do not involve a space-speed tradeoff.  The compiler does not
5161 perform loop unrolling or function inlining when you specify @option{-O2}.
5162 As compared to @option{-O}, this option increases both compilation time
5163 and the performance of the generated code.
5164
5165 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5166 also turns on the following optimization flags:
5167 @gccoptlist{-fthread-jumps @gol
5168 -falign-functions  -falign-jumps @gol
5169 -falign-loops  -falign-labels @gol
5170 -fcaller-saves @gol
5171 -fcrossjumping @gol
5172 -fcse-follow-jumps  -fcse-skip-blocks @gol
5173 -fdelete-null-pointer-checks @gol
5174 -fexpensive-optimizations @gol
5175 -fgcse  -fgcse-lm  @gol
5176 -foptimize-sibling-calls @gol
5177 -fpeephole2 @gol
5178 -fregmove @gol
5179 -freorder-blocks  -freorder-functions @gol
5180 -frerun-cse-after-loop  @gol
5181 -fsched-interblock  -fsched-spec @gol
5182 -fschedule-insns  -fschedule-insns2 @gol
5183 -fstrict-aliasing -fstrict-overflow @gol
5184 -ftree-pre @gol
5185 -ftree-vrp}
5186
5187 Please note the warning under @option{-fgcse} about
5188 invoking @option{-O2} on programs that use computed gotos.
5189
5190 @item -O3
5191 @opindex O3
5192 Optimize yet more.  @option{-O3} turns on all optimizations specified by
5193 @option{-O2} and also turns on the @option{-finline-functions},
5194 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5195 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5196
5197 @item -O0
5198 @opindex O0
5199 Reduce compilation time and make debugging produce the expected
5200 results.  This is the default.
5201
5202 @item -Os
5203 @opindex Os
5204 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5205 do not typically increase code size.  It also performs further
5206 optimizations designed to reduce code size.
5207
5208 @option{-Os} disables the following optimization flags:
5209 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5210 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5211 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5212
5213 If you use multiple @option{-O} options, with or without level numbers,
5214 the last such option is the one that is effective.
5215 @end table
5216
5217 Options of the form @option{-f@var{flag}} specify machine-independent
5218 flags.  Most flags have both positive and negative forms; the negative
5219 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5220 below, only one of the forms is listed---the one you typically will
5221 use.  You can figure out the other form by either removing @samp{no-}
5222 or adding it.
5223
5224 The following options control specific optimizations.  They are either
5225 activated by @option{-O} options or are related to ones that are.  You
5226 can use the following flags in the rare cases when ``fine-tuning'' of
5227 optimizations to be performed is desired.
5228
5229 @table @gcctabopt
5230 @item -fno-default-inline
5231 @opindex fno-default-inline
5232 Do not make member functions inline by default merely because they are
5233 defined inside the class scope (C++ only).  Otherwise, when you specify
5234 @w{@option{-O}}, member functions defined inside class scope are compiled
5235 inline by default; i.e., you don't need to add @samp{inline} in front of
5236 the member function name.
5237
5238 @item -fno-defer-pop
5239 @opindex fno-defer-pop
5240 Always pop the arguments to each function call as soon as that function
5241 returns.  For machines which must pop arguments after a function call,
5242 the compiler normally lets arguments accumulate on the stack for several
5243 function calls and pops them all at once.
5244
5245 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5246
5247 @item -fforward-propagate
5248 @opindex fforward-propagate
5249 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5250 instructions and checks if the result can be simplified.  If loop unrolling
5251 is active, two passes are performed and the second is scheduled after
5252 loop unrolling.
5253
5254 This option is enabled by default at optimization levels @option{-O2},
5255 @option{-O3}, @option{-Os}.
5256
5257 @item -fomit-frame-pointer
5258 @opindex fomit-frame-pointer
5259 Don't keep the frame pointer in a register for functions that
5260 don't need one.  This avoids the instructions to save, set up and
5261 restore frame pointers; it also makes an extra register available
5262 in many functions.  @strong{It also makes debugging impossible on
5263 some machines.}
5264
5265 On some machines, such as the VAX, this flag has no effect, because
5266 the standard calling sequence automatically handles the frame pointer
5267 and nothing is saved by pretending it doesn't exist.  The
5268 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5269 whether a target machine supports this flag.  @xref{Registers,,Register
5270 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5271
5272 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5273
5274 @item -foptimize-sibling-calls
5275 @opindex foptimize-sibling-calls
5276 Optimize sibling and tail recursive calls.
5277
5278 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5279
5280 @item -fno-inline
5281 @opindex fno-inline
5282 Don't pay attention to the @code{inline} keyword.  Normally this option
5283 is used to keep the compiler from expanding any functions inline.
5284 Note that if you are not optimizing, no functions can be expanded inline.
5285
5286 @item -finline-small-functions
5287 @opindex finline-small-functions
5288 Integrate functions into their callers when their body is smaller than expected
5289 function call code (so overall size of program gets smaller).  The compiler
5290 heuristically decides which functions are simple enough to be worth integrating
5291 in this way.
5292
5293 Enabled at level @option{-O2}.
5294
5295 @item -finline-functions
5296 @opindex finline-functions
5297 Integrate all simple functions into their callers.  The compiler
5298 heuristically decides which functions are simple enough to be worth
5299 integrating in this way.
5300
5301 If all calls to a given function are integrated, and the function is
5302 declared @code{static}, then the function is normally not output as
5303 assembler code in its own right.
5304
5305 Enabled at level @option{-O3}.
5306
5307 @item -finline-functions-called-once
5308 @opindex finline-functions-called-once
5309 Consider all @code{static} functions called once for inlining into their
5310 caller even if they are not marked @code{inline}.  If a call to a given
5311 function is integrated, then the function is not output as assembler code
5312 in its own right.
5313
5314 Enabled if @option{-funit-at-a-time} is enabled.
5315
5316 @item -fearly-inlining
5317 @opindex fearly-inlining
5318 Inline functions marked by @code{always_inline} and functions whose body seems
5319 smaller than the function call overhead early before doing
5320 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5321 makes profiling significantly cheaper and usually inlining faster on programs
5322 having large chains of nested wrapper functions.
5323
5324 Enabled by default.
5325
5326 @item -finline-limit=@var{n}
5327 @opindex finline-limit
5328 By default, GCC limits the size of functions that can be inlined.  This flag
5329 allows coarse control of this limit.  @var{n} is the size of functions that
5330 can be inlined in number of pseudo instructions.
5331
5332 Inlining is actually controlled by a number of parameters, which may be
5333 specified individually by using @option{--param @var{name}=@var{value}}.
5334 The @option{-finline-limit=@var{n}} option sets some of these parameters
5335 as follows:
5336
5337 @table @gcctabopt
5338 @item max-inline-insns-single
5339  is set to @var{n}/2.
5340 @item max-inline-insns-auto
5341  is set to @var{n}/2.
5342 @end table
5343
5344 See below for a documentation of the individual
5345 parameters controlling inlining and for the defaults of these parameters.
5346
5347 @emph{Note:} there may be no value to @option{-finline-limit} that results
5348 in default behavior.
5349
5350 @emph{Note:} pseudo instruction represents, in this particular context, an
5351 abstract measurement of function's size.  In no way does it represent a count
5352 of assembly instructions and as such its exact meaning might change from one
5353 release to an another.
5354
5355 @item -fkeep-inline-functions
5356 @opindex fkeep-inline-functions
5357 In C, emit @code{static} functions that are declared @code{inline}
5358 into the object file, even if the function has been inlined into all
5359 of its callers.  This switch does not affect functions using the
5360 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5361 inline functions into the object file.
5362
5363 @item -fkeep-static-consts
5364 @opindex fkeep-static-consts
5365 Emit variables declared @code{static const} when optimization isn't turned
5366 on, even if the variables aren't referenced.
5367
5368 GCC enables this option by default.  If you want to force the compiler to
5369 check if the variable was referenced, regardless of whether or not
5370 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5371
5372 @item -fmerge-constants
5373 @opindex fmerge-constants
5374 Attempt to merge identical constants (string constants and floating point
5375 constants) across compilation units.
5376
5377 This option is the default for optimized compilation if the assembler and
5378 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5379 behavior.
5380
5381 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5382
5383 @item -fmerge-all-constants
5384 @opindex fmerge-all-constants
5385 Attempt to merge identical constants and identical variables.
5386
5387 This option implies @option{-fmerge-constants}.  In addition to
5388 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5389 arrays or initialized constant variables with integral or floating point
5390 types.  Languages like C or C++ require each non-automatic variable to
5391 have distinct location, so using this option will result in non-conforming
5392 behavior.
5393
5394 @item -fmodulo-sched
5395 @opindex fmodulo-sched
5396 Perform swing modulo scheduling immediately before the first scheduling
5397 pass.  This pass looks at innermost loops and reorders their
5398 instructions by overlapping different iterations.
5399
5400 @item -fmodulo-sched-allow-regmoves
5401 @opindex fmodulo-sched-allow-regmoves
5402 Perform more aggressive SMS based modulo scheduling with register moves
5403 allowed.  By setting this flag certain anti-dependences edges will be
5404 deleted which will trigger the generation of reg-moves based on the
5405 life-range analysis.  This option is effective only with
5406 @option{-fmodulo-sched} enabled.
5407
5408 @item -fno-branch-count-reg
5409 @opindex fno-branch-count-reg
5410 Do not use ``decrement and branch'' instructions on a count register,
5411 but instead generate a sequence of instructions that decrement a
5412 register, compare it against zero, then branch based upon the result.
5413 This option is only meaningful on architectures that support such
5414 instructions, which include x86, PowerPC, IA-64 and S/390.
5415
5416 The default is @option{-fbranch-count-reg}.
5417
5418 @item -fno-function-cse
5419 @opindex fno-function-cse
5420 Do not put function addresses in registers; make each instruction that
5421 calls a constant function contain the function's address explicitly.
5422
5423 This option results in less efficient code, but some strange hacks
5424 that alter the assembler output may be confused by the optimizations
5425 performed when this option is not used.
5426
5427 The default is @option{-ffunction-cse}
5428
5429 @item -fno-zero-initialized-in-bss
5430 @opindex fno-zero-initialized-in-bss
5431 If the target supports a BSS section, GCC by default puts variables that
5432 are initialized to zero into BSS@.  This can save space in the resulting
5433 code.
5434
5435 This option turns off this behavior because some programs explicitly
5436 rely on variables going to the data section.  E.g., so that the
5437 resulting executable can find the beginning of that section and/or make
5438 assumptions based on that.
5439
5440 The default is @option{-fzero-initialized-in-bss}.
5441
5442 @item -fmudflap -fmudflapth -fmudflapir
5443 @opindex fmudflap
5444 @opindex fmudflapth
5445 @opindex fmudflapir
5446 @cindex bounds checking
5447 @cindex mudflap
5448 For front-ends that support it (C and C++), instrument all risky
5449 pointer/array dereferencing operations, some standard library
5450 string/heap functions, and some other associated constructs with
5451 range/validity tests.  Modules so instrumented should be immune to
5452 buffer overflows, invalid heap use, and some other classes of C/C++
5453 programming errors.  The instrumentation relies on a separate runtime
5454 library (@file{libmudflap}), which will be linked into a program if
5455 @option{-fmudflap} is given at link time.  Run-time behavior of the
5456 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5457 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5458 for its options.
5459
5460 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5461 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5462 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5463 instrumentation should ignore pointer reads.  This produces less
5464 instrumentation (and therefore faster execution) and still provides
5465 some protection against outright memory corrupting writes, but allows
5466 erroneously read data to propagate within a program.
5467
5468 @item -fthread-jumps
5469 @opindex fthread-jumps
5470 Perform optimizations where we check to see if a jump branches to a
5471 location where another comparison subsumed by the first is found.  If
5472 so, the first branch is redirected to either the destination of the
5473 second branch or a point immediately following it, depending on whether
5474 the condition is known to be true or false.
5475
5476 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5477
5478 @item -fsplit-wide-types
5479 @opindex fsplit-wide-types
5480 When using a type that occupies multiple registers, such as @code{long
5481 long} on a 32-bit system, split the registers apart and allocate them
5482 independently.  This normally generates better code for those types,
5483 but may make debugging more difficult.
5484
5485 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5486 @option{-Os}.
5487
5488 @item -fcse-follow-jumps
5489 @opindex fcse-follow-jumps
5490 In common subexpression elimination (CSE), scan through jump instructions
5491 when the target of the jump is not reached by any other path.  For
5492 example, when CSE encounters an @code{if} statement with an
5493 @code{else} clause, CSE will follow the jump when the condition
5494 tested is false.
5495
5496 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5497
5498 @item -fcse-skip-blocks
5499 @opindex fcse-skip-blocks
5500 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5501 follow jumps which conditionally skip over blocks.  When CSE
5502 encounters a simple @code{if} statement with no else clause,
5503 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5504 body of the @code{if}.
5505
5506 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5507
5508 @item -frerun-cse-after-loop
5509 @opindex frerun-cse-after-loop
5510 Re-run common subexpression elimination after loop optimizations has been
5511 performed.
5512
5513 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5514
5515 @item -fgcse
5516 @opindex fgcse
5517 Perform a global common subexpression elimination pass.
5518 This pass also performs global constant and copy propagation.
5519
5520 @emph{Note:} When compiling a program using computed gotos, a GCC
5521 extension, you may get better runtime performance if you disable
5522 the global common subexpression elimination pass by adding
5523 @option{-fno-gcse} to the command line.
5524
5525 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5526
5527 @item -fgcse-lm
5528 @opindex fgcse-lm
5529 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5530 attempt to move loads which are only killed by stores into themselves.  This
5531 allows a loop containing a load/store sequence to be changed to a load outside
5532 the loop, and a copy/store within the loop.
5533
5534 Enabled by default when gcse is enabled.
5535
5536 @item -fgcse-sm
5537 @opindex fgcse-sm
5538 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5539 global common subexpression elimination.  This pass will attempt to move
5540 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5541 loops containing a load/store sequence can be changed to a load before
5542 the loop and a store after the loop.
5543
5544 Not enabled at any optimization level.
5545
5546 @item -fgcse-las
5547 @opindex fgcse-las
5548 When @option{-fgcse-las} is enabled, the global common subexpression
5549 elimination pass eliminates redundant loads that come after stores to the
5550 same memory location (both partial and full redundancies).
5551
5552 Not enabled at any optimization level.
5553
5554 @item -fgcse-after-reload
5555 @opindex fgcse-after-reload
5556 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5557 pass is performed after reload.  The purpose of this pass is to cleanup
5558 redundant spilling.
5559
5560 @item -funsafe-loop-optimizations
5561 @opindex funsafe-loop-optimizations
5562 If given, the loop optimizer will assume that loop indices do not
5563 overflow, and that the loops with nontrivial exit condition are not
5564 infinite.  This enables a wider range of loop optimizations even if
5565 the loop optimizer itself cannot prove that these assumptions are valid.
5566 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5567 if it finds this kind of loop.
5568
5569 @item -fcrossjumping
5570 @opindex fcrossjumping
5571 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5572 resulting code may or may not perform better than without cross-jumping.
5573
5574 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5575
5576 @item -fauto-inc-dec
5577 @opindex fauto-inc-dec
5578 Combine increments or decrements of addresses with memory accesses.
5579 This pass is always skipped on architectures that do not have
5580 instructions to support this.  Enabled by default at @option{-O} and
5581 higher on architectures that support this.
5582
5583 @item -fdce
5584 @opindex fdce
5585 Perform dead code elimination (DCE) on RTL@.
5586 Enabled by default at @option{-O} and higher.
5587
5588 @item -fdse
5589 @opindex fdse
5590 Perform dead store elimination (DSE) on RTL@.
5591 Enabled by default at @option{-O} and higher.
5592
5593 @item -fif-conversion
5594 @opindex fif-conversion
5595 Attempt to transform conditional jumps into branch-less equivalents.  This
5596 include use of conditional moves, min, max, set flags and abs instructions, and
5597 some tricks doable by standard arithmetics.  The use of conditional execution
5598 on chips where it is available is controlled by @code{if-conversion2}.
5599
5600 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5601
5602 @item -fif-conversion2
5603 @opindex fif-conversion2
5604 Use conditional execution (where available) to transform conditional jumps into
5605 branch-less equivalents.
5606
5607 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5608
5609 @item -fdelete-null-pointer-checks
5610 @opindex fdelete-null-pointer-checks
5611 Use global dataflow analysis to identify and eliminate useless checks
5612 for null pointers.  The compiler assumes that dereferencing a null
5613 pointer would have halted the program.  If a pointer is checked after
5614 it has already been dereferenced, it cannot be null.
5615
5616 In some environments, this assumption is not true, and programs can
5617 safely dereference null pointers.  Use
5618 @option{-fno-delete-null-pointer-checks} to disable this optimization
5619 for programs which depend on that behavior.
5620
5621 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5622
5623 @item -fexpensive-optimizations
5624 @opindex fexpensive-optimizations
5625 Perform a number of minor optimizations that are relatively expensive.
5626
5627 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5628
5629 @item -foptimize-register-move
5630 @itemx -fregmove
5631 @opindex foptimize-register-move
5632 @opindex fregmove
5633 Attempt to reassign register numbers in move instructions and as
5634 operands of other simple instructions in order to maximize the amount of
5635 register tying.  This is especially helpful on machines with two-operand
5636 instructions.
5637
5638 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5639 optimization.
5640
5641 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5642
5643 @item -fdelayed-branch
5644 @opindex fdelayed-branch
5645 If supported for the target machine, attempt to reorder instructions
5646 to exploit instruction slots available after delayed branch
5647 instructions.
5648
5649 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5650
5651 @item -fschedule-insns
5652 @opindex fschedule-insns
5653 If supported for the target machine, attempt to reorder instructions to
5654 eliminate execution stalls due to required data being unavailable.  This
5655 helps machines that have slow floating point or memory load instructions
5656 by allowing other instructions to be issued until the result of the load
5657 or floating point instruction is required.
5658
5659 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5660
5661 @item -fschedule-insns2
5662 @opindex fschedule-insns2
5663 Similar to @option{-fschedule-insns}, but requests an additional pass of
5664 instruction scheduling after register allocation has been done.  This is
5665 especially useful on machines with a relatively small number of
5666 registers and where memory load instructions take more than one cycle.
5667
5668 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5669
5670 @item -fno-sched-interblock
5671 @opindex fno-sched-interblock
5672 Don't schedule instructions across basic blocks.  This is normally
5673 enabled by default when scheduling before register allocation, i.e.@:
5674 with @option{-fschedule-insns} or at @option{-O2} or higher.
5675
5676 @item -fno-sched-spec
5677 @opindex fno-sched-spec
5678 Don't allow speculative motion of non-load instructions.  This is normally
5679 enabled by default when scheduling before register allocation, i.e.@:
5680 with @option{-fschedule-insns} or at @option{-O2} or higher.
5681
5682 @item -fsched-spec-load
5683 @opindex fsched-spec-load
5684 Allow speculative motion of some load instructions.  This only makes
5685 sense when scheduling before register allocation, i.e.@: with
5686 @option{-fschedule-insns} or at @option{-O2} or higher.
5687
5688 @item -fsched-spec-load-dangerous
5689 @opindex fsched-spec-load-dangerous
5690 Allow speculative motion of more load instructions.  This only makes
5691 sense when scheduling before register allocation, i.e.@: with
5692 @option{-fschedule-insns} or at @option{-O2} or higher.
5693
5694 @item -fsched-stalled-insns
5695 @itemx -fsched-stalled-insns=@var{n}
5696 @opindex fsched-stalled-insns
5697 Define how many insns (if any) can be moved prematurely from the queue
5698 of stalled insns into the ready list, during the second scheduling pass.
5699 @option{-fno-sched-stalled-insns} means that no insns will be moved
5700 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
5701 on how many queued insns can be moved prematurely.
5702 @option{-fsched-stalled-insns} without a value is equivalent to
5703 @option{-fsched-stalled-insns=1}.
5704
5705 @item -fsched-stalled-insns-dep
5706 @itemx -fsched-stalled-insns-dep=@var{n}
5707 @opindex fsched-stalled-insns-dep
5708 Define how many insn groups (cycles) will be examined for a dependency
5709 on a stalled insn that is candidate for premature removal from the queue
5710 of stalled insns.  This has an effect only during the second scheduling pass,
5711 and only if @option{-fsched-stalled-insns} is used.
5712 @option{-fno-sched-stalled-insns-dep} is equivalent to
5713 @option{-fsched-stalled-insns-dep=0}.
5714 @option{-fsched-stalled-insns-dep} without a value is equivalent to
5715 @option{-fsched-stalled-insns-dep=1}.
5716
5717 @item -fsched2-use-superblocks
5718 @opindex fsched2-use-superblocks
5719 When scheduling after register allocation, do use superblock scheduling
5720 algorithm.  Superblock scheduling allows motion across basic block boundaries
5721 resulting on faster schedules.  This option is experimental, as not all machine
5722 descriptions used by GCC model the CPU closely enough to avoid unreliable
5723 results from the algorithm.
5724
5725 This only makes sense when scheduling after register allocation, i.e.@: with
5726 @option{-fschedule-insns2} or at @option{-O2} or higher.
5727
5728 @item -fsched2-use-traces
5729 @opindex fsched2-use-traces
5730 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5731 allocation and additionally perform code duplication in order to increase the
5732 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5733 trace formation.
5734
5735 This mode should produce faster but significantly longer programs.  Also
5736 without @option{-fbranch-probabilities} the traces constructed may not
5737 match the reality and hurt the performance.  This only makes
5738 sense when scheduling after register allocation, i.e.@: with
5739 @option{-fschedule-insns2} or at @option{-O2} or higher.
5740
5741 @item -fsee
5742 @opindex fsee
5743 Eliminate redundant sign extension instructions and move the non-redundant
5744 ones to optimal placement using lazy code motion (LCM).
5745
5746 @item -freschedule-modulo-scheduled-loops
5747 @opindex freschedule-modulo-scheduled-loops
5748 The modulo scheduling comes before the traditional scheduling, if a loop
5749 was modulo scheduled we may want to prevent the later scheduling passes
5750 from changing its schedule, we use this option to control that.
5751
5752 @item -fcaller-saves
5753 @opindex fcaller-saves
5754 Enable values to be allocated in registers that will be clobbered by
5755 function calls, by emitting extra instructions to save and restore the
5756 registers around such calls.  Such allocation is done only when it
5757 seems to result in better code than would otherwise be produced.
5758
5759 This option is always enabled by default on certain machines, usually
5760 those which have no call-preserved registers to use instead.
5761
5762 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5763
5764 @item -ftree-reassoc
5765 @opindex ftree-reassoc
5766 Perform reassociation on trees.  This flag is enabled by default
5767 at @option{-O} and higher.
5768
5769 @item -ftree-pre
5770 @opindex ftree-pre
5771 Perform partial redundancy elimination (PRE) on trees.  This flag is
5772 enabled by default at @option{-O2} and @option{-O3}.
5773
5774 @item -ftree-fre
5775 @opindex ftree-fre
5776 Perform full redundancy elimination (FRE) on trees.  The difference
5777 between FRE and PRE is that FRE only considers expressions
5778 that are computed on all paths leading to the redundant computation.
5779 This analysis is faster than PRE, though it exposes fewer redundancies.
5780 This flag is enabled by default at @option{-O} and higher.
5781
5782 @item -ftree-copy-prop
5783 @opindex ftree-copy-prop
5784 Perform copy propagation on trees.  This pass eliminates unnecessary
5785 copy operations.  This flag is enabled by default at @option{-O} and
5786 higher.
5787
5788 @item -ftree-salias
5789 @opindex ftree-salias
5790 Perform structural alias analysis on trees.  This flag
5791 is enabled by default at @option{-O} and higher.
5792
5793 @item -fipa-pure-const
5794 @opindex fipa-pure-const
5795 Discover which functions are pure or constant.
5796 Enabled by default at @option{-O} and higher.
5797
5798 @item -fipa-reference
5799 @opindex fipa-reference
5800 Discover which static variables do not escape cannot escape the
5801 compilation unit.
5802 Enabled by default at @option{-O} and higher.
5803
5804 @item -fipa-struct-reorg
5805 @opindex fipa-struct-reorg
5806 Perform structure reorganization optimization, that change C-like structures 
5807 layout in order to better utilize spatial locality.  This transformation is 
5808 affective for programs containing arrays of structures.  Available in two 
5809 compilation modes: profile-based (enabled with @option{-fprofile-generate})
5810 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
5811 to provide the safety of this transformation.  It works only in whole program
5812 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
5813 enabled.  Structures considered @samp{cold} by this transformation are not
5814 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
5815
5816 With this flag, the program debug info reflects a new structure layout.
5817
5818 @item -fipa-pta
5819 @opindex fipa-pta
5820 Perform interprocedural pointer analysis.
5821
5822 @item -fipa-cp
5823 @opindex fipa-cp
5824 Perform interprocedural constant propagation.
5825 This optimization analyzes the program to determine when values passed
5826 to functions are constants and then optimizes accordingly.  
5827 This optimization can substantially increase performance
5828 if the application has constants passed to functions, but
5829 because this optimization can create multiple copies of functions,
5830 it may significantly increase code size.
5831
5832 @item -fipa-matrix-reorg
5833 @opindex fipa-matrix-reorg
5834 Perform matrix flattening and transposing.
5835 Matrix flattening tries to replace a m-dimensional matrix 
5836 with its equivalent n-dimensional matrix, where n < m.
5837 This reduces the level of indirection needed for accessing the elements
5838 of the matrix. The second optimization is matrix transposing that
5839 attemps to change the order of the matrix's dimensions in order to 
5840 improve cache locality.
5841 Both optimizations need fwhole-program flag. 
5842 Transposing is enabled only if profiling information is avaliable.
5843
5844
5845 @item -ftree-sink
5846 @opindex ftree-sink
5847 Perform forward store motion  on trees.  This flag is
5848 enabled by default at @option{-O} and higher.
5849
5850 @item -ftree-ccp
5851 @opindex ftree-ccp
5852 Perform sparse conditional constant propagation (CCP) on trees.  This
5853 pass only operates on local scalar variables and is enabled by default
5854 at @option{-O} and higher.
5855
5856 @item -ftree-store-ccp
5857 @opindex ftree-store-ccp
5858 Perform sparse conditional constant propagation (CCP) on trees.  This
5859 pass operates on both local scalar variables and memory stores and
5860 loads (global variables, structures, arrays, etc).  This flag is
5861 enabled by default at @option{-O2} and higher.
5862
5863 @item -ftree-dce
5864 @opindex ftree-dce
5865 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5866 default at @option{-O} and higher.
5867
5868 @item -ftree-dominator-opts
5869 @opindex ftree-dominator-opts
5870 Perform a variety of simple scalar cleanups (constant/copy
5871 propagation, redundancy elimination, range propagation and expression
5872 simplification) based on a dominator tree traversal.  This also
5873 performs jump threading (to reduce jumps to jumps). This flag is
5874 enabled by default at @option{-O} and higher.
5875
5876 @item -ftree-dse
5877 @opindex ftree-dse
5878 Perform dead store elimination (DSE) on trees.  A dead store is a store into
5879 a memory location which will later be overwritten by another store without
5880 any intervening loads.  In this case the earlier store can be deleted.  This
5881 flag is enabled by default at @option{-O} and higher.
5882
5883 @item -ftree-ch
5884 @opindex ftree-ch
5885 Perform loop header copying on trees.  This is beneficial since it increases
5886 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5887 is enabled by default at @option{-O} and higher.  It is not enabled
5888 for @option{-Os}, since it usually increases code size.
5889
5890 @item -ftree-loop-optimize
5891 @opindex ftree-loop-optimize
5892 Perform loop optimizations on trees.  This flag is enabled by default
5893 at @option{-O} and higher.
5894
5895 @item -ftree-loop-linear
5896 @opindex ftree-loop-linear
5897 Perform linear loop transformations on tree.  This flag can improve cache
5898 performance and allow further loop optimizations to take place.
5899
5900 @item -fcheck-data-deps
5901 @opindex fcheck-data-deps
5902 Compare the results of several data dependence analyzers.  This option
5903 is used for debugging the data dependence analyzers.
5904
5905 @item -ftree-loop-distribution
5906 Perform loop distribution.  This flag can improve cache performance on
5907 big loop bodies and allow further loop optimizations, like
5908 parallelization or vectorization, to take place.  For example, the loop
5909 @smallexample
5910 DO I = 1, N
5911   A(I) = B(I) + C
5912   D(I) = E(I) * F
5913 ENDDO
5914 @end smallexample
5915 is transformed to
5916 @smallexample
5917 DO I = 1, N
5918    A(I) = B(I) + C
5919 ENDDO
5920 DO I = 1, N
5921    D(I) = E(I) * F
5922 ENDDO
5923 @end smallexample
5924
5925 @item -ftree-loop-im
5926 @opindex ftree-loop-im
5927 Perform loop invariant motion on trees.  This pass moves only invariants that
5928 would be hard to handle at RTL level (function calls, operations that expand to
5929 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5930 operands of conditions that are invariant out of the loop, so that we can use
5931 just trivial invariantness analysis in loop unswitching.  The pass also includes
5932 store motion.
5933
5934 @item -ftree-loop-ivcanon
5935 @opindex ftree-loop-ivcanon
5936 Create a canonical counter for number of iterations in the loop for that
5937 determining number of iterations requires complicated analysis.  Later
5938 optimizations then may determine the number easily.  Useful especially
5939 in connection with unrolling.
5940
5941 @item -fivopts
5942 @opindex fivopts
5943 Perform induction variable optimizations (strength reduction, induction
5944 variable merging and induction variable elimination) on trees.
5945
5946 @item -ftree-parallelize-loops=n
5947 @opindex ftree-parallelize-loops
5948 Parallelize loops, i.e., split their iteration space to run in n threads.
5949 This is only possible for loops whose iterations are independent
5950 and can be arbitrarily reordered.  The optimization is only
5951 profitable on multiprocessor machines, for loops that are CPU-intensive,
5952 rather than constrained e.g.@: by memory bandwidth.  This option
5953 implies @option{-pthread}, and thus is only supported on targets
5954 that have support for @option{-pthread}.
5955
5956 @item -ftree-sra
5957 @opindex ftree-sra
5958 Perform scalar replacement of aggregates.  This pass replaces structure
5959 references with scalars to prevent committing structures to memory too
5960 early.  This flag is enabled by default at @option{-O} and higher.
5961
5962 @item -ftree-copyrename
5963 @opindex ftree-copyrename
5964 Perform copy renaming on trees.  This pass attempts to rename compiler
5965 temporaries to other variables at copy locations, usually resulting in
5966 variable names which more closely resemble the original variables.  This flag
5967 is enabled by default at @option{-O} and higher.
5968
5969 @item -ftree-ter
5970 @opindex ftree-ter
5971 Perform temporary expression replacement during the SSA->normal phase.  Single
5972 use/single def temporaries are replaced at their use location with their
5973 defining expression.  This results in non-GIMPLE code, but gives the expanders
5974 much more complex trees to work on resulting in better RTL generation.  This is
5975 enabled by default at @option{-O} and higher.
5976
5977 @item -ftree-vectorize
5978 @opindex ftree-vectorize
5979 Perform loop vectorization on trees. This flag is enabled by default at
5980 @option{-O3}.
5981
5982 @item -ftree-vect-loop-version
5983 @opindex ftree-vect-loop-version
5984 Perform loop versioning when doing loop vectorization on trees.  When a loop
5985 appears to be vectorizable except that data alignment or data dependence cannot
5986 be determined at compile time then vectorized and non-vectorized versions of
5987 the loop are generated along with runtime checks for alignment or dependence
5988 to control which version is executed.  This option is enabled by default
5989 except at level @option{-Os} where it is disabled.
5990
5991 @item -fvect-cost-model
5992 @opindex fvect-cost-model
5993 Enable cost model for vectorization.
5994
5995 @item -ftree-vrp
5996 @opindex ftree-vrp
5997 Perform Value Range Propagation on trees.  This is similar to the
5998 constant propagation pass, but instead of values, ranges of values are
5999 propagated.  This allows the optimizers to remove unnecessary range
6000 checks like array bound checks and null pointer checks.  This is
6001 enabled by default at @option{-O2} and higher.  Null pointer check
6002 elimination is only done if @option{-fdelete-null-pointer-checks} is
6003 enabled.
6004
6005 @item -ftracer
6006 @opindex ftracer
6007 Perform tail duplication to enlarge superblock size.  This transformation
6008 simplifies the control flow of the function allowing other optimizations to do
6009 better job.
6010
6011 @item -funroll-loops
6012 @opindex funroll-loops
6013 Unroll loops whose number of iterations can be determined at compile
6014 time or upon entry to the loop.  @option{-funroll-loops} implies
6015 @option{-frerun-cse-after-loop}.  This option makes code larger,
6016 and may or may not make it run faster.
6017
6018 @item -funroll-all-loops
6019 @opindex funroll-all-loops
6020 Unroll all loops, even if their number of iterations is uncertain when
6021 the loop is entered.  This usually makes programs run more slowly.
6022 @option{-funroll-all-loops} implies the same options as
6023 @option{-funroll-loops},
6024
6025 @item -fsplit-ivs-in-unroller
6026 @opindex fsplit-ivs-in-unroller
6027 Enables expressing of values of induction variables in later iterations
6028 of the unrolled loop using the value in the first iteration.  This breaks
6029 long dependency chains, thus improving efficiency of the scheduling passes.
6030
6031 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6032 same effect.  However in cases the loop body is more complicated than
6033 a single basic block, this is not reliable.  It also does not work at all
6034 on some of the architectures due to restrictions in the CSE pass.
6035
6036 This optimization is enabled by default.
6037
6038 @item -fvariable-expansion-in-unroller
6039 @opindex fvariable-expansion-in-unroller
6040 With this option, the compiler will create multiple copies of some
6041 local variables when unrolling a loop which can result in superior code.
6042
6043 @item -fpredictive-commoning
6044 @opindex fpredictive-commoning
6045 Perform predictive commoning optimization, i.e., reusing computations
6046 (especially memory loads and stores) performed in previous
6047 iterations of loops.
6048
6049 This option is enabled at level @option{-O3}.
6050
6051 @item -fprefetch-loop-arrays
6052 @opindex fprefetch-loop-arrays
6053 If supported by the target machine, generate instructions to prefetch
6054 memory to improve the performance of loops that access large arrays.
6055
6056 This option may generate better or worse code; results are highly
6057 dependent on the structure of loops within the source code.
6058
6059 Disabled at level @option{-Os}.
6060
6061 @item -fno-peephole
6062 @itemx -fno-peephole2
6063 @opindex fno-peephole
6064 @opindex fno-peephole2
6065 Disable any machine-specific peephole optimizations.  The difference
6066 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6067 are implemented in the compiler; some targets use one, some use the
6068 other, a few use both.
6069
6070 @option{-fpeephole} is enabled by default.
6071 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6072
6073 @item -fno-guess-branch-probability
6074 @opindex fno-guess-branch-probability
6075 Do not guess branch probabilities using heuristics.
6076
6077 GCC will use heuristics to guess branch probabilities if they are
6078 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6079 heuristics are based on the control flow graph.  If some branch probabilities
6080 are specified by @samp{__builtin_expect}, then the heuristics will be
6081 used to guess branch probabilities for the rest of the control flow graph,
6082 taking the @samp{__builtin_expect} info into account.  The interactions
6083 between the heuristics and @samp{__builtin_expect} can be complex, and in
6084 some cases, it may be useful to disable the heuristics so that the effects
6085 of @samp{__builtin_expect} are easier to understand.
6086
6087 The default is @option{-fguess-branch-probability} at levels
6088 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6089
6090 @item -freorder-blocks
6091 @opindex freorder-blocks
6092 Reorder basic blocks in the compiled function in order to reduce number of
6093 taken branches and improve code locality.
6094
6095 Enabled at levels @option{-O2}, @option{-O3}.
6096
6097 @item -freorder-blocks-and-partition
6098 @opindex freorder-blocks-and-partition
6099 In addition to reordering basic blocks in the compiled function, in order
6100 to reduce number of taken branches, partitions hot and cold basic blocks
6101 into separate sections of the assembly and .o files, to improve
6102 paging and cache locality performance.
6103
6104 This optimization is automatically turned off in the presence of
6105 exception handling, for linkonce sections, for functions with a user-defined
6106 section attribute and on any architecture that does not support named
6107 sections.
6108
6109 @item -freorder-functions
6110 @opindex freorder-functions
6111 Reorder functions in the object file in order to
6112 improve code locality.  This is implemented by using special
6113 subsections @code{.text.hot} for most frequently executed functions and
6114 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6115 the linker so object file format must support named sections and linker must
6116 place them in a reasonable way.
6117
6118 Also profile feedback must be available in to make this option effective.  See
6119 @option{-fprofile-arcs} for details.
6120
6121 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6122
6123 @item -fstrict-aliasing
6124 @opindex fstrict-aliasing
6125 Allows the compiler to assume the strictest aliasing rules applicable to
6126 the language being compiled.  For C (and C++), this activates
6127 optimizations based on the type of expressions.  In particular, an
6128 object of one type is assumed never to reside at the same address as an
6129 object of a different type, unless the types are almost the same.  For
6130 example, an @code{unsigned int} can alias an @code{int}, but not a
6131 @code{void*} or a @code{double}.  A character type may alias any other
6132 type.
6133
6134 Pay special attention to code like this:
6135 @smallexample
6136 union a_union @{
6137   int i;
6138   double d;
6139 @};
6140
6141 int f() @{
6142   a_union t;
6143   t.d = 3.0;
6144   return t.i;
6145 @}
6146 @end smallexample
6147 The practice of reading from a different union member than the one most
6148 recently written to (called ``type-punning'') is common.  Even with
6149 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6150 is accessed through the union type.  So, the code above will work as
6151 expected.  However, this code might not:
6152 @smallexample
6153 int f() @{
6154   a_union t;
6155   int* ip;
6156   t.d = 3.0;
6157   ip = &t.i;
6158   return *ip;
6159 @}
6160 @end smallexample
6161
6162 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6163
6164 @item -fstrict-overflow
6165 @opindex fstrict-overflow
6166 Allow the compiler to assume strict signed overflow rules, depending
6167 on the language being compiled.  For C (and C++) this means that
6168 overflow when doing arithmetic with signed numbers is undefined, which
6169 means that the compiler may assume that it will not happen.  This
6170 permits various optimizations.  For example, the compiler will assume
6171 that an expression like @code{i + 10 > i} will always be true for
6172 signed @code{i}.  This assumption is only valid if signed overflow is
6173 undefined, as the expression is false if @code{i + 10} overflows when
6174 using twos complement arithmetic.  When this option is in effect any
6175 attempt to determine whether an operation on signed numbers will
6176 overflow must be written carefully to not actually involve overflow.
6177
6178 This option also allows the compiler to assume strict pointer
6179 semantics: given a pointer to an object, if adding an offset to that
6180 pointer does not produce a pointer to the same object, the addition is
6181 undefined.  This permits the compiler to conclude that @code{p + u >
6182 p} is always true for a pointer @code{p} and unsigned integer
6183 @code{u}.  This assumption is only valid because pointer wraparound is
6184 undefined, as the expression is false if @code{p + u} overflows using
6185 twos complement arithmetic.
6186
6187 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6188 that integer signed overflow is fully defined: it wraps.  When
6189 @option{-fwrapv} is used, there is no difference between
6190 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
6191 integers.  With @option{-fwrapv} certain types of overflow are
6192 permitted.  For example, if the compiler gets an overflow when doing
6193 arithmetic on constants, the overflowed value can still be used with
6194 @option{-fwrapv}, but not otherwise.
6195
6196 The @option{-fstrict-overflow} option is enabled at levels
6197 @option{-O2}, @option{-O3}, @option{-Os}.
6198
6199 @item -falign-functions
6200 @itemx -falign-functions=@var{n}
6201 @opindex falign-functions
6202 Align the start of functions to the next power-of-two greater than
6203 @var{n}, skipping up to @var{n} bytes.  For instance,
6204 @option{-falign-functions=32} aligns functions to the next 32-byte
6205 boundary, but @option{-falign-functions=24} would align to the next
6206 32-byte boundary only if this can be done by skipping 23 bytes or less.
6207
6208 @option{-fno-align-functions} and @option{-falign-functions=1} are
6209 equivalent and mean that functions will not be aligned.
6210
6211 Some assemblers only support this flag when @var{n} is a power of two;
6212 in that case, it is rounded up.
6213
6214 If @var{n} is not specified or is zero, use a machine-dependent default.
6215
6216 Enabled at levels @option{-O2}, @option{-O3}.
6217
6218 @item -falign-labels
6219 @itemx -falign-labels=@var{n}
6220 @opindex falign-labels
6221 Align all branch targets to a power-of-two boundary, skipping up to
6222 @var{n} bytes like @option{-falign-functions}.  This option can easily
6223 make code slower, because it must insert dummy operations for when the
6224 branch target is reached in the usual flow of the code.
6225
6226 @option{-fno-align-labels} and @option{-falign-labels=1} are
6227 equivalent and mean that labels will not be aligned.
6228
6229 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6230 are greater than this value, then their values are used instead.
6231
6232 If @var{n} is not specified or is zero, use a machine-dependent default
6233 which is very likely to be @samp{1}, meaning no alignment.
6234
6235 Enabled at levels @option{-O2}, @option{-O3}.
6236
6237 @item -falign-loops
6238 @itemx -falign-loops=@var{n}
6239 @opindex falign-loops
6240 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6241 like @option{-falign-functions}.  The hope is that the loop will be
6242 executed many times, which will make up for any execution of the dummy
6243 operations.
6244
6245 @option{-fno-align-loops} and @option{-falign-loops=1} are
6246 equivalent and mean that loops will not be aligned.
6247
6248 If @var{n} is not specified or is zero, use a machine-dependent default.
6249
6250 Enabled at levels @option{-O2}, @option{-O3}.
6251
6252 @item -falign-jumps
6253 @itemx -falign-jumps=@var{n}
6254 @opindex falign-jumps
6255 Align branch targets to a power-of-two boundary, for branch targets
6256 where the targets can only be reached by jumping, skipping up to @var{n}
6257 bytes like @option{-falign-functions}.  In this case, no dummy operations
6258 need be executed.
6259
6260 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6261 equivalent and mean that loops will not be aligned.
6262
6263 If @var{n} is not specified or is zero, use a machine-dependent default.
6264
6265 Enabled at levels @option{-O2}, @option{-O3}.
6266
6267 @item -funit-at-a-time
6268 @opindex funit-at-a-time
6269 Parse the whole compilation unit before starting to produce code.
6270 This allows some extra optimizations to take place but consumes
6271 more memory (in general).  There are some compatibility issues
6272 with @emph{unit-at-a-time} mode:
6273 @itemize @bullet
6274 @item
6275 enabling @emph{unit-at-a-time} mode may change the order
6276 in which functions, variables, and top-level @code{asm} statements
6277 are emitted, and will likely break code relying on some particular
6278 ordering.  The majority of such top-level @code{asm} statements,
6279 though, can be replaced by @code{section} attributes.  The
6280 @option{fno-toplevel-reorder} option may be used to keep the ordering
6281 used in the input file, at the cost of some optimizations.
6282
6283 @item
6284 @emph{unit-at-a-time} mode removes unreferenced static variables
6285 and functions.  This may result in undefined references
6286 when an @code{asm} statement refers directly to variables or functions
6287 that are otherwise unused.  In that case either the variable/function
6288 shall be listed as an operand of the @code{asm} statement operand or,
6289 in the case of top-level @code{asm} statements the attribute @code{used}
6290 shall be used on the declaration.
6291
6292 @item
6293 Static functions now can use non-standard passing conventions that
6294 may break @code{asm} statements calling functions directly.  Again,
6295 attribute @code{used} will prevent this behavior.
6296 @end itemize
6297
6298 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
6299 but this scheme may not be supported by future releases of GCC@.
6300
6301 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6302
6303 @item -fno-toplevel-reorder
6304 @opindex fno-toplevel-reorder
6305 Do not reorder top-level functions, variables, and @code{asm}
6306 statements.  Output them in the same order that they appear in the
6307 input file.  When this option is used, unreferenced static variables
6308 will not be removed.  This option is intended to support existing code
6309 which relies on a particular ordering.  For new code, it is better to
6310 use attributes.
6311
6312 @item -fweb
6313 @opindex fweb
6314 Constructs webs as commonly used for register allocation purposes and assign
6315 each web individual pseudo register.  This allows the register allocation pass
6316 to operate on pseudos directly, but also strengthens several other optimization
6317 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6318 however, make debugging impossible, since variables will no longer stay in a
6319 ``home register''.
6320
6321 Enabled by default with @option{-funroll-loops}.
6322
6323 @item -fwhole-program
6324 @opindex fwhole-program
6325 Assume that the current compilation unit represents whole program being
6326 compiled.  All public functions and variables with the exception of @code{main}
6327 and those merged by attribute @code{externally_visible} become static functions
6328 and in a affect gets more aggressively optimized by interprocedural optimizers.
6329 While this option is equivalent to proper use of @code{static} keyword for
6330 programs consisting of single file, in combination with option
6331 @option{--combine} this flag can be used to compile most of smaller scale C
6332 programs since the functions and variables become local for the whole combined
6333 compilation unit, not for the single source file itself.
6334
6335 This option is not supported for Fortran programs.
6336
6337 @item -fcprop-registers
6338 @opindex fcprop-registers
6339 After register allocation and post-register allocation instruction splitting,
6340 we perform a copy-propagation pass to try to reduce scheduling dependencies
6341 and occasionally eliminate the copy.
6342
6343 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6344
6345 @item -fprofile-dir=@var{path}
6346 @opindex fprofile-dir
6347
6348 Set the directory to search the profile data files in to @var{path}.
6349 This option affects only the profile data generated by
6350 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
6351 and used by @option{-fprofile-use} and @option{-fbranch-probabilities} 
6352 and its related options.
6353 By default, GCC will use the current directory as @var{path}
6354 thus the profile data file will appear in the same directory as the object file.
6355
6356 @item -fprofile-generate
6357 @itemx -fprofile-generate=@var{path}
6358 @opindex fprofile-generate
6359
6360 Enable options usually used for instrumenting application to produce
6361 profile useful for later recompilation with profile feedback based
6362 optimization.  You must use @option{-fprofile-generate} both when
6363 compiling and when linking your program.
6364
6365 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6366
6367 If @var{path} is specified, GCC will look at the @var{path} to find
6368 the profile feeedback data files. See @option{-fprofile-dir}.
6369
6370 @item -fprofile-use
6371 @itemx -fprofile-use=@var{path}
6372 @opindex fprofile-use
6373 Enable profile feedback directed optimizations, and optimizations
6374 generally profitable only with profile feedback available.
6375
6376 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6377 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6378
6379 By default, GCC emits an error message if the feedback profiles do not
6380 match the source code.  This error can be turned into a warning by using
6381 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6382 code.
6383
6384 If @var{path} is specified, GCC will look at the @var{path} to find
6385 the profile feedback data files. See @option{-fprofile-dir}.
6386 @end table
6387
6388 The following options control compiler behavior regarding floating
6389 point arithmetic.  These options trade off between speed and
6390 correctness.  All must be specifically enabled.
6391
6392 @table @gcctabopt
6393 @item -ffloat-store
6394 @opindex ffloat-store
6395 Do not store floating point variables in registers, and inhibit other
6396 options that might change whether a floating point value is taken from a
6397 register or memory.
6398
6399 @cindex floating point precision
6400 This option prevents undesirable excess precision on machines such as
6401 the 68000 where the floating registers (of the 68881) keep more
6402 precision than a @code{double} is supposed to have.  Similarly for the
6403 x86 architecture.  For most programs, the excess precision does only
6404 good, but a few programs rely on the precise definition of IEEE floating
6405 point.  Use @option{-ffloat-store} for such programs, after modifying
6406 them to store all pertinent intermediate computations into variables.
6407
6408 @item -ffast-math
6409 @opindex ffast-math
6410 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
6411 @option{-ffinite-math-only}, @option{-fno-rounding-math},
6412 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
6413
6414 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6415
6416 This option is not turned on by any @option{-O} option since
6417 it can result in incorrect output for programs which depend on
6418 an exact implementation of IEEE or ISO rules/specifications for
6419 math functions. It may, however, yield faster code for programs
6420 that do not require the guarantees of these specifications.
6421
6422 @item -fno-math-errno
6423 @opindex fno-math-errno
6424 Do not set ERRNO after calling math functions that are executed
6425 with a single instruction, e.g., sqrt.  A program that relies on
6426 IEEE exceptions for math error handling may want to use this flag
6427 for speed while maintaining IEEE arithmetic compatibility.
6428
6429 This option is not turned on by any @option{-O} option since
6430 it can result in incorrect output for programs which depend on
6431 an exact implementation of IEEE or ISO rules/specifications for
6432 math functions. It may, however, yield faster code for programs
6433 that do not require the guarantees of these specifications.
6434
6435 The default is @option{-fmath-errno}.
6436
6437 On Darwin systems, the math library never sets @code{errno}.  There is
6438 therefore no reason for the compiler to consider the possibility that
6439 it might, and @option{-fno-math-errno} is the default.
6440
6441 @item -funsafe-math-optimizations
6442 @opindex funsafe-math-optimizations
6443
6444 Allow optimizations for floating-point arithmetic that (a) assume
6445 that arguments and results are valid and (b) may violate IEEE or
6446 ANSI standards.  When used at link-time, it may include libraries
6447 or startup files that change the default FPU control word or other
6448 similar optimizations.
6449
6450 This option is not turned on by any @option{-O} option since
6451 it can result in incorrect output for programs which depend on
6452 an exact implementation of IEEE or ISO rules/specifications for
6453 math functions. It may, however, yield faster code for programs
6454 that do not require the guarantees of these specifications.
6455 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
6456 @option{-fassociative-math} and @option{-freciprocal-math}.
6457
6458 The default is @option{-fno-unsafe-math-optimizations}.
6459
6460 @item -fassociative-math
6461 @opindex fassociative-math
6462
6463 Allow re-association of operands in series of floating-point operations.
6464 This violates the ISO C and C++ language standard by possibly changing
6465 computation result.  NOTE: re-ordering may change the sign of zero as
6466 well as ignore NaNs and inhibit or create underflow or overflow (and
6467 thus cannot be used on a code which relies on rounding behavior like
6468 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
6469 and thus may not be used when ordered comparisons are required.
6470 This option requires that both @option{-fno-signed-zeros} and
6471 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
6472 much sense with @option{-frounding-math}.
6473
6474 The default is @option{-fno-associative-math}.
6475
6476 @item -freciprocal-math
6477 @opindex freciprocal-math
6478
6479 Allow the reciprocal of a value to be used instead of dividing by
6480 the value if this enables optimizations.  For example @code{x / y}
6481 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
6482 is subject to common subexpression elimination.  Note that this loses
6483 precision and increases the number of flops operating on the value.
6484
6485 The default is @option{-fno-reciprocal-math}.
6486
6487 @item -ffinite-math-only
6488 @opindex ffinite-math-only
6489 Allow optimizations for floating-point arithmetic that assume
6490 that arguments and results are not NaNs or +-Infs.
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
6498 The default is @option{-fno-finite-math-only}.
6499
6500 @item -fno-signed-zeros
6501 @opindex fno-signed-zeros
6502 Allow optimizations for floating point arithmetic that ignore the
6503 signedness of zero.  IEEE arithmetic specifies the behavior of
6504 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6505 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6506 This option implies that the sign of a zero result isn't significant.
6507
6508 The default is @option{-fsigned-zeros}.
6509
6510 @item -fno-trapping-math
6511 @opindex fno-trapping-math
6512 Compile code assuming that floating-point operations cannot generate
6513 user-visible traps.  These traps include division by zero, overflow,
6514 underflow, inexact result and invalid operation.  This option requires
6515 that @option{-fno-signaling-nans} be in effect.  Setting this option may
6516 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
6517
6518 This option should never be turned on by any @option{-O} option since
6519 it can result in incorrect output for programs which depend on
6520 an exact implementation of IEEE or ISO rules/specifications for
6521 math functions.
6522
6523 The default is @option{-ftrapping-math}.
6524
6525 @item -frounding-math
6526 @opindex frounding-math
6527 Disable transformations and optimizations that assume default floating
6528 point rounding behavior.  This is round-to-zero for all floating point
6529 to integer conversions, and round-to-nearest for all other arithmetic
6530 truncations.  This option should be specified for programs that change
6531 the FP rounding mode dynamically, or that may be executed with a
6532 non-default rounding mode.  This option disables constant folding of
6533 floating point expressions at compile-time (which may be affected by
6534 rounding mode) and arithmetic transformations that are unsafe in the
6535 presence of sign-dependent rounding modes.
6536
6537 The default is @option{-fno-rounding-math}.
6538
6539 This option is experimental and does not currently guarantee to
6540 disable all GCC optimizations that are affected by rounding mode.
6541 Future versions of GCC may provide finer control of this setting
6542 using C99's @code{FENV_ACCESS} pragma.  This command line option
6543 will be used to specify the default state for @code{FENV_ACCESS}.
6544
6545 @item -frtl-abstract-sequences
6546 @opindex frtl-abstract-sequences
6547 It is a size optimization method. This option is to find identical
6548 sequences of code, which can be turned into pseudo-procedures  and
6549 then  replace  all  occurrences with  calls to  the  newly created
6550 subroutine. It is kind of an opposite of @option{-finline-functions}.
6551 This optimization runs at RTL level.
6552
6553 @item -fsignaling-nans
6554 @opindex fsignaling-nans
6555 Compile code assuming that IEEE signaling NaNs may generate user-visible
6556 traps during floating-point operations.  Setting this option disables
6557 optimizations that may change the number of exceptions visible with
6558 signaling NaNs.  This option implies @option{-ftrapping-math}.
6559
6560 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6561 be defined.
6562
6563 The default is @option{-fno-signaling-nans}.
6564
6565 This option is experimental and does not currently guarantee to
6566 disable all GCC optimizations that affect signaling NaN behavior.
6567
6568 @item -fsingle-precision-constant
6569 @opindex fsingle-precision-constant
6570 Treat floating point constant as single precision constant instead of
6571 implicitly converting it to double precision constant.
6572
6573 @item -fcx-limited-range
6574 @opindex fcx-limited-range
6575 When enabled, this option states that a range reduction step is not
6576 needed when performing complex division.  Also, there is no checking
6577 whether the result of a complex multiplication or division is @code{NaN
6578 + I*NaN}, with an attempt to rescue the situation in that case.  The
6579 default is @option{-fno-cx-limited-range}, but is enabled by
6580 @option{-ffast-math}.
6581
6582 This option controls the default setting of the ISO C99
6583 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6584 all languages.
6585
6586 @item -fcx-fortran-rules
6587 @opindex fcx-fortran-rules
6588 Complex multiplication and division follow Fortran rules.  Range
6589 reduction is done as part of complex division, but there is no checking
6590 whether the result of a complex multiplication or division is @code{NaN
6591 + I*NaN}, with an attempt to rescue the situation in that case.
6592
6593 The default is @option{-fno-cx-fortran-rules}.
6594
6595 @end table
6596
6597 The following options control optimizations that may improve
6598 performance, but are not enabled by any @option{-O} options.  This
6599 section includes experimental options that may produce broken code.
6600
6601 @table @gcctabopt
6602 @item -fbranch-probabilities
6603 @opindex fbranch-probabilities
6604 After running a program compiled with @option{-fprofile-arcs}
6605 (@pxref{Debugging Options,, Options for Debugging Your Program or
6606 @command{gcc}}), you can compile it a second time using
6607 @option{-fbranch-probabilities}, to improve optimizations based on
6608 the number of times each branch was taken.  When the program
6609 compiled with @option{-fprofile-arcs} exits it saves arc execution
6610 counts to a file called @file{@var{sourcename}.gcda} for each source
6611 file.  The information in this data file is very dependent on the
6612 structure of the generated code, so you must use the same source code
6613 and the same optimization options for both compilations.
6614
6615 With @option{-fbranch-probabilities}, GCC puts a
6616 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6617 These can be used to improve optimization.  Currently, they are only
6618 used in one place: in @file{reorg.c}, instead of guessing which path a
6619 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6620 exactly determine which path is taken more often.
6621
6622 @item -fprofile-values
6623 @opindex fprofile-values
6624 If combined with @option{-fprofile-arcs}, it adds code so that some
6625 data about values of expressions in the program is gathered.
6626
6627 With @option{-fbranch-probabilities}, it reads back the data gathered
6628 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6629 notes to instructions for their later usage in optimizations.
6630
6631 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6632
6633 @item -fvpt
6634 @opindex fvpt
6635 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
6636 a code to gather information about values of expressions.
6637
6638 With @option{-fbranch-probabilities}, it reads back the data gathered
6639 and actually performs the optimizations based on them.
6640 Currently the optimizations include specialization of division operation
6641 using the knowledge about the value of the denominator.
6642
6643 @item -frename-registers
6644 @opindex frename-registers
6645 Attempt to avoid false dependencies in scheduled code by making use
6646 of registers left over after register allocation.  This optimization
6647 will most benefit processors with lots of registers.  Depending on the
6648 debug information format adopted by the target, however, it can
6649 make debugging impossible, since variables will no longer stay in
6650 a ``home register''.
6651
6652 Enabled by default with @option{-funroll-loops}.
6653
6654 @item -ftracer
6655 @opindex ftracer
6656 Perform tail duplication to enlarge superblock size.  This transformation
6657 simplifies the control flow of the function allowing other optimizations to do
6658 better job.
6659
6660 Enabled with @option{-fprofile-use}.
6661
6662 @item -funroll-loops
6663 @opindex funroll-loops
6664 Unroll loops whose number of iterations can be determined at compile time or
6665 upon entry to the loop.  @option{-funroll-loops} implies
6666 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
6667 It also turns on complete loop peeling (i.e.@: complete removal of loops with
6668 small constant number of iterations).  This option makes code larger, and may
6669 or may not make it run faster.
6670
6671 Enabled with @option{-fprofile-use}.
6672
6673 @item -funroll-all-loops
6674 @opindex funroll-all-loops
6675 Unroll all loops, even if their number of iterations is uncertain when
6676 the loop is entered.  This usually makes programs run more slowly.
6677 @option{-funroll-all-loops} implies the same options as
6678 @option{-funroll-loops}.
6679
6680 @item -fpeel-loops
6681 @opindex fpeel-loops
6682 Peels the loops for that there is enough information that they do not
6683 roll much (from profile feedback).  It also turns on complete loop peeling
6684 (i.e.@: complete removal of loops with small constant number of iterations).
6685
6686 Enabled with @option{-fprofile-use}.
6687
6688 @item -fmove-loop-invariants
6689 @opindex fmove-loop-invariants
6690 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
6691 at level @option{-O1}
6692
6693 @item -funswitch-loops
6694 @opindex funswitch-loops
6695 Move branches with loop invariant conditions out of the loop, with duplicates
6696 of the loop on both branches (modified according to result of the condition).
6697
6698 @item -ffunction-sections
6699 @itemx -fdata-sections
6700 @opindex ffunction-sections
6701 @opindex fdata-sections
6702 Place each function or data item into its own section in the output
6703 file if the target supports arbitrary sections.  The name of the
6704 function or the name of the data item determines the section's name
6705 in the output file.
6706
6707 Use these options on systems where the linker can perform optimizations
6708 to improve locality of reference in the instruction space.  Most systems
6709 using the ELF object format and SPARC processors running Solaris 2 have
6710 linkers with such optimizations.  AIX may have these optimizations in
6711 the future.
6712
6713 Only use these options when there are significant benefits from doing
6714 so.  When you specify these options, the assembler and linker will
6715 create larger object and executable files and will also be slower.
6716 You will not be able to use @code{gprof} on all systems if you
6717 specify this option and you may have problems with debugging if
6718 you specify both this option and @option{-g}.
6719
6720 @item -fbranch-target-load-optimize
6721 @opindex fbranch-target-load-optimize
6722 Perform branch target register load optimization before prologue / epilogue
6723 threading.
6724 The use of target registers can typically be exposed only during reload,
6725 thus hoisting loads out of loops and doing inter-block scheduling needs
6726 a separate optimization pass.
6727
6728 @item -fbranch-target-load-optimize2
6729 @opindex fbranch-target-load-optimize2
6730 Perform branch target register load optimization after prologue / epilogue
6731 threading.
6732
6733 @item -fbtr-bb-exclusive
6734 @opindex fbtr-bb-exclusive
6735 When performing branch target register load optimization, don't reuse
6736 branch target registers in within any basic block.
6737
6738 @item -fstack-protector
6739 @opindex fstack-protector
6740 Emit extra code to check for buffer overflows, such as stack smashing
6741 attacks.  This is done by adding a guard variable to functions with
6742 vulnerable objects.  This includes functions that call alloca, and
6743 functions with buffers larger than 8 bytes.  The guards are initialized
6744 when a function is entered and then checked when the function exits.
6745 If a guard check fails, an error message is printed and the program exits.
6746
6747 @item -fstack-protector-all
6748 @opindex fstack-protector-all
6749 Like @option{-fstack-protector} except that all functions are protected.
6750
6751 @item -fsection-anchors
6752 @opindex fsection-anchors
6753 Try to reduce the number of symbolic address calculations by using
6754 shared ``anchor'' symbols to address nearby objects.  This transformation
6755 can help to reduce the number of GOT entries and GOT accesses on some
6756 targets.
6757
6758 For example, the implementation of the following function @code{foo}:
6759
6760 @smallexample
6761 static int a, b, c;
6762 int foo (void) @{ return a + b + c; @}
6763 @end smallexample
6764
6765 would usually calculate the addresses of all three variables, but if you
6766 compile it with @option{-fsection-anchors}, it will access the variables
6767 from a common anchor point instead.  The effect is similar to the
6768 following pseudocode (which isn't valid C):
6769
6770 @smallexample
6771 int foo (void)
6772 @{
6773   register int *xr = &x;
6774   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6775 @}
6776 @end smallexample
6777
6778 Not all targets support this option.
6779
6780 @item --param @var{name}=@var{value}
6781 @opindex param
6782 In some places, GCC uses various constants to control the amount of
6783 optimization that is done.  For example, GCC will not inline functions
6784 that contain more that a certain number of instructions.  You can
6785 control some of these constants on the command-line using the
6786 @option{--param} option.
6787
6788 The names of specific parameters, and the meaning of the values, are
6789 tied to the internals of the compiler, and are subject to change
6790 without notice in future releases.
6791
6792 In each case, the @var{value} is an integer.  The allowable choices for
6793 @var{name} are given in the following table:
6794
6795 @table @gcctabopt
6796 @item salias-max-implicit-fields
6797 The maximum number of fields in a variable without direct
6798 structure accesses for which structure aliasing will consider trying
6799 to track each field.  The default is 5
6800
6801 @item salias-max-array-elements
6802 The maximum number of elements an array can have and its elements
6803 still be tracked individually by structure aliasing. The default is 4
6804
6805 @item sra-max-structure-size
6806 The maximum structure size, in bytes, at which the scalar replacement
6807 of aggregates (SRA) optimization will perform block copies.  The
6808 default value, 0, implies that GCC will select the most appropriate
6809 size itself.
6810
6811 @item sra-field-structure-ratio
6812 The threshold ratio (as a percentage) between instantiated fields and
6813 the complete structure size.  We say that if the ratio of the number
6814 of bytes in instantiated fields to the number of bytes in the complete
6815 structure exceeds this parameter, then block copies are not used.  The
6816 default is 75.
6817
6818 @item struct-reorg-cold-struct-ratio
6819 The threshold ratio (as a percentage) between a structure frequency
6820 and the frequency of the hottest structure in the program.  This parameter
6821 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
6822 We say that if the ratio of a structure frequency, calculated by profiling, 
6823 to the hottest structure frequency in the program is less than this 
6824 parameter, then structure reorganization is not applied to this structure.
6825 The default is 10.
6826
6827 @item max-crossjump-edges
6828 The maximum number of incoming edges to consider for crossjumping.
6829 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6830 the number of edges incoming to each block.  Increasing values mean
6831 more aggressive optimization, making the compile time increase with
6832 probably small improvement in executable size.
6833
6834 @item min-crossjump-insns
6835 The minimum number of instructions which must be matched at the end
6836 of two blocks before crossjumping will be performed on them.  This
6837 value is ignored in the case where all instructions in the block being
6838 crossjumped from are matched.  The default value is 5.
6839
6840 @item max-grow-copy-bb-insns
6841 The maximum code size expansion factor when copying basic blocks
6842 instead of jumping.  The expansion is relative to a jump instruction.
6843 The default value is 8.
6844
6845 @item max-goto-duplication-insns
6846 The maximum number of instructions to duplicate to a block that jumps
6847 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6848 passes, GCC factors computed gotos early in the compilation process,
6849 and unfactors them as late as possible.  Only computed jumps at the
6850 end of a basic blocks with no more than max-goto-duplication-insns are
6851 unfactored.  The default value is 8.
6852
6853 @item max-delay-slot-insn-search
6854 The maximum number of instructions to consider when looking for an
6855 instruction to fill a delay slot.  If more than this arbitrary number of
6856 instructions is searched, the time savings from filling the delay slot
6857 will be minimal so stop searching.  Increasing values mean more
6858 aggressive optimization, making the compile time increase with probably
6859 small improvement in executable run time.
6860
6861 @item max-delay-slot-live-search
6862 When trying to fill delay slots, the maximum number of instructions to
6863 consider when searching for a block with valid live register
6864 information.  Increasing this arbitrarily chosen value means more
6865 aggressive optimization, increasing the compile time.  This parameter
6866 should be removed when the delay slot code is rewritten to maintain the
6867 control-flow graph.
6868
6869 @item max-gcse-memory
6870 The approximate maximum amount of memory that will be allocated in
6871 order to perform the global common subexpression elimination
6872 optimization.  If more memory than specified is required, the
6873 optimization will not be done.
6874
6875 @item max-gcse-passes
6876 The maximum number of passes of GCSE to run.  The default is 1.
6877
6878 @item max-pending-list-length
6879 The maximum number of pending dependencies scheduling will allow
6880 before flushing the current state and starting over.  Large functions
6881 with few branches or calls can create excessively large lists which
6882 needlessly consume memory and resources.
6883
6884 @item max-inline-insns-single
6885 Several parameters control the tree inliner used in gcc.
6886 This number sets the maximum number of instructions (counted in GCC's
6887 internal representation) in a single function that the tree inliner
6888 will consider for inlining.  This only affects functions declared
6889 inline and methods implemented in a class declaration (C++).
6890 The default value is 450.
6891
6892 @item max-inline-insns-auto
6893 When you use @option{-finline-functions} (included in @option{-O3}),
6894 a lot of functions that would otherwise not be considered for inlining
6895 by the compiler will be investigated.  To those functions, a different
6896 (more restrictive) limit compared to functions declared inline can
6897 be applied.
6898 The default value is 90.
6899
6900 @item large-function-insns
6901 The limit specifying really large functions.  For functions larger than this
6902 limit after inlining inlining is constrained by
6903 @option{--param large-function-growth}.  This parameter is useful primarily
6904 to avoid extreme compilation time caused by non-linear algorithms used by the
6905 backend.
6906 This parameter is ignored when @option{-funit-at-a-time} is not used.
6907 The default value is 2700.
6908
6909 @item large-function-growth
6910 Specifies maximal growth of large function caused by inlining in percents.
6911 This parameter is ignored when @option{-funit-at-a-time} is not used.
6912 The default value is 100 which limits large function growth to 2.0 times
6913 the original size.
6914
6915 @item large-unit-insns
6916 The limit specifying large translation unit.  Growth caused by inlining of
6917 units larger than this limit is limited by @option{--param inline-unit-growth}.
6918 For small units this might be too tight (consider unit consisting of function A
6919 that is inline and B that just calls A three time.  If B is small relative to
6920 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6921 large units consisting of small inlineable functions however the overall unit
6922 growth limit is needed to avoid exponential explosion of code size.  Thus for
6923 smaller units, the size is increased to @option{--param large-unit-insns}
6924 before applying @option{--param inline-unit-growth}.  The default is 10000
6925
6926 @item inline-unit-growth
6927 Specifies maximal overall growth of the compilation unit caused by inlining.
6928 This parameter is ignored when @option{-funit-at-a-time} is not used.
6929 The default value is 30 which limits unit growth to 1.3 times the original
6930 size.
6931
6932 @item large-stack-frame
6933 The limit specifying large stack frames.  While inlining the algorithm is trying
6934 to not grow past this limit too much.  Default value is 256 bytes.
6935
6936 @item large-stack-frame-growth
6937 Specifies maximal growth of large stack frames caused by inlining in percents.
6938 The default value is 1000 which limits large stack frame growth to 11 times
6939 the original size.
6940
6941 @item max-inline-insns-recursive
6942 @itemx max-inline-insns-recursive-auto
6943 Specifies maximum number of instructions out-of-line copy of self recursive inline
6944 function can grow into by performing recursive inlining.
6945
6946 For functions declared inline @option{--param max-inline-insns-recursive} is
6947 taken into account.  For function not declared inline, recursive inlining
6948 happens only when @option{-finline-functions} (included in @option{-O3}) is
6949 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6950 default value is 450.
6951
6952 @item max-inline-recursive-depth
6953 @itemx max-inline-recursive-depth-auto
6954 Specifies maximum recursion depth used by the recursive inlining.
6955
6956 For functions declared inline @option{--param max-inline-recursive-depth} is
6957 taken into account.  For function not declared inline, recursive inlining
6958 happens only when @option{-finline-functions} (included in @option{-O3}) is
6959 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6960 default value is 8.
6961
6962 @item min-inline-recursive-probability
6963 Recursive inlining is profitable only for function having deep recursion
6964 in average and can hurt for function having little recursion depth by
6965 increasing the prologue size or complexity of function body to other
6966 optimizers.
6967
6968 When profile feedback is available (see @option{-fprofile-generate}) the actual
6969 recursion depth can be guessed from probability that function will recurse via
6970 given call expression.  This parameter limits inlining only to call expression
6971 whose probability exceeds given threshold (in percents).  The default value is
6972 10.
6973
6974 @item inline-call-cost
6975 Specify cost of call instruction relative to simple arithmetics operations
6976 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6977 functions and at the same time increases size of leaf function that is believed to
6978 reduce function size by being inlined.  In effect it increases amount of
6979 inlining for code having large abstraction penalty (many functions that just
6980 pass the arguments to other functions) and decrease inlining for code with low
6981 abstraction penalty.  The default value is 12.
6982
6983 @item min-vect-loop-bound
6984 The minimum number of iterations under which a loop will not get vectorized
6985 when @option{-ftree-vectorize} is used.  The number of iterations after
6986 vectorization needs to be greater than the value specified by this option
6987 to allow vectorization.  The default value is 0.
6988
6989 @item max-unrolled-insns
6990 The maximum number of instructions that a loop should have if that loop
6991 is unrolled, and if the loop is unrolled, it determines how many times
6992 the loop code is unrolled.
6993
6994 @item max-average-unrolled-insns
6995 The maximum number of instructions biased by probabilities of their execution
6996 that a loop should have if that loop is unrolled, and if the loop is unrolled,
6997 it determines how many times the loop code is unrolled.
6998
6999 @item max-unroll-times
7000 The maximum number of unrollings of a single loop.
7001
7002 @item max-peeled-insns
7003 The maximum number of instructions that a loop should have if that loop
7004 is peeled, and if the loop is peeled, it determines how many times
7005 the loop code is peeled.
7006
7007 @item max-peel-times
7008 The maximum number of peelings of a single loop.
7009
7010 @item max-completely-peeled-insns
7011 The maximum number of insns of a completely peeled loop.
7012
7013 @item max-completely-peel-times
7014 The maximum number of iterations of a loop to be suitable for complete peeling.
7015
7016 @item max-unswitch-insns
7017 The maximum number of insns of an unswitched loop.
7018
7019 @item max-unswitch-level
7020 The maximum number of branches unswitched in a single loop.
7021
7022 @item lim-expensive
7023 The minimum cost of an expensive expression in the loop invariant motion.
7024
7025 @item iv-consider-all-candidates-bound
7026 Bound on number of candidates for induction variables below that
7027 all candidates are considered for each use in induction variable
7028 optimizations.  Only the most relevant candidates are considered
7029 if there are more candidates, to avoid quadratic time complexity.
7030
7031 @item iv-max-considered-uses
7032 The induction variable optimizations give up on loops that contain more
7033 induction variable uses.
7034
7035 @item iv-always-prune-cand-set-bound
7036 If number of candidates in the set is smaller than this value,
7037 we always try to remove unnecessary ivs from the set during its
7038 optimization when a new iv is added to the set.
7039
7040 @item scev-max-expr-size
7041 Bound on size of expressions used in the scalar evolutions analyzer.
7042 Large expressions slow the analyzer.
7043
7044 @item omega-max-vars
7045 The maximum number of variables in an Omega constraint system.
7046 The default value is 128.
7047
7048 @item omega-max-geqs
7049 The maximum number of inequalities in an Omega constraint system.
7050 The default value is 256.
7051
7052 @item omega-max-eqs
7053 The maximum number of equalities in an Omega constraint system.
7054 The default value is 128.
7055
7056 @item omega-max-wild-cards
7057 The maximum number of wildcard variables that the Omega solver will
7058 be able to insert.  The default value is 18.
7059
7060 @item omega-hash-table-size
7061 The size of the hash table in the Omega solver.  The default value is
7062 550.
7063
7064 @item omega-max-keys
7065 The maximal number of keys used by the Omega solver.  The default
7066 value is 500.
7067
7068 @item omega-eliminate-redundant-constraints
7069 When set to 1, use expensive methods to eliminate all redundant
7070 constraints.  The default value is 0.
7071
7072 @item vect-max-version-for-alignment-checks
7073 The maximum number of runtime checks that can be performed when
7074 doing loop versioning for alignment in the vectorizer.  See option
7075 ftree-vect-loop-version for more information.
7076
7077 @item vect-max-version-for-alias-checks
7078 The maximum number of runtime checks that can be performed when
7079 doing loop versioning for alias in the vectorizer.  See option
7080 ftree-vect-loop-version for more information.
7081
7082 @item max-iterations-to-track
7083
7084 The maximum number of iterations of a loop the brute force algorithm
7085 for analysis of # of iterations of the loop tries to evaluate.
7086
7087 @item hot-bb-count-fraction
7088 Select fraction of the maximal count of repetitions of basic block in program
7089 given basic block needs to have to be considered hot.
7090
7091 @item hot-bb-frequency-fraction
7092 Select fraction of the maximal frequency of executions of basic block in
7093 function given basic block needs to have to be considered hot
7094
7095 @item max-predicted-iterations
7096 The maximum number of loop iterations we predict statically.  This is useful
7097 in cases where function contain single loop with known bound and other loop
7098 with unknown.  We predict the known number of iterations correctly, while
7099 the unknown number of iterations average to roughly 10.  This means that the
7100 loop without bounds would appear artificially cold relative to the other one.
7101
7102 @item align-threshold
7103
7104 Select fraction of the maximal frequency of executions of basic block in
7105 function given basic block will get aligned.
7106
7107 @item align-loop-iterations
7108
7109 A loop expected to iterate at lest the selected number of iterations will get
7110 aligned.
7111
7112 @item tracer-dynamic-coverage
7113 @itemx tracer-dynamic-coverage-feedback
7114
7115 This value is used to limit superblock formation once the given percentage of
7116 executed instructions is covered.  This limits unnecessary code size
7117 expansion.
7118
7119 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7120 feedback is available.  The real profiles (as opposed to statically estimated
7121 ones) are much less balanced allowing the threshold to be larger value.
7122
7123 @item tracer-max-code-growth
7124 Stop tail duplication once code growth has reached given percentage.  This is
7125 rather hokey argument, as most of the duplicates will be eliminated later in
7126 cross jumping, so it may be set to much higher values than is the desired code
7127 growth.
7128
7129 @item tracer-min-branch-ratio
7130
7131 Stop reverse growth when the reverse probability of best edge is less than this
7132 threshold (in percent).
7133
7134 @item tracer-min-branch-ratio
7135 @itemx tracer-min-branch-ratio-feedback
7136
7137 Stop forward growth if the best edge do have probability lower than this
7138 threshold.
7139
7140 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7141 compilation for profile feedback and one for compilation without.  The value
7142 for compilation with profile feedback needs to be more conservative (higher) in
7143 order to make tracer effective.
7144
7145 @item max-cse-path-length
7146
7147 Maximum number of basic blocks on path that cse considers.  The default is 10.
7148
7149 @item max-cse-insns
7150 The maximum instructions CSE process before flushing. The default is 1000.
7151
7152 @item max-aliased-vops
7153
7154 Maximum number of virtual operands per function allowed to represent
7155 aliases before triggering the alias partitioning heuristic.  Alias
7156 partitioning reduces compile times and memory consumption needed for
7157 aliasing at the expense of precision loss in alias information.  The
7158 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
7159 for -O3.
7160
7161 Notice that if a function contains more memory statements than the
7162 value of this parameter, it is not really possible to achieve this
7163 reduction.  In this case, the compiler will use the number of memory
7164 statements as the value for @option{max-aliased-vops}.
7165
7166 @item avg-aliased-vops
7167
7168 Average number of virtual operands per statement allowed to represent
7169 aliases before triggering the alias partitioning heuristic.  This
7170 works in conjunction with @option{max-aliased-vops}.  If a function
7171 contains more than @option{max-aliased-vops} virtual operators, then
7172 memory symbols will be grouped into memory partitions until either the
7173 total number of virtual operators is below @option{max-aliased-vops}
7174 or the average number of virtual operators per memory statement is
7175 below @option{avg-aliased-vops}.  The default value for this parameter
7176 is 1 for -O1 and -O2, and 3 for -O3.
7177
7178 @item ggc-min-expand
7179
7180 GCC uses a garbage collector to manage its own memory allocation.  This
7181 parameter specifies the minimum percentage by which the garbage
7182 collector's heap should be allowed to expand between collections.
7183 Tuning this may improve compilation speed; it has no effect on code
7184 generation.
7185
7186 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7187 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7188 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7189 GCC is not able to calculate RAM on a particular platform, the lower
7190 bound of 30% is used.  Setting this parameter and
7191 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7192 every opportunity.  This is extremely slow, but can be useful for
7193 debugging.
7194
7195 @item ggc-min-heapsize
7196
7197 Minimum size of the garbage collector's heap before it begins bothering
7198 to collect garbage.  The first collection occurs after the heap expands
7199 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7200 tuning this may improve compilation speed, and has no effect on code
7201 generation.
7202
7203 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7204 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7205 with a lower bound of 4096 (four megabytes) and an upper bound of
7206 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7207 particular platform, the lower bound is used.  Setting this parameter
7208 very large effectively disables garbage collection.  Setting this
7209 parameter and @option{ggc-min-expand} to zero causes a full collection
7210 to occur at every opportunity.
7211
7212 @item max-reload-search-insns
7213 The maximum number of instruction reload should look backward for equivalent
7214 register.  Increasing values mean more aggressive optimization, making the
7215 compile time increase with probably slightly better performance.  The default
7216 value is 100.
7217
7218 @item max-cselib-memory-locations
7219 The maximum number of memory locations cselib should take into account.
7220 Increasing values mean more aggressive optimization, making the compile time
7221 increase with probably slightly better performance.  The default value is 500.
7222
7223 @item max-flow-memory-locations
7224 Similar as @option{max-cselib-memory-locations} but for dataflow liveness.
7225 The default value is 100.
7226
7227 @item reorder-blocks-duplicate
7228 @itemx reorder-blocks-duplicate-feedback
7229
7230 Used by basic block reordering pass to decide whether to use unconditional
7231 branch or duplicate the code on its destination.  Code is duplicated when its
7232 estimated size is smaller than this value multiplied by the estimated size of
7233 unconditional jump in the hot spots of the program.
7234
7235 The @option{reorder-block-duplicate-feedback} is used only when profile
7236 feedback is available and may be set to higher values than
7237 @option{reorder-block-duplicate} since information about the hot spots is more
7238 accurate.
7239
7240 @item max-sched-ready-insns
7241 The maximum number of instructions ready to be issued the scheduler should
7242 consider at any given time during the first scheduling pass.  Increasing
7243 values mean more thorough searches, making the compilation time increase
7244 with probably little benefit.  The default value is 100.
7245
7246 @item max-sched-region-blocks
7247 The maximum number of blocks in a region to be considered for
7248 interblock scheduling.  The default value is 10.
7249
7250 @item max-sched-region-insns
7251 The maximum number of insns in a region to be considered for
7252 interblock scheduling.  The default value is 100.
7253
7254 @item min-spec-prob
7255 The minimum probability (in percents) of reaching a source block
7256 for interblock speculative scheduling.  The default value is 40.
7257
7258 @item max-sched-extend-regions-iters
7259 The maximum number of iterations through CFG to extend regions.
7260 0 - disable region extension,
7261 N - do at most N iterations.
7262 The default value is 0.
7263
7264 @item max-sched-insn-conflict-delay
7265 The maximum conflict delay for an insn to be considered for speculative motion.
7266 The default value is 3.
7267
7268 @item sched-spec-prob-cutoff
7269 The minimal probability of speculation success (in percents), so that
7270 speculative insn will be scheduled.
7271 The default value is 40.
7272
7273 @item max-last-value-rtl
7274
7275 The maximum size measured as number of RTLs that can be recorded in an expression
7276 in combiner for a pseudo register as last known value of that register.  The default
7277 is 10000.
7278
7279 @item integer-share-limit
7280 Small integer constants can use a shared data structure, reducing the
7281 compiler's memory usage and increasing its speed.  This sets the maximum
7282 value of a shared integer constant.  The default value is 256.
7283
7284 @item min-virtual-mappings
7285 Specifies the minimum number of virtual mappings in the incremental
7286 SSA updater that should be registered to trigger the virtual mappings
7287 heuristic defined by virtual-mappings-ratio.  The default value is
7288 100.
7289
7290 @item virtual-mappings-ratio
7291 If the number of virtual mappings is virtual-mappings-ratio bigger
7292 than the number of virtual symbols to be updated, then the incremental
7293 SSA updater switches to a full update for those symbols.  The default
7294 ratio is 3.
7295
7296 @item ssp-buffer-size
7297 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
7298 protection when @option{-fstack-protection} is used.
7299
7300 @item max-jump-thread-duplication-stmts
7301 Maximum number of statements allowed in a block that needs to be
7302 duplicated when threading jumps.
7303
7304 @item max-fields-for-field-sensitive
7305 Maximum number of fields in a structure we will treat in
7306 a field sensitive manner during pointer analysis.
7307
7308 @item prefetch-latency
7309 Estimate on average number of instructions that are executed before
7310 prefetch finishes.  The distance we prefetch ahead is proportional
7311 to this constant.  Increasing this number may also lead to less
7312 streams being prefetched (see @option{simultaneous-prefetches}).
7313
7314 @item simultaneous-prefetches
7315 Maximum number of prefetches that can run at the same time.
7316
7317 @item l1-cache-line-size
7318 The size of cache line in L1 cache, in bytes.
7319
7320 @item l1-cache-size
7321 The size of L1 cache, in kilobytes.
7322
7323 @item l2-cache-size
7324 The size of L2 cache, in kilobytes.
7325
7326 @item use-canonical-types
7327 Whether the compiler should use the ``canonical'' type system.  By
7328 default, this should always be 1, which uses a more efficient internal
7329 mechanism for comparing types in C++ and Objective-C++.  However, if
7330 bugs in the canonical type system are causing compilation failures,
7331 set this value to 0 to disable canonical types.
7332
7333 @item max-partial-antic-length
7334 Maximum length of the partial antic set computed during the tree
7335 partial redundancy elimination optimization (@option{-ftree-pre}) when
7336 optimizing at @option{-O3} and above.  For some sorts of source code
7337 the enhanced partial redundancy elimination optimization can run away,
7338 consuming all of the memory available on the host machine.  This
7339 parameter sets a limit on the length of the sets that are computed,
7340 which prevents the runaway behaviour.  Setting a value of 0 for
7341 this paramter will allow an unlimited set length.
7342
7343 @item sccvn-max-scc-size
7344 Maximum size of a strongly connected component (SCC) during SCCVN
7345 processing.  If this limit is hit, SCCVN processing for the whole
7346 function will not be done and optimizations depending on it will
7347 be disabled.  The default maximum SCC size is 10000.
7348
7349 @end table
7350 @end table
7351
7352 @node Preprocessor Options
7353 @section Options Controlling the Preprocessor
7354 @cindex preprocessor options
7355 @cindex options, preprocessor
7356
7357 These options control the C preprocessor, which is run on each C source
7358 file before actual compilation.
7359
7360 If you use the @option{-E} option, nothing is done except preprocessing.
7361 Some of these options make sense only together with @option{-E} because
7362 they cause the preprocessor output to be unsuitable for actual
7363 compilation.
7364
7365 @table @gcctabopt
7366 @opindex Wp
7367 You can use @option{-Wp,@var{option}} to bypass the compiler driver
7368 and pass @var{option} directly through to the preprocessor.  If
7369 @var{option} contains commas, it is split into multiple options at the
7370 commas.  However, many options are modified, translated or interpreted
7371 by the compiler driver before being passed to the preprocessor, and
7372 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
7373 interface is undocumented and subject to change, so whenever possible
7374 you should avoid using @option{-Wp} and let the driver handle the
7375 options instead.
7376
7377 @item -Xpreprocessor @var{option}
7378 @opindex preprocessor
7379 Pass @var{option} as an option to the preprocessor.  You can use this to
7380 supply system-specific preprocessor options which GCC does not know how to
7381 recognize.
7382
7383 If you want to pass an option that takes an argument, you must use
7384 @option{-Xpreprocessor} twice, once for the option and once for the argument.
7385 @end table
7386
7387 @include cppopts.texi
7388
7389 @node Assembler Options
7390 @section Passing Options to the Assembler
7391
7392 @c prevent bad page break with this line
7393 You can pass options to the assembler.
7394
7395 @table @gcctabopt
7396 @item -Wa,@var{option}
7397 @opindex Wa
7398 Pass @var{option} as an option to the assembler.  If @var{option}
7399 contains commas, it is split into multiple options at the commas.
7400
7401 @item -Xassembler @var{option}
7402 @opindex Xassembler
7403 Pass @var{option} as an option to the assembler.  You can use this to
7404 supply system-specific assembler options which GCC does not know how to
7405 recognize.
7406
7407 If you want to pass an option that takes an argument, you must use
7408 @option{-Xassembler} twice, once for the option and once for the argument.
7409
7410 @end table
7411
7412 @node Link Options
7413 @section Options for Linking
7414 @cindex link options
7415 @cindex options, linking
7416
7417 These options come into play when the compiler links object files into
7418 an executable output file.  They are meaningless if the compiler is
7419 not doing a link step.
7420
7421 @table @gcctabopt
7422 @cindex file names
7423 @item @var{object-file-name}
7424 A file name that does not end in a special recognized suffix is
7425 considered to name an object file or library.  (Object files are
7426 distinguished from libraries by the linker according to the file
7427 contents.)  If linking is done, these object files are used as input
7428 to the linker.
7429
7430 @item -c
7431 @itemx -S
7432 @itemx -E
7433 @opindex c
7434 @opindex S
7435 @opindex E
7436 If any of these options is used, then the linker is not run, and
7437 object file names should not be used as arguments.  @xref{Overall
7438 Options}.
7439
7440 @cindex Libraries
7441 @item -l@var{library}
7442 @itemx -l @var{library}
7443 @opindex l
7444 Search the library named @var{library} when linking.  (The second
7445 alternative with the library as a separate argument is only for
7446 POSIX compliance and is not recommended.)
7447
7448 It makes a difference where in the command you write this option; the
7449 linker searches and processes libraries and object files in the order they
7450 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7451 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7452 to functions in @samp{z}, those functions may not be loaded.
7453
7454 The linker searches a standard list of directories for the library,
7455 which is actually a file named @file{lib@var{library}.a}.  The linker
7456 then uses this file as if it had been specified precisely by name.
7457
7458 The directories searched include several standard system directories
7459 plus any that you specify with @option{-L}.
7460
7461 Normally the files found this way are library files---archive files
7462 whose members are object files.  The linker handles an archive file by
7463 scanning through it for members which define symbols that have so far
7464 been referenced but not defined.  But if the file that is found is an
7465 ordinary object file, it is linked in the usual fashion.  The only
7466 difference between using an @option{-l} option and specifying a file name
7467 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7468 and searches several directories.
7469
7470 @item -lobjc
7471 @opindex lobjc
7472 You need this special case of the @option{-l} option in order to
7473 link an Objective-C or Objective-C++ program.
7474
7475 @item -nostartfiles
7476 @opindex nostartfiles
7477 Do not use the standard system startup files when linking.
7478 The standard system libraries are used normally, unless @option{-nostdlib}
7479 or @option{-nodefaultlibs} is used.
7480
7481 @item -nodefaultlibs
7482 @opindex nodefaultlibs
7483 Do not use the standard system libraries when linking.
7484 Only the libraries you specify will be passed to the linker.
7485 The standard startup files are used normally, unless @option{-nostartfiles}
7486 is used.  The compiler may generate calls to @code{memcmp},
7487 @code{memset}, @code{memcpy} and @code{memmove}.
7488 These entries are usually resolved by entries in
7489 libc.  These entry points should be supplied through some other
7490 mechanism when this option is specified.
7491
7492 @item -nostdlib
7493 @opindex nostdlib
7494 Do not use the standard system startup files or libraries when linking.
7495 No startup files and only the libraries you specify will be passed to
7496 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7497 @code{memcpy} and @code{memmove}.
7498 These entries are usually resolved by entries in
7499 libc.  These entry points should be supplied through some other
7500 mechanism when this option is specified.
7501
7502 @cindex @option{-lgcc}, use with @option{-nostdlib}
7503 @cindex @option{-nostdlib} and unresolved references
7504 @cindex unresolved references and @option{-nostdlib}
7505 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7506 @cindex @option{-nodefaultlibs} and unresolved references
7507 @cindex unresolved references and @option{-nodefaultlibs}
7508 One of the standard libraries bypassed by @option{-nostdlib} and
7509 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7510 that GCC uses to overcome shortcomings of particular machines, or special
7511 needs for some languages.
7512 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7513 Collection (GCC) Internals},
7514 for more discussion of @file{libgcc.a}.)
7515 In most cases, you need @file{libgcc.a} even when you want to avoid
7516 other standard libraries.  In other words, when you specify @option{-nostdlib}
7517 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7518 This ensures that you have no unresolved references to internal GCC
7519 library subroutines.  (For example, @samp{__main}, used to ensure C++
7520 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7521 GNU Compiler Collection (GCC) Internals}.)
7522
7523 @item -pie
7524 @opindex pie
7525 Produce a position independent executable on targets which support it.
7526 For predictable results, you must also specify the same set of options
7527 that were used to generate code (@option{-fpie}, @option{-fPIE},
7528 or model suboptions) when you specify this option.
7529
7530 @item -rdynamic
7531 @opindex rdynamic
7532 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7533 that support it. This instructs the linker to add all symbols, not
7534 only used ones, to the dynamic symbol table. This option is needed
7535 for some uses of @code{dlopen} or to allow obtaining backtraces
7536 from within a program.
7537
7538 @item -s
7539 @opindex s
7540 Remove all symbol table and relocation information from the executable.
7541
7542 @item -static
7543 @opindex static
7544 On systems that support dynamic linking, this prevents linking with the shared
7545 libraries.  On other systems, this option has no effect.
7546
7547 @item -shared
7548 @opindex shared
7549 Produce a shared object which can then be linked with other objects to
7550 form an executable.  Not all systems support this option.  For predictable
7551 results, you must also specify the same set of options that were used to
7552 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7553 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7554 needs to build supplementary stub code for constructors to work.  On
7555 multi-libbed systems, @samp{gcc -shared} must select the correct support
7556 libraries to link against.  Failing to supply the correct flags may lead
7557 to subtle defects.  Supplying them in cases where they are not necessary
7558 is innocuous.}
7559
7560 @item -shared-libgcc
7561 @itemx -static-libgcc
7562 @opindex shared-libgcc
7563 @opindex static-libgcc
7564 On systems that provide @file{libgcc} as a shared library, these options
7565 force the use of either the shared or static version respectively.
7566 If no shared version of @file{libgcc} was built when the compiler was
7567 configured, these options have no effect.
7568
7569 There are several situations in which an application should use the
7570 shared @file{libgcc} instead of the static version.  The most common
7571 of these is when the application wishes to throw and catch exceptions
7572 across different shared libraries.  In that case, each of the libraries
7573 as well as the application itself should use the shared @file{libgcc}.
7574
7575 Therefore, the G++ and GCJ drivers automatically add
7576 @option{-shared-libgcc} whenever you build a shared library or a main
7577 executable, because C++ and Java programs typically use exceptions, so
7578 this is the right thing to do.
7579
7580 If, instead, you use the GCC driver to create shared libraries, you may
7581 find that they will not always be linked with the shared @file{libgcc}.
7582 If GCC finds, at its configuration time, that you have a non-GNU linker
7583 or a GNU linker that does not support option @option{--eh-frame-hdr},
7584 it will link the shared version of @file{libgcc} into shared libraries
7585 by default.  Otherwise, it will take advantage of the linker and optimize
7586 away the linking with the shared version of @file{libgcc}, linking with
7587 the static version of libgcc by default.  This allows exceptions to
7588 propagate through such shared libraries, without incurring relocation
7589 costs at library load time.
7590
7591 However, if a library or main executable is supposed to throw or catch
7592 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7593 for the languages used in the program, or using the option
7594 @option{-shared-libgcc}, such that it is linked with the shared
7595 @file{libgcc}.
7596
7597 @item -symbolic
7598 @opindex symbolic
7599 Bind references to global symbols when building a shared object.  Warn
7600 about any unresolved references (unless overridden by the link editor
7601 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
7602 this option.
7603
7604 @item -Xlinker @var{option}
7605 @opindex Xlinker
7606 Pass @var{option} as an option to the linker.  You can use this to
7607 supply system-specific linker options which GCC does not know how to
7608 recognize.
7609
7610 If you want to pass an option that takes an argument, you must use
7611 @option{-Xlinker} twice, once for the option and once for the argument.
7612 For example, to pass @option{-assert definitions}, you must write
7613 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
7614 @option{-Xlinker "-assert definitions"}, because this passes the entire
7615 string as a single argument, which is not what the linker expects.
7616
7617 @item -Wl,@var{option}
7618 @opindex Wl
7619 Pass @var{option} as an option to the linker.  If @var{option} contains
7620 commas, it is split into multiple options at the commas.
7621
7622 @item -u @var{symbol}
7623 @opindex u
7624 Pretend the symbol @var{symbol} is undefined, to force linking of
7625 library modules to define it.  You can use @option{-u} multiple times with
7626 different symbols to force loading of additional library modules.
7627 @end table
7628
7629 @node Directory Options
7630 @section Options for Directory Search
7631 @cindex directory options
7632 @cindex options, directory search
7633 @cindex search path
7634
7635 These options specify directories to search for header files, for
7636 libraries and for parts of the compiler:
7637
7638 @table @gcctabopt
7639 @item -I@var{dir}
7640 @opindex I
7641 Add the directory @var{dir} to the head of the list of directories to be
7642 searched for header files.  This can be used to override a system header
7643 file, substituting your own version, since these directories are
7644 searched before the system header file directories.  However, you should
7645 not use this option to add directories that contain vendor-supplied
7646 system header files (use @option{-isystem} for that).  If you use more than
7647 one @option{-I} option, the directories are scanned in left-to-right
7648 order; the standard system directories come after.
7649
7650 If a standard system include directory, or a directory specified with
7651 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
7652 option will be ignored.  The directory will still be searched but as a
7653 system directory at its normal position in the system include chain.
7654 This is to ensure that GCC's procedure to fix buggy system headers and
7655 the ordering for the include_next directive are not inadvertently changed.
7656 If you really need to change the search order for system directories,
7657 use the @option{-nostdinc} and/or @option{-isystem} options.
7658
7659 @item -iquote@var{dir}
7660 @opindex iquote
7661 Add the directory @var{dir} to the head of the list of directories to
7662 be searched for header files only for the case of @samp{#include
7663 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
7664 otherwise just like @option{-I}.
7665
7666 @item -L@var{dir}
7667 @opindex L
7668 Add directory @var{dir} to the list of directories to be searched
7669 for @option{-l}.
7670
7671 @item -B@var{prefix}
7672 @opindex B
7673 This option specifies where to find the executables, libraries,
7674 include files, and data files of the compiler itself.
7675
7676 The compiler driver program runs one or more of the subprograms
7677 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
7678 @var{prefix} as a prefix for each program it tries to run, both with and
7679 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
7680
7681 For each subprogram to be run, the compiler driver first tries the
7682 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
7683 was not specified, the driver tries two standard prefixes, which are
7684 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
7685 those results in a file name that is found, the unmodified program
7686 name is searched for using the directories specified in your
7687 @env{PATH} environment variable.
7688
7689 The compiler will check to see if the path provided by the @option{-B}
7690 refers to a directory, and if necessary it will add a directory
7691 separator character at the end of the path.
7692
7693 @option{-B} prefixes that effectively specify directory names also apply
7694 to libraries in the linker, because the compiler translates these
7695 options into @option{-L} options for the linker.  They also apply to
7696 includes files in the preprocessor, because the compiler translates these
7697 options into @option{-isystem} options for the preprocessor.  In this case,
7698 the compiler appends @samp{include} to the prefix.
7699
7700 The run-time support file @file{libgcc.a} can also be searched for using
7701 the @option{-B} prefix, if needed.  If it is not found there, the two
7702 standard prefixes above are tried, and that is all.  The file is left
7703 out of the link if it is not found by those means.
7704
7705 Another way to specify a prefix much like the @option{-B} prefix is to use
7706 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
7707 Variables}.
7708
7709 As a special kludge, if the path provided by @option{-B} is
7710 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
7711 9, then it will be replaced by @file{[dir/]include}.  This is to help
7712 with boot-strapping the compiler.
7713
7714 @item -specs=@var{file}
7715 @opindex specs
7716 Process @var{file} after the compiler reads in the standard @file{specs}
7717 file, in order to override the defaults that the @file{gcc} driver
7718 program uses when determining what switches to pass to @file{cc1},
7719 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
7720 @option{-specs=@var{file}} can be specified on the command line, and they
7721 are processed in order, from left to right.
7722
7723 @item --sysroot=@var{dir}
7724 @opindex sysroot
7725 Use @var{dir} as the logical root directory for headers and libraries.
7726 For example, if the compiler would normally search for headers in
7727 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
7728 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
7729
7730 If you use both this option and the @option{-isysroot} option, then
7731 the @option{--sysroot} option will apply to libraries, but the
7732 @option{-isysroot} option will apply to header files.
7733
7734 The GNU linker (beginning with version 2.16) has the necessary support
7735 for this option.  If your linker does not support this option, the
7736 header file aspect of @option{--sysroot} will still work, but the
7737 library aspect will not.
7738
7739 @item -I-
7740 @opindex I-
7741 This option has been deprecated.  Please use @option{-iquote} instead for
7742 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
7743 Any directories you specify with @option{-I} options before the @option{-I-}
7744 option are searched only for the case of @samp{#include "@var{file}"};
7745 they are not searched for @samp{#include <@var{file}>}.
7746
7747 If additional directories are specified with @option{-I} options after
7748 the @option{-I-}, these directories are searched for all @samp{#include}
7749 directives.  (Ordinarily @emph{all} @option{-I} directories are used
7750 this way.)
7751
7752 In addition, the @option{-I-} option inhibits the use of the current
7753 directory (where the current input file came from) as the first search
7754 directory for @samp{#include "@var{file}"}.  There is no way to
7755 override this effect of @option{-I-}.  With @option{-I.} you can specify
7756 searching the directory which was current when the compiler was
7757 invoked.  That is not exactly the same as what the preprocessor does
7758 by default, but it is often satisfactory.
7759
7760 @option{-I-} does not inhibit the use of the standard system directories
7761 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
7762 independent.
7763 @end table
7764
7765 @c man end
7766
7767 @node Spec Files
7768 @section Specifying subprocesses and the switches to pass to them
7769 @cindex Spec Files
7770
7771 @command{gcc} is a driver program.  It performs its job by invoking a
7772 sequence of other programs to do the work of compiling, assembling and
7773 linking.  GCC interprets its command-line parameters and uses these to
7774 deduce which programs it should invoke, and which command-line options
7775 it ought to place on their command lines.  This behavior is controlled
7776 by @dfn{spec strings}.  In most cases there is one spec string for each
7777 program that GCC can invoke, but a few programs have multiple spec
7778 strings to control their behavior.  The spec strings built into GCC can
7779 be overridden by using the @option{-specs=} command-line switch to specify
7780 a spec file.
7781
7782 @dfn{Spec files} are plaintext files that are used to construct spec
7783 strings.  They consist of a sequence of directives separated by blank
7784 lines.  The type of directive is determined by the first non-whitespace
7785 character on the line and it can be one of the following:
7786
7787 @table @code
7788 @item %@var{command}
7789 Issues a @var{command} to the spec file processor.  The commands that can
7790 appear here are:
7791
7792 @table @code
7793 @item %include <@var{file}>
7794 @cindex %include
7795 Search for @var{file} and insert its text at the current point in the
7796 specs file.
7797
7798 @item %include_noerr <@var{file}>
7799 @cindex %include_noerr
7800 Just like @samp{%include}, but do not generate an error message if the include
7801 file cannot be found.
7802
7803 @item %rename @var{old_name} @var{new_name}
7804 @cindex %rename
7805 Rename the spec string @var{old_name} to @var{new_name}.
7806
7807 @end table
7808
7809 @item *[@var{spec_name}]:
7810 This tells the compiler to create, override or delete the named spec
7811 string.  All lines after this directive up to the next directive or
7812 blank line are considered to be the text for the spec string.  If this
7813 results in an empty string then the spec will be deleted.  (Or, if the
7814 spec did not exist, then nothing will happened.)  Otherwise, if the spec
7815 does not currently exist a new spec will be created.  If the spec does
7816 exist then its contents will be overridden by the text of this
7817 directive, unless the first character of that text is the @samp{+}
7818 character, in which case the text will be appended to the spec.
7819
7820 @item [@var{suffix}]:
7821 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
7822 and up to the next directive or blank line are considered to make up the
7823 spec string for the indicated suffix.  When the compiler encounters an
7824 input file with the named suffix, it will processes the spec string in
7825 order to work out how to compile that file.  For example:
7826
7827 @smallexample
7828 .ZZ:
7829 z-compile -input %i
7830 @end smallexample
7831
7832 This says that any input file whose name ends in @samp{.ZZ} should be
7833 passed to the program @samp{z-compile}, which should be invoked with the
7834 command-line switch @option{-input} and with the result of performing the
7835 @samp{%i} substitution.  (See below.)
7836
7837 As an alternative to providing a spec string, the text that follows a
7838 suffix directive can be one of the following:
7839
7840 @table @code
7841 @item @@@var{language}
7842 This says that the suffix is an alias for a known @var{language}.  This is
7843 similar to using the @option{-x} command-line switch to GCC to specify a
7844 language explicitly.  For example:
7845
7846 @smallexample
7847 .ZZ:
7848 @@c++
7849 @end smallexample
7850
7851 Says that .ZZ files are, in fact, C++ source files.
7852
7853 @item #@var{name}
7854 This causes an error messages saying:
7855
7856 @smallexample
7857 @var{name} compiler not installed on this system.
7858 @end smallexample
7859 @end table
7860
7861 GCC already has an extensive list of suffixes built into it.
7862 This directive will add an entry to the end of the list of suffixes, but
7863 since the list is searched from the end backwards, it is effectively
7864 possible to override earlier entries using this technique.
7865
7866 @end table
7867
7868 GCC has the following spec strings built into it.  Spec files can
7869 override these strings or create their own.  Note that individual
7870 targets can also add their own spec strings to this list.
7871
7872 @smallexample
7873 asm          Options to pass to the assembler
7874 asm_final    Options to pass to the assembler post-processor
7875 cpp          Options to pass to the C preprocessor
7876 cc1          Options to pass to the C compiler
7877 cc1plus      Options to pass to the C++ compiler
7878 endfile      Object files to include at the end of the link
7879 link         Options to pass to the linker
7880 lib          Libraries to include on the command line to the linker
7881 libgcc       Decides which GCC support library to pass to the linker
7882 linker       Sets the name of the linker
7883 predefines   Defines to be passed to the C preprocessor
7884 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7885              by default
7886 startfile    Object files to include at the start of the link
7887 @end smallexample
7888
7889 Here is a small example of a spec file:
7890
7891 @smallexample
7892 %rename lib                 old_lib
7893
7894 *lib:
7895 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7896 @end smallexample
7897
7898 This example renames the spec called @samp{lib} to @samp{old_lib} and
7899 then overrides the previous definition of @samp{lib} with a new one.
7900 The new definition adds in some extra command-line options before
7901 including the text of the old definition.
7902
7903 @dfn{Spec strings} are a list of command-line options to be passed to their
7904 corresponding program.  In addition, the spec strings can contain
7905 @samp{%}-prefixed sequences to substitute variable text or to
7906 conditionally insert text into the command line.  Using these constructs
7907 it is possible to generate quite complex command lines.
7908
7909 Here is a table of all defined @samp{%}-sequences for spec
7910 strings.  Note that spaces are not generated automatically around the
7911 results of expanding these sequences.  Therefore you can concatenate them
7912 together or combine them with constant text in a single argument.
7913
7914 @table @code
7915 @item %%
7916 Substitute one @samp{%} into the program name or argument.
7917
7918 @item %i
7919 Substitute the name of the input file being processed.
7920
7921 @item %b
7922 Substitute the basename of the input file being processed.
7923 This is the substring up to (and not including) the last period
7924 and not including the directory.
7925
7926 @item %B
7927 This is the same as @samp{%b}, but include the file suffix (text after
7928 the last period).
7929
7930 @item %d
7931 Marks the argument containing or following the @samp{%d} as a
7932 temporary file name, so that that file will be deleted if GCC exits
7933 successfully.  Unlike @samp{%g}, this contributes no text to the
7934 argument.
7935
7936 @item %g@var{suffix}
7937 Substitute a file name that has suffix @var{suffix} and is chosen
7938 once per compilation, and mark the argument in the same way as
7939 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7940 name is now chosen in a way that is hard to predict even when previously
7941 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7942 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7943 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7944 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7945 was simply substituted with a file name chosen once per compilation,
7946 without regard to any appended suffix (which was therefore treated
7947 just like ordinary text), making such attacks more likely to succeed.
7948
7949 @item %u@var{suffix}
7950 Like @samp{%g}, but generates a new temporary file name even if
7951 @samp{%u@var{suffix}} was already seen.
7952
7953 @item %U@var{suffix}
7954 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7955 new one if there is no such last file name.  In the absence of any
7956 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7957 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7958 would involve the generation of two distinct file names, one
7959 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7960 simply substituted with a file name chosen for the previous @samp{%u},
7961 without regard to any appended suffix.
7962
7963 @item %j@var{suffix}
7964 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7965 writable, and if save-temps is off; otherwise, substitute the name
7966 of a temporary file, just like @samp{%u}.  This temporary file is not
7967 meant for communication between processes, but rather as a junk
7968 disposal mechanism.
7969
7970 @item %|@var{suffix}
7971 @itemx %m@var{suffix}
7972 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
7973 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7974 all.  These are the two most common ways to instruct a program that it
7975 should read from standard input or write to standard output.  If you
7976 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7977 construct: see for example @file{f/lang-specs.h}.
7978
7979 @item %.@var{SUFFIX}
7980 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7981 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
7982 terminated by the next space or %.
7983
7984 @item %w
7985 Marks the argument containing or following the @samp{%w} as the
7986 designated output file of this compilation.  This puts the argument
7987 into the sequence of arguments that @samp{%o} will substitute later.
7988
7989 @item %o
7990 Substitutes the names of all the output files, with spaces
7991 automatically placed around them.  You should write spaces
7992 around the @samp{%o} as well or the results are undefined.
7993 @samp{%o} is for use in the specs for running the linker.
7994 Input files whose names have no recognized suffix are not compiled
7995 at all, but they are included among the output files, so they will
7996 be linked.
7997
7998 @item %O
7999 Substitutes the suffix for object files.  Note that this is
8000 handled specially when it immediately follows @samp{%g, %u, or %U},
8001 because of the need for those to form complete file names.  The
8002 handling is such that @samp{%O} is treated exactly as if it had already
8003 been substituted, except that @samp{%g, %u, and %U} do not currently
8004 support additional @var{suffix} characters following @samp{%O} as they would
8005 following, for example, @samp{.o}.
8006
8007 @item %p
8008 Substitutes the standard macro predefinitions for the
8009 current target machine.  Use this when running @code{cpp}.
8010
8011 @item %P
8012 Like @samp{%p}, but puts @samp{__} before and after the name of each
8013 predefined macro, except for macros that start with @samp{__} or with
8014 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8015 C@.
8016
8017 @item %I
8018 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8019 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8020 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8021 and @option{-imultilib} as necessary.
8022
8023 @item %s
8024 Current argument is the name of a library or startup file of some sort.
8025 Search for that file in a standard list of directories and substitute
8026 the full name found.
8027
8028 @item %e@var{str}
8029 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8030 Use this when inconsistent options are detected.
8031
8032 @item %(@var{name})
8033 Substitute the contents of spec string @var{name} at this point.
8034
8035 @item %[@var{name}]
8036 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8037
8038 @item %x@{@var{option}@}
8039 Accumulate an option for @samp{%X}.
8040
8041 @item %X
8042 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8043 spec string.
8044
8045 @item %Y
8046 Output the accumulated assembler options specified by @option{-Wa}.
8047
8048 @item %Z
8049 Output the accumulated preprocessor options specified by @option{-Wp}.
8050
8051 @item %a
8052 Process the @code{asm} spec.  This is used to compute the
8053 switches to be passed to the assembler.
8054
8055 @item %A
8056 Process the @code{asm_final} spec.  This is a spec string for
8057 passing switches to an assembler post-processor, if such a program is
8058 needed.
8059
8060 @item %l
8061 Process the @code{link} spec.  This is the spec for computing the
8062 command line passed to the linker.  Typically it will make use of the
8063 @samp{%L %G %S %D and %E} sequences.
8064
8065 @item %D
8066 Dump out a @option{-L} option for each directory that GCC believes might
8067 contain startup files.  If the target supports multilibs then the
8068 current multilib directory will be prepended to each of these paths.
8069
8070 @item %L
8071 Process the @code{lib} spec.  This is a spec string for deciding which
8072 libraries should be included on the command line to the linker.
8073
8074 @item %G
8075 Process the @code{libgcc} spec.  This is a spec string for deciding
8076 which GCC support library should be included on the command line to the linker.
8077
8078 @item %S
8079 Process the @code{startfile} spec.  This is a spec for deciding which
8080 object files should be the first ones passed to the linker.  Typically
8081 this might be a file named @file{crt0.o}.
8082
8083 @item %E
8084 Process the @code{endfile} spec.  This is a spec string that specifies
8085 the last object files that will be passed to the linker.
8086
8087 @item %C
8088 Process the @code{cpp} spec.  This is used to construct the arguments
8089 to be passed to the C preprocessor.
8090
8091 @item %1
8092 Process the @code{cc1} spec.  This is used to construct the options to be
8093 passed to the actual C compiler (@samp{cc1}).
8094
8095 @item %2
8096 Process the @code{cc1plus} spec.  This is used to construct the options to be
8097 passed to the actual C++ compiler (@samp{cc1plus}).
8098
8099 @item %*
8100 Substitute the variable part of a matched option.  See below.
8101 Note that each comma in the substituted string is replaced by
8102 a single space.
8103
8104 @item %<@code{S}
8105 Remove all occurrences of @code{-S} from the command line.  Note---this
8106 command is position dependent.  @samp{%} commands in the spec string
8107 before this one will see @code{-S}, @samp{%} commands in the spec string
8108 after this one will not.
8109
8110 @item %:@var{function}(@var{args})
8111 Call the named function @var{function}, passing it @var{args}.
8112 @var{args} is first processed as a nested spec string, then split
8113 into an argument vector in the usual fashion.  The function returns
8114 a string which is processed as if it had appeared literally as part
8115 of the current spec.
8116
8117 The following built-in spec functions are provided:
8118
8119 @table @code
8120 @item @code{getenv}
8121 The @code{getenv} spec function takes two arguments: an environment
8122 variable name and a string.  If the environment variable is not
8123 defined, a fatal error is issued.  Otherwise, the return value is the
8124 value of the environment variable concatenated with the string.  For
8125 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
8126
8127 @smallexample
8128 %:getenv(TOPDIR /include)
8129 @end smallexample
8130
8131 expands to @file{/path/to/top/include}.
8132
8133 @item @code{if-exists}
8134 The @code{if-exists} spec function takes one argument, an absolute
8135 pathname to a file.  If the file exists, @code{if-exists} returns the
8136 pathname.  Here is a small example of its usage:
8137
8138 @smallexample
8139 *startfile:
8140 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
8141 @end smallexample
8142
8143 @item @code{if-exists-else}
8144 The @code{if-exists-else} spec function is similar to the @code{if-exists}
8145 spec function, except that it takes two arguments.  The first argument is
8146 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
8147 returns the pathname.  If it does not exist, it returns the second argument.
8148 This way, @code{if-exists-else} can be used to select one file or another,
8149 based on the existence of the first.  Here is a small example of its usage:
8150
8151 @smallexample
8152 *startfile:
8153 crt0%O%s %:if-exists(crti%O%s) \
8154 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
8155 @end smallexample
8156
8157 @item @code{replace-outfile}
8158 The @code{replace-outfile} spec function takes two arguments.  It looks for the
8159 first argument in the outfiles array and replaces it with the second argument.  Here
8160 is a small example of its usage:
8161
8162 @smallexample
8163 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
8164 @end smallexample
8165
8166 @item @code{print-asm-header}
8167 The @code{print-asm-header} function takes no arguments and simply
8168 prints a banner like:
8169
8170 @smallexample
8171 Assembler options
8172 =================
8173
8174 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
8175 @end smallexample
8176
8177 It is used to separate compiler options from assembler options
8178 in the @option{--target-help} output.
8179 @end table
8180
8181 @item %@{@code{S}@}
8182 Substitutes the @code{-S} switch, if that switch was given to GCC@.
8183 If that switch was not specified, this substitutes nothing.  Note that
8184 the leading dash is omitted when specifying this option, and it is
8185 automatically inserted if the substitution is performed.  Thus the spec
8186 string @samp{%@{foo@}} would match the command-line option @option{-foo}
8187 and would output the command line option @option{-foo}.
8188
8189 @item %W@{@code{S}@}
8190 Like %@{@code{S}@} but mark last argument supplied within as a file to be
8191 deleted on failure.
8192
8193 @item %@{@code{S}*@}
8194 Substitutes all the switches specified to GCC whose names start
8195 with @code{-S}, but which also take an argument.  This is used for
8196 switches like @option{-o}, @option{-D}, @option{-I}, etc.
8197 GCC considers @option{-o foo} as being
8198 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
8199 text, including the space.  Thus two arguments would be generated.
8200
8201 @item %@{@code{S}*&@code{T}*@}
8202 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
8203 (the order of @code{S} and @code{T} in the spec is not significant).
8204 There can be any number of ampersand-separated variables; for each the
8205 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
8206
8207 @item %@{@code{S}:@code{X}@}
8208 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
8209
8210 @item %@{!@code{S}:@code{X}@}
8211 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
8212
8213 @item %@{@code{S}*:@code{X}@}
8214 Substitutes @code{X} if one or more switches whose names start with
8215 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
8216 once, no matter how many such switches appeared.  However, if @code{%*}
8217 appears somewhere in @code{X}, then @code{X} will be substituted once
8218 for each matching switch, with the @code{%*} replaced by the part of
8219 that switch that matched the @code{*}.
8220
8221 @item %@{.@code{S}:@code{X}@}
8222 Substitutes @code{X}, if processing a file with suffix @code{S}.
8223
8224 @item %@{!.@code{S}:@code{X}@}
8225 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
8226
8227 @item %@{,@code{S}:@code{X}@}
8228 Substitutes @code{X}, if processing a file for language @code{S}.
8229
8230 @item %@{!,@code{S}:@code{X}@}
8231 Substitutes @code{X}, if not processing a file for language @code{S}.
8232
8233 @item %@{@code{S}|@code{P}:@code{X}@}
8234 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
8235 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
8236 @code{*} sequences as well, although they have a stronger binding than
8237 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
8238 alternatives must be starred, and only the first matching alternative
8239 is substituted.
8240
8241 For example, a spec string like this:
8242
8243 @smallexample
8244 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
8245 @end smallexample
8246
8247 will output the following command-line options from the following input
8248 command-line options:
8249
8250 @smallexample
8251 fred.c        -foo -baz
8252 jim.d         -bar -boggle
8253 -d fred.c     -foo -baz -boggle
8254 -d jim.d      -bar -baz -boggle
8255 @end smallexample
8256
8257 @item %@{S:X; T:Y; :D@}
8258
8259 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
8260 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
8261 be as many clauses as you need.  This may be combined with @code{.},
8262 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
8263
8264
8265 @end table
8266
8267 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
8268 construct may contain other nested @samp{%} constructs or spaces, or
8269 even newlines.  They are processed as usual, as described above.
8270 Trailing white space in @code{X} is ignored.  White space may also
8271 appear anywhere on the left side of the colon in these constructs,
8272 except between @code{.} or @code{*} and the corresponding word.
8273
8274 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
8275 handled specifically in these constructs.  If another value of
8276 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
8277 @option{-W} switch is found later in the command line, the earlier
8278 switch value is ignored, except with @{@code{S}*@} where @code{S} is
8279 just one letter, which passes all matching options.
8280
8281 The character @samp{|} at the beginning of the predicate text is used to
8282 indicate that a command should be piped to the following command, but
8283 only if @option{-pipe} is specified.
8284
8285 It is built into GCC which switches take arguments and which do not.
8286 (You might think it would be useful to generalize this to allow each
8287 compiler's spec to say which switches take arguments.  But this cannot
8288 be done in a consistent fashion.  GCC cannot even decide which input
8289 files have been specified without knowing which switches take arguments,
8290 and it must know which input files to compile in order to tell which
8291 compilers to run).
8292
8293 GCC also knows implicitly that arguments starting in @option{-l} are to be
8294 treated as compiler output files, and passed to the linker in their
8295 proper position among the other output files.
8296
8297 @c man begin OPTIONS
8298
8299 @node Target Options
8300 @section Specifying Target Machine and Compiler Version
8301 @cindex target options
8302 @cindex cross compiling
8303 @cindex specifying machine version
8304 @cindex specifying compiler version and target machine
8305 @cindex compiler version, specifying
8306 @cindex target machine, specifying
8307
8308 The usual way to run GCC is to run the executable called @file{gcc}, or
8309 @file{<machine>-gcc} when cross-compiling, or
8310 @file{<machine>-gcc-<version>} to run a version other than the one that
8311 was installed last.  Sometimes this is inconvenient, so GCC provides
8312 options that will switch to another cross-compiler or version.
8313
8314 @table @gcctabopt
8315 @item -b @var{machine}
8316 @opindex b
8317 The argument @var{machine} specifies the target machine for compilation.
8318
8319 The value to use for @var{machine} is the same as was specified as the
8320 machine type when configuring GCC as a cross-compiler.  For
8321 example, if a cross-compiler was configured with @samp{configure
8322 arm-elf}, meaning to compile for an arm processor with elf binaries,
8323 then you would specify @option{-b arm-elf} to run that cross compiler.
8324 Because there are other options beginning with @option{-b}, the
8325 configuration must contain a hyphen.
8326
8327 @item -V @var{version}
8328 @opindex V
8329 The argument @var{version} specifies which version of GCC to run.
8330 This is useful when multiple versions are installed.  For example,
8331 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
8332 @end table
8333
8334 The @option{-V} and @option{-b} options work by running the
8335 @file{<machine>-gcc-<version>} executable, so there's no real reason to
8336 use them if you can just run that directly.
8337
8338 @node Submodel Options
8339 @section Hardware Models and Configurations
8340 @cindex submodel options
8341 @cindex specifying hardware config
8342 @cindex hardware models and configurations, specifying
8343 @cindex machine dependent options
8344
8345 Earlier we discussed the standard option @option{-b} which chooses among
8346 different installed compilers for completely different target
8347 machines, such as VAX vs.@: 68000 vs.@: 80386.
8348
8349 In addition, each of these target machine types can have its own
8350 special options, starting with @samp{-m}, to choose among various
8351 hardware models or configurations---for example, 68010 vs 68020,
8352 floating coprocessor or none.  A single installed version of the
8353 compiler can compile for any model or configuration, according to the
8354 options specified.
8355
8356 Some configurations of the compiler also support additional special
8357 options, usually for compatibility with other compilers on the same
8358 platform.
8359
8360 @c This list is ordered alphanumerically by subsection name.
8361 @c It should be the same order and spelling as these options are listed
8362 @c in Machine Dependent Options
8363
8364 @menu
8365 * ARC Options::
8366 * ARM Options::
8367 * AVR Options::
8368 * Blackfin Options::
8369 * CRIS Options::
8370 * CRX Options::
8371 * Darwin Options::
8372 * DEC Alpha Options::
8373 * DEC Alpha/VMS Options::
8374 * FRV Options::
8375 * GNU/Linux Options::
8376 * H8/300 Options::
8377 * HPPA Options::
8378 * i386 and x86-64 Options::
8379 * IA-64 Options::
8380 * M32C Options::
8381 * M32R/D Options::
8382 * M680x0 Options::
8383 * M68hc1x Options::
8384 * MCore Options::
8385 * MIPS Options::
8386 * MMIX Options::
8387 * MN10300 Options::
8388 * MT Options::
8389 * PDP-11 Options::
8390 * PowerPC Options::
8391 * RS/6000 and PowerPC Options::
8392 * S/390 and zSeries Options::
8393 * Score Options::
8394 * SH Options::
8395 * SPARC Options::
8396 * SPU Options::
8397 * System V Options::
8398 * V850 Options::
8399 * VAX Options::
8400 * VxWorks Options::
8401 * x86-64 Options::
8402 * Xstormy16 Options::
8403 * Xtensa Options::
8404 * zSeries Options::
8405 @end menu
8406
8407 @node ARC Options
8408 @subsection ARC Options
8409 @cindex ARC Options
8410
8411 These options are defined for ARC implementations:
8412
8413 @table @gcctabopt
8414 @item -EL
8415 @opindex EL
8416 Compile code for little endian mode.  This is the default.
8417
8418 @item -EB
8419 @opindex EB
8420 Compile code for big endian mode.
8421
8422 @item -mmangle-cpu
8423 @opindex mmangle-cpu
8424 Prepend the name of the cpu to all public symbol names.
8425 In multiple-processor systems, there are many ARC variants with different
8426 instruction and register set characteristics.  This flag prevents code
8427 compiled for one cpu to be linked with code compiled for another.
8428 No facility exists for handling variants that are ``almost identical''.
8429 This is an all or nothing option.
8430
8431 @item -mcpu=@var{cpu}
8432 @opindex mcpu
8433 Compile code for ARC variant @var{cpu}.
8434 Which variants are supported depend on the configuration.
8435 All variants support @option{-mcpu=base}, this is the default.
8436
8437 @item -mtext=@var{text-section}
8438 @itemx -mdata=@var{data-section}
8439 @itemx -mrodata=@var{readonly-data-section}
8440 @opindex mtext
8441 @opindex mdata
8442 @opindex mrodata
8443 Put functions, data, and readonly data in @var{text-section},
8444 @var{data-section}, and @var{readonly-data-section} respectively
8445 by default.  This can be overridden with the @code{section} attribute.
8446 @xref{Variable Attributes}.
8447
8448 @end table
8449
8450 @node ARM Options
8451 @subsection ARM Options
8452 @cindex ARM options
8453
8454 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8455 architectures:
8456
8457 @table @gcctabopt
8458 @item -mabi=@var{name}
8459 @opindex mabi
8460 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8461 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8462
8463 @item -mapcs-frame
8464 @opindex mapcs-frame
8465 Generate a stack frame that is compliant with the ARM Procedure Call
8466 Standard for all functions, even if this is not strictly necessary for
8467 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8468 with this option will cause the stack frames not to be generated for
8469 leaf functions.  The default is @option{-mno-apcs-frame}.
8470
8471 @item -mapcs
8472 @opindex mapcs
8473 This is a synonym for @option{-mapcs-frame}.
8474
8475 @ignore
8476 @c not currently implemented
8477 @item -mapcs-stack-check
8478 @opindex mapcs-stack-check
8479 Generate code to check the amount of stack space available upon entry to
8480 every function (that actually uses some stack space).  If there is
8481 insufficient space available then either the function
8482 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8483 called, depending upon the amount of stack space required.  The run time
8484 system is required to provide these functions.  The default is
8485 @option{-mno-apcs-stack-check}, since this produces smaller code.
8486
8487 @c not currently implemented
8488 @item -mapcs-float
8489 @opindex mapcs-float
8490 Pass floating point arguments using the float point registers.  This is
8491 one of the variants of the APCS@.  This option is recommended if the
8492 target hardware has a floating point unit or if a lot of floating point
8493 arithmetic is going to be performed by the code.  The default is
8494 @option{-mno-apcs-float}, since integer only code is slightly increased in
8495 size if @option{-mapcs-float} is used.
8496
8497 @c not currently implemented
8498 @item -mapcs-reentrant
8499 @opindex mapcs-reentrant
8500 Generate reentrant, position independent code.  The default is
8501 @option{-mno-apcs-reentrant}.
8502 @end ignore
8503
8504 @item -mthumb-interwork
8505 @opindex mthumb-interwork
8506 Generate code which supports calling between the ARM and Thumb
8507 instruction sets.  Without this option the two instruction sets cannot
8508 be reliably used inside one program.  The default is
8509 @option{-mno-thumb-interwork}, since slightly larger code is generated
8510 when @option{-mthumb-interwork} is specified.
8511
8512 @item -mno-sched-prolog
8513 @opindex mno-sched-prolog
8514 Prevent the reordering of instructions in the function prolog, or the
8515 merging of those instruction with the instructions in the function's
8516 body.  This means that all functions will start with a recognizable set
8517 of instructions (or in fact one of a choice from a small set of
8518 different function prologues), and this information can be used to
8519 locate the start if functions inside an executable piece of code.  The
8520 default is @option{-msched-prolog}.
8521
8522 @item -mhard-float
8523 @opindex mhard-float
8524 Generate output containing floating point instructions.  This is the
8525 default.
8526
8527 @item -msoft-float
8528 @opindex msoft-float
8529 Generate output containing library calls for floating point.
8530 @strong{Warning:} the requisite libraries are not available for all ARM
8531 targets.  Normally the facilities of the machine's usual C compiler are
8532 used, but this cannot be done directly in cross-compilation.  You must make
8533 your own arrangements to provide suitable library functions for
8534 cross-compilation.
8535
8536 @option{-msoft-float} changes the calling convention in the output file;
8537 therefore, it is only useful if you compile @emph{all} of a program with
8538 this option.  In particular, you need to compile @file{libgcc.a}, the
8539 library that comes with GCC, with @option{-msoft-float} in order for
8540 this to work.
8541
8542 @item -mfloat-abi=@var{name}
8543 @opindex mfloat-abi
8544 Specifies which ABI to use for floating point values.  Permissible values
8545 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8546
8547 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
8548 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
8549 of floating point instructions, but still uses the soft-float calling
8550 conventions.
8551
8552 @item -mlittle-endian
8553 @opindex mlittle-endian
8554 Generate code for a processor running in little-endian mode.  This is
8555 the default for all standard configurations.
8556
8557 @item -mbig-endian
8558 @opindex mbig-endian
8559 Generate code for a processor running in big-endian mode; the default is
8560 to compile code for a little-endian processor.
8561
8562 @item -mwords-little-endian
8563 @opindex mwords-little-endian
8564 This option only applies when generating code for big-endian processors.
8565 Generate code for a little-endian word order but a big-endian byte
8566 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8567 option should only be used if you require compatibility with code for
8568 big-endian ARM processors generated by versions of the compiler prior to
8569 2.8.
8570
8571 @item -mcpu=@var{name}
8572 @opindex mcpu
8573 This specifies the name of the target ARM processor.  GCC uses this name
8574 to determine what kind of instructions it can emit when generating
8575 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8576 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8577 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8578 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
8579 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
8580 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
8581 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
8582 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
8583 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
8584 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
8585 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
8586 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
8587 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
8588 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
8589 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3}, @samp{cortex-m1},
8590 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
8591
8592 @item -mtune=@var{name}
8593 @opindex mtune
8594 This option is very similar to the @option{-mcpu=} option, except that
8595 instead of specifying the actual target processor type, and hence
8596 restricting which instructions can be used, it specifies that GCC should
8597 tune the performance of the code as if the target were of the type
8598 specified in this option, but still choosing the instructions that it
8599 will generate based on the cpu specified by a @option{-mcpu=} option.
8600 For some ARM implementations better performance can be obtained by using
8601 this option.
8602
8603 @item -march=@var{name}
8604 @opindex march
8605 This specifies the name of the target ARM architecture.  GCC uses this
8606 name to determine what kind of instructions it can emit when generating
8607 assembly code.  This option can be used in conjunction with or instead
8608 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
8609 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
8610 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
8611 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
8612 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
8613 @samp{iwmmxt}, @samp{ep9312}.
8614
8615 @item -mfpu=@var{name}
8616 @itemx -mfpe=@var{number}
8617 @itemx -mfp=@var{number}
8618 @opindex mfpu
8619 @opindex mfpe
8620 @opindex mfp
8621 This specifies what floating point hardware (or hardware emulation) is
8622 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
8623 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
8624 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
8625 with older versions of GCC@.
8626
8627 If @option{-msoft-float} is specified this specifies the format of
8628 floating point values.
8629
8630 @item -mstructure-size-boundary=@var{n}
8631 @opindex mstructure-size-boundary
8632 The size of all structures and unions will be rounded up to a multiple
8633 of the number of bits set by this option.  Permissible values are 8, 32
8634 and 64.  The default value varies for different toolchains.  For the COFF
8635 targeted toolchain the default value is 8.  A value of 64 is only allowed
8636 if the underlying ABI supports it.
8637
8638 Specifying the larger number can produce faster, more efficient code, but
8639 can also increase the size of the program.  Different values are potentially
8640 incompatible.  Code compiled with one value cannot necessarily expect to
8641 work with code or libraries compiled with another value, if they exchange
8642 information using structures or unions.
8643
8644 @item -mabort-on-noreturn
8645 @opindex mabort-on-noreturn
8646 Generate a call to the function @code{abort} at the end of a
8647 @code{noreturn} function.  It will be executed if the function tries to
8648 return.
8649
8650 @item -mlong-calls
8651 @itemx -mno-long-calls
8652 @opindex mlong-calls
8653 @opindex mno-long-calls
8654 Tells the compiler to perform function calls by first loading the
8655 address of the function into a register and then performing a subroutine
8656 call on this register.  This switch is needed if the target function
8657 will lie outside of the 64 megabyte addressing range of the offset based
8658 version of subroutine call instruction.
8659
8660 Even if this switch is enabled, not all function calls will be turned
8661 into long calls.  The heuristic is that static functions, functions
8662 which have the @samp{short-call} attribute, functions that are inside
8663 the scope of a @samp{#pragma no_long_calls} directive and functions whose
8664 definitions have already been compiled within the current compilation
8665 unit, will not be turned into long calls.  The exception to this rule is
8666 that weak function definitions, functions with the @samp{long-call}
8667 attribute or the @samp{section} attribute, and functions that are within
8668 the scope of a @samp{#pragma long_calls} directive, will always be
8669 turned into long calls.
8670
8671 This feature is not enabled by default.  Specifying
8672 @option{-mno-long-calls} will restore the default behavior, as will
8673 placing the function calls within the scope of a @samp{#pragma
8674 long_calls_off} directive.  Note these switches have no effect on how
8675 the compiler generates code to handle function calls via function
8676 pointers.
8677
8678 @item -mnop-fun-dllimport
8679 @opindex mnop-fun-dllimport
8680 Disable support for the @code{dllimport} attribute.
8681
8682 @item -msingle-pic-base
8683 @opindex msingle-pic-base
8684 Treat the register used for PIC addressing as read-only, rather than
8685 loading it in the prologue for each function.  The run-time system is
8686 responsible for initializing this register with an appropriate value
8687 before execution begins.
8688
8689 @item -mpic-register=@var{reg}
8690 @opindex mpic-register
8691 Specify the register to be used for PIC addressing.  The default is R10
8692 unless stack-checking is enabled, when R9 is used.
8693
8694 @item -mcirrus-fix-invalid-insns
8695 @opindex mcirrus-fix-invalid-insns
8696 @opindex mno-cirrus-fix-invalid-insns
8697 Insert NOPs into the instruction stream to in order to work around
8698 problems with invalid Maverick instruction combinations.  This option
8699 is only valid if the @option{-mcpu=ep9312} option has been used to
8700 enable generation of instructions for the Cirrus Maverick floating
8701 point co-processor.  This option is not enabled by default, since the
8702 problem is only present in older Maverick implementations.  The default
8703 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
8704 switch.
8705
8706 @item -mpoke-function-name
8707 @opindex mpoke-function-name
8708 Write the name of each function into the text section, directly
8709 preceding the function prologue.  The generated code is similar to this:
8710
8711 @smallexample
8712      t0
8713          .ascii "arm_poke_function_name", 0
8714          .align
8715      t1
8716          .word 0xff000000 + (t1 - t0)
8717      arm_poke_function_name
8718          mov     ip, sp
8719          stmfd   sp!, @{fp, ip, lr, pc@}
8720          sub     fp, ip, #4
8721 @end smallexample
8722
8723 When performing a stack backtrace, code can inspect the value of
8724 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
8725 location @code{pc - 12} and the top 8 bits are set, then we know that
8726 there is a function name embedded immediately preceding this location
8727 and has length @code{((pc[-3]) & 0xff000000)}.
8728
8729 @item -mthumb
8730 @opindex mthumb
8731 Generate code for the Thumb instruction set.  The default is to
8732 use the 32-bit ARM instruction set.
8733 This option automatically enables either 16-bit Thumb-1 or
8734 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
8735 and @option{-march=@var{name}} options.
8736
8737 @item -mtpcs-frame
8738 @opindex mtpcs-frame
8739 Generate a stack frame that is compliant with the Thumb Procedure Call
8740 Standard for all non-leaf functions.  (A leaf function is one that does
8741 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
8742
8743 @item -mtpcs-leaf-frame
8744 @opindex mtpcs-leaf-frame
8745 Generate a stack frame that is compliant with the Thumb Procedure Call
8746 Standard for all leaf functions.  (A leaf function is one that does
8747 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
8748
8749 @item -mcallee-super-interworking
8750 @opindex mcallee-super-interworking
8751 Gives all externally visible functions in the file being compiled an ARM
8752 instruction set header which switches to Thumb mode before executing the
8753 rest of the function.  This allows these functions to be called from
8754 non-interworking code.
8755
8756 @item -mcaller-super-interworking
8757 @opindex mcaller-super-interworking
8758 Allows calls via function pointers (including virtual functions) to
8759 execute correctly regardless of whether the target code has been
8760 compiled for interworking or not.  There is a small overhead in the cost
8761 of executing a function pointer if this option is enabled.
8762
8763 @item -mtp=@var{name}
8764 @opindex mtp
8765 Specify the access model for the thread local storage pointer.  The valid
8766 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
8767 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
8768 (supported in the arm6k architecture), and @option{auto}, which uses the
8769 best available method for the selected processor.  The default setting is
8770 @option{auto}.
8771
8772 @end table
8773
8774 @node AVR Options
8775 @subsection AVR Options
8776 @cindex AVR Options
8777
8778 These options are defined for AVR implementations:
8779
8780 @table @gcctabopt
8781 @item -mmcu=@var{mcu}
8782 @opindex mmcu
8783 Specify ATMEL AVR instruction set or MCU type.
8784
8785 Instruction set avr1 is for the minimal AVR core, not supported by the C
8786 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8787 attiny11, attiny12, attiny15, attiny28).
8788
8789 Instruction set avr2 (default) is for the classic AVR core with up to
8790 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8791 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8792 at90c8534, at90s8535).
8793
8794 Instruction set avr3 is for the classic AVR core with up to 128K program
8795 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
8796
8797 Instruction set avr4 is for the enhanced AVR core with up to 8K program
8798 memory space (MCU types: atmega8, atmega83, atmega85).
8799
8800 Instruction set avr5 is for the enhanced AVR core with up to 128K program
8801 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8802 atmega64, atmega128, at43usb355, at94k).
8803
8804 @item -msize
8805 @opindex msize
8806 Output instruction sizes to the asm file.
8807
8808 @item -minit-stack=@var{N}
8809 @opindex minit-stack
8810 Specify the initial stack address, which may be a symbol or numeric value,
8811 @samp{__stack} is the default.
8812
8813 @item -mno-interrupts
8814 @opindex mno-interrupts
8815 Generated code is not compatible with hardware interrupts.
8816 Code size will be smaller.
8817
8818 @item -mcall-prologues
8819 @opindex mcall-prologues
8820 Functions prologues/epilogues expanded as call to appropriate
8821 subroutines.  Code size will be smaller.
8822
8823 @item -mno-tablejump
8824 @opindex mno-tablejump
8825 Do not generate tablejump insns which sometimes increase code size.
8826
8827 @item -mtiny-stack
8828 @opindex mtiny-stack
8829 Change only the low 8 bits of the stack pointer.
8830
8831 @item -mint8
8832 @opindex mint8
8833 Assume int to be 8 bit integer.  This affects the sizes of all types: A
8834 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8835 and long long will be 4 bytes.  Please note that this option does not
8836 comply to the C standards, but it will provide you with smaller code
8837 size.
8838 @end table
8839
8840 @node Blackfin Options
8841 @subsection Blackfin Options
8842 @cindex Blackfin Options
8843
8844 @table @gcctabopt
8845 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
8846 @opindex mcpu=
8847 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
8848 can be one of @samp{bf522}, @samp{bf523}, @samp{bf524},
8849 @samp{bf525}, @samp{bf526}, @samp{bf527},
8850 @samp{bf531}, @samp{bf532}, @samp{bf533}, @samp{bf534},
8851 @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
8852 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
8853 @samp{bf561}.
8854 The optional @var{sirevision} specifies the silicon revision of the target
8855 Blackfin processor.  Any workarounds available for the targeted silicon revision
8856 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
8857 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
8858 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
8859 hexadecimal digits representing the major and minor numbers in the silicon
8860 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
8861 is not defined.  If @var{sirevision} is @samp{any}, the
8862 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
8863 If this optional @var{sirevision} is not used, GCC assumes the latest known
8864 silicon revision of the targeted Blackfin processor.
8865
8866 Support for @samp{bf561} is incomplete.  For @samp{bf561},
8867 Only the processor macro is defined.
8868 Without this option, @samp{bf532} is used as the processor by default.
8869 The corresponding predefined processor macros for @var{cpu} is to
8870 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
8871 provided by libgloss to be linked in if @option{-msim} is not given.
8872
8873 @item -msim
8874 @opindex msim
8875 Specifies that the program will be run on the simulator.  This causes
8876 the simulator BSP provided by libgloss to be linked in.  This option
8877 has effect only for @samp{bfin-elf} toolchain.
8878 Certain other options, such as @option{-mid-shared-library} and
8879 @option{-mfdpic}, imply @option{-msim}.
8880
8881 @item -momit-leaf-frame-pointer
8882 @opindex momit-leaf-frame-pointer
8883 Don't keep the frame pointer in a register for leaf functions.  This
8884 avoids the instructions to save, set up and restore frame pointers and
8885 makes an extra register available in leaf functions.  The option
8886 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8887 which might make debugging harder.
8888
8889 @item -mspecld-anomaly
8890 @opindex mspecld-anomaly
8891 When enabled, the compiler will ensure that the generated code does not
8892 contain speculative loads after jump instructions. If this option is used,
8893 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
8894
8895 @item -mno-specld-anomaly
8896 @opindex mno-specld-anomaly
8897 Don't generate extra code to prevent speculative loads from occurring.
8898
8899 @item -mcsync-anomaly
8900 @opindex mcsync-anomaly
8901 When enabled, the compiler will ensure that the generated code does not
8902 contain CSYNC or SSYNC instructions too soon after conditional branches.
8903 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
8904
8905 @item -mno-csync-anomaly
8906 @opindex mno-csync-anomaly
8907 Don't generate extra code to prevent CSYNC or SSYNC instructions from
8908 occurring too soon after a conditional branch.
8909
8910 @item -mlow-64k
8911 @opindex mlow-64k
8912 When enabled, the compiler is free to take advantage of the knowledge that
8913 the entire program fits into the low 64k of memory.
8914
8915 @item -mno-low-64k
8916 @opindex mno-low-64k
8917 Assume that the program is arbitrarily large.  This is the default.
8918
8919 @item -mstack-check-l1
8920 @opindex mstack-check-l1
8921 Do stack checking using information placed into L1 scratchpad memory by the
8922 uClinux kernel.
8923
8924 @item -mid-shared-library
8925 @opindex mid-shared-library
8926 Generate code that supports shared libraries via the library ID method.
8927 This allows for execute in place and shared libraries in an environment
8928 without virtual memory management.  This option implies @option{-fPIC}.
8929 With a @samp{bfin-elf} target, this option implies @option{-msim}.
8930
8931 @item -mno-id-shared-library
8932 @opindex mno-id-shared-library
8933 Generate code that doesn't assume ID based shared libraries are being used.
8934 This is the default.
8935
8936 @item -mleaf-id-shared-library
8937 @opindex mleaf-id-shared-library
8938 Generate code that supports shared libraries via the library ID method,
8939 but assumes that this library or executable won't link against any other
8940 ID shared libraries.  That allows the compiler to use faster code for jumps
8941 and calls.
8942
8943 @item -mno-leaf-id-shared-library
8944 @opindex mno-leaf-id-shared-library
8945 Do not assume that the code being compiled won't link against any ID shared
8946 libraries.  Slower code will be generated for jump and call insns.
8947
8948 @item -mshared-library-id=n
8949 @opindex mshared-library-id
8950 Specified the identification number of the ID based shared library being
8951 compiled.  Specifying a value of 0 will generate more compact code, specifying
8952 other values will force the allocation of that number to the current
8953 library but is no more space or time efficient than omitting this option.
8954
8955 @item -msep-data
8956 @opindex msep-data
8957 Generate code that allows the data segment to be located in a different
8958 area of memory from the text segment.  This allows for execute in place in
8959 an environment without virtual memory management by eliminating relocations
8960 against the text section.
8961
8962 @item -mno-sep-data
8963 @opindex mno-sep-data
8964 Generate code that assumes that the data segment follows the text segment.
8965 This is the default.
8966
8967 @item -mlong-calls
8968 @itemx -mno-long-calls
8969 @opindex mlong-calls
8970 @opindex mno-long-calls
8971 Tells the compiler to perform function calls by first loading the
8972 address of the function into a register and then performing a subroutine
8973 call on this register.  This switch is needed if the target function
8974 will lie outside of the 24 bit addressing range of the offset based
8975 version of subroutine call instruction.
8976
8977 This feature is not enabled by default.  Specifying
8978 @option{-mno-long-calls} will restore the default behavior.  Note these
8979 switches have no effect on how the compiler generates code to handle
8980 function calls via function pointers.
8981
8982 @item -mfast-fp
8983 @opindex mfast-fp
8984 Link with the fast floating-point library. This library relaxes some of
8985 the IEEE floating-point standard's rules for checking inputs against
8986 Not-a-Number (NAN), in the interest of performance.
8987
8988 @item -minline-plt
8989 @opindex minline-plt
8990 Enable inlining of PLT entries in function calls to functions that are
8991 not known to bind locally.  It has no effect without @option{-mfdpic}.
8992 @end table
8993
8994 @node CRIS Options
8995 @subsection CRIS Options
8996 @cindex CRIS Options
8997
8998 These options are defined specifically for the CRIS ports.
8999
9000 @table @gcctabopt
9001 @item -march=@var{architecture-type}
9002 @itemx -mcpu=@var{architecture-type}
9003 @opindex march
9004 @opindex mcpu
9005 Generate code for the specified architecture.  The choices for
9006 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9007 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9008 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9009 @samp{v10}.
9010
9011 @item -mtune=@var{architecture-type}
9012 @opindex mtune
9013 Tune to @var{architecture-type} everything applicable about the generated
9014 code, except for the ABI and the set of available instructions.  The
9015 choices for @var{architecture-type} are the same as for
9016 @option{-march=@var{architecture-type}}.
9017
9018 @item -mmax-stack-frame=@var{n}
9019 @opindex mmax-stack-frame
9020 Warn when the stack frame of a function exceeds @var{n} bytes.
9021
9022 @item -melinux-stacksize=@var{n}
9023 @opindex melinux-stacksize
9024 Only available with the @samp{cris-axis-aout} target.  Arranges for
9025 indications in the program to the kernel loader that the stack of the
9026 program should be set to @var{n} bytes.
9027
9028 @item -metrax4
9029 @itemx -metrax100
9030 @opindex metrax4
9031 @opindex metrax100
9032 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9033 @option{-march=v3} and @option{-march=v8} respectively.
9034
9035 @item -mmul-bug-workaround
9036 @itemx -mno-mul-bug-workaround
9037 @opindex mmul-bug-workaround
9038 @opindex mno-mul-bug-workaround
9039 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
9040 models where it applies.  This option is active by default.
9041
9042 @item -mpdebug
9043 @opindex mpdebug
9044 Enable CRIS-specific verbose debug-related information in the assembly
9045 code.  This option also has the effect to turn off the @samp{#NO_APP}
9046 formatted-code indicator to the assembler at the beginning of the
9047 assembly file.
9048
9049 @item -mcc-init
9050 @opindex mcc-init
9051 Do not use condition-code results from previous instruction; always emit
9052 compare and test instructions before use of condition codes.
9053
9054 @item -mno-side-effects
9055 @opindex mno-side-effects
9056 Do not emit instructions with side-effects in addressing modes other than
9057 post-increment.
9058
9059 @item -mstack-align
9060 @itemx -mno-stack-align
9061 @itemx -mdata-align
9062 @itemx -mno-data-align
9063 @itemx -mconst-align
9064 @itemx -mno-const-align
9065 @opindex mstack-align
9066 @opindex mno-stack-align
9067 @opindex mdata-align
9068 @opindex mno-data-align
9069 @opindex mconst-align
9070 @opindex mno-const-align
9071 These options (no-options) arranges (eliminate arrangements) for the
9072 stack-frame, individual data and constants to be aligned for the maximum
9073 single data access size for the chosen CPU model.  The default is to
9074 arrange for 32-bit alignment.  ABI details such as structure layout are
9075 not affected by these options.
9076
9077 @item -m32-bit
9078 @itemx -m16-bit
9079 @itemx -m8-bit
9080 @opindex m32-bit
9081 @opindex m16-bit
9082 @opindex m8-bit
9083 Similar to the stack- data- and const-align options above, these options
9084 arrange for stack-frame, writable data and constants to all be 32-bit,
9085 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9086
9087 @item -mno-prologue-epilogue
9088 @itemx -mprologue-epilogue
9089 @opindex mno-prologue-epilogue
9090 @opindex mprologue-epilogue
9091 With @option{-mno-prologue-epilogue}, the normal function prologue and
9092 epilogue that sets up the stack-frame are omitted and no return
9093 instructions or return sequences are generated in the code.  Use this
9094 option only together with visual inspection of the compiled code: no
9095 warnings or errors are generated when call-saved registers must be saved,
9096 or storage for local variable needs to be allocated.
9097
9098 @item -mno-gotplt
9099 @itemx -mgotplt
9100 @opindex mno-gotplt
9101 @opindex mgotplt
9102 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9103 instruction sequences that load addresses for functions from the PLT part
9104 of the GOT rather than (traditional on other architectures) calls to the
9105 PLT@.  The default is @option{-mgotplt}.
9106
9107 @item -maout
9108 @opindex maout
9109 Legacy no-op option only recognized with the cris-axis-aout target.
9110
9111 @item -melf
9112 @opindex melf
9113 Legacy no-op option only recognized with the cris-axis-elf and
9114 cris-axis-linux-gnu targets.
9115
9116 @item -melinux
9117 @opindex melinux
9118 Only recognized with the cris-axis-aout target, where it selects a
9119 GNU/linux-like multilib, include files and instruction set for
9120 @option{-march=v8}.
9121
9122 @item -mlinux
9123 @opindex mlinux
9124 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9125
9126 @item -sim
9127 @opindex sim
9128 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9129 to link with input-output functions from a simulator library.  Code,
9130 initialized data and zero-initialized data are allocated consecutively.
9131
9132 @item -sim2
9133 @opindex sim2
9134 Like @option{-sim}, but pass linker options to locate initialized data at
9135 0x40000000 and zero-initialized data at 0x80000000.
9136 @end table
9137
9138 @node CRX Options
9139 @subsection CRX Options
9140 @cindex CRX Options
9141
9142 These options are defined specifically for the CRX ports.
9143
9144 @table @gcctabopt
9145
9146 @item -mmac
9147 @opindex mmac
9148 Enable the use of multiply-accumulate instructions. Disabled by default.
9149
9150 @item -mpush-args
9151 @opindex mpush-args
9152 Push instructions will be used to pass outgoing arguments when functions
9153 are called. Enabled by default.
9154 @end table
9155
9156 @node Darwin Options
9157 @subsection Darwin Options
9158 @cindex Darwin options
9159
9160 These options are defined for all architectures running the Darwin operating
9161 system.
9162
9163 FSF GCC on Darwin does not create ``fat'' object files; it will create
9164 an object file for the single architecture that it was built to
9165 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
9166 @option{-arch} options are used; it does so by running the compiler or
9167 linker multiple times and joining the results together with
9168 @file{lipo}.
9169
9170 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
9171 @samp{i686}) is determined by the flags that specify the ISA
9172 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
9173 @option{-force_cpusubtype_ALL} option can be used to override this.
9174
9175 The Darwin tools vary in their behavior when presented with an ISA
9176 mismatch.  The assembler, @file{as}, will only permit instructions to
9177 be used that are valid for the subtype of the file it is generating,
9178 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
9179 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
9180 and print an error if asked to create a shared library with a less
9181 restrictive subtype than its input files (for instance, trying to put
9182 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
9183 for executables, @file{ld}, will quietly give the executable the most
9184 restrictive subtype of any of its input files.
9185
9186 @table @gcctabopt
9187 @item -F@var{dir}
9188 @opindex F
9189 Add the framework directory @var{dir} to the head of the list of
9190 directories to be searched for header files.  These directories are
9191 interleaved with those specified by @option{-I} options and are
9192 scanned in a left-to-right order.
9193
9194 A framework directory is a directory with frameworks in it.  A
9195 framework is a directory with a @samp{"Headers"} and/or
9196 @samp{"PrivateHeaders"} directory contained directly in it that ends
9197 in @samp{".framework"}.  The name of a framework is the name of this
9198 directory excluding the @samp{".framework"}.  Headers associated with
9199 the framework are found in one of those two directories, with
9200 @samp{"Headers"} being searched first.  A subframework is a framework
9201 directory that is in a framework's @samp{"Frameworks"} directory.
9202 Includes of subframework headers can only appear in a header of a
9203 framework that contains the subframework, or in a sibling subframework
9204 header.  Two subframeworks are siblings if they occur in the same
9205 framework.  A subframework should not have the same name as a
9206 framework, a warning will be issued if this is violated.  Currently a
9207 subframework cannot have subframeworks, in the future, the mechanism
9208 may be extended to support this.  The standard frameworks can be found
9209 in @samp{"/System/Library/Frameworks"} and
9210 @samp{"/Library/Frameworks"}.  An example include looks like
9211 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
9212 the name of the framework and header.h is found in the
9213 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
9214
9215 @item -iframework@var{dir}
9216 @opindex iframework
9217 Like @option{-F} except the directory is a treated as a system
9218 directory.  The main difference between this @option{-iframework} and
9219 @option{-F} is that with @option{-iframework} the compiler does not
9220 warn about constructs contained within header files found via
9221 @var{dir}.  This option is valid only for the C family of languages.
9222
9223 @item -gused
9224 @opindex gused
9225 Emit debugging information for symbols that are used.  For STABS
9226 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
9227 This is by default ON@.
9228
9229 @item -gfull
9230 @opindex gfull
9231 Emit debugging information for all symbols and types.
9232
9233 @item -mmacosx-version-min=@var{version}
9234 The earliest version of MacOS X that this executable will run on
9235 is @var{version}.  Typical values of @var{version} include @code{10.1},
9236 @code{10.2}, and @code{10.3.9}.
9237
9238 If the compiler was built to use the system's headers by default,
9239 then the default for this option is the system version on which the
9240 compiler is running, otherwise the default is to make choices which
9241 are compatible with as many systems and code bases as possible.
9242
9243 @item -mkernel
9244 @opindex mkernel
9245 Enable kernel development mode.  The @option{-mkernel} option sets
9246 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
9247 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
9248 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
9249 applicable.  This mode also sets @option{-mno-altivec},
9250 @option{-msoft-float}, @option{-fno-builtin} and
9251 @option{-mlong-branch} for PowerPC targets.
9252
9253 @item -mone-byte-bool
9254 @opindex mone-byte-bool
9255 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
9256 By default @samp{sizeof(bool)} is @samp{4} when compiling for
9257 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
9258 option has no effect on x86.
9259
9260 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
9261 to generate code that is not binary compatible with code generated
9262 without that switch.  Using this switch may require recompiling all
9263 other modules in a program, including system libraries.  Use this
9264 switch to conform to a non-default data model.
9265
9266 @item -mfix-and-continue
9267 @itemx -ffix-and-continue
9268 @itemx -findirect-data
9269 @opindex mfix-and-continue
9270 @opindex ffix-and-continue
9271 @opindex findirect-data
9272 Generate code suitable for fast turn around development.  Needed to
9273 enable gdb to dynamically load @code{.o} files into already running
9274 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
9275 are provided for backwards compatibility.
9276
9277 @item -all_load
9278 @opindex all_load
9279 Loads all members of static archive libraries.
9280 See man ld(1) for more information.
9281
9282 @item -arch_errors_fatal
9283 @opindex arch_errors_fatal
9284 Cause the errors having to do with files that have the wrong architecture
9285 to be fatal.
9286
9287 @item -bind_at_load
9288 @opindex bind_at_load
9289 Causes the output file to be marked such that the dynamic linker will
9290 bind all undefined references when the file is loaded or launched.
9291
9292 @item -bundle
9293 @opindex bundle
9294 Produce a Mach-o bundle format file.
9295 See man ld(1) for more information.
9296
9297 @item -bundle_loader @var{executable}
9298 @opindex bundle_loader
9299 This option specifies the @var{executable} that will be loading the build
9300 output file being linked.  See man ld(1) for more information.
9301
9302 @item -dynamiclib
9303 @opindex dynamiclib
9304 When passed this option, GCC will produce a dynamic library instead of
9305 an executable when linking, using the Darwin @file{libtool} command.
9306
9307 @item -force_cpusubtype_ALL
9308 @opindex force_cpusubtype_ALL
9309 This causes GCC's output file to have the @var{ALL} subtype, instead of
9310 one controlled by the @option{-mcpu} or @option{-march} option.
9311
9312 @item -allowable_client  @var{client_name}
9313 @itemx -client_name
9314 @itemx -compatibility_version
9315 @itemx -current_version
9316 @itemx -dead_strip
9317 @itemx -dependency-file
9318 @itemx -dylib_file
9319 @itemx -dylinker_install_name
9320 @itemx -dynamic
9321 @itemx -exported_symbols_list
9322 @itemx -filelist
9323 @itemx -flat_namespace
9324 @itemx -force_flat_namespace
9325 @itemx -headerpad_max_install_names
9326 @itemx -image_base
9327 @itemx -init
9328 @itemx -install_name
9329 @itemx -keep_private_externs
9330 @itemx -multi_module
9331 @itemx -multiply_defined
9332 @itemx -multiply_defined_unused
9333 @itemx -noall_load
9334 @itemx -no_dead_strip_inits_and_terms
9335 @itemx -nofixprebinding
9336 @itemx -nomultidefs
9337 @itemx -noprebind
9338 @itemx -noseglinkedit
9339 @itemx -pagezero_size
9340 @itemx -prebind
9341 @itemx -prebind_all_twolevel_modules
9342 @itemx -private_bundle
9343 @itemx -read_only_relocs
9344 @itemx -sectalign
9345 @itemx -sectobjectsymbols
9346 @itemx -whyload
9347 @itemx -seg1addr
9348 @itemx -sectcreate
9349 @itemx -sectobjectsymbols
9350 @itemx -sectorder
9351 @itemx -segaddr
9352 @itemx -segs_read_only_addr
9353 @itemx -segs_read_write_addr
9354 @itemx -seg_addr_table
9355 @itemx -seg_addr_table_filename
9356 @itemx -seglinkedit
9357 @itemx -segprot
9358 @itemx -segs_read_only_addr
9359 @itemx -segs_read_write_addr
9360 @itemx -single_module
9361 @itemx -static
9362 @itemx -sub_library
9363 @itemx -sub_umbrella
9364 @itemx -twolevel_namespace
9365 @itemx -umbrella
9366 @itemx -undefined
9367 @itemx -unexported_symbols_list
9368 @itemx -weak_reference_mismatches
9369 @itemx -whatsloaded
9370 @opindex allowable_client
9371 @opindex client_name
9372 @opindex compatibility_version
9373 @opindex current_version
9374 @opindex dead_strip
9375 @opindex dependency-file
9376 @opindex dylib_file
9377 @opindex dylinker_install_name
9378 @opindex dynamic
9379 @opindex exported_symbols_list
9380 @opindex filelist
9381 @opindex flat_namespace
9382 @opindex force_flat_namespace
9383 @opindex headerpad_max_install_names
9384 @opindex image_base
9385 @opindex init
9386 @opindex install_name
9387 @opindex keep_private_externs
9388 @opindex multi_module
9389 @opindex multiply_defined
9390 @opindex multiply_defined_unused
9391 @opindex noall_load
9392 @opindex no_dead_strip_inits_and_terms
9393 @opindex nofixprebinding
9394 @opindex nomultidefs
9395 @opindex noprebind
9396 @opindex noseglinkedit
9397 @opindex pagezero_size
9398 @opindex prebind
9399 @opindex prebind_all_twolevel_modules
9400 @opindex private_bundle
9401 @opindex read_only_relocs
9402 @opindex sectalign
9403 @opindex sectobjectsymbols
9404 @opindex whyload
9405 @opindex seg1addr
9406 @opindex sectcreate
9407 @opindex sectobjectsymbols
9408 @opindex sectorder
9409 @opindex segaddr
9410 @opindex segs_read_only_addr
9411 @opindex segs_read_write_addr
9412 @opindex seg_addr_table
9413 @opindex seg_addr_table_filename
9414 @opindex seglinkedit
9415 @opindex segprot
9416 @opindex segs_read_only_addr
9417 @opindex segs_read_write_addr
9418 @opindex single_module
9419 @opindex static
9420 @opindex sub_library
9421 @opindex sub_umbrella
9422 @opindex twolevel_namespace
9423 @opindex umbrella
9424 @opindex undefined
9425 @opindex unexported_symbols_list
9426 @opindex weak_reference_mismatches
9427 @opindex whatsloaded
9428 These options are passed to the Darwin linker.  The Darwin linker man page
9429 describes them in detail.
9430 @end table
9431
9432 @node DEC Alpha Options
9433 @subsection DEC Alpha Options
9434
9435 These @samp{-m} options are defined for the DEC Alpha implementations:
9436
9437 @table @gcctabopt
9438 @item -mno-soft-float
9439 @itemx -msoft-float
9440 @opindex mno-soft-float
9441 @opindex msoft-float
9442 Use (do not use) the hardware floating-point instructions for
9443 floating-point operations.  When @option{-msoft-float} is specified,
9444 functions in @file{libgcc.a} will be used to perform floating-point
9445 operations.  Unless they are replaced by routines that emulate the
9446 floating-point operations, or compiled in such a way as to call such
9447 emulations routines, these routines will issue floating-point
9448 operations.   If you are compiling for an Alpha without floating-point
9449 operations, you must ensure that the library is built so as not to call
9450 them.
9451
9452 Note that Alpha implementations without floating-point operations are
9453 required to have floating-point registers.
9454
9455 @item -mfp-reg
9456 @itemx -mno-fp-regs
9457 @opindex mfp-reg
9458 @opindex mno-fp-regs
9459 Generate code that uses (does not use) the floating-point register set.
9460 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9461 register set is not used, floating point operands are passed in integer
9462 registers as if they were integers and floating-point results are passed
9463 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9464 so any function with a floating-point argument or return value called by code
9465 compiled with @option{-mno-fp-regs} must also be compiled with that
9466 option.
9467
9468 A typical use of this option is building a kernel that does not use,
9469 and hence need not save and restore, any floating-point registers.
9470
9471 @item -mieee
9472 @opindex mieee
9473 The Alpha architecture implements floating-point hardware optimized for
9474 maximum performance.  It is mostly compliant with the IEEE floating
9475 point standard.  However, for full compliance, software assistance is
9476 required.  This option generates code fully IEEE compliant code
9477 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9478 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9479 defined during compilation.  The resulting code is less efficient but is
9480 able to correctly support denormalized numbers and exceptional IEEE
9481 values such as not-a-number and plus/minus infinity.  Other Alpha
9482 compilers call this option @option{-ieee_with_no_inexact}.
9483
9484 @item -mieee-with-inexact
9485 @opindex mieee-with-inexact
9486 This is like @option{-mieee} except the generated code also maintains
9487 the IEEE @var{inexact-flag}.  Turning on this option causes the
9488 generated code to implement fully-compliant IEEE math.  In addition to
9489 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9490 macro.  On some Alpha implementations the resulting code may execute
9491 significantly slower than the code generated by default.  Since there is
9492 very little code that depends on the @var{inexact-flag}, you should
9493 normally not specify this option.  Other Alpha compilers call this
9494 option @option{-ieee_with_inexact}.
9495
9496 @item -mfp-trap-mode=@var{trap-mode}
9497 @opindex mfp-trap-mode
9498 This option controls what floating-point related traps are enabled.
9499 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9500 The trap mode can be set to one of four values:
9501
9502 @table @samp
9503 @item n
9504 This is the default (normal) setting.  The only traps that are enabled
9505 are the ones that cannot be disabled in software (e.g., division by zero
9506 trap).
9507
9508 @item u
9509 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9510 as well.
9511
9512 @item su
9513 Like @samp{u}, but the instructions are marked to be safe for software
9514 completion (see Alpha architecture manual for details).
9515
9516 @item sui
9517 Like @samp{su}, but inexact traps are enabled as well.
9518 @end table
9519
9520 @item -mfp-rounding-mode=@var{rounding-mode}
9521 @opindex mfp-rounding-mode
9522 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9523 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9524 of:
9525
9526 @table @samp
9527 @item n
9528 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9529 the nearest machine number or towards the even machine number in case
9530 of a tie.
9531
9532 @item m
9533 Round towards minus infinity.
9534
9535 @item c
9536 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9537
9538 @item d
9539 Dynamic rounding mode.  A field in the floating point control register
9540 (@var{fpcr}, see Alpha architecture reference manual) controls the
9541 rounding mode in effect.  The C library initializes this register for
9542 rounding towards plus infinity.  Thus, unless your program modifies the
9543 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9544 @end table
9545
9546 @item -mtrap-precision=@var{trap-precision}
9547 @opindex mtrap-precision
9548 In the Alpha architecture, floating point traps are imprecise.  This
9549 means without software assistance it is impossible to recover from a
9550 floating trap and program execution normally needs to be terminated.
9551 GCC can generate code that can assist operating system trap handlers
9552 in determining the exact location that caused a floating point trap.
9553 Depending on the requirements of an application, different levels of
9554 precisions can be selected:
9555
9556 @table @samp
9557 @item p
9558 Program precision.  This option is the default and means a trap handler
9559 can only identify which program caused a floating point exception.
9560
9561 @item f
9562 Function precision.  The trap handler can determine the function that
9563 caused a floating point exception.
9564
9565 @item i
9566 Instruction precision.  The trap handler can determine the exact
9567 instruction that caused a floating point exception.
9568 @end table
9569
9570 Other Alpha compilers provide the equivalent options called
9571 @option{-scope_safe} and @option{-resumption_safe}.
9572
9573 @item -mieee-conformant
9574 @opindex mieee-conformant
9575 This option marks the generated code as IEEE conformant.  You must not
9576 use this option unless you also specify @option{-mtrap-precision=i} and either
9577 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9578 is to emit the line @samp{.eflag 48} in the function prologue of the
9579 generated assembly file.  Under DEC Unix, this has the effect that
9580 IEEE-conformant math library routines will be linked in.
9581
9582 @item -mbuild-constants
9583 @opindex mbuild-constants
9584 Normally GCC examines a 32- or 64-bit integer constant to
9585 see if it can construct it from smaller constants in two or three
9586 instructions.  If it cannot, it will output the constant as a literal and
9587 generate code to load it from the data segment at runtime.
9588
9589 Use this option to require GCC to construct @emph{all} integer constants
9590 using code, even if it takes more instructions (the maximum is six).
9591
9592 You would typically use this option to build a shared library dynamic
9593 loader.  Itself a shared library, it must relocate itself in memory
9594 before it can find the variables and constants in its own data segment.
9595
9596 @item -malpha-as
9597 @itemx -mgas
9598 @opindex malpha-as
9599 @opindex mgas
9600 Select whether to generate code to be assembled by the vendor-supplied
9601 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9602
9603 @item -mbwx
9604 @itemx -mno-bwx
9605 @itemx -mcix
9606 @itemx -mno-cix
9607 @itemx -mfix
9608 @itemx -mno-fix
9609 @itemx -mmax
9610 @itemx -mno-max
9611 @opindex mbwx
9612 @opindex mno-bwx
9613 @opindex mcix
9614 @opindex mno-cix
9615 @opindex mfix
9616 @opindex mno-fix
9617 @opindex mmax
9618 @opindex mno-max
9619 Indicate whether GCC should generate code to use the optional BWX,
9620 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9621 sets supported by the CPU type specified via @option{-mcpu=} option or that
9622 of the CPU on which GCC was built if none was specified.
9623
9624 @item -mfloat-vax
9625 @itemx -mfloat-ieee
9626 @opindex mfloat-vax
9627 @opindex mfloat-ieee
9628 Generate code that uses (does not use) VAX F and G floating point
9629 arithmetic instead of IEEE single and double precision.
9630
9631 @item -mexplicit-relocs
9632 @itemx -mno-explicit-relocs
9633 @opindex mexplicit-relocs
9634 @opindex mno-explicit-relocs
9635 Older Alpha assemblers provided no way to generate symbol relocations
9636 except via assembler macros.  Use of these macros does not allow
9637 optimal instruction scheduling.  GNU binutils as of version 2.12
9638 supports a new syntax that allows the compiler to explicitly mark
9639 which relocations should apply to which instructions.  This option
9640 is mostly useful for debugging, as GCC detects the capabilities of
9641 the assembler when it is built and sets the default accordingly.
9642
9643 @item -msmall-data
9644 @itemx -mlarge-data
9645 @opindex msmall-data
9646 @opindex mlarge-data
9647 When @option{-mexplicit-relocs} is in effect, static data is
9648 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9649 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9650 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9651 16-bit relocations off of the @code{$gp} register.  This limits the
9652 size of the small data area to 64KB, but allows the variables to be
9653 directly accessed via a single instruction.
9654
9655 The default is @option{-mlarge-data}.  With this option the data area
9656 is limited to just below 2GB@.  Programs that require more than 2GB of
9657 data must use @code{malloc} or @code{mmap} to allocate the data in the
9658 heap instead of in the program's data segment.
9659
9660 When generating code for shared libraries, @option{-fpic} implies
9661 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9662
9663 @item -msmall-text
9664 @itemx -mlarge-text
9665 @opindex msmall-text
9666 @opindex mlarge-text
9667 When @option{-msmall-text} is used, the compiler assumes that the
9668 code of the entire program (or shared library) fits in 4MB, and is
9669 thus reachable with a branch instruction.  When @option{-msmall-data}
9670 is used, the compiler can assume that all local symbols share the
9671 same @code{$gp} value, and thus reduce the number of instructions
9672 required for a function call from 4 to 1.
9673
9674 The default is @option{-mlarge-text}.
9675
9676 @item -mcpu=@var{cpu_type}
9677 @opindex mcpu
9678 Set the instruction set and instruction scheduling parameters for
9679 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9680 style name or the corresponding chip number.  GCC supports scheduling
9681 parameters for the EV4, EV5 and EV6 family of processors and will
9682 choose the default values for the instruction set from the processor
9683 you specify.  If you do not specify a processor type, GCC will default
9684 to the processor on which the compiler was built.
9685
9686 Supported values for @var{cpu_type} are
9687
9688 @table @samp
9689 @item ev4
9690 @itemx ev45
9691 @itemx 21064
9692 Schedules as an EV4 and has no instruction set extensions.
9693
9694 @item ev5
9695 @itemx 21164
9696 Schedules as an EV5 and has no instruction set extensions.
9697
9698 @item ev56
9699 @itemx 21164a
9700 Schedules as an EV5 and supports the BWX extension.
9701
9702 @item pca56
9703 @itemx 21164pc
9704 @itemx 21164PC
9705 Schedules as an EV5 and supports the BWX and MAX extensions.
9706
9707 @item ev6
9708 @itemx 21264
9709 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9710
9711 @item ev67
9712 @itemx 21264a
9713 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9714 @end table
9715
9716 @item -mtune=@var{cpu_type}
9717 @opindex mtune
9718 Set only the instruction scheduling parameters for machine type
9719 @var{cpu_type}.  The instruction set is not changed.
9720
9721 @item -mmemory-latency=@var{time}
9722 @opindex mmemory-latency
9723 Sets the latency the scheduler should assume for typical memory
9724 references as seen by the application.  This number is highly
9725 dependent on the memory access patterns used by the application
9726 and the size of the external cache on the machine.
9727
9728 Valid options for @var{time} are
9729
9730 @table @samp
9731 @item @var{number}
9732 A decimal number representing clock cycles.
9733
9734 @item L1
9735 @itemx L2
9736 @itemx L3
9737 @itemx main
9738 The compiler contains estimates of the number of clock cycles for
9739 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9740 (also called Dcache, Scache, and Bcache), as well as to main memory.
9741 Note that L3 is only valid for EV5.
9742
9743 @end table
9744 @end table
9745
9746 @node DEC Alpha/VMS Options
9747 @subsection DEC Alpha/VMS Options
9748
9749 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9750
9751 @table @gcctabopt
9752 @item -mvms-return-codes
9753 @opindex mvms-return-codes
9754 Return VMS condition codes from main.  The default is to return POSIX
9755 style condition (e.g.@: error) codes.
9756 @end table
9757
9758 @node FRV Options
9759 @subsection FRV Options
9760 @cindex FRV Options
9761
9762 @table @gcctabopt
9763 @item -mgpr-32
9764 @opindex mgpr-32
9765
9766 Only use the first 32 general purpose registers.
9767
9768 @item -mgpr-64
9769 @opindex mgpr-64
9770
9771 Use all 64 general purpose registers.
9772
9773 @item -mfpr-32
9774 @opindex mfpr-32
9775
9776 Use only the first 32 floating point registers.
9777
9778 @item -mfpr-64
9779 @opindex mfpr-64
9780
9781 Use all 64 floating point registers
9782
9783 @item -mhard-float
9784 @opindex mhard-float
9785
9786 Use hardware instructions for floating point operations.
9787
9788 @item -msoft-float
9789 @opindex msoft-float
9790
9791 Use library routines for floating point operations.
9792
9793 @item -malloc-cc
9794 @opindex malloc-cc
9795
9796 Dynamically allocate condition code registers.
9797
9798 @item -mfixed-cc
9799 @opindex mfixed-cc
9800
9801 Do not try to dynamically allocate condition code registers, only
9802 use @code{icc0} and @code{fcc0}.
9803
9804 @item -mdword
9805 @opindex mdword
9806
9807 Change ABI to use double word insns.
9808
9809 @item -mno-dword
9810 @opindex mno-dword
9811
9812 Do not use double word instructions.
9813
9814 @item -mdouble
9815 @opindex mdouble
9816
9817 Use floating point double instructions.
9818
9819 @item -mno-double
9820 @opindex mno-double
9821
9822 Do not use floating point double instructions.
9823
9824 @item -mmedia
9825 @opindex mmedia
9826
9827 Use media instructions.
9828
9829 @item -mno-media
9830 @opindex mno-media
9831
9832 Do not use media instructions.
9833
9834 @item -mmuladd
9835 @opindex mmuladd
9836
9837 Use multiply and add/subtract instructions.
9838
9839 @item -mno-muladd
9840 @opindex mno-muladd
9841
9842 Do not use multiply and add/subtract instructions.
9843
9844 @item -mfdpic
9845 @opindex mfdpic
9846
9847 Select the FDPIC ABI, that uses function descriptors to represent
9848 pointers to functions.  Without any PIC/PIE-related options, it
9849 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
9850 assumes GOT entries and small data are within a 12-bit range from the
9851 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
9852 are computed with 32 bits.
9853 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9854
9855 @item -minline-plt
9856 @opindex minline-plt
9857
9858 Enable inlining of PLT entries in function calls to functions that are
9859 not known to bind locally.  It has no effect without @option{-mfdpic}.
9860 It's enabled by default if optimizing for speed and compiling for
9861 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
9862 optimization option such as @option{-O3} or above is present in the
9863 command line.
9864
9865 @item -mTLS
9866 @opindex TLS
9867
9868 Assume a large TLS segment when generating thread-local code.
9869
9870 @item -mtls
9871 @opindex tls
9872
9873 Do not assume a large TLS segment when generating thread-local code.
9874
9875 @item -mgprel-ro
9876 @opindex mgprel-ro
9877
9878 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
9879 that is known to be in read-only sections.  It's enabled by default,
9880 except for @option{-fpic} or @option{-fpie}: even though it may help
9881 make the global offset table smaller, it trades 1 instruction for 4.
9882 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
9883 one of which may be shared by multiple symbols, and it avoids the need
9884 for a GOT entry for the referenced symbol, so it's more likely to be a
9885 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
9886
9887 @item -multilib-library-pic
9888 @opindex multilib-library-pic
9889
9890 Link with the (library, not FD) pic libraries.  It's implied by
9891 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
9892 @option{-fpic} without @option{-mfdpic}.  You should never have to use
9893 it explicitly.
9894
9895 @item -mlinked-fp
9896 @opindex mlinked-fp
9897
9898 Follow the EABI requirement of always creating a frame pointer whenever
9899 a stack frame is allocated.  This option is enabled by default and can
9900 be disabled with @option{-mno-linked-fp}.
9901
9902 @item -mlong-calls
9903 @opindex mlong-calls
9904
9905 Use indirect addressing to call functions outside the current
9906 compilation unit.  This allows the functions to be placed anywhere
9907 within the 32-bit address space.
9908
9909 @item -malign-labels
9910 @opindex malign-labels
9911
9912 Try to align labels to an 8-byte boundary by inserting nops into the
9913 previous packet.  This option only has an effect when VLIW packing
9914 is enabled.  It doesn't create new packets; it merely adds nops to
9915 existing ones.
9916
9917 @item -mlibrary-pic
9918 @opindex mlibrary-pic
9919
9920 Generate position-independent EABI code.
9921
9922 @item -macc-4
9923 @opindex macc-4
9924
9925 Use only the first four media accumulator registers.
9926
9927 @item -macc-8
9928 @opindex macc-8
9929
9930 Use all eight media accumulator registers.
9931
9932 @item -mpack
9933 @opindex mpack
9934
9935 Pack VLIW instructions.
9936
9937 @item -mno-pack
9938 @opindex mno-pack
9939
9940 Do not pack VLIW instructions.
9941
9942 @item -mno-eflags
9943 @opindex mno-eflags
9944
9945 Do not mark ABI switches in e_flags.
9946
9947 @item -mcond-move
9948 @opindex mcond-move
9949
9950 Enable the use of conditional-move instructions (default).
9951
9952 This switch is mainly for debugging the compiler and will likely be removed
9953 in a future version.
9954
9955 @item -mno-cond-move
9956 @opindex mno-cond-move
9957
9958 Disable the use of conditional-move instructions.
9959
9960 This switch is mainly for debugging the compiler and will likely be removed
9961 in a future version.
9962
9963 @item -mscc
9964 @opindex mscc
9965
9966 Enable the use of conditional set instructions (default).
9967
9968 This switch is mainly for debugging the compiler and will likely be removed
9969 in a future version.
9970
9971 @item -mno-scc
9972 @opindex mno-scc
9973
9974 Disable the use of conditional set instructions.
9975
9976 This switch is mainly for debugging the compiler and will likely be removed
9977 in a future version.
9978
9979 @item -mcond-exec
9980 @opindex mcond-exec
9981
9982 Enable the use of conditional execution (default).
9983
9984 This switch is mainly for debugging the compiler and will likely be removed
9985 in a future version.
9986
9987 @item -mno-cond-exec
9988 @opindex mno-cond-exec
9989
9990 Disable the use of conditional execution.
9991
9992 This switch is mainly for debugging the compiler and will likely be removed
9993 in a future version.
9994
9995 @item -mvliw-branch
9996 @opindex mvliw-branch
9997
9998 Run a pass to pack branches into VLIW instructions (default).
9999
10000 This switch is mainly for debugging the compiler and will likely be removed
10001 in a future version.
10002
10003 @item -mno-vliw-branch
10004 @opindex mno-vliw-branch
10005
10006 Do not run a pass to pack branches into VLIW instructions.
10007
10008 This switch is mainly for debugging the compiler and will likely be removed
10009 in a future version.
10010
10011 @item -mmulti-cond-exec
10012 @opindex mmulti-cond-exec
10013
10014 Enable optimization of @code{&&} and @code{||} in conditional execution
10015 (default).
10016
10017 This switch is mainly for debugging the compiler and will likely be removed
10018 in a future version.
10019
10020 @item -mno-multi-cond-exec
10021 @opindex mno-multi-cond-exec
10022
10023 Disable optimization of @code{&&} and @code{||} in conditional execution.
10024
10025 This switch is mainly for debugging the compiler and will likely be removed
10026 in a future version.
10027
10028 @item -mnested-cond-exec
10029 @opindex mnested-cond-exec
10030
10031 Enable nested conditional execution optimizations (default).
10032
10033 This switch is mainly for debugging the compiler and will likely be removed
10034 in a future version.
10035
10036 @item -mno-nested-cond-exec
10037 @opindex mno-nested-cond-exec
10038
10039 Disable nested conditional execution optimizations.
10040
10041 This switch is mainly for debugging the compiler and will likely be removed
10042 in a future version.
10043
10044 @item -moptimize-membar
10045 @opindex moptimize-membar
10046
10047 This switch removes redundant @code{membar} instructions from the
10048 compiler generated code.  It is enabled by default.
10049
10050 @item -mno-optimize-membar
10051 @opindex mno-optimize-membar
10052
10053 This switch disables the automatic removal of redundant @code{membar}
10054 instructions from the generated code.
10055
10056 @item -mtomcat-stats
10057 @opindex mtomcat-stats
10058
10059 Cause gas to print out tomcat statistics.
10060
10061 @item -mcpu=@var{cpu}
10062 @opindex mcpu
10063
10064 Select the processor type for which to generate code.  Possible values are
10065 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
10066 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
10067
10068 @end table
10069
10070 @node GNU/Linux Options
10071 @subsection GNU/Linux Options
10072
10073 These @samp{-m} options are defined for GNU/Linux targets:
10074
10075 @table @gcctabopt
10076 @item -mglibc
10077 @opindex mglibc
10078 Use the GNU C library instead of uClibc.  This is the default except
10079 on @samp{*-*-linux-*uclibc*} targets.
10080
10081 @item -muclibc
10082 @opindex muclibc
10083 Use uClibc instead of the GNU C library.  This is the default on
10084 @samp{*-*-linux-*uclibc*} targets.
10085 @end table
10086
10087 @node H8/300 Options
10088 @subsection H8/300 Options
10089
10090 These @samp{-m} options are defined for the H8/300 implementations:
10091
10092 @table @gcctabopt
10093 @item -mrelax
10094 @opindex mrelax
10095 Shorten some address references at link time, when possible; uses the
10096 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
10097 ld, Using ld}, for a fuller description.
10098
10099 @item -mh
10100 @opindex mh
10101 Generate code for the H8/300H@.
10102
10103 @item -ms
10104 @opindex ms
10105 Generate code for the H8S@.
10106
10107 @item -mn
10108 @opindex mn
10109 Generate code for the H8S and H8/300H in the normal mode.  This switch
10110 must be used either with @option{-mh} or @option{-ms}.
10111
10112 @item -ms2600
10113 @opindex ms2600
10114 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
10115
10116 @item -mint32
10117 @opindex mint32
10118 Make @code{int} data 32 bits by default.
10119
10120 @item -malign-300
10121 @opindex malign-300
10122 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
10123 The default for the H8/300H and H8S is to align longs and floats on 4
10124 byte boundaries.
10125 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
10126 This option has no effect on the H8/300.
10127 @end table
10128
10129 @node HPPA Options
10130 @subsection HPPA Options
10131 @cindex HPPA Options
10132
10133 These @samp{-m} options are defined for the HPPA family of computers:
10134
10135 @table @gcctabopt
10136 @item -march=@var{architecture-type}
10137 @opindex march
10138 Generate code for the specified architecture.  The choices for
10139 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
10140 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
10141 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
10142 architecture option for your machine.  Code compiled for lower numbered
10143 architectures will run on higher numbered architectures, but not the
10144 other way around.
10145
10146 @item -mpa-risc-1-0
10147 @itemx -mpa-risc-1-1
10148 @itemx -mpa-risc-2-0
10149 @opindex mpa-risc-1-0
10150 @opindex mpa-risc-1-1
10151 @opindex mpa-risc-2-0
10152 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
10153
10154 @item -mbig-switch
10155 @opindex mbig-switch
10156 Generate code suitable for big switch tables.  Use this option only if
10157 the assembler/linker complain about out of range branches within a switch
10158 table.
10159
10160 @item -mjump-in-delay
10161 @opindex mjump-in-delay
10162 Fill delay slots of function calls with unconditional jump instructions
10163 by modifying the return pointer for the function call to be the target
10164 of the conditional jump.
10165
10166 @item -mdisable-fpregs
10167 @opindex mdisable-fpregs
10168 Prevent floating point registers from being used in any manner.  This is
10169 necessary for compiling kernels which perform lazy context switching of
10170 floating point registers.  If you use this option and attempt to perform
10171 floating point operations, the compiler will abort.
10172
10173 @item -mdisable-indexing
10174 @opindex mdisable-indexing
10175 Prevent the compiler from using indexing address modes.  This avoids some
10176 rather obscure problems when compiling MIG generated code under MACH@.
10177
10178 @item -mno-space-regs
10179 @opindex mno-space-regs
10180 Generate code that assumes the target has no space registers.  This allows
10181 GCC to generate faster indirect calls and use unscaled index address modes.
10182
10183 Such code is suitable for level 0 PA systems and kernels.
10184
10185 @item -mfast-indirect-calls
10186 @opindex mfast-indirect-calls
10187 Generate code that assumes calls never cross space boundaries.  This
10188 allows GCC to emit code which performs faster indirect calls.
10189
10190 This option will not work in the presence of shared libraries or nested
10191 functions.
10192
10193 @item -mfixed-range=@var{register-range}
10194 @opindex mfixed-range
10195 Generate code treating the given register range as fixed registers.
10196 A fixed register is one that the register allocator can not use.  This is
10197 useful when compiling kernel code.  A register range is specified as
10198 two registers separated by a dash.  Multiple register ranges can be
10199 specified separated by a comma.
10200
10201 @item -mlong-load-store
10202 @opindex mlong-load-store
10203 Generate 3-instruction load and store sequences as sometimes required by
10204 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
10205 the HP compilers.
10206
10207 @item -mportable-runtime
10208 @opindex mportable-runtime
10209 Use the portable calling conventions proposed by HP for ELF systems.
10210
10211 @item -mgas
10212 @opindex mgas
10213 Enable the use of assembler directives only GAS understands.
10214
10215 @item -mschedule=@var{cpu-type}
10216 @opindex mschedule
10217 Schedule code according to the constraints for the machine type
10218 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
10219 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
10220 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
10221 proper scheduling option for your machine.  The default scheduling is
10222 @samp{8000}.
10223
10224 @item -mlinker-opt
10225 @opindex mlinker-opt
10226 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
10227 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
10228 linkers in which they give bogus error messages when linking some programs.
10229
10230 @item -msoft-float
10231 @opindex msoft-float
10232 Generate output containing library calls for floating point.
10233 @strong{Warning:} the requisite libraries are not available for all HPPA
10234 targets.  Normally the facilities of the machine's usual C compiler are
10235 used, but this cannot be done directly in cross-compilation.  You must make
10236 your own arrangements to provide suitable library functions for
10237 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
10238 does provide software floating point support.
10239
10240 @option{-msoft-float} changes the calling convention in the output file;
10241 therefore, it is only useful if you compile @emph{all} of a program with
10242 this option.  In particular, you need to compile @file{libgcc.a}, the
10243 library that comes with GCC, with @option{-msoft-float} in order for
10244 this to work.
10245
10246 @item -msio
10247 @opindex msio
10248 Generate the predefine, @code{_SIO}, for server IO@.  The default is
10249 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
10250 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
10251 options are available under HP-UX and HI-UX@.
10252
10253 @item -mgnu-ld
10254 @opindex gnu-ld
10255 Use GNU ld specific options.  This passes @option{-shared} to ld when
10256 building a shared library.  It is the default when GCC is configured,
10257 explicitly or implicitly, with the GNU linker.  This option does not
10258 have any affect on which ld is called, it only changes what parameters
10259 are passed to that ld.  The ld that is called is determined by the
10260 @option{--with-ld} configure option, GCC's program search path, and
10261 finally by the user's @env{PATH}.  The linker used by GCC can be printed
10262 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
10263 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10264
10265 @item -mhp-ld
10266 @opindex hp-ld
10267 Use HP ld specific options.  This passes @option{-b} to ld when building
10268 a shared library and passes @option{+Accept TypeMismatch} to ld on all
10269 links.  It is the default when GCC is configured, explicitly or
10270 implicitly, with the HP linker.  This option does not have any affect on
10271 which ld is called, it only changes what parameters are passed to that
10272 ld.  The ld that is called is determined by the @option{--with-ld}
10273 configure option, GCC's program search path, and finally by the user's
10274 @env{PATH}.  The linker used by GCC can be printed using @samp{which
10275 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
10276 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10277
10278 @item -mlong-calls
10279 @opindex mno-long-calls
10280 Generate code that uses long call sequences.  This ensures that a call
10281 is always able to reach linker generated stubs.  The default is to generate
10282 long calls only when the distance from the call site to the beginning
10283 of the function or translation unit, as the case may be, exceeds a
10284 predefined limit set by the branch type being used.  The limits for
10285 normal calls are 7,600,000 and 240,000 bytes, respectively for the
10286 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
10287 240,000 bytes.
10288
10289 Distances are measured from the beginning of functions when using the
10290 @option{-ffunction-sections} option, or when using the @option{-mgas}
10291 and @option{-mno-portable-runtime} options together under HP-UX with
10292 the SOM linker.
10293
10294 It is normally not desirable to use this option as it will degrade
10295 performance.  However, it may be useful in large applications,
10296 particularly when partial linking is used to build the application.
10297
10298 The types of long calls used depends on the capabilities of the
10299 assembler and linker, and the type of code being generated.  The
10300 impact on systems that support long absolute calls, and long pic
10301 symbol-difference or pc-relative calls should be relatively small.
10302 However, an indirect call is used on 32-bit ELF systems in pic code
10303 and it is quite long.
10304
10305 @item -munix=@var{unix-std}
10306 @opindex march
10307 Generate compiler predefines and select a startfile for the specified
10308 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
10309 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
10310 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
10311 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
10312 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
10313 and later.
10314
10315 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
10316 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
10317 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
10318 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
10319 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
10320 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
10321
10322 It is @emph{important} to note that this option changes the interfaces
10323 for various library routines.  It also affects the operational behavior
10324 of the C library.  Thus, @emph{extreme} care is needed in using this
10325 option.
10326
10327 Library code that is intended to operate with more than one UNIX
10328 standard must test, set and restore the variable @var{__xpg4_extended_mask}
10329 as appropriate.  Most GNU software doesn't provide this capability.
10330
10331 @item -nolibdld
10332 @opindex nolibdld
10333 Suppress the generation of link options to search libdld.sl when the
10334 @option{-static} option is specified on HP-UX 10 and later.
10335
10336 @item -static
10337 @opindex static
10338 The HP-UX implementation of setlocale in libc has a dependency on
10339 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
10340 when the @option{-static} option is specified, special link options
10341 are needed to resolve this dependency.
10342
10343 On HP-UX 10 and later, the GCC driver adds the necessary options to
10344 link with libdld.sl when the @option{-static} option is specified.
10345 This causes the resulting binary to be dynamic.  On the 64-bit port,
10346 the linkers generate dynamic binaries by default in any case.  The
10347 @option{-nolibdld} option can be used to prevent the GCC driver from
10348 adding these link options.
10349
10350 @item -threads
10351 @opindex threads
10352 Add support for multithreading with the @dfn{dce thread} library
10353 under HP-UX@.  This option sets flags for both the preprocessor and
10354 linker.
10355 @end table
10356
10357 @node i386 and x86-64 Options
10358 @subsection Intel 386 and AMD x86-64 Options
10359 @cindex i386 Options
10360 @cindex x86-64 Options
10361 @cindex Intel 386 Options
10362 @cindex AMD x86-64 Options
10363
10364 These @samp{-m} options are defined for the i386 and x86-64 family of
10365 computers:
10366
10367 @table @gcctabopt
10368 @item -mtune=@var{cpu-type}
10369 @opindex mtune
10370 Tune to @var{cpu-type} everything applicable about the generated code, except
10371 for the ABI and the set of available instructions.  The choices for
10372 @var{cpu-type} are:
10373 @table @emph
10374 @item generic
10375 Produce code optimized for the most common IA32/AMD64/EM64T processors.
10376 If you know the CPU on which your code will run, then you should use
10377 the corresponding @option{-mtune} option instead of
10378 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
10379 of your application will have, then you should use this option.
10380
10381 As new processors are deployed in the marketplace, the behavior of this
10382 option will change.  Therefore, if you upgrade to a newer version of
10383 GCC, the code generated option will change to reflect the processors
10384 that were most common when that version of GCC was released.
10385
10386 There is no @option{-march=generic} option because @option{-march}
10387 indicates the instruction set the compiler can use, and there is no
10388 generic instruction set applicable to all processors.  In contrast,
10389 @option{-mtune} indicates the processor (or, in this case, collection of
10390 processors) for which the code is optimized.
10391 @item native
10392 This selects the CPU to tune for at compilation time by determining
10393 the processor type of the compiling machine.  Using @option{-mtune=native}
10394 will produce code optimized for the local machine under the constraints
10395 of the selected instruction set.  Using @option{-march=native} will
10396 enable all instruction subsets supported by the local machine (hence
10397 the result might not run on different machines).
10398 @item i386
10399 Original Intel's i386 CPU@.
10400 @item i486
10401 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
10402 @item i586, pentium
10403 Intel Pentium CPU with no MMX support.
10404 @item pentium-mmx
10405 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
10406 @item pentiumpro
10407 Intel PentiumPro CPU@.
10408 @item i686
10409 Same as @code{generic}, but when used as @code{march} option, PentiumPro
10410 instruction set will be used, so the code will run on all i686 family chips.
10411 @item pentium2
10412 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
10413 @item pentium3, pentium3m
10414 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
10415 support.
10416 @item pentium-m
10417 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10418 support.  Used by Centrino notebooks.
10419 @item pentium4, pentium4m
10420 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10421 @item prescott
10422 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10423 set support.
10424 @item nocona
10425 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10426 SSE2 and SSE3 instruction set support.
10427 @item core2
10428 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10429 instruction set support.
10430 @item k6
10431 AMD K6 CPU with MMX instruction set support.
10432 @item k6-2, k6-3
10433 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
10434 @item athlon, athlon-tbird
10435 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
10436 support.
10437 @item athlon-4, athlon-xp, athlon-mp
10438 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
10439 instruction set support.
10440 @item k8, opteron, athlon64, athlon-fx
10441 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10442 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
10443 @item k8-sse3, opteron-sse3, athlon64-sse3
10444 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10445 @item amdfam10, barcelona
10446 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10447 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10448 instruction set extensions.)
10449 @item winchip-c6
10450 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10451 set support.
10452 @item winchip2
10453 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
10454 instruction set support.
10455 @item c3
10456 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
10457 implemented for this chip.)
10458 @item c3-2
10459 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10460 implemented for this chip.)
10461 @item geode
10462 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10463 @end table
10464
10465 While picking a specific @var{cpu-type} will schedule things appropriately
10466 for that particular chip, the compiler will not generate any code that
10467 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10468 being used.
10469
10470 @item -march=@var{cpu-type}
10471 @opindex march
10472 Generate instructions for the machine type @var{cpu-type}.  The choices
10473 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10474 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10475
10476 @item -mcpu=@var{cpu-type}
10477 @opindex mcpu
10478 A deprecated synonym for @option{-mtune}.
10479
10480 @item -mfpmath=@var{unit}
10481 @opindex march
10482 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10483 for @var{unit} are:
10484
10485 @table @samp
10486 @item 387
10487 Use the standard 387 floating point coprocessor present majority of chips and
10488 emulated otherwise.  Code compiled with this option will run almost everywhere.
10489 The temporary results are computed in 80bit precision instead of precision
10490 specified by the type resulting in slightly different results compared to most
10491 of other chips.  See @option{-ffloat-store} for more detailed description.
10492
10493 This is the default choice for i386 compiler.
10494
10495 @item sse
10496 Use scalar floating point instructions present in the SSE instruction set.
10497 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10498 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10499 instruction set supports only single precision arithmetics, thus the double and
10500 extended precision arithmetics is still done using 387.  Later version, present
10501 only in Pentium4 and the future AMD x86-64 chips supports double precision
10502 arithmetics too.
10503
10504 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10505 or @option{-msse2} switches to enable SSE extensions and make this option
10506 effective.  For the x86-64 compiler, these extensions are enabled by default.
10507
10508 The resulting code should be considerably faster in the majority of cases and avoid
10509 the numerical instability problems of 387 code, but may break some existing
10510 code that expects temporaries to be 80bit.
10511
10512 This is the default choice for the x86-64 compiler.
10513
10514 @item sse,387
10515 Attempt to utilize both instruction sets at once.  This effectively double the
10516 amount of available registers and on chips with separate execution units for
10517 387 and SSE the execution resources too.  Use this option with care, as it is
10518 still experimental, because the GCC register allocator does not model separate
10519 functional units well resulting in instable performance.
10520 @end table
10521
10522 @item -masm=@var{dialect}
10523 @opindex masm=@var{dialect}
10524 Output asm instructions using selected @var{dialect}.  Supported
10525 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10526 not support @samp{intel}.
10527
10528 @item -mieee-fp
10529 @itemx -mno-ieee-fp
10530 @opindex mieee-fp
10531 @opindex mno-ieee-fp
10532 Control whether or not the compiler uses IEEE floating point
10533 comparisons.  These handle correctly the case where the result of a
10534 comparison is unordered.
10535
10536 @item -msoft-float
10537 @opindex msoft-float
10538 Generate output containing library calls for floating point.
10539 @strong{Warning:} the requisite libraries are not part of GCC@.
10540 Normally the facilities of the machine's usual C compiler are used, but
10541 this can't be done directly in cross-compilation.  You must make your
10542 own arrangements to provide suitable library functions for
10543 cross-compilation.
10544
10545 On machines where a function returns floating point results in the 80387
10546 register stack, some floating point opcodes may be emitted even if
10547 @option{-msoft-float} is used.
10548
10549 @item -mno-fp-ret-in-387
10550 @opindex mno-fp-ret-in-387
10551 Do not use the FPU registers for return values of functions.
10552
10553 The usual calling convention has functions return values of types
10554 @code{float} and @code{double} in an FPU register, even if there
10555 is no FPU@.  The idea is that the operating system should emulate
10556 an FPU@.
10557
10558 The option @option{-mno-fp-ret-in-387} causes such values to be returned
10559 in ordinary CPU registers instead.
10560
10561 @item -mno-fancy-math-387
10562 @opindex mno-fancy-math-387
10563 Some 387 emulators do not support the @code{sin}, @code{cos} and
10564 @code{sqrt} instructions for the 387.  Specify this option to avoid
10565 generating those instructions.  This option is the default on FreeBSD,
10566 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
10567 indicates that the target cpu will always have an FPU and so the
10568 instruction will not need emulation.  As of revision 2.6.1, these
10569 instructions are not generated unless you also use the
10570 @option{-funsafe-math-optimizations} switch.
10571
10572 @item -malign-double
10573 @itemx -mno-align-double
10574 @opindex malign-double
10575 @opindex mno-align-double
10576 Control whether GCC aligns @code{double}, @code{long double}, and
10577 @code{long long} variables on a two word boundary or a one word
10578 boundary.  Aligning @code{double} variables on a two word boundary will
10579 produce code that runs somewhat faster on a @samp{Pentium} at the
10580 expense of more memory.
10581
10582 On x86-64, @option{-malign-double} is enabled by default.
10583
10584 @strong{Warning:} if you use the @option{-malign-double} switch,
10585 structures containing the above types will be aligned differently than
10586 the published application binary interface specifications for the 386
10587 and will not be binary compatible with structures in code compiled
10588 without that switch.
10589
10590 @item -m96bit-long-double
10591 @itemx -m128bit-long-double
10592 @opindex m96bit-long-double
10593 @opindex m128bit-long-double
10594 These switches control the size of @code{long double} type.  The i386
10595 application binary interface specifies the size to be 96 bits,
10596 so @option{-m96bit-long-double} is the default in 32 bit mode.
10597
10598 Modern architectures (Pentium and newer) would prefer @code{long double}
10599 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
10600 conforming to the ABI, this would not be possible.  So specifying a
10601 @option{-m128bit-long-double} will align @code{long double}
10602 to a 16 byte boundary by padding the @code{long double} with an additional
10603 32 bit zero.
10604
10605 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
10606 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
10607
10608 Notice that neither of these options enable any extra precision over the x87
10609 standard of 80 bits for a @code{long double}.
10610
10611 @strong{Warning:} if you override the default value for your target ABI, the
10612 structures and arrays containing @code{long double} variables will change
10613 their size as well as function calling convention for function taking
10614 @code{long double} will be modified.  Hence they will not be binary
10615 compatible with arrays or structures in code compiled without that switch.
10616
10617 @item -mmlarge-data-threshold=@var{number}
10618 @opindex mlarge-data-threshold=@var{number}
10619 When @option{-mcmodel=medium} is specified, the data greater than
10620 @var{threshold} are placed in large data section.  This value must be the
10621 same across all object linked into the binary and defaults to 65535.
10622
10623 @item -mrtd
10624 @opindex mrtd
10625 Use a different function-calling convention, in which functions that
10626 take a fixed number of arguments return with the @code{ret} @var{num}
10627 instruction, which pops their arguments while returning.  This saves one
10628 instruction in the caller since there is no need to pop the arguments
10629 there.
10630
10631 You can specify that an individual function is called with this calling
10632 sequence with the function attribute @samp{stdcall}.  You can also
10633 override the @option{-mrtd} option by using the function attribute
10634 @samp{cdecl}.  @xref{Function Attributes}.
10635
10636 @strong{Warning:} this calling convention is incompatible with the one
10637 normally used on Unix, so you cannot use it if you need to call
10638 libraries compiled with the Unix compiler.
10639
10640 Also, you must provide function prototypes for all functions that
10641 take variable numbers of arguments (including @code{printf});
10642 otherwise incorrect code will be generated for calls to those
10643 functions.
10644
10645 In addition, seriously incorrect code will result if you call a
10646 function with too many arguments.  (Normally, extra arguments are
10647 harmlessly ignored.)
10648
10649 @item -mregparm=@var{num}
10650 @opindex mregparm
10651 Control how many registers are used to pass integer arguments.  By
10652 default, no registers are used to pass arguments, and at most 3
10653 registers can be used.  You can control this behavior for a specific
10654 function by using the function attribute @samp{regparm}.
10655 @xref{Function Attributes}.
10656
10657 @strong{Warning:} if you use this switch, and
10658 @var{num} is nonzero, then you must build all modules with the same
10659 value, including any libraries.  This includes the system libraries and
10660 startup modules.
10661
10662 @item -msseregparm
10663 @opindex msseregparm
10664 Use SSE register passing conventions for float and double arguments
10665 and return values.  You can control this behavior for a specific
10666 function by using the function attribute @samp{sseregparm}.
10667 @xref{Function Attributes}.
10668
10669 @strong{Warning:} if you use this switch then you must build all
10670 modules with the same value, including any libraries.  This includes
10671 the system libraries and startup modules.
10672
10673 @item -mpc32
10674 @itemx -mpc64
10675 @itemx -mpc80
10676 @opindex mpc32
10677 @opindex mpc64
10678 @opindex mpc80
10679
10680 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
10681 is specified, the significands of results of floating-point operations are
10682 rounded to 24 bits (single precision); @option{-mpc64} rounds the the
10683 significands of results of floating-point operations to 53 bits (double
10684 precision) and @option{-mpc80} rounds the significands of results of
10685 floating-point operations to 64 bits (extended double precision), which is
10686 the default.  When this option is used, floating-point operations in higher
10687 precisions are not available to the programmer without setting the FPU
10688 control word explicitly.
10689
10690 Setting the rounding of floating-point operations to less than the default
10691 80 bits can speed some programs by 2% or more.  Note that some mathematical
10692 libraries assume that extended precision (80 bit) floating-point operations
10693 are enabled by default; routines in such libraries could suffer significant
10694 loss of accuracy, typically through so-called "catastrophic cancellation",
10695 when this option is used to set the precision to less than extended precision. 
10696
10697 @item -mstackrealign
10698 @opindex mstackrealign
10699 Realign the stack at entry.  On the Intel x86, the
10700 @option{-mstackrealign} option will generate an alternate prologue and
10701 epilogue that realigns the runtime stack.  This supports mixing legacy
10702 codes that keep a 4-byte aligned stack with modern codes that keep a
10703 16-byte stack for SSE compatibility.  The alternate prologue and
10704 epilogue are slower and bigger than the regular ones, and the
10705 alternate prologue requires an extra scratch register; this lowers the
10706 number of registers available if used in conjunction with the
10707 @code{regparm} attribute.  The @option{-mstackrealign} option is
10708 incompatible with the nested function prologue; this is considered a
10709 hard error.  See also the attribute @code{force_align_arg_pointer},
10710 applicable to individual functions.
10711
10712 @item -mpreferred-stack-boundary=@var{num}
10713 @opindex mpreferred-stack-boundary
10714 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
10715 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
10716 the default is 4 (16 bytes or 128 bits).
10717
10718 On Pentium and PentiumPro, @code{double} and @code{long double} values
10719 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
10720 suffer significant run time performance penalties.  On Pentium III, the
10721 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
10722 properly if it is not 16 byte aligned.
10723
10724 To ensure proper alignment of this values on the stack, the stack boundary
10725 must be as aligned as that required by any value stored on the stack.
10726 Further, every function must be generated such that it keeps the stack
10727 aligned.  Thus calling a function compiled with a higher preferred
10728 stack boundary from a function compiled with a lower preferred stack
10729 boundary will most likely misalign the stack.  It is recommended that
10730 libraries that use callbacks always use the default setting.
10731
10732 This extra alignment does consume extra stack space, and generally
10733 increases code size.  Code that is sensitive to stack space usage, such
10734 as embedded systems and operating system kernels, may want to reduce the
10735 preferred alignment to @option{-mpreferred-stack-boundary=2}.
10736
10737 @item -mmmx
10738 @itemx -mno-mmx
10739 @itemx -msse
10740 @itemx -mno-sse
10741 @itemx -msse2
10742 @itemx -mno-sse2
10743 @itemx -msse3
10744 @itemx -mno-sse3
10745 @itemx -mssse3
10746 @itemx -mno-ssse3
10747 @itemx -msse4.1
10748 @itemx -mno-sse4.1
10749 @itemx -msse4.2
10750 @itemx -mno-sse4.2
10751 @itemx -msse4
10752 @itemx -mno-sse4
10753 @itemx -maes
10754 @itemx -mno-aes
10755 @itemx -mpclmul
10756 @itemx -mno-pclmul
10757 @itemx -msse4a
10758 @itemx -mno-sse4a
10759 @itemx -msse5
10760 @itemx -mno-sse5
10761 @itemx -m3dnow
10762 @itemx -mno-3dnow
10763 @itemx -mpopcnt
10764 @itemx -mno-popcnt
10765 @itemx -mabm
10766 @itemx -mno-abm
10767 @opindex mmmx
10768 @opindex mno-mmx
10769 @opindex msse
10770 @opindex mno-sse
10771 @opindex m3dnow
10772 @opindex mno-3dnow
10773 These switches enable or disable the use of instructions in the MMX,
10774 SSE, SSE2, SSE3, SSSE3, SSE4.1, AES, PCLMUL, SSE4A, SSE5, ABM or
10775 3DNow!@: extended instruction sets.
10776 These extensions are also available as built-in functions: see
10777 @ref{X86 Built-in Functions}, for details of the functions enabled and
10778 disabled by these switches.
10779
10780 To have SSE/SSE2 instructions generated automatically from floating-point
10781 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
10782
10783 These options will enable GCC to use these extended instructions in
10784 generated code, even without @option{-mfpmath=sse}.  Applications which
10785 perform runtime CPU detection must compile separate files for each
10786 supported architecture, using the appropriate flags.  In particular,
10787 the file containing the CPU detection code should be compiled without
10788 these options.
10789
10790 @item -mcx16
10791 @opindex mcx16
10792 This option will enable GCC to use CMPXCHG16B instruction in generated code.
10793 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
10794 data types.  This is useful for high resolution counters that could be updated
10795 by multiple processors (or cores).  This instruction is generated as part of
10796 atomic built-in functions: see @ref{Atomic Builtins} for details.
10797
10798 @item -msahf
10799 @opindex msahf
10800 This option will enable GCC to use SAHF instruction in generated 64-bit code.
10801 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
10802 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
10803 SAHF are load and store instructions, respectively, for certain status flags.
10804 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
10805 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
10806
10807 @item -mrecip
10808 @opindex mrecip
10809 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
10810 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Rhapson step
10811 to increase precision instead of DIVSS and SQRTSS (and their vectorized
10812 variants) for single precision floating point arguments.  These instructions
10813 are generated only when @option{-funsafe-math-optimizations} is enabled
10814 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
10815 Note that while the throughput of the sequence is higher than the throughput
10816 of the non-reciprocal instruction, the precision of the sequence can be
10817 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
10818
10819 @item -mveclibabi=@var{type}
10820 @opindex mveclibabi
10821 Specifies the ABI type to use for vectorizing intrinsics using an
10822 external library.  Supported types are @code{svml} for the Intel short
10823 vector math library and @code{acml} for the AMD math core library style
10824 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
10825 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
10826 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
10827 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
10828 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
10829 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
10830 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
10831 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
10832 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
10833 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
10834 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
10835 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
10836 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
10837 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
10838 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
10839 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
10840 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
10841 compatible library will have to be specified at link time.
10842
10843 @item -mpush-args
10844 @itemx -mno-push-args
10845 @opindex mpush-args
10846 @opindex mno-push-args
10847 Use PUSH operations to store outgoing parameters.  This method is shorter
10848 and usually equally fast as method using SUB/MOV operations and is enabled
10849 by default.  In some cases disabling it may improve performance because of
10850 improved scheduling and reduced dependencies.
10851
10852 @item -maccumulate-outgoing-args
10853 @opindex maccumulate-outgoing-args
10854 If enabled, the maximum amount of space required for outgoing arguments will be
10855 computed in the function prologue.  This is faster on most modern CPUs
10856 because of reduced dependencies, improved scheduling and reduced stack usage
10857 when preferred stack boundary is not equal to 2.  The drawback is a notable
10858 increase in code size.  This switch implies @option{-mno-push-args}.
10859
10860 @item -mthreads
10861 @opindex mthreads
10862 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
10863 on thread-safe exception handling must compile and link all code with the
10864 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
10865 @option{-D_MT}; when linking, it links in a special thread helper library
10866 @option{-lmingwthrd} which cleans up per thread exception handling data.
10867
10868 @item -mno-align-stringops
10869 @opindex mno-align-stringops
10870 Do not align destination of inlined string operations.  This switch reduces
10871 code size and improves performance in case the destination is already aligned,
10872 but GCC doesn't know about it.
10873
10874 @item -minline-all-stringops
10875 @opindex minline-all-stringops
10876 By default GCC inlines string operations only when destination is known to be
10877 aligned at least to 4 byte boundary.  This enables more inlining, increase code
10878 size, but may improve performance of code that depends on fast memcpy, strlen
10879 and memset for short lengths.
10880
10881 @item -minline-stringops-dynamically
10882 @opindex minline-stringops-dynamically
10883 For string operation of unknown size, inline runtime checks so for small
10884 blocks inline code is used, while for large blocks library call is used.
10885
10886 @item -mstringop-strategy=@var{alg}
10887 @opindex mstringop-strategy=@var{alg}
10888 Overwrite internal decision heuristic about particular algorithm to inline
10889 string operation with.  The allowed values are @code{rep_byte},
10890 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
10891 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
10892 expanding inline loop, @code{libcall} for always expanding library call.
10893
10894 @item -momit-leaf-frame-pointer
10895 @opindex momit-leaf-frame-pointer
10896 Don't keep the frame pointer in a register for leaf functions.  This
10897 avoids the instructions to save, set up and restore frame pointers and
10898 makes an extra register available in leaf functions.  The option
10899 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10900 which might make debugging harder.
10901
10902 @item -mtls-direct-seg-refs
10903 @itemx -mno-tls-direct-seg-refs
10904 @opindex mtls-direct-seg-refs
10905 Controls whether TLS variables may be accessed with offsets from the
10906 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
10907 or whether the thread base pointer must be added.  Whether or not this
10908 is legal depends on the operating system, and whether it maps the
10909 segment to cover the entire TLS area.
10910
10911 For systems that use GNU libc, the default is on.
10912
10913 @item -mfused-madd
10914 @itemx -mno-fused-madd
10915 @opindex mfused-madd
10916 Enable automatic generation of fused floating point multiply-add instructions
10917 if the ISA supports such instructions.  The -mfused-madd option is on by
10918 default.  The fused multiply-add instructions have a different
10919 rounding behavior compared to executing a multiply followed by an add.
10920 @end table
10921
10922 These @samp{-m} switches are supported in addition to the above
10923 on AMD x86-64 processors in 64-bit environments.
10924
10925 @table @gcctabopt
10926 @item -m32
10927 @itemx -m64
10928 @opindex m32
10929 @opindex m64
10930 Generate code for a 32-bit or 64-bit environment.
10931 The 32-bit environment sets int, long and pointer to 32 bits and
10932 generates code that runs on any i386 system.
10933 The 64-bit environment sets int to 32 bits and long and pointer
10934 to 64 bits and generates code for AMD's x86-64 architecture. For
10935 darwin only the -m64 option turns off the @option{-fno-pic} and
10936 @option{-mdynamic-no-pic} options.
10937
10938 @item -mno-red-zone
10939 @opindex no-red-zone
10940 Do not use a so called red zone for x86-64 code.  The red zone is mandated
10941 by the x86-64 ABI, it is a 128-byte area beyond the location of the
10942 stack pointer that will not be modified by signal or interrupt handlers
10943 and therefore can be used for temporary data without adjusting the stack
10944 pointer.  The flag @option{-mno-red-zone} disables this red zone.
10945
10946 @item -mcmodel=small
10947 @opindex mcmodel=small
10948 Generate code for the small code model: the program and its symbols must
10949 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
10950 Programs can be statically or dynamically linked.  This is the default
10951 code model.
10952
10953 @item -mcmodel=kernel
10954 @opindex mcmodel=kernel
10955 Generate code for the kernel code model.  The kernel runs in the
10956 negative 2 GB of the address space.
10957 This model has to be used for Linux kernel code.
10958
10959 @item -mcmodel=medium
10960 @opindex mcmodel=medium
10961 Generate code for the medium model: The program is linked in the lower 2
10962 GB of the address space but symbols can be located anywhere in the
10963 address space.  Programs can be statically or dynamically linked, but
10964 building of shared libraries are not supported with the medium model.
10965
10966 @item -mcmodel=large
10967 @opindex mcmodel=large
10968 Generate code for the large model: This model makes no assumptions
10969 about addresses and sizes of sections.
10970 @end table
10971
10972 @node IA-64 Options
10973 @subsection IA-64 Options
10974 @cindex IA-64 Options
10975
10976 These are the @samp{-m} options defined for the Intel IA-64 architecture.
10977
10978 @table @gcctabopt
10979 @item -mbig-endian
10980 @opindex mbig-endian
10981 Generate code for a big endian target.  This is the default for HP-UX@.
10982
10983 @item -mlittle-endian
10984 @opindex mlittle-endian
10985 Generate code for a little endian target.  This is the default for AIX5
10986 and GNU/Linux.
10987
10988 @item -mgnu-as
10989 @itemx -mno-gnu-as
10990 @opindex mgnu-as
10991 @opindex mno-gnu-as
10992 Generate (or don't) code for the GNU assembler.  This is the default.
10993 @c Also, this is the default if the configure option @option{--with-gnu-as}
10994 @c is used.
10995
10996 @item -mgnu-ld
10997 @itemx -mno-gnu-ld
10998 @opindex mgnu-ld
10999 @opindex mno-gnu-ld
11000 Generate (or don't) code for the GNU linker.  This is the default.
11001 @c Also, this is the default if the configure option @option{--with-gnu-ld}
11002 @c is used.
11003
11004 @item -mno-pic
11005 @opindex mno-pic
11006 Generate code that does not use a global pointer register.  The result
11007 is not position independent code, and violates the IA-64 ABI@.
11008
11009 @item -mvolatile-asm-stop
11010 @itemx -mno-volatile-asm-stop
11011 @opindex mvolatile-asm-stop
11012 @opindex mno-volatile-asm-stop
11013 Generate (or don't) a stop bit immediately before and after volatile asm
11014 statements.
11015
11016 @item -mregister-names
11017 @itemx -mno-register-names
11018 @opindex mregister-names
11019 @opindex mno-register-names
11020 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
11021 the stacked registers.  This may make assembler output more readable.
11022
11023 @item -mno-sdata
11024 @itemx -msdata
11025 @opindex mno-sdata
11026 @opindex msdata
11027 Disable (or enable) optimizations that use the small data section.  This may
11028 be useful for working around optimizer bugs.
11029
11030 @item -mconstant-gp
11031 @opindex mconstant-gp
11032 Generate code that uses a single constant global pointer value.  This is
11033 useful when compiling kernel code.
11034
11035 @item -mauto-pic
11036 @opindex mauto-pic
11037 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
11038 This is useful when compiling firmware code.
11039
11040 @item -minline-float-divide-min-latency
11041 @opindex minline-float-divide-min-latency
11042 Generate code for inline divides of floating point values
11043 using the minimum latency algorithm.
11044
11045 @item -minline-float-divide-max-throughput
11046 @opindex minline-float-divide-max-throughput
11047 Generate code for inline divides of floating point values
11048 using the maximum throughput algorithm.
11049
11050 @item -minline-int-divide-min-latency
11051 @opindex minline-int-divide-min-latency
11052 Generate code for inline divides of integer values
11053 using the minimum latency algorithm.
11054
11055 @item -minline-int-divide-max-throughput
11056 @opindex minline-int-divide-max-throughput
11057 Generate code for inline divides of integer values
11058 using the maximum throughput algorithm.
11059
11060 @item -minline-sqrt-min-latency
11061 @opindex minline-sqrt-min-latency
11062 Generate code for inline square roots
11063 using the minimum latency algorithm.
11064
11065 @item -minline-sqrt-max-throughput
11066 @opindex minline-sqrt-max-throughput
11067 Generate code for inline square roots
11068 using the maximum throughput algorithm.
11069
11070 @item -mno-dwarf2-asm
11071 @itemx -mdwarf2-asm
11072 @opindex mno-dwarf2-asm
11073 @opindex mdwarf2-asm
11074 Don't (or do) generate assembler code for the DWARF2 line number debugging
11075 info.  This may be useful when not using the GNU assembler.
11076
11077 @item -mearly-stop-bits
11078 @itemx -mno-early-stop-bits
11079 @opindex mearly-stop-bits
11080 @opindex mno-early-stop-bits
11081 Allow stop bits to be placed earlier than immediately preceding the
11082 instruction that triggered the stop bit.  This can improve instruction
11083 scheduling, but does not always do so.
11084
11085 @item -mfixed-range=@var{register-range}
11086 @opindex mfixed-range
11087 Generate code treating the given register range as fixed registers.
11088 A fixed register is one that the register allocator can not use.  This is
11089 useful when compiling kernel code.  A register range is specified as
11090 two registers separated by a dash.  Multiple register ranges can be
11091 specified separated by a comma.
11092
11093 @item -mtls-size=@var{tls-size}
11094 @opindex mtls-size
11095 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
11096 64.
11097
11098 @item -mtune=@var{cpu-type}
11099 @opindex mtune
11100 Tune the instruction scheduling for a particular CPU, Valid values are
11101 itanium, itanium1, merced, itanium2, and mckinley.
11102
11103 @item -mt
11104 @itemx -pthread
11105 @opindex mt
11106 @opindex pthread
11107 Add support for multithreading using the POSIX threads library.  This
11108 option sets flags for both the preprocessor and linker.  It does
11109 not affect the thread safety of object code produced by the compiler or
11110 that of libraries supplied with it.  These are HP-UX specific flags.
11111
11112 @item -milp32
11113 @itemx -mlp64
11114 @opindex milp32
11115 @opindex mlp64
11116 Generate code for a 32-bit or 64-bit environment.
11117 The 32-bit environment sets int, long and pointer to 32 bits.
11118 The 64-bit environment sets int to 32 bits and long and pointer
11119 to 64 bits.  These are HP-UX specific flags.
11120
11121 @item -mno-sched-br-data-spec
11122 @itemx -msched-br-data-spec
11123 @opindex mno-sched-br-data-spec
11124 @opindex msched-br-data-spec
11125 (Dis/En)able data speculative scheduling before reload.
11126 This will result in generation of the ld.a instructions and
11127 the corresponding check instructions (ld.c / chk.a).
11128 The default is 'disable'.
11129
11130 @item -msched-ar-data-spec
11131 @itemx -mno-sched-ar-data-spec
11132 @opindex msched-ar-data-spec
11133 @opindex mno-sched-ar-data-spec
11134 (En/Dis)able data speculative scheduling after reload.
11135 This will result in generation of the ld.a instructions and
11136 the corresponding check instructions (ld.c / chk.a).
11137 The default is 'enable'.
11138
11139 @item -mno-sched-control-spec
11140 @itemx -msched-control-spec
11141 @opindex mno-sched-control-spec
11142 @opindex msched-control-spec
11143 (Dis/En)able control speculative scheduling.  This feature is
11144 available only during region scheduling (i.e.@: before reload).
11145 This will result in generation of the ld.s instructions and
11146 the corresponding check instructions chk.s .
11147 The default is 'disable'.
11148
11149 @item -msched-br-in-data-spec
11150 @itemx -mno-sched-br-in-data-spec
11151 @opindex msched-br-in-data-spec
11152 @opindex mno-sched-br-in-data-spec
11153 (En/Dis)able speculative scheduling of the instructions that
11154 are dependent on the data speculative loads before reload.
11155 This is effective only with @option{-msched-br-data-spec} enabled.
11156 The default is 'enable'.
11157
11158 @item -msched-ar-in-data-spec
11159 @itemx -mno-sched-ar-in-data-spec
11160 @opindex msched-ar-in-data-spec
11161 @opindex mno-sched-ar-in-data-spec
11162 (En/Dis)able speculative scheduling of the instructions that
11163 are dependent on the data speculative loads after reload.
11164 This is effective only with @option{-msched-ar-data-spec} enabled.
11165 The default is 'enable'.
11166
11167 @item -msched-in-control-spec
11168 @itemx -mno-sched-in-control-spec
11169 @opindex msched-in-control-spec
11170 @opindex mno-sched-in-control-spec
11171 (En/Dis)able speculative scheduling of the instructions that
11172 are dependent on the control speculative loads.
11173 This is effective only with @option{-msched-control-spec} enabled.
11174 The default is 'enable'.
11175
11176 @item -msched-ldc
11177 @itemx -mno-sched-ldc
11178 @opindex msched-ldc
11179 @opindex mno-sched-ldc
11180 (En/Dis)able use of simple data speculation checks ld.c .
11181 If disabled, only chk.a instructions will be emitted to check
11182 data speculative loads.
11183 The default is 'enable'.
11184
11185 @item -mno-sched-control-ldc
11186 @itemx -msched-control-ldc
11187 @opindex mno-sched-control-ldc
11188 @opindex msched-control-ldc
11189 (Dis/En)able use of ld.c instructions to check control speculative loads.
11190 If enabled, in case of control speculative load with no speculatively
11191 scheduled dependent instructions this load will be emitted as ld.sa and
11192 ld.c will be used to check it.
11193 The default is 'disable'.
11194
11195 @item -mno-sched-spec-verbose
11196 @itemx -msched-spec-verbose
11197 @opindex mno-sched-spec-verbose
11198 @opindex msched-spec-verbose
11199 (Dis/En)able printing of the information about speculative motions.
11200
11201 @item -mno-sched-prefer-non-data-spec-insns
11202 @itemx -msched-prefer-non-data-spec-insns
11203 @opindex mno-sched-prefer-non-data-spec-insns
11204 @opindex msched-prefer-non-data-spec-insns
11205 If enabled, data speculative instructions will be chosen for schedule
11206 only if there are no other choices at the moment.  This will make
11207 the use of the data speculation much more conservative.
11208 The default is 'disable'.
11209
11210 @item -mno-sched-prefer-non-control-spec-insns
11211 @itemx -msched-prefer-non-control-spec-insns
11212 @opindex mno-sched-prefer-non-control-spec-insns
11213 @opindex msched-prefer-non-control-spec-insns
11214 If enabled, control speculative instructions will be chosen for schedule
11215 only if there are no other choices at the moment.  This will make
11216 the use of the control speculation much more conservative.
11217 The default is 'disable'.
11218
11219 @item -mno-sched-count-spec-in-critical-path
11220 @itemx -msched-count-spec-in-critical-path
11221 @opindex mno-sched-count-spec-in-critical-path
11222 @opindex msched-count-spec-in-critical-path
11223 If enabled, speculative dependencies will be considered during
11224 computation of the instructions priorities.  This will make the use of the
11225 speculation a bit more conservative.
11226 The default is 'disable'.
11227
11228 @end table
11229
11230 @node M32C Options
11231 @subsection M32C Options
11232 @cindex M32C options
11233
11234 @table @gcctabopt
11235 @item -mcpu=@var{name}
11236 @opindex mcpu=
11237 Select the CPU for which code is generated.  @var{name} may be one of
11238 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
11239 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
11240 the M32C/80 series.
11241
11242 @item -msim
11243 @opindex msim
11244 Specifies that the program will be run on the simulator.  This causes
11245 an alternate runtime library to be linked in which supports, for
11246 example, file I/O@.  You must not use this option when generating
11247 programs that will run on real hardware; you must provide your own
11248 runtime library for whatever I/O functions are needed.
11249
11250 @item -memregs=@var{number}
11251 @opindex memregs=
11252 Specifies the number of memory-based pseudo-registers GCC will use
11253 during code generation.  These pseudo-registers will be used like real
11254 registers, so there is a tradeoff between GCC's ability to fit the
11255 code into available registers, and the performance penalty of using
11256 memory instead of registers.  Note that all modules in a program must
11257 be compiled with the same value for this option.  Because of that, you
11258 must not use this option with the default runtime libraries gcc
11259 builds.
11260
11261 @end table
11262
11263 @node M32R/D Options
11264 @subsection M32R/D Options
11265 @cindex M32R/D options
11266
11267 These @option{-m} options are defined for Renesas M32R/D architectures:
11268
11269 @table @gcctabopt
11270 @item -m32r2
11271 @opindex m32r2
11272 Generate code for the M32R/2@.
11273
11274 @item -m32rx
11275 @opindex m32rx
11276 Generate code for the M32R/X@.
11277
11278 @item -m32r
11279 @opindex m32r
11280 Generate code for the M32R@.  This is the default.
11281
11282 @item -mmodel=small
11283 @opindex mmodel=small
11284 Assume all objects live in the lower 16MB of memory (so that their addresses
11285 can be loaded with the @code{ld24} instruction), and assume all subroutines
11286 are reachable with the @code{bl} instruction.
11287 This is the default.
11288
11289 The addressability of a particular object can be set with the
11290 @code{model} attribute.
11291
11292 @item -mmodel=medium
11293 @opindex mmodel=medium
11294 Assume objects may be anywhere in the 32-bit address space (the compiler
11295 will generate @code{seth/add3} instructions to load their addresses), and
11296 assume all subroutines are reachable with the @code{bl} instruction.
11297
11298 @item -mmodel=large
11299 @opindex mmodel=large
11300 Assume objects may be anywhere in the 32-bit address space (the compiler
11301 will generate @code{seth/add3} instructions to load their addresses), and
11302 assume subroutines may not be reachable with the @code{bl} instruction
11303 (the compiler will generate the much slower @code{seth/add3/jl}
11304 instruction sequence).
11305
11306 @item -msdata=none
11307 @opindex msdata=none
11308 Disable use of the small data area.  Variables will be put into
11309 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
11310 @code{section} attribute has been specified).
11311 This is the default.
11312
11313 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
11314 Objects may be explicitly put in the small data area with the
11315 @code{section} attribute using one of these sections.
11316
11317 @item -msdata=sdata
11318 @opindex msdata=sdata
11319 Put small global and static data in the small data area, but do not
11320 generate special code to reference them.
11321
11322 @item -msdata=use
11323 @opindex msdata=use
11324 Put small global and static data in the small data area, and generate
11325 special instructions to reference them.
11326
11327 @item -G @var{num}
11328 @opindex G
11329 @cindex smaller data references
11330 Put global and static objects less than or equal to @var{num} bytes
11331 into the small data or bss sections instead of the normal data or bss
11332 sections.  The default value of @var{num} is 8.
11333 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
11334 for this option to have any effect.
11335
11336 All modules should be compiled with the same @option{-G @var{num}} value.
11337 Compiling with different values of @var{num} may or may not work; if it
11338 doesn't the linker will give an error message---incorrect code will not be
11339 generated.
11340
11341 @item -mdebug
11342 @opindex mdebug
11343 Makes the M32R specific code in the compiler display some statistics
11344 that might help in debugging programs.
11345
11346 @item -malign-loops
11347 @opindex malign-loops
11348 Align all loops to a 32-byte boundary.
11349
11350 @item -mno-align-loops
11351 @opindex mno-align-loops
11352 Do not enforce a 32-byte alignment for loops.  This is the default.
11353
11354 @item -missue-rate=@var{number}
11355 @opindex missue-rate=@var{number}
11356 Issue @var{number} instructions per cycle.  @var{number} can only be 1
11357 or 2.
11358
11359 @item -mbranch-cost=@var{number}
11360 @opindex mbranch-cost=@var{number}
11361 @var{number} can only be 1 or 2.  If it is 1 then branches will be
11362 preferred over conditional code, if it is 2, then the opposite will
11363 apply.
11364
11365 @item -mflush-trap=@var{number}
11366 @opindex mflush-trap=@var{number}
11367 Specifies the trap number to use to flush the cache.  The default is
11368 12.  Valid numbers are between 0 and 15 inclusive.
11369
11370 @item -mno-flush-trap
11371 @opindex mno-flush-trap
11372 Specifies that the cache cannot be flushed by using a trap.
11373
11374 @item -mflush-func=@var{name}
11375 @opindex mflush-func=@var{name}
11376 Specifies the name of the operating system function to call to flush
11377 the cache.  The default is @emph{_flush_cache}, but a function call
11378 will only be used if a trap is not available.
11379
11380 @item -mno-flush-func
11381 @opindex mno-flush-func
11382 Indicates that there is no OS function for flushing the cache.
11383
11384 @end table
11385
11386 @node M680x0 Options
11387 @subsection M680x0 Options
11388 @cindex M680x0 options
11389
11390 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
11391 The default settings depend on which architecture was selected when
11392 the compiler was configured; the defaults for the most common choices
11393 are given below.
11394
11395 @table @gcctabopt
11396 @item -march=@var{arch}
11397 @opindex march
11398 Generate code for a specific M680x0 or ColdFire instruction set
11399 architecture.  Permissible values of @var{arch} for M680x0
11400 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
11401 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
11402 architectures are selected according to Freescale's ISA classification
11403 and the permissible values are: @samp{isaa}, @samp{isaaplus},
11404 @samp{isab} and @samp{isac}.
11405
11406 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
11407 code for a ColdFire target.  The @var{arch} in this macro is one of the
11408 @option{-march} arguments given above.
11409
11410 When used together, @option{-march} and @option{-mtune} select code
11411 that runs on a family of similar processors but that is optimized
11412 for a particular microarchitecture.
11413
11414 @item -mcpu=@var{cpu}
11415 @opindex mcpu
11416 Generate code for a specific M680x0 or ColdFire processor.
11417 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
11418 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
11419 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
11420 below, which also classifies the CPUs into families:
11421
11422 @multitable @columnfractions 0.20 0.80
11423 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
11424 @item @samp{51qe} @tab @samp{51qe}
11425 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
11426 @item @samp{5206e} @tab @samp{5206e}
11427 @item @samp{5208} @tab @samp{5207} @samp{5208}
11428 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
11429 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
11430 @item @samp{5216} @tab @samp{5214} @samp{5216}
11431 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
11432 @item @samp{5225} @tab @samp{5224} @samp{5225}
11433 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
11434 @item @samp{5249} @tab @samp{5249}
11435 @item @samp{5250} @tab @samp{5250}
11436 @item @samp{5271} @tab @samp{5270} @samp{5271}
11437 @item @samp{5272} @tab @samp{5272}
11438 @item @samp{5275} @tab @samp{5274} @samp{5275}
11439 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
11440 @item @samp{5307} @tab @samp{5307}
11441 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
11442 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
11443 @item @samp{5407} @tab @samp{5407}
11444 @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}
11445 @end multitable
11446
11447 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
11448 @var{arch} is compatible with @var{cpu}.  Other combinations of
11449 @option{-mcpu} and @option{-march} are rejected.
11450
11451 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
11452 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
11453 where the value of @var{family} is given by the table above.
11454
11455 @item -mtune=@var{tune}
11456 @opindex mtune
11457 Tune the code for a particular microarchitecture, within the
11458 constraints set by @option{-march} and @option{-mcpu}.
11459 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
11460 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11461 and @samp{cpu32}.  The ColdFire microarchitectures
11462 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11463
11464 You can also use @option{-mtune=68020-40} for code that needs
11465 to run relatively well on 68020, 68030 and 68040 targets.
11466 @option{-mtune=68020-60} is similar but includes 68060 targets
11467 as well.  These two options select the same tuning decisions as
11468 @option{-m68020-40} and @option{-m68020-60} respectively.
11469
11470 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11471 when tuning for 680x0 architecture @var{arch}.  It also defines
11472 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11473 option is used.  If gcc is tuning for a range of architectures,
11474 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11475 it defines the macros for every architecture in the range.
11476
11477 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11478 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11479 of the arguments given above.
11480
11481 @item -m68000
11482 @itemx -mc68000
11483 @opindex m68000
11484 @opindex mc68000
11485 Generate output for a 68000.  This is the default
11486 when the compiler is configured for 68000-based systems.
11487 It is equivalent to @option{-march=68000}.
11488
11489 Use this option for microcontrollers with a 68000 or EC000 core,
11490 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11491
11492 @item -m68010
11493 @opindex m68010
11494 Generate output for a 68010.  This is the default
11495 when the compiler is configured for 68010-based systems.
11496 It is equivalent to @option{-march=68010}.
11497
11498 @item -m68020
11499 @itemx -mc68020
11500 @opindex m68020
11501 @opindex mc68020
11502 Generate output for a 68020.  This is the default
11503 when the compiler is configured for 68020-based systems.
11504 It is equivalent to @option{-march=68020}.
11505
11506 @item -m68030
11507 @opindex m68030
11508 Generate output for a 68030.  This is the default when the compiler is
11509 configured for 68030-based systems.  It is equivalent to
11510 @option{-march=68030}.
11511
11512 @item -m68040
11513 @opindex m68040
11514 Generate output for a 68040.  This is the default when the compiler is
11515 configured for 68040-based systems.  It is equivalent to
11516 @option{-march=68040}.
11517
11518 This option inhibits the use of 68881/68882 instructions that have to be
11519 emulated by software on the 68040.  Use this option if your 68040 does not
11520 have code to emulate those instructions.
11521
11522 @item -m68060
11523 @opindex m68060
11524 Generate output for a 68060.  This is the default when the compiler is
11525 configured for 68060-based systems.  It is equivalent to
11526 @option{-march=68060}.
11527
11528 This option inhibits the use of 68020 and 68881/68882 instructions that
11529 have to be emulated by software on the 68060.  Use this option if your 68060
11530 does not have code to emulate those instructions.
11531
11532 @item -mcpu32
11533 @opindex mcpu32
11534 Generate output for a CPU32.  This is the default
11535 when the compiler is configured for CPU32-based systems.
11536 It is equivalent to @option{-march=cpu32}.
11537
11538 Use this option for microcontrollers with a
11539 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
11540 68336, 68340, 68341, 68349 and 68360.
11541
11542 @item -m5200
11543 @opindex m5200
11544 Generate output for a 520X ColdFire CPU@.  This is the default
11545 when the compiler is configured for 520X-based systems.
11546 It is equivalent to @option{-mcpu=5206}, and is now deprecated
11547 in favor of that option.
11548
11549 Use this option for microcontroller with a 5200 core, including
11550 the MCF5202, MCF5203, MCF5204 and MCF5206.
11551
11552 @item -m5206e
11553 @opindex m5206e
11554 Generate output for a 5206e ColdFire CPU@.  The option is now
11555 deprecated in favor of the equivalent @option{-mcpu=5206e}.
11556
11557 @item -m528x
11558 @opindex m528x
11559 Generate output for a member of the ColdFire 528X family.
11560 The option is now deprecated in favor of the equivalent
11561 @option{-mcpu=528x}.
11562
11563 @item -m5307
11564 @opindex m5307
11565 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
11566 in favor of the equivalent @option{-mcpu=5307}.
11567
11568 @item -m5407
11569 @opindex m5407
11570 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
11571 in favor of the equivalent @option{-mcpu=5407}.
11572
11573 @item -mcfv4e
11574 @opindex mcfv4e
11575 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
11576 This includes use of hardware floating point instructions.
11577 The option is equivalent to @option{-mcpu=547x}, and is now
11578 deprecated in favor of that option.
11579
11580 @item -m68020-40
11581 @opindex m68020-40
11582 Generate output for a 68040, without using any of the new instructions.
11583 This results in code which can run relatively efficiently on either a
11584 68020/68881 or a 68030 or a 68040.  The generated code does use the
11585 68881 instructions that are emulated on the 68040.
11586
11587 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
11588
11589 @item -m68020-60
11590 @opindex m68020-60
11591 Generate output for a 68060, without using any of the new instructions.
11592 This results in code which can run relatively efficiently on either a
11593 68020/68881 or a 68030 or a 68040.  The generated code does use the
11594 68881 instructions that are emulated on the 68060.
11595
11596 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
11597
11598 @item -mhard-float
11599 @itemx -m68881
11600 @opindex mhard-float
11601 @opindex m68881
11602 Generate floating-point instructions.  This is the default for 68020
11603 and above, and for ColdFire devices that have an FPU@.  It defines the
11604 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
11605 on ColdFire targets.
11606
11607 @item -msoft-float
11608 @opindex msoft-float
11609 Do not generate floating-point instructions; use library calls instead.
11610 This is the default for 68000, 68010, and 68832 targets.  It is also
11611 the default for ColdFire devices that have no FPU.
11612
11613 @item -mdiv
11614 @itemx -mno-div
11615 @opindex mdiv
11616 @opindex mno-div
11617 Generate (do not generate) ColdFire hardware divide and remainder
11618 instructions.  If @option{-march} is used without @option{-mcpu},
11619 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
11620 architectures.  Otherwise, the default is taken from the target CPU
11621 (either the default CPU, or the one specified by @option{-mcpu}).  For
11622 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
11623 @option{-mcpu=5206e}.
11624
11625 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
11626
11627 @item -mshort
11628 @opindex mshort
11629 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11630 Additionally, parameters passed on the stack are also aligned to a
11631 16-bit boundary even on targets whose API mandates promotion to 32-bit.
11632
11633 @item -mno-short
11634 @opindex mno-short
11635 Do not consider type @code{int} to be 16 bits wide.  This is the default.
11636
11637 @item -mnobitfield
11638 @itemx -mno-bitfield
11639 @opindex mnobitfield
11640 @opindex mno-bitfield
11641 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
11642 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
11643
11644 @item -mbitfield
11645 @opindex mbitfield
11646 Do use the bit-field instructions.  The @option{-m68020} option implies
11647 @option{-mbitfield}.  This is the default if you use a configuration
11648 designed for a 68020.
11649
11650 @item -mrtd
11651 @opindex mrtd
11652 Use a different function-calling convention, in which functions
11653 that take a fixed number of arguments return with the @code{rtd}
11654 instruction, which pops their arguments while returning.  This
11655 saves one instruction in the caller since there is no need to pop
11656 the arguments there.
11657
11658 This calling convention is incompatible with the one normally
11659 used on Unix, so you cannot use it if you need to call libraries
11660 compiled with the Unix compiler.
11661
11662 Also, you must provide function prototypes for all functions that
11663 take variable numbers of arguments (including @code{printf});
11664 otherwise incorrect code will be generated for calls to those
11665 functions.
11666
11667 In addition, seriously incorrect code will result if you call a
11668 function with too many arguments.  (Normally, extra arguments are
11669 harmlessly ignored.)
11670
11671 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
11672 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
11673
11674 @item -mno-rtd
11675 @opindex mno-rtd
11676 Do not use the calling conventions selected by @option{-mrtd}.
11677 This is the default.
11678
11679 @item -malign-int
11680 @itemx -mno-align-int
11681 @opindex malign-int
11682 @opindex mno-align-int
11683 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
11684 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
11685 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
11686 Aligning variables on 32-bit boundaries produces code that runs somewhat
11687 faster on processors with 32-bit busses at the expense of more memory.
11688
11689 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
11690 align structures containing the above types  differently than
11691 most published application binary interface specifications for the m68k.
11692
11693 @item -mpcrel
11694 @opindex mpcrel
11695 Use the pc-relative addressing mode of the 68000 directly, instead of
11696 using a global offset table.  At present, this option implies @option{-fpic},
11697 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
11698 not presently supported with @option{-mpcrel}, though this could be supported for
11699 68020 and higher processors.
11700
11701 @item -mno-strict-align
11702 @itemx -mstrict-align
11703 @opindex mno-strict-align
11704 @opindex mstrict-align
11705 Do not (do) assume that unaligned memory references will be handled by
11706 the system.
11707
11708 @item -msep-data
11709 Generate code that allows the data segment to be located in a different
11710 area of memory from the text segment.  This allows for execute in place in
11711 an environment without virtual memory management.  This option implies
11712 @option{-fPIC}.
11713
11714 @item -mno-sep-data
11715 Generate code that assumes that the data segment follows the text segment.
11716 This is the default.
11717
11718 @item -mid-shared-library
11719 Generate code that supports shared libraries via the library ID method.
11720 This allows for execute in place and shared libraries in an environment
11721 without virtual memory management.  This option implies @option{-fPIC}.
11722
11723 @item -mno-id-shared-library
11724 Generate code that doesn't assume ID based shared libraries are being used.
11725 This is the default.
11726
11727 @item -mshared-library-id=n
11728 Specified the identification number of the ID based shared library being
11729 compiled.  Specifying a value of 0 will generate more compact code, specifying
11730 other values will force the allocation of that number to the current
11731 library but is no more space or time efficient than omitting this option.
11732
11733 @end table
11734
11735 @node M68hc1x Options
11736 @subsection M68hc1x Options
11737 @cindex M68hc1x options
11738
11739 These are the @samp{-m} options defined for the 68hc11 and 68hc12
11740 microcontrollers.  The default values for these options depends on
11741 which style of microcontroller was selected when the compiler was configured;
11742 the defaults for the most common choices are given below.
11743
11744 @table @gcctabopt
11745 @item -m6811
11746 @itemx -m68hc11
11747 @opindex m6811
11748 @opindex m68hc11
11749 Generate output for a 68HC11.  This is the default
11750 when the compiler is configured for 68HC11-based systems.
11751
11752 @item -m6812
11753 @itemx -m68hc12
11754 @opindex m6812
11755 @opindex m68hc12
11756 Generate output for a 68HC12.  This is the default
11757 when the compiler is configured for 68HC12-based systems.
11758
11759 @item -m68S12
11760 @itemx -m68hcs12
11761 @opindex m68S12
11762 @opindex m68hcs12
11763 Generate output for a 68HCS12.
11764
11765 @item -mauto-incdec
11766 @opindex mauto-incdec
11767 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
11768 addressing modes.
11769
11770 @item -minmax
11771 @itemx -nominmax
11772 @opindex minmax
11773 @opindex mnominmax
11774 Enable the use of 68HC12 min and max instructions.
11775
11776 @item -mlong-calls
11777 @itemx -mno-long-calls
11778 @opindex mlong-calls
11779 @opindex mno-long-calls
11780 Treat all calls as being far away (near).  If calls are assumed to be
11781 far away, the compiler will use the @code{call} instruction to
11782 call a function and the @code{rtc} instruction for returning.
11783
11784 @item -mshort
11785 @opindex mshort
11786 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11787
11788 @item -msoft-reg-count=@var{count}
11789 @opindex msoft-reg-count
11790 Specify the number of pseudo-soft registers which are used for the
11791 code generation.  The maximum number is 32.  Using more pseudo-soft
11792 register may or may not result in better code depending on the program.
11793 The default is 4 for 68HC11 and 2 for 68HC12.
11794
11795 @end table
11796
11797 @node MCore Options
11798 @subsection MCore Options
11799 @cindex MCore options
11800
11801 These are the @samp{-m} options defined for the Motorola M*Core
11802 processors.
11803
11804 @table @gcctabopt
11805
11806 @item -mhardlit
11807 @itemx -mno-hardlit
11808 @opindex mhardlit
11809 @opindex mno-hardlit
11810 Inline constants into the code stream if it can be done in two
11811 instructions or less.
11812
11813 @item -mdiv
11814 @itemx -mno-div
11815 @opindex mdiv
11816 @opindex mno-div
11817 Use the divide instruction.  (Enabled by default).
11818
11819 @item -mrelax-immediate
11820 @itemx -mno-relax-immediate
11821 @opindex mrelax-immediate
11822 @opindex mno-relax-immediate
11823 Allow arbitrary sized immediates in bit operations.
11824
11825 @item -mwide-bitfields
11826 @itemx -mno-wide-bitfields
11827 @opindex mwide-bitfields
11828 @opindex mno-wide-bitfields
11829 Always treat bit-fields as int-sized.
11830
11831 @item -m4byte-functions
11832 @itemx -mno-4byte-functions
11833 @opindex m4byte-functions
11834 @opindex mno-4byte-functions
11835 Force all functions to be aligned to a four byte boundary.
11836
11837 @item -mcallgraph-data
11838 @itemx -mno-callgraph-data
11839 @opindex mcallgraph-data
11840 @opindex mno-callgraph-data
11841 Emit callgraph information.
11842
11843 @item -mslow-bytes
11844 @itemx -mno-slow-bytes
11845 @opindex mslow-bytes
11846 @opindex mno-slow-bytes
11847 Prefer word access when reading byte quantities.
11848
11849 @item -mlittle-endian
11850 @itemx -mbig-endian
11851 @opindex mlittle-endian
11852 @opindex mbig-endian
11853 Generate code for a little endian target.
11854
11855 @item -m210
11856 @itemx -m340
11857 @opindex m210
11858 @opindex m340
11859 Generate code for the 210 processor.
11860 @end table
11861
11862 @node MIPS Options
11863 @subsection MIPS Options
11864 @cindex MIPS options
11865
11866 @table @gcctabopt
11867
11868 @item -EB
11869 @opindex EB
11870 Generate big-endian code.
11871
11872 @item -EL
11873 @opindex EL
11874 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
11875 configurations.
11876
11877 @item -march=@var{arch}
11878 @opindex march
11879 Generate code that will run on @var{arch}, which can be the name of a
11880 generic MIPS ISA, or the name of a particular processor.
11881 The ISA names are:
11882 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
11883 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
11884 The processor names are:
11885 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
11886 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
11887 @samp{5kc}, @samp{5kf},
11888 @samp{20kc},
11889 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
11890 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
11891 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
11892 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
11893 @samp{m4k},
11894 @samp{orion},
11895 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
11896 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
11897 @samp{rm7000}, @samp{rm9000},
11898 @samp{sb1},
11899 @samp{sr71000},
11900 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
11901 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
11902 The special value @samp{from-abi} selects the
11903 most compatible architecture for the selected ABI (that is,
11904 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
11905
11906 In processor names, a final @samp{000} can be abbreviated as @samp{k}
11907 (for example, @samp{-march=r2k}).  Prefixes are optional, and
11908 @samp{vr} may be written @samp{r}.
11909
11910 Names of the form @samp{@var{n}f2_1} refer to processors with
11911 FPUs clocked at half the rate of the core, names of the form
11912 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
11913 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
11914 processors with FPUs clocked a ratio of 3:2 with respect to the core.
11915 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
11916 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
11917 accepted as synonyms for @samp{@var{n}f1_1}.
11918
11919 GCC defines two macros based on the value of this option.  The first
11920 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
11921 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
11922 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
11923 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
11924 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
11925
11926 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
11927 above.  In other words, it will have the full prefix and will not
11928 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
11929 the macro names the resolved architecture (either @samp{"mips1"} or
11930 @samp{"mips3"}).  It names the default architecture when no
11931 @option{-march} option is given.
11932
11933 @item -mtune=@var{arch}
11934 @opindex mtune
11935 Optimize for @var{arch}.  Among other things, this option controls
11936 the way instructions are scheduled, and the perceived cost of arithmetic
11937 operations.  The list of @var{arch} values is the same as for
11938 @option{-march}.
11939
11940 When this option is not used, GCC will optimize for the processor
11941 specified by @option{-march}.  By using @option{-march} and
11942 @option{-mtune} together, it is possible to generate code that will
11943 run on a family of processors, but optimize the code for one
11944 particular member of that family.
11945
11946 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
11947 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
11948 @samp{-march} ones described above.
11949
11950 @item -mips1
11951 @opindex mips1
11952 Equivalent to @samp{-march=mips1}.
11953
11954 @item -mips2
11955 @opindex mips2
11956 Equivalent to @samp{-march=mips2}.
11957
11958 @item -mips3
11959 @opindex mips3
11960 Equivalent to @samp{-march=mips3}.
11961
11962 @item -mips4
11963 @opindex mips4
11964 Equivalent to @samp{-march=mips4}.
11965
11966 @item -mips32
11967 @opindex mips32
11968 Equivalent to @samp{-march=mips32}.
11969
11970 @item -mips32r2
11971 @opindex mips32r2
11972 Equivalent to @samp{-march=mips32r2}.
11973
11974 @item -mips64
11975 @opindex mips64
11976 Equivalent to @samp{-march=mips64}.
11977
11978 @item -mips16
11979 @itemx -mno-mips16
11980 @opindex mips16
11981 @opindex mno-mips16
11982 Generate (do not generate) MIPS16 code.  If GCC is targetting a
11983 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
11984
11985 MIPS16 code generation can also be controlled on a per-function basis
11986 by means of @code{mips16} and @code{nomips16} attributes.  
11987 @xref{Function Attributes}, for more information.
11988
11989 @item -mflip-mips16
11990 @opindex mflip-mips16
11991 Generate MIPS16 code on alternating functions.  This option is provided
11992 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
11993 not intended for ordinary use in compiling user code.
11994
11995 @item -minterlink-mips16
11996 @itemx -mno-interlink-mips16
11997 @opindex minterlink-mips16
11998 @opindex mno-interlink-mips16
11999 Require (do not require) that non-MIPS16 code be link-compatible with
12000 MIPS16 code.
12001
12002 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
12003 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
12004 therefore disables direct jumps unless GCC knows that the target of the
12005 jump is not MIPS16.
12006
12007 @item -mabi=32
12008 @itemx -mabi=o64
12009 @itemx -mabi=n32
12010 @itemx -mabi=64
12011 @itemx -mabi=eabi
12012 @opindex mabi=32
12013 @opindex mabi=o64
12014 @opindex mabi=n32
12015 @opindex mabi=64
12016 @opindex mabi=eabi
12017 Generate code for the given ABI@.
12018
12019 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
12020 generates 64-bit code when you select a 64-bit architecture, but you
12021 can use @option{-mgp32} to get 32-bit code instead.
12022
12023 For information about the O64 ABI, see
12024 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
12025
12026 GCC supports a variant of the o32 ABI in which floating-point registers
12027 are 64 rather than 32 bits wide.  You can select this combination with
12028 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
12029 and @samp{mfhc1} instructions and is therefore only supported for
12030 MIPS32R2 processors.
12031
12032 The register assignments for arguments and return values remain the
12033 same, but each scalar value is passed in a single 64-bit register
12034 rather than a pair of 32-bit registers.  For example, scalar
12035 floating-point values are returned in @samp{$f0} only, not a
12036 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
12037 remains the same, but all 64 bits are saved.
12038
12039 @item -mabicalls
12040 @itemx -mno-abicalls
12041 @opindex mabicalls
12042 @opindex mno-abicalls
12043 Generate (do not generate) code that is suitable for SVR4-style
12044 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
12045 systems.
12046
12047 @item -mshared
12048 @itemx -mno-shared
12049 Generate (do not generate) code that is fully position-independent,
12050 and that can therefore be linked into shared libraries.  This option
12051 only affects @option{-mabicalls}.
12052
12053 All @option{-mabicalls} code has traditionally been position-independent,
12054 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
12055 as an extension, the GNU toolchain allows executables to use absolute
12056 accesses for locally-binding symbols.  It can also use shorter GP
12057 initialization sequences and generate direct calls to locally-defined
12058 functions.  This mode is selected by @option{-mno-shared}.
12059
12060 @option{-mno-shared} depends on binutils 2.16 or higher and generates
12061 objects that can only be linked by the GNU linker.  However, the option
12062 does not affect the ABI of the final executable; it only affects the ABI
12063 of relocatable objects.  Using @option{-mno-shared} will generally make
12064 executables both smaller and quicker.
12065
12066 @option{-mshared} is the default.
12067
12068 @item -mxgot
12069 @itemx -mno-xgot
12070 @opindex mxgot
12071 @opindex mno-xgot
12072 Lift (do not lift) the usual restrictions on the size of the global
12073 offset table.
12074
12075 GCC normally uses a single instruction to load values from the GOT@.
12076 While this is relatively efficient, it will only work if the GOT
12077 is smaller than about 64k.  Anything larger will cause the linker
12078 to report an error such as:
12079
12080 @cindex relocation truncated to fit (MIPS)
12081 @smallexample
12082 relocation truncated to fit: R_MIPS_GOT16 foobar
12083 @end smallexample
12084
12085 If this happens, you should recompile your code with @option{-mxgot}.
12086 It should then work with very large GOTs, although it will also be
12087 less efficient, since it will take three instructions to fetch the
12088 value of a global symbol.
12089
12090 Note that some linkers can create multiple GOTs.  If you have such a
12091 linker, you should only need to use @option{-mxgot} when a single object
12092 file accesses more than 64k's worth of GOT entries.  Very few do.
12093
12094 These options have no effect unless GCC is generating position
12095 independent code.
12096
12097 @item -mgp32
12098 @opindex mgp32
12099 Assume that general-purpose registers are 32 bits wide.
12100
12101 @item -mgp64
12102 @opindex mgp64
12103 Assume that general-purpose registers are 64 bits wide.
12104
12105 @item -mfp32
12106 @opindex mfp32
12107 Assume that floating-point registers are 32 bits wide.
12108
12109 @item -mfp64
12110 @opindex mfp64
12111 Assume that floating-point registers are 64 bits wide.
12112
12113 @item -mhard-float
12114 @opindex mhard-float
12115 Use floating-point coprocessor instructions.
12116
12117 @item -msoft-float
12118 @opindex msoft-float
12119 Do not use floating-point coprocessor instructions.  Implement
12120 floating-point calculations using library calls instead.
12121
12122 @item -msingle-float
12123 @opindex msingle-float
12124 Assume that the floating-point coprocessor only supports single-precision
12125 operations.
12126
12127 @item -mdouble-float
12128 @opindex mdouble-float
12129 Assume that the floating-point coprocessor supports double-precision
12130 operations.  This is the default.
12131
12132 @item -mllsc
12133 @itemx -mno-llsc
12134 @opindex mllsc
12135 @opindex mno-llsc
12136 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
12137 implement atomic memory built-in functions.  When neither option is
12138 specified, GCC will use the instructions if the target architecture
12139 supports them.
12140
12141 @option{-mllsc} is useful if the runtime environment can emulate the
12142 instructions and @option{-mno-llsc} can be useful when compiling for
12143 nonstandard ISAs.  You can make either option the default by
12144 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
12145 respectively.  @option{--with-llsc} is the default for some
12146 configurations; see the installation documentation for details.
12147
12148 @item -mdsp
12149 @itemx -mno-dsp
12150 @opindex mdsp
12151 @opindex mno-dsp
12152 Use (do not use) revision 1 of the MIPS DSP ASE@.
12153 @xref{MIPS DSP Built-in Functions}.  This option defines the
12154 preprocessor macro @samp{__mips_dsp}.  It also defines
12155 @samp{__mips_dsp_rev} to 1.
12156
12157 @item -mdspr2
12158 @itemx -mno-dspr2
12159 @opindex mdspr2
12160 @opindex mno-dspr2
12161 Use (do not use) revision 2 of the MIPS DSP ASE@.
12162 @xref{MIPS DSP Built-in Functions}.  This option defines the
12163 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
12164 It also defines @samp{__mips_dsp_rev} to 2.
12165
12166 @item -msmartmips
12167 @itemx -mno-smartmips
12168 @opindex msmartmips
12169 @opindex mno-smartmips
12170 Use (do not use) the MIPS SmartMIPS ASE.
12171
12172 @item -mpaired-single
12173 @itemx -mno-paired-single
12174 @opindex mpaired-single
12175 @opindex mno-paired-single
12176 Use (do not use) paired-single floating-point instructions.
12177 @xref{MIPS Paired-Single Support}.  This option requires
12178 hardware floating-point support to be enabled.
12179
12180 @item -mdmx
12181 @itemx -mno-mdmx
12182 @opindex mdmx
12183 @opindex mno-mdmx
12184 Use (do not use) MIPS Digital Media Extension instructions.
12185 This option can only be used when generating 64-bit code and requires
12186 hardware floating-point support to be enabled.
12187
12188 @item -mips3d
12189 @itemx -mno-mips3d
12190 @opindex mips3d
12191 @opindex mno-mips3d
12192 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
12193 The option @option{-mips3d} implies @option{-mpaired-single}.
12194
12195 @item -mmt
12196 @itemx -mno-mt
12197 @opindex mmt
12198 @opindex mno-mt
12199 Use (do not use) MT Multithreading instructions.
12200
12201 @item -mlong64
12202 @opindex mlong64
12203 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
12204 an explanation of the default and the way that the pointer size is
12205 determined.
12206
12207 @item -mlong32
12208 @opindex mlong32
12209 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
12210
12211 The default size of @code{int}s, @code{long}s and pointers depends on
12212 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
12213 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
12214 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
12215 or the same size as integer registers, whichever is smaller.
12216
12217 @item -msym32
12218 @itemx -mno-sym32
12219 @opindex msym32
12220 @opindex mno-sym32
12221 Assume (do not assume) that all symbols have 32-bit values, regardless
12222 of the selected ABI@.  This option is useful in combination with
12223 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
12224 to generate shorter and faster references to symbolic addresses.
12225
12226 @item -G @var{num}
12227 @opindex G
12228 Put definitions of externally-visible data in a small data section
12229 if that data is no bigger than @var{num} bytes.  GCC can then access
12230 the data more efficiently; see @option{-mgpopt} for details.
12231
12232 The default @option{-G} option depends on the configuration.
12233
12234 @item -mlocal-sdata
12235 @itemx -mno-local-sdata
12236 @opindex mlocal-sdata
12237 @opindex mno-local-sdata
12238 Extend (do not extend) the @option{-G} behavior to local data too,
12239 such as to static variables in C@.  @option{-mlocal-sdata} is the
12240 default for all configurations.
12241
12242 If the linker complains that an application is using too much small data,
12243 you might want to try rebuilding the less performance-critical parts with
12244 @option{-mno-local-sdata}.  You might also want to build large
12245 libraries with @option{-mno-local-sdata}, so that the libraries leave
12246 more room for the main program.
12247
12248 @item -mextern-sdata
12249 @itemx -mno-extern-sdata
12250 @opindex mextern-sdata
12251 @opindex mno-extern-sdata
12252 Assume (do not assume) that externally-defined data will be in
12253 a small data section if that data is within the @option{-G} limit.
12254 @option{-mextern-sdata} is the default for all configurations.
12255
12256 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
12257 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
12258 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
12259 is placed in a small data section.  If @var{Var} is defined by another
12260 module, you must either compile that module with a high-enough
12261 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
12262 definition.  If @var{Var} is common, you must link the application
12263 with a high-enough @option{-G} setting.
12264
12265 The easiest way of satisfying these restrictions is to compile
12266 and link every module with the same @option{-G} option.  However,
12267 you may wish to build a library that supports several different
12268 small data limits.  You can do this by compiling the library with
12269 the highest supported @option{-G} setting and additionally using
12270 @option{-mno-extern-sdata} to stop the library from making assumptions
12271 about externally-defined data.
12272
12273 @item -mgpopt
12274 @itemx -mno-gpopt
12275 @opindex mgpopt
12276 @opindex mno-gpopt
12277 Use (do not use) GP-relative accesses for symbols that are known to be
12278 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
12279 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
12280 configurations.
12281
12282 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
12283 might not hold the value of @code{_gp}.  For example, if the code is
12284 part of a library that might be used in a boot monitor, programs that
12285 call boot monitor routines will pass an unknown value in @code{$gp}.
12286 (In such situations, the boot monitor itself would usually be compiled
12287 with @option{-G0}.)
12288
12289 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
12290 @option{-mno-extern-sdata}.
12291
12292 @item -membedded-data
12293 @itemx -mno-embedded-data
12294 @opindex membedded-data
12295 @opindex mno-embedded-data
12296 Allocate variables to the read-only data section first if possible, then
12297 next in the small data section if possible, otherwise in data.  This gives
12298 slightly slower code than the default, but reduces the amount of RAM required
12299 when executing, and thus may be preferred for some embedded systems.
12300
12301 @item -muninit-const-in-rodata
12302 @itemx -mno-uninit-const-in-rodata
12303 @opindex muninit-const-in-rodata
12304 @opindex mno-uninit-const-in-rodata
12305 Put uninitialized @code{const} variables in the read-only data section.
12306 This option is only meaningful in conjunction with @option{-membedded-data}.
12307
12308 @item -mcode-readable=@var{setting}
12309 @opindex mcode-readable
12310 Specify whether GCC may generate code that reads from executable sections.
12311 There are three possible settings:
12312
12313 @table @gcctabopt
12314 @item -mcode-readable=yes
12315 Instructions may freely access executable sections.  This is the
12316 default setting.
12317
12318 @item -mcode-readable=pcrel
12319 MIPS16 PC-relative load instructions can access executable sections,
12320 but other instructions must not do so.  This option is useful on 4KSc
12321 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
12322 It is also useful on processors that can be configured to have a dual
12323 instruction/data SRAM interface and that, like the M4K, automatically
12324 redirect PC-relative loads to the instruction RAM.
12325
12326 @item -mcode-readable=no
12327 Instructions must not access executable sections.  This option can be
12328 useful on targets that are configured to have a dual instruction/data
12329 SRAM interface but that (unlike the M4K) do not automatically redirect
12330 PC-relative loads to the instruction RAM.
12331 @end table
12332
12333 @item -msplit-addresses
12334 @itemx -mno-split-addresses
12335 @opindex msplit-addresses
12336 @opindex mno-split-addresses
12337 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
12338 relocation operators.  This option has been superseded by
12339 @option{-mexplicit-relocs} but is retained for backwards compatibility.
12340
12341 @item -mexplicit-relocs
12342 @itemx -mno-explicit-relocs
12343 @opindex mexplicit-relocs
12344 @opindex mno-explicit-relocs
12345 Use (do not use) assembler relocation operators when dealing with symbolic
12346 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
12347 is to use assembler macros instead.
12348
12349 @option{-mexplicit-relocs} is the default if GCC was configured
12350 to use an assembler that supports relocation operators.
12351
12352 @item -mcheck-zero-division
12353 @itemx -mno-check-zero-division
12354 @opindex mcheck-zero-division
12355 @opindex mno-check-zero-division
12356 Trap (do not trap) on integer division by zero.
12357
12358 The default is @option{-mcheck-zero-division}.
12359
12360 @item -mdivide-traps
12361 @itemx -mdivide-breaks
12362 @opindex mdivide-traps
12363 @opindex mdivide-breaks
12364 MIPS systems check for division by zero by generating either a
12365 conditional trap or a break instruction.  Using traps results in
12366 smaller code, but is only supported on MIPS II and later.  Also, some
12367 versions of the Linux kernel have a bug that prevents trap from
12368 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
12369 allow conditional traps on architectures that support them and
12370 @option{-mdivide-breaks} to force the use of breaks.
12371
12372 The default is usually @option{-mdivide-traps}, but this can be
12373 overridden at configure time using @option{--with-divide=breaks}.
12374 Divide-by-zero checks can be completely disabled using
12375 @option{-mno-check-zero-division}.
12376
12377 @item -mmemcpy
12378 @itemx -mno-memcpy
12379 @opindex mmemcpy
12380 @opindex mno-memcpy
12381 Force (do not force) the use of @code{memcpy()} for non-trivial block
12382 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
12383 most constant-sized copies.
12384
12385 @item -mlong-calls
12386 @itemx -mno-long-calls
12387 @opindex mlong-calls
12388 @opindex mno-long-calls
12389 Disable (do not disable) use of the @code{jal} instruction.  Calling
12390 functions using @code{jal} is more efficient but requires the caller
12391 and callee to be in the same 256 megabyte segment.
12392
12393 This option has no effect on abicalls code.  The default is
12394 @option{-mno-long-calls}.
12395
12396 @item -mmad
12397 @itemx -mno-mad
12398 @opindex mmad
12399 @opindex mno-mad
12400 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
12401 instructions, as provided by the R4650 ISA@.
12402
12403 @item -mfused-madd
12404 @itemx -mno-fused-madd
12405 @opindex mfused-madd
12406 @opindex mno-fused-madd
12407 Enable (disable) use of the floating point multiply-accumulate
12408 instructions, when they are available.  The default is
12409 @option{-mfused-madd}.
12410
12411 When multiply-accumulate instructions are used, the intermediate
12412 product is calculated to infinite precision and is not subject to
12413 the FCSR Flush to Zero bit.  This may be undesirable in some
12414 circumstances.
12415
12416 @item -nocpp
12417 @opindex nocpp
12418 Tell the MIPS assembler to not run its preprocessor over user
12419 assembler files (with a @samp{.s} suffix) when assembling them.
12420
12421 @item -mfix-r4000
12422 @itemx -mno-fix-r4000
12423 @opindex mfix-r4000
12424 @opindex mno-fix-r4000
12425 Work around certain R4000 CPU errata:
12426 @itemize @minus
12427 @item
12428 A double-word or a variable shift may give an incorrect result if executed
12429 immediately after starting an integer division.
12430 @item
12431 A double-word or a variable shift may give an incorrect result if executed
12432 while an integer multiplication is in progress.
12433 @item
12434 An integer division may give an incorrect result if started in a delay slot
12435 of a taken branch or a jump.
12436 @end itemize
12437
12438 @item -mfix-r4400
12439 @itemx -mno-fix-r4400
12440 @opindex mfix-r4400
12441 @opindex mno-fix-r4400
12442 Work around certain R4400 CPU errata:
12443 @itemize @minus
12444 @item
12445 A double-word or a variable shift may give an incorrect result if executed
12446 immediately after starting an integer division.
12447 @end itemize
12448
12449 @item -mfix-vr4120
12450 @itemx -mno-fix-vr4120
12451 @opindex mfix-vr4120
12452 Work around certain VR4120 errata:
12453 @itemize @minus
12454 @item
12455 @code{dmultu} does not always produce the correct result.
12456 @item
12457 @code{div} and @code{ddiv} do not always produce the correct result if one
12458 of the operands is negative.
12459 @end itemize
12460 The workarounds for the division errata rely on special functions in
12461 @file{libgcc.a}.  At present, these functions are only provided by
12462 the @code{mips64vr*-elf} configurations.
12463
12464 Other VR4120 errata require a nop to be inserted between certain pairs of
12465 instructions.  These errata are handled by the assembler, not by GCC itself.
12466
12467 @item -mfix-vr4130
12468 @opindex mfix-vr4130
12469 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
12470 workarounds are implemented by the assembler rather than by GCC,
12471 although GCC will avoid using @code{mflo} and @code{mfhi} if the
12472 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
12473 instructions are available instead.
12474
12475 @item -mfix-sb1
12476 @itemx -mno-fix-sb1
12477 @opindex mfix-sb1
12478 Work around certain SB-1 CPU core errata.
12479 (This flag currently works around the SB-1 revision 2
12480 ``F1'' and ``F2'' floating point errata.)
12481
12482 @item -mflush-func=@var{func}
12483 @itemx -mno-flush-func
12484 @opindex mflush-func
12485 Specifies the function to call to flush the I and D caches, or to not
12486 call any such function.  If called, the function must take the same
12487 arguments as the common @code{_flush_func()}, that is, the address of the
12488 memory range for which the cache is being flushed, the size of the
12489 memory range, and the number 3 (to flush both caches).  The default
12490 depends on the target GCC was configured for, but commonly is either
12491 @samp{_flush_func} or @samp{__cpu_flush}.
12492
12493 @item mbranch-cost=@var{num}
12494 @opindex mbranch-cost
12495 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12496 This cost is only a heuristic and is not guaranteed to produce
12497 consistent results across releases.  A zero cost redundantly selects
12498 the default, which is based on the @option{-mtune} setting.
12499
12500 @item -mbranch-likely
12501 @itemx -mno-branch-likely
12502 @opindex mbranch-likely
12503 @opindex mno-branch-likely
12504 Enable or disable use of Branch Likely instructions, regardless of the
12505 default for the selected architecture.  By default, Branch Likely
12506 instructions may be generated if they are supported by the selected
12507 architecture.  An exception is for the MIPS32 and MIPS64 architectures
12508 and processors which implement those architectures; for those, Branch
12509 Likely instructions will not be generated by default because the MIPS32
12510 and MIPS64 architectures specifically deprecate their use.
12511
12512 @item -mfp-exceptions
12513 @itemx -mno-fp-exceptions
12514 @opindex mfp-exceptions
12515 Specifies whether FP exceptions are enabled.  This affects how we schedule
12516 FP instructions for some processors.  The default is that FP exceptions are
12517 enabled.
12518
12519 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
12520 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
12521 FP pipe.
12522
12523 @item -mvr4130-align
12524 @itemx -mno-vr4130-align
12525 @opindex mvr4130-align
12526 The VR4130 pipeline is two-way superscalar, but can only issue two
12527 instructions together if the first one is 8-byte aligned.  When this
12528 option is enabled, GCC will align pairs of instructions that it
12529 thinks should execute in parallel.
12530
12531 This option only has an effect when optimizing for the VR4130.
12532 It normally makes code faster, but at the expense of making it bigger.
12533 It is enabled by default at optimization level @option{-O3}.
12534 @end table
12535
12536 @node MMIX Options
12537 @subsection MMIX Options
12538 @cindex MMIX Options
12539
12540 These options are defined for the MMIX:
12541
12542 @table @gcctabopt
12543 @item -mlibfuncs
12544 @itemx -mno-libfuncs
12545 @opindex mlibfuncs
12546 @opindex mno-libfuncs
12547 Specify that intrinsic library functions are being compiled, passing all
12548 values in registers, no matter the size.
12549
12550 @item -mepsilon
12551 @itemx -mno-epsilon
12552 @opindex mepsilon
12553 @opindex mno-epsilon
12554 Generate floating-point comparison instructions that compare with respect
12555 to the @code{rE} epsilon register.
12556
12557 @item -mabi=mmixware
12558 @itemx -mabi=gnu
12559 @opindex mabi-mmixware
12560 @opindex mabi=gnu
12561 Generate code that passes function parameters and return values that (in
12562 the called function) are seen as registers @code{$0} and up, as opposed to
12563 the GNU ABI which uses global registers @code{$231} and up.
12564
12565 @item -mzero-extend
12566 @itemx -mno-zero-extend
12567 @opindex mzero-extend
12568 @opindex mno-zero-extend
12569 When reading data from memory in sizes shorter than 64 bits, use (do not
12570 use) zero-extending load instructions by default, rather than
12571 sign-extending ones.
12572
12573 @item -mknuthdiv
12574 @itemx -mno-knuthdiv
12575 @opindex mknuthdiv
12576 @opindex mno-knuthdiv
12577 Make the result of a division yielding a remainder have the same sign as
12578 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
12579 remainder follows the sign of the dividend.  Both methods are
12580 arithmetically valid, the latter being almost exclusively used.
12581
12582 @item -mtoplevel-symbols
12583 @itemx -mno-toplevel-symbols
12584 @opindex mtoplevel-symbols
12585 @opindex mno-toplevel-symbols
12586 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
12587 code can be used with the @code{PREFIX} assembly directive.
12588
12589 @item -melf
12590 @opindex melf
12591 Generate an executable in the ELF format, rather than the default
12592 @samp{mmo} format used by the @command{mmix} simulator.
12593
12594 @item -mbranch-predict
12595 @itemx -mno-branch-predict
12596 @opindex mbranch-predict
12597 @opindex mno-branch-predict
12598 Use (do not use) the probable-branch instructions, when static branch
12599 prediction indicates a probable branch.
12600
12601 @item -mbase-addresses
12602 @itemx -mno-base-addresses
12603 @opindex mbase-addresses
12604 @opindex mno-base-addresses
12605 Generate (do not generate) code that uses @emph{base addresses}.  Using a
12606 base address automatically generates a request (handled by the assembler
12607 and the linker) for a constant to be set up in a global register.  The
12608 register is used for one or more base address requests within the range 0
12609 to 255 from the value held in the register.  The generally leads to short
12610 and fast code, but the number of different data items that can be
12611 addressed is limited.  This means that a program that uses lots of static
12612 data may require @option{-mno-base-addresses}.
12613
12614 @item -msingle-exit
12615 @itemx -mno-single-exit
12616 @opindex msingle-exit
12617 @opindex mno-single-exit
12618 Force (do not force) generated code to have a single exit point in each
12619 function.
12620 @end table
12621
12622 @node MN10300 Options
12623 @subsection MN10300 Options
12624 @cindex MN10300 options
12625
12626 These @option{-m} options are defined for Matsushita MN10300 architectures:
12627
12628 @table @gcctabopt
12629 @item -mmult-bug
12630 @opindex mmult-bug
12631 Generate code to avoid bugs in the multiply instructions for the MN10300
12632 processors.  This is the default.
12633
12634 @item -mno-mult-bug
12635 @opindex mno-mult-bug
12636 Do not generate code to avoid bugs in the multiply instructions for the
12637 MN10300 processors.
12638
12639 @item -mam33
12640 @opindex mam33
12641 Generate code which uses features specific to the AM33 processor.
12642
12643 @item -mno-am33
12644 @opindex mno-am33
12645 Do not generate code which uses features specific to the AM33 processor.  This
12646 is the default.
12647
12648 @item -mreturn-pointer-on-d0
12649 @opindex mreturn-pointer-on-d0
12650 When generating a function which returns a pointer, return the pointer
12651 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
12652 only in a0, and attempts to call such functions without a prototype
12653 would result in errors.  Note that this option is on by default; use
12654 @option{-mno-return-pointer-on-d0} to disable it.
12655
12656 @item -mno-crt0
12657 @opindex mno-crt0
12658 Do not link in the C run-time initialization object file.
12659
12660 @item -mrelax
12661 @opindex mrelax
12662 Indicate to the linker that it should perform a relaxation optimization pass
12663 to shorten branches, calls and absolute memory addresses.  This option only
12664 has an effect when used on the command line for the final link step.
12665
12666 This option makes symbolic debugging impossible.
12667 @end table
12668
12669 @node MT Options
12670 @subsection MT Options
12671 @cindex MT options
12672
12673 These @option{-m} options are defined for Morpho MT architectures:
12674
12675 @table @gcctabopt
12676
12677 @item -march=@var{cpu-type}
12678 @opindex march
12679 Generate code that will run on @var{cpu-type}, which is the name of a system
12680 representing a certain processor type.  Possible values for
12681 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
12682 @samp{ms1-16-003} and @samp{ms2}.
12683
12684 When this option is not used, the default is @option{-march=ms1-16-002}.
12685
12686 @item -mbacc
12687 @opindex mbacc
12688 Use byte loads and stores when generating code.
12689
12690 @item -mno-bacc
12691 @opindex mno-bacc
12692 Do not use byte loads and stores when generating code.
12693
12694 @item -msim
12695 @opindex msim
12696 Use simulator runtime
12697
12698 @item -mno-crt0
12699 @opindex mno-crt0
12700 Do not link in the C run-time initialization object file
12701 @file{crti.o}.  Other run-time initialization and termination files
12702 such as @file{startup.o} and @file{exit.o} are still included on the
12703 linker command line.
12704
12705 @end table
12706
12707 @node PDP-11 Options
12708 @subsection PDP-11 Options
12709 @cindex PDP-11 Options
12710
12711 These options are defined for the PDP-11:
12712
12713 @table @gcctabopt
12714 @item -mfpu
12715 @opindex mfpu
12716 Use hardware FPP floating point.  This is the default.  (FIS floating
12717 point on the PDP-11/40 is not supported.)
12718
12719 @item -msoft-float
12720 @opindex msoft-float
12721 Do not use hardware floating point.
12722
12723 @item -mac0
12724 @opindex mac0
12725 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
12726
12727 @item -mno-ac0
12728 @opindex mno-ac0
12729 Return floating-point results in memory.  This is the default.
12730
12731 @item -m40
12732 @opindex m40
12733 Generate code for a PDP-11/40.
12734
12735 @item -m45
12736 @opindex m45
12737 Generate code for a PDP-11/45.  This is the default.
12738
12739 @item -m10
12740 @opindex m10
12741 Generate code for a PDP-11/10.
12742
12743 @item -mbcopy-builtin
12744 @opindex bcopy-builtin
12745 Use inline @code{movmemhi} patterns for copying memory.  This is the
12746 default.
12747
12748 @item -mbcopy
12749 @opindex mbcopy
12750 Do not use inline @code{movmemhi} patterns for copying memory.
12751
12752 @item -mint16
12753 @itemx -mno-int32
12754 @opindex mint16
12755 @opindex mno-int32
12756 Use 16-bit @code{int}.  This is the default.
12757
12758 @item -mint32
12759 @itemx -mno-int16
12760 @opindex mint32
12761 @opindex mno-int16
12762 Use 32-bit @code{int}.
12763
12764 @item -mfloat64
12765 @itemx -mno-float32
12766 @opindex mfloat64
12767 @opindex mno-float32
12768 Use 64-bit @code{float}.  This is the default.
12769
12770 @item -mfloat32
12771 @itemx -mno-float64
12772 @opindex mfloat32
12773 @opindex mno-float64
12774 Use 32-bit @code{float}.
12775
12776 @item -mabshi
12777 @opindex mabshi
12778 Use @code{abshi2} pattern.  This is the default.
12779
12780 @item -mno-abshi
12781 @opindex mno-abshi
12782 Do not use @code{abshi2} pattern.
12783
12784 @item -mbranch-expensive
12785 @opindex mbranch-expensive
12786 Pretend that branches are expensive.  This is for experimenting with
12787 code generation only.
12788
12789 @item -mbranch-cheap
12790 @opindex mbranch-cheap
12791 Do not pretend that branches are expensive.  This is the default.
12792
12793 @item -msplit
12794 @opindex msplit
12795 Generate code for a system with split I&D@.
12796
12797 @item -mno-split
12798 @opindex mno-split
12799 Generate code for a system without split I&D@.  This is the default.
12800
12801 @item -munix-asm
12802 @opindex munix-asm
12803 Use Unix assembler syntax.  This is the default when configured for
12804 @samp{pdp11-*-bsd}.
12805
12806 @item -mdec-asm
12807 @opindex mdec-asm
12808 Use DEC assembler syntax.  This is the default when configured for any
12809 PDP-11 target other than @samp{pdp11-*-bsd}.
12810 @end table
12811
12812 @node PowerPC Options
12813 @subsection PowerPC Options
12814 @cindex PowerPC options
12815
12816 These are listed under @xref{RS/6000 and PowerPC Options}.
12817
12818 @node RS/6000 and PowerPC Options
12819 @subsection IBM RS/6000 and PowerPC Options
12820 @cindex RS/6000 and PowerPC Options
12821 @cindex IBM RS/6000 and PowerPC Options
12822
12823 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
12824 @table @gcctabopt
12825 @item -mpower
12826 @itemx -mno-power
12827 @itemx -mpower2
12828 @itemx -mno-power2
12829 @itemx -mpowerpc
12830 @itemx -mno-powerpc
12831 @itemx -mpowerpc-gpopt
12832 @itemx -mno-powerpc-gpopt
12833 @itemx -mpowerpc-gfxopt
12834 @itemx -mno-powerpc-gfxopt
12835 @itemx -mpowerpc64
12836 @itemx -mno-powerpc64
12837 @itemx -mmfcrf
12838 @itemx -mno-mfcrf
12839 @itemx -mpopcntb
12840 @itemx -mno-popcntb
12841 @itemx -mfprnd
12842 @itemx -mno-fprnd
12843 @itemx -mcmpb
12844 @itemx -mno-cmpb
12845 @itemx -mmfpgpr
12846 @itemx -mno-mfpgpr
12847 @itemx -mhard-dfp
12848 @itemx -mno-hard-dfp
12849 @opindex mpower
12850 @opindex mno-power
12851 @opindex mpower2
12852 @opindex mno-power2
12853 @opindex mpowerpc
12854 @opindex mno-powerpc
12855 @opindex mpowerpc-gpopt
12856 @opindex mno-powerpc-gpopt
12857 @opindex mpowerpc-gfxopt
12858 @opindex mno-powerpc-gfxopt
12859 @opindex mpowerpc64
12860 @opindex mno-powerpc64
12861 @opindex mmfcrf
12862 @opindex mno-mfcrf
12863 @opindex mpopcntb
12864 @opindex mno-popcntb
12865 @opindex mfprnd
12866 @opindex mno-fprnd
12867 @opindex mcmpb
12868 @opindex mno-cmpb
12869 @opindex mmfpgpr
12870 @opindex mno-mfpgpr
12871 @opindex mhard-dfp
12872 @opindex mno-hard-dfp
12873 GCC supports two related instruction set architectures for the
12874 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
12875 instructions supported by the @samp{rios} chip set used in the original
12876 RS/6000 systems and the @dfn{PowerPC} instruction set is the
12877 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
12878 the IBM 4xx, 6xx, and follow-on microprocessors.
12879
12880 Neither architecture is a subset of the other.  However there is a
12881 large common subset of instructions supported by both.  An MQ
12882 register is included in processors supporting the POWER architecture.
12883
12884 You use these options to specify which instructions are available on the
12885 processor you are using.  The default value of these options is
12886 determined when configuring GCC@.  Specifying the
12887 @option{-mcpu=@var{cpu_type}} overrides the specification of these
12888 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
12889 rather than the options listed above.
12890
12891 The @option{-mpower} option allows GCC to generate instructions that
12892 are found only in the POWER architecture and to use the MQ register.
12893 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
12894 to generate instructions that are present in the POWER2 architecture but
12895 not the original POWER architecture.
12896
12897 The @option{-mpowerpc} option allows GCC to generate instructions that
12898 are found only in the 32-bit subset of the PowerPC architecture.
12899 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
12900 GCC to use the optional PowerPC architecture instructions in the
12901 General Purpose group, including floating-point square root.  Specifying
12902 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
12903 use the optional PowerPC architecture instructions in the Graphics
12904 group, including floating-point select.
12905
12906 The @option{-mmfcrf} option allows GCC to generate the move from
12907 condition register field instruction implemented on the POWER4
12908 processor and other processors that support the PowerPC V2.01
12909 architecture.
12910 The @option{-mpopcntb} option allows GCC to generate the popcount and
12911 double precision FP reciprocal estimate instruction implemented on the
12912 POWER5 processor and other processors that support the PowerPC V2.02
12913 architecture.
12914 The @option{-mfprnd} option allows GCC to generate the FP round to
12915 integer instructions implemented on the POWER5+ processor and other
12916 processors that support the PowerPC V2.03 architecture.
12917 The @option{-mcmpb} option allows GCC to generate the compare bytes
12918 instruction implemented on the POWER6 processor and other processors
12919 that support the PowerPC V2.05 architecture.
12920 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
12921 general purpose register instructions implemented on the POWER6X
12922 processor and other processors that support the extended PowerPC V2.05
12923 architecture.
12924 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
12925 point instructions implemented on some POWER processors.
12926
12927 The @option{-mpowerpc64} option allows GCC to generate the additional
12928 64-bit instructions that are found in the full PowerPC64 architecture
12929 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
12930 @option{-mno-powerpc64}.
12931
12932 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
12933 will use only the instructions in the common subset of both
12934 architectures plus some special AIX common-mode calls, and will not use
12935 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
12936 permits GCC to use any instruction from either architecture and to
12937 allow use of the MQ register; specify this for the Motorola MPC601.
12938
12939 @item -mnew-mnemonics
12940 @itemx -mold-mnemonics
12941 @opindex mnew-mnemonics
12942 @opindex mold-mnemonics
12943 Select which mnemonics to use in the generated assembler code.  With
12944 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
12945 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
12946 assembler mnemonics defined for the POWER architecture.  Instructions
12947 defined in only one architecture have only one mnemonic; GCC uses that
12948 mnemonic irrespective of which of these options is specified.
12949
12950 GCC defaults to the mnemonics appropriate for the architecture in
12951 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
12952 value of these option.  Unless you are building a cross-compiler, you
12953 should normally not specify either @option{-mnew-mnemonics} or
12954 @option{-mold-mnemonics}, but should instead accept the default.
12955
12956 @item -mcpu=@var{cpu_type}
12957 @opindex mcpu
12958 Set architecture type, register usage, choice of mnemonics, and
12959 instruction scheduling parameters for machine type @var{cpu_type}.
12960 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
12961 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
12962 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
12963 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
12964 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
12965 @samp{860}, @samp{970}, @samp{8540}, @samp{e300c2}, @samp{e300c3},
12966 @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5}, @samp{power},
12967 @samp{power2}, @samp{power3}, @samp{power4}, @samp{power5},
12968 @samp{power5+}, @samp{power6}, @samp{power6x}, @samp{common},
12969 @samp{powerpc}, @samp{powerpc64}, @samp{rios}, @samp{rios1},
12970 @samp{rios2}, @samp{rsc}, and @samp{rs64}.
12971
12972 @option{-mcpu=common} selects a completely generic processor.  Code
12973 generated under this option will run on any POWER or PowerPC processor.
12974 GCC will use only the instructions in the common subset of both
12975 architectures, and will not use the MQ register.  GCC assumes a generic
12976 processor model for scheduling purposes.
12977
12978 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
12979 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
12980 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
12981 types, with an appropriate, generic processor model assumed for
12982 scheduling purposes.
12983
12984 The other options specify a specific processor.  Code generated under
12985 those options will run best on that processor, and may not run at all on
12986 others.
12987
12988 The @option{-mcpu} options automatically enable or disable the
12989 following options:
12990
12991 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
12992 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
12993 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
12994
12995 The particular options set for any particular CPU will vary between
12996 compiler versions, depending on what setting seems to produce optimal
12997 code for that CPU; it doesn't necessarily reflect the actual hardware's
12998 capabilities.  If you wish to set an individual option to a particular
12999 value, you may specify it after the @option{-mcpu} option, like
13000 @samp{-mcpu=970 -mno-altivec}.
13001
13002 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
13003 not enabled or disabled by the @option{-mcpu} option at present because
13004 AIX does not have full support for these options.  You may still
13005 enable or disable them individually if you're sure it'll work in your
13006 environment.
13007
13008 @item -mtune=@var{cpu_type}
13009 @opindex mtune
13010 Set the instruction scheduling parameters for machine type
13011 @var{cpu_type}, but do not set the architecture type, register usage, or
13012 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
13013 values for @var{cpu_type} are used for @option{-mtune} as for
13014 @option{-mcpu}.  If both are specified, the code generated will use the
13015 architecture, registers, and mnemonics set by @option{-mcpu}, but the
13016 scheduling parameters set by @option{-mtune}.
13017
13018 @item -mswdiv
13019 @itemx -mno-swdiv
13020 @opindex mswdiv
13021 @opindex mno-swdiv
13022 Generate code to compute division as reciprocal estimate and iterative
13023 refinement, creating opportunities for increased throughput.  This
13024 feature requires: optional PowerPC Graphics instruction set for single
13025 precision and FRE instruction for double precision, assuming divides
13026 cannot generate user-visible traps, and the domain values not include
13027 Infinities, denormals or zero denominator.
13028
13029 @item -maltivec
13030 @itemx -mno-altivec
13031 @opindex maltivec
13032 @opindex mno-altivec
13033 Generate code that uses (does not use) AltiVec instructions, and also
13034 enable the use of built-in functions that allow more direct access to
13035 the AltiVec instruction set.  You may also need to set
13036 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
13037 enhancements.
13038
13039 @item -mvrsave
13040 @itemx -mno-vrsave
13041 @opindex mvrsave
13042 @opindex mno-vrsave
13043 Generate VRSAVE instructions when generating AltiVec code.
13044
13045 @item -msecure-plt
13046 @opindex msecure-plt
13047 Generate code that allows ld and ld.so to build executables and shared
13048 libraries with non-exec .plt and .got sections.  This is a PowerPC
13049 32-bit SYSV ABI option.
13050
13051 @item -mbss-plt
13052 @opindex mbss-plt
13053 Generate code that uses a BSS .plt section that ld.so fills in, and
13054 requires .plt and .got sections that are both writable and executable.
13055 This is a PowerPC 32-bit SYSV ABI option.
13056
13057 @item -misel
13058 @itemx -mno-isel
13059 @opindex misel
13060 @opindex mno-isel
13061 This switch enables or disables the generation of ISEL instructions.
13062
13063 @item -misel=@var{yes/no}
13064 This switch has been deprecated.  Use @option{-misel} and
13065 @option{-mno-isel} instead.
13066
13067 @item -mspe
13068 @itemx -mno-spe
13069 @opindex mspe
13070 @opindex mno-spe
13071 This switch enables or disables the generation of SPE simd
13072 instructions.
13073
13074 @item -mpaired
13075 @itemx -mno-paired
13076 @opindex mpaired
13077 @opindex mno-paired
13078 This switch enables or disables the generation of PAIRED simd
13079 instructions.
13080
13081 @item -mspe=@var{yes/no}
13082 This option has been deprecated.  Use @option{-mspe} and
13083 @option{-mno-spe} instead.
13084
13085 @item -mfloat-gprs=@var{yes/single/double/no}
13086 @itemx -mfloat-gprs
13087 @opindex mfloat-gprs
13088 This switch enables or disables the generation of floating point
13089 operations on the general purpose registers for architectures that
13090 support it.
13091
13092 The argument @var{yes} or @var{single} enables the use of
13093 single-precision floating point operations.
13094
13095 The argument @var{double} enables the use of single and
13096 double-precision floating point operations.
13097
13098 The argument @var{no} disables floating point operations on the
13099 general purpose registers.
13100
13101 This option is currently only available on the MPC854x.
13102
13103 @item -m32
13104 @itemx -m64
13105 @opindex m32
13106 @opindex m64
13107 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
13108 targets (including GNU/Linux).  The 32-bit environment sets int, long
13109 and pointer to 32 bits and generates code that runs on any PowerPC
13110 variant.  The 64-bit environment sets int to 32 bits and long and
13111 pointer to 64 bits, and generates code for PowerPC64, as for
13112 @option{-mpowerpc64}.
13113
13114 @item -mfull-toc
13115 @itemx -mno-fp-in-toc
13116 @itemx -mno-sum-in-toc
13117 @itemx -mminimal-toc
13118 @opindex mfull-toc
13119 @opindex mno-fp-in-toc
13120 @opindex mno-sum-in-toc
13121 @opindex mminimal-toc
13122 Modify generation of the TOC (Table Of Contents), which is created for
13123 every executable file.  The @option{-mfull-toc} option is selected by
13124 default.  In that case, GCC will allocate at least one TOC entry for
13125 each unique non-automatic variable reference in your program.  GCC
13126 will also place floating-point constants in the TOC@.  However, only
13127 16,384 entries are available in the TOC@.
13128
13129 If you receive a linker error message that saying you have overflowed
13130 the available TOC space, you can reduce the amount of TOC space used
13131 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
13132 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
13133 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
13134 generate code to calculate the sum of an address and a constant at
13135 run-time instead of putting that sum into the TOC@.  You may specify one
13136 or both of these options.  Each causes GCC to produce very slightly
13137 slower and larger code at the expense of conserving TOC space.
13138
13139 If you still run out of space in the TOC even when you specify both of
13140 these options, specify @option{-mminimal-toc} instead.  This option causes
13141 GCC to make only one TOC entry for every file.  When you specify this
13142 option, GCC will produce code that is slower and larger but which
13143 uses extremely little TOC space.  You may wish to use this option
13144 only on files that contain less frequently executed code.
13145
13146 @item -maix64
13147 @itemx -maix32
13148 @opindex maix64
13149 @opindex maix32
13150 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
13151 @code{long} type, and the infrastructure needed to support them.
13152 Specifying @option{-maix64} implies @option{-mpowerpc64} and
13153 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
13154 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
13155
13156 @item -mxl-compat
13157 @itemx -mno-xl-compat
13158 @opindex mxl-compat
13159 @opindex mno-xl-compat
13160 Produce code that conforms more closely to IBM XL compiler semantics
13161 when using AIX-compatible ABI@.  Pass floating-point arguments to
13162 prototyped functions beyond the register save area (RSA) on the stack
13163 in addition to argument FPRs.  Do not assume that most significant
13164 double in 128-bit long double value is properly rounded when comparing
13165 values and converting to double.  Use XL symbol names for long double
13166 support routines.
13167
13168 The AIX calling convention was extended but not initially documented to
13169 handle an obscure K&R C case of calling a function that takes the
13170 address of its arguments with fewer arguments than declared.  IBM XL
13171 compilers access floating point arguments which do not fit in the
13172 RSA from the stack when a subroutine is compiled without
13173 optimization.  Because always storing floating-point arguments on the
13174 stack is inefficient and rarely needed, this option is not enabled by
13175 default and only is necessary when calling subroutines compiled by IBM
13176 XL compilers without optimization.
13177
13178 @item -mpe
13179 @opindex mpe
13180 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
13181 application written to use message passing with special startup code to
13182 enable the application to run.  The system must have PE installed in the
13183 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
13184 must be overridden with the @option{-specs=} option to specify the
13185 appropriate directory location.  The Parallel Environment does not
13186 support threads, so the @option{-mpe} option and the @option{-pthread}
13187 option are incompatible.
13188
13189 @item -malign-natural
13190 @itemx -malign-power
13191 @opindex malign-natural
13192 @opindex malign-power
13193 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
13194 @option{-malign-natural} overrides the ABI-defined alignment of larger
13195 types, such as floating-point doubles, on their natural size-based boundary.
13196 The option @option{-malign-power} instructs GCC to follow the ABI-specified
13197 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
13198
13199 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
13200 is not supported.
13201
13202 @item -msoft-float
13203 @itemx -mhard-float
13204 @opindex msoft-float
13205 @opindex mhard-float
13206 Generate code that does not use (uses) the floating-point register set.
13207 Software floating point emulation is provided if you use the
13208 @option{-msoft-float} option, and pass the option to GCC when linking.
13209
13210 @item -mmultiple
13211 @itemx -mno-multiple
13212 @opindex mmultiple
13213 @opindex mno-multiple
13214 Generate code that uses (does not use) the load multiple word
13215 instructions and the store multiple word instructions.  These
13216 instructions are generated by default on POWER systems, and not
13217 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
13218 endian PowerPC systems, since those instructions do not work when the
13219 processor is in little endian mode.  The exceptions are PPC740 and
13220 PPC750 which permit the instructions usage in little endian mode.
13221
13222 @item -mstring
13223 @itemx -mno-string
13224 @opindex mstring
13225 @opindex mno-string
13226 Generate code that uses (does not use) the load string instructions
13227 and the store string word instructions to save multiple registers and
13228 do small block moves.  These instructions are generated by default on
13229 POWER systems, and not generated on PowerPC systems.  Do not use
13230 @option{-mstring} on little endian PowerPC systems, since those
13231 instructions do not work when the processor is in little endian mode.
13232 The exceptions are PPC740 and PPC750 which permit the instructions
13233 usage in little endian mode.
13234
13235 @item -mupdate
13236 @itemx -mno-update
13237 @opindex mupdate
13238 @opindex mno-update
13239 Generate code that uses (does not use) the load or store instructions
13240 that update the base register to the address of the calculated memory
13241 location.  These instructions are generated by default.  If you use
13242 @option{-mno-update}, there is a small window between the time that the
13243 stack pointer is updated and the address of the previous frame is
13244 stored, which means code that walks the stack frame across interrupts or
13245 signals may get corrupted data.
13246
13247 @item -mfused-madd
13248 @itemx -mno-fused-madd
13249 @opindex mfused-madd
13250 @opindex mno-fused-madd
13251 Generate code that uses (does not use) the floating point multiply and
13252 accumulate instructions.  These instructions are generated by default if
13253 hardware floating is used.
13254
13255 @item -mmulhw
13256 @itemx -mno-mulhw
13257 @opindex mmulhw
13258 @opindex mno-mulhw
13259 Generate code that uses (does not use) the half-word multiply and
13260 multiply-accumulate instructions on the IBM 405 and 440 processors.
13261 These instructions are generated by default when targetting those
13262 processors.
13263
13264 @item -mdlmzb
13265 @itemx -mno-dlmzb
13266 @opindex mdlmzb
13267 @opindex mno-dlmzb
13268 Generate code that uses (does not use) the string-search @samp{dlmzb}
13269 instruction on the IBM 405 and 440 processors.  This instruction is
13270 generated by default when targetting those processors.
13271
13272 @item -mno-bit-align
13273 @itemx -mbit-align
13274 @opindex mno-bit-align
13275 @opindex mbit-align
13276 On System V.4 and embedded PowerPC systems do not (do) force structures
13277 and unions that contain bit-fields to be aligned to the base type of the
13278 bit-field.
13279
13280 For example, by default a structure containing nothing but 8
13281 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
13282 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
13283 the structure would be aligned to a 1 byte boundary and be one byte in
13284 size.
13285
13286 @item -mno-strict-align
13287 @itemx -mstrict-align
13288 @opindex mno-strict-align
13289 @opindex mstrict-align
13290 On System V.4 and embedded PowerPC systems do not (do) assume that
13291 unaligned memory references will be handled by the system.
13292
13293 @item -mrelocatable
13294 @itemx -mno-relocatable
13295 @opindex mrelocatable
13296 @opindex mno-relocatable
13297 On embedded PowerPC systems generate code that allows (does not allow)
13298 the program to be relocated to a different address at runtime.  If you
13299 use @option{-mrelocatable} on any module, all objects linked together must
13300 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
13301
13302 @item -mrelocatable-lib
13303 @itemx -mno-relocatable-lib
13304 @opindex mrelocatable-lib
13305 @opindex mno-relocatable-lib
13306 On embedded PowerPC systems generate code that allows (does not allow)
13307 the program to be relocated to a different address at runtime.  Modules
13308 compiled with @option{-mrelocatable-lib} can be linked with either modules
13309 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
13310 with modules compiled with the @option{-mrelocatable} options.
13311
13312 @item -mno-toc
13313 @itemx -mtoc
13314 @opindex mno-toc
13315 @opindex mtoc
13316 On System V.4 and embedded PowerPC systems do not (do) assume that
13317 register 2 contains a pointer to a global area pointing to the addresses
13318 used in the program.
13319
13320 @item -mlittle
13321 @itemx -mlittle-endian
13322 @opindex mlittle
13323 @opindex mlittle-endian
13324 On System V.4 and embedded PowerPC systems compile code for the
13325 processor in little endian mode.  The @option{-mlittle-endian} option is
13326 the same as @option{-mlittle}.
13327
13328 @item -mbig
13329 @itemx -mbig-endian
13330 @opindex mbig
13331 @opindex mbig-endian
13332 On System V.4 and embedded PowerPC systems compile code for the
13333 processor in big endian mode.  The @option{-mbig-endian} option is
13334 the same as @option{-mbig}.
13335
13336 @item -mdynamic-no-pic
13337 @opindex mdynamic-no-pic
13338 On Darwin and Mac OS X systems, compile code so that it is not
13339 relocatable, but that its external references are relocatable.  The
13340 resulting code is suitable for applications, but not shared
13341 libraries.
13342
13343 @item -mprioritize-restricted-insns=@var{priority}
13344 @opindex mprioritize-restricted-insns
13345 This option controls the priority that is assigned to
13346 dispatch-slot restricted instructions during the second scheduling
13347 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
13348 @var{no/highest/second-highest} priority to dispatch slot restricted
13349 instructions.
13350
13351 @item -msched-costly-dep=@var{dependence_type}
13352 @opindex msched-costly-dep
13353 This option controls which dependences are considered costly
13354 by the target during instruction scheduling.  The argument
13355 @var{dependence_type} takes one of the following values:
13356 @var{no}: no dependence is costly,
13357 @var{all}: all dependences are costly,
13358 @var{true_store_to_load}: a true dependence from store to load is costly,
13359 @var{store_to_load}: any dependence from store to load is costly,
13360 @var{number}: any dependence which latency >= @var{number} is costly.
13361
13362 @item -minsert-sched-nops=@var{scheme}
13363 @opindex minsert-sched-nops
13364 This option controls which nop insertion scheme will be used during
13365 the second scheduling pass.  The argument @var{scheme} takes one of the
13366 following values:
13367 @var{no}: Don't insert nops.
13368 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
13369 according to the scheduler's grouping.
13370 @var{regroup_exact}: Insert nops to force costly dependent insns into
13371 separate groups.  Insert exactly as many nops as needed to force an insn
13372 to a new group, according to the estimated processor grouping.
13373 @var{number}: Insert nops to force costly dependent insns into
13374 separate groups.  Insert @var{number} nops to force an insn to a new group.
13375
13376 @item -mcall-sysv
13377 @opindex mcall-sysv
13378 On System V.4 and embedded PowerPC systems compile code using calling
13379 conventions that adheres to the March 1995 draft of the System V
13380 Application Binary Interface, PowerPC processor supplement.  This is the
13381 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
13382
13383 @item -mcall-sysv-eabi
13384 @opindex mcall-sysv-eabi
13385 Specify both @option{-mcall-sysv} and @option{-meabi} options.
13386
13387 @item -mcall-sysv-noeabi
13388 @opindex mcall-sysv-noeabi
13389 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
13390
13391 @item -mcall-solaris
13392 @opindex mcall-solaris
13393 On System V.4 and embedded PowerPC systems compile code for the Solaris
13394 operating system.
13395
13396 @item -mcall-linux
13397 @opindex mcall-linux
13398 On System V.4 and embedded PowerPC systems compile code for the
13399 Linux-based GNU system.
13400
13401 @item -mcall-gnu
13402 @opindex mcall-gnu
13403 On System V.4 and embedded PowerPC systems compile code for the
13404 Hurd-based GNU system.
13405
13406 @item -mcall-netbsd
13407 @opindex mcall-netbsd
13408 On System V.4 and embedded PowerPC systems compile code for the
13409 NetBSD operating system.
13410
13411 @item -maix-struct-return
13412 @opindex maix-struct-return
13413 Return all structures in memory (as specified by the AIX ABI)@.
13414
13415 @item -msvr4-struct-return
13416 @opindex msvr4-struct-return
13417 Return structures smaller than 8 bytes in registers (as specified by the
13418 SVR4 ABI)@.
13419
13420 @item -mabi=@var{abi-type}
13421 @opindex mabi
13422 Extend the current ABI with a particular extension, or remove such extension.
13423 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
13424 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
13425
13426 @item -mabi=spe
13427 @opindex mabi=spe
13428 Extend the current ABI with SPE ABI extensions.  This does not change
13429 the default ABI, instead it adds the SPE ABI extensions to the current
13430 ABI@.
13431
13432 @item -mabi=no-spe
13433 @opindex mabi=no-spe
13434 Disable Booke SPE ABI extensions for the current ABI@.
13435
13436 @item -mabi=ibmlongdouble
13437 @opindex mabi=ibmlongdouble
13438 Change the current ABI to use IBM extended precision long double.
13439 This is a PowerPC 32-bit SYSV ABI option.
13440
13441 @item -mabi=ieeelongdouble
13442 @opindex mabi=ieeelongdouble
13443 Change the current ABI to use IEEE extended precision long double.
13444 This is a PowerPC 32-bit Linux ABI option.
13445
13446 @item -mprototype
13447 @itemx -mno-prototype
13448 @opindex mprototype
13449 @opindex mno-prototype
13450 On System V.4 and embedded PowerPC systems assume that all calls to
13451 variable argument functions are properly prototyped.  Otherwise, the
13452 compiler must insert an instruction before every non prototyped call to
13453 set or clear bit 6 of the condition code register (@var{CR}) to
13454 indicate whether floating point values were passed in the floating point
13455 registers in case the function takes a variable arguments.  With
13456 @option{-mprototype}, only calls to prototyped variable argument functions
13457 will set or clear the bit.
13458
13459 @item -msim
13460 @opindex msim
13461 On embedded PowerPC systems, assume that the startup module is called
13462 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
13463 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
13464 configurations.
13465
13466 @item -mmvme
13467 @opindex mmvme
13468 On embedded PowerPC systems, assume that the startup module is called
13469 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
13470 @file{libc.a}.
13471
13472 @item -mads
13473 @opindex mads
13474 On embedded PowerPC systems, assume that the startup module is called
13475 @file{crt0.o} and the standard C libraries are @file{libads.a} and
13476 @file{libc.a}.
13477
13478 @item -myellowknife
13479 @opindex myellowknife
13480 On embedded PowerPC systems, assume that the startup module is called
13481 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
13482 @file{libc.a}.
13483
13484 @item -mvxworks
13485 @opindex mvxworks
13486 On System V.4 and embedded PowerPC systems, specify that you are
13487 compiling for a VxWorks system.
13488
13489 @item -mwindiss
13490 @opindex mwindiss
13491 Specify that you are compiling for the WindISS simulation environment.
13492
13493 @item -memb
13494 @opindex memb
13495 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
13496 header to indicate that @samp{eabi} extended relocations are used.
13497
13498 @item -meabi
13499 @itemx -mno-eabi
13500 @opindex meabi
13501 @opindex mno-eabi
13502 On System V.4 and embedded PowerPC systems do (do not) adhere to the
13503 Embedded Applications Binary Interface (eabi) which is a set of
13504 modifications to the System V.4 specifications.  Selecting @option{-meabi}
13505 means that the stack is aligned to an 8 byte boundary, a function
13506 @code{__eabi} is called to from @code{main} to set up the eabi
13507 environment, and the @option{-msdata} option can use both @code{r2} and
13508 @code{r13} to point to two separate small data areas.  Selecting
13509 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
13510 do not call an initialization function from @code{main}, and the
13511 @option{-msdata} option will only use @code{r13} to point to a single
13512 small data area.  The @option{-meabi} option is on by default if you
13513 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
13514
13515 @item -msdata=eabi
13516 @opindex msdata=eabi
13517 On System V.4 and embedded PowerPC systems, put small initialized
13518 @code{const} global and static data in the @samp{.sdata2} section, which
13519 is pointed to by register @code{r2}.  Put small initialized
13520 non-@code{const} global and static data in the @samp{.sdata} section,
13521 which is pointed to by register @code{r13}.  Put small uninitialized
13522 global and static data in the @samp{.sbss} section, which is adjacent to
13523 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
13524 incompatible with the @option{-mrelocatable} option.  The
13525 @option{-msdata=eabi} option also sets the @option{-memb} option.
13526
13527 @item -msdata=sysv
13528 @opindex msdata=sysv
13529 On System V.4 and embedded PowerPC systems, put small global and static
13530 data in the @samp{.sdata} section, which is pointed to by register
13531 @code{r13}.  Put small uninitialized global and static data in the
13532 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
13533 The @option{-msdata=sysv} option is incompatible with the
13534 @option{-mrelocatable} option.
13535
13536 @item -msdata=default
13537 @itemx -msdata
13538 @opindex msdata=default
13539 @opindex msdata
13540 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
13541 compile code the same as @option{-msdata=eabi}, otherwise compile code the
13542 same as @option{-msdata=sysv}.
13543
13544 @item -msdata-data
13545 @opindex msdata-data
13546 On System V.4 and embedded PowerPC systems, put small global
13547 data in the @samp{.sdata} section.  Put small uninitialized global
13548 data in the @samp{.sbss} section.  Do not use register @code{r13}
13549 to address small data however.  This is the default behavior unless
13550 other @option{-msdata} options are used.
13551
13552 @item -msdata=none
13553 @itemx -mno-sdata
13554 @opindex msdata=none
13555 @opindex mno-sdata
13556 On embedded PowerPC systems, put all initialized global and static data
13557 in the @samp{.data} section, and all uninitialized data in the
13558 @samp{.bss} section.
13559
13560 @item -G @var{num}
13561 @opindex G
13562 @cindex smaller data references (PowerPC)
13563 @cindex .sdata/.sdata2 references (PowerPC)
13564 On embedded PowerPC systems, put global and static items less than or
13565 equal to @var{num} bytes into the small data or bss sections instead of
13566 the normal data or bss section.  By default, @var{num} is 8.  The
13567 @option{-G @var{num}} switch is also passed to the linker.
13568 All modules should be compiled with the same @option{-G @var{num}} value.
13569
13570 @item -mregnames
13571 @itemx -mno-regnames
13572 @opindex mregnames
13573 @opindex mno-regnames
13574 On System V.4 and embedded PowerPC systems do (do not) emit register
13575 names in the assembly language output using symbolic forms.
13576
13577 @item -mlongcall
13578 @itemx -mno-longcall
13579 @opindex mlongcall
13580 @opindex mno-longcall
13581 By default assume that all calls are far away so that a longer more
13582 expensive calling sequence is required.  This is required for calls
13583 further than 32 megabytes (33,554,432 bytes) from the current location.
13584 A short call will be generated if the compiler knows
13585 the call cannot be that far away.  This setting can be overridden by
13586 the @code{shortcall} function attribute, or by @code{#pragma
13587 longcall(0)}.
13588
13589 Some linkers are capable of detecting out-of-range calls and generating
13590 glue code on the fly.  On these systems, long calls are unnecessary and
13591 generate slower code.  As of this writing, the AIX linker can do this,
13592 as can the GNU linker for PowerPC/64.  It is planned to add this feature
13593 to the GNU linker for 32-bit PowerPC systems as well.
13594
13595 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
13596 callee, L42'', plus a ``branch island'' (glue code).  The two target
13597 addresses represent the callee and the ``branch island''.  The
13598 Darwin/PPC linker will prefer the first address and generate a ``bl
13599 callee'' if the PPC ``bl'' instruction will reach the callee directly;
13600 otherwise, the linker will generate ``bl L42'' to call the ``branch
13601 island''.  The ``branch island'' is appended to the body of the
13602 calling function; it computes the full 32-bit address of the callee
13603 and jumps to it.
13604
13605 On Mach-O (Darwin) systems, this option directs the compiler emit to
13606 the glue for every direct call, and the Darwin linker decides whether
13607 to use or discard it.
13608
13609 In the future, we may cause GCC to ignore all longcall specifications
13610 when the linker is known to generate glue.
13611
13612 @item -pthread
13613 @opindex pthread
13614 Adds support for multithreading with the @dfn{pthreads} library.
13615 This option sets flags for both the preprocessor and linker.
13616
13617 @end table
13618
13619 @node S/390 and zSeries Options
13620 @subsection S/390 and zSeries Options
13621 @cindex S/390 and zSeries Options
13622
13623 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
13624
13625 @table @gcctabopt
13626 @item -mhard-float
13627 @itemx -msoft-float
13628 @opindex mhard-float
13629 @opindex msoft-float
13630 Use (do not use) the hardware floating-point instructions and registers
13631 for floating-point operations.  When @option{-msoft-float} is specified,
13632 functions in @file{libgcc.a} will be used to perform floating-point
13633 operations.  When @option{-mhard-float} is specified, the compiler
13634 generates IEEE floating-point instructions.  This is the default.
13635
13636 @item -mlong-double-64
13637 @itemx -mlong-double-128
13638 @opindex mlong-double-64
13639 @opindex mlong-double-128
13640 These switches control the size of @code{long double} type. A size
13641 of 64bit makes the @code{long double} type equivalent to the @code{double}
13642 type. This is the default.
13643
13644 @item -mbackchain
13645 @itemx -mno-backchain
13646 @opindex mbackchain
13647 @opindex mno-backchain
13648 Store (do not store) the address of the caller's frame as backchain pointer
13649 into the callee's stack frame.
13650 A backchain may be needed to allow debugging using tools that do not understand
13651 DWARF-2 call frame information.
13652 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
13653 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
13654 the backchain is placed into the topmost word of the 96/160 byte register
13655 save area.
13656
13657 In general, code compiled with @option{-mbackchain} is call-compatible with
13658 code compiled with @option{-mmo-backchain}; however, use of the backchain
13659 for debugging purposes usually requires that the whole binary is built with
13660 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
13661 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13662 to build a linux kernel use @option{-msoft-float}.
13663
13664 The default is to not maintain the backchain.
13665
13666 @item -mpacked-stack
13667 @itemx -mno-packed-stack
13668 @opindex mpacked-stack
13669 @opindex mno-packed-stack
13670 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
13671 specified, the compiler uses the all fields of the 96/160 byte register save
13672 area only for their default purpose; unused fields still take up stack space.
13673 When @option{-mpacked-stack} is specified, register save slots are densely
13674 packed at the top of the register save area; unused space is reused for other
13675 purposes, allowing for more efficient use of the available stack space.
13676 However, when @option{-mbackchain} is also in effect, the topmost word of
13677 the save area is always used to store the backchain, and the return address
13678 register is always saved two words below the backchain.
13679
13680 As long as the stack frame backchain is not used, code generated with
13681 @option{-mpacked-stack} is call-compatible with code generated with
13682 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
13683 S/390 or zSeries generated code that uses the stack frame backchain at run
13684 time, not just for debugging purposes.  Such code is not call-compatible
13685 with code compiled with @option{-mpacked-stack}.  Also, note that the
13686 combination of @option{-mbackchain},
13687 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13688 to build a linux kernel use @option{-msoft-float}.
13689
13690 The default is to not use the packed stack layout.
13691
13692 @item -msmall-exec
13693 @itemx -mno-small-exec
13694 @opindex msmall-exec
13695 @opindex mno-small-exec
13696 Generate (or do not generate) code using the @code{bras} instruction
13697 to do subroutine calls.
13698 This only works reliably if the total executable size does not
13699 exceed 64k.  The default is to use the @code{basr} instruction instead,
13700 which does not have this limitation.
13701
13702 @item -m64
13703 @itemx -m31
13704 @opindex m64
13705 @opindex m31
13706 When @option{-m31} is specified, generate code compliant to the
13707 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
13708 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
13709 particular to generate 64-bit instructions.  For the @samp{s390}
13710 targets, the default is @option{-m31}, while the @samp{s390x}
13711 targets default to @option{-m64}.
13712
13713 @item -mzarch
13714 @itemx -mesa
13715 @opindex mzarch
13716 @opindex mesa
13717 When @option{-mzarch} is specified, generate code using the
13718 instructions available on z/Architecture.
13719 When @option{-mesa} is specified, generate code using the
13720 instructions available on ESA/390.  Note that @option{-mesa} is
13721 not possible with @option{-m64}.
13722 When generating code compliant to the GNU/Linux for S/390 ABI,
13723 the default is @option{-mesa}.  When generating code compliant
13724 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
13725
13726 @item -mmvcle
13727 @itemx -mno-mvcle
13728 @opindex mmvcle
13729 @opindex mno-mvcle
13730 Generate (or do not generate) code using the @code{mvcle} instruction
13731 to perform block moves.  When @option{-mno-mvcle} is specified,
13732 use a @code{mvc} loop instead.  This is the default unless optimizing for
13733 size.
13734
13735 @item -mdebug
13736 @itemx -mno-debug
13737 @opindex mdebug
13738 @opindex mno-debug
13739 Print (or do not print) additional debug information when compiling.
13740 The default is to not print debug information.
13741
13742 @item -march=@var{cpu-type}
13743 @opindex march
13744 Generate code that will run on @var{cpu-type}, which is the name of a system
13745 representing a certain processor type.  Possible values for
13746 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
13747 When generating code using the instructions available on z/Architecture,
13748 the default is @option{-march=z900}.  Otherwise, the default is
13749 @option{-march=g5}.
13750
13751 @item -mtune=@var{cpu-type}
13752 @opindex mtune
13753 Tune to @var{cpu-type} everything applicable about the generated code,
13754 except for the ABI and the set of available instructions.
13755 The list of @var{cpu-type} values is the same as for @option{-march}.
13756 The default is the value used for @option{-march}.
13757
13758 @item -mtpf-trace
13759 @itemx -mno-tpf-trace
13760 @opindex mtpf-trace
13761 @opindex mno-tpf-trace
13762 Generate code that adds (does not add) in TPF OS specific branches to trace
13763 routines in the operating system.  This option is off by default, even
13764 when compiling for the TPF OS@.
13765
13766 @item -mfused-madd
13767 @itemx -mno-fused-madd
13768 @opindex mfused-madd
13769 @opindex mno-fused-madd
13770 Generate code that uses (does not use) the floating point multiply and
13771 accumulate instructions.  These instructions are generated by default if
13772 hardware floating point is used.
13773
13774 @item -mwarn-framesize=@var{framesize}
13775 @opindex mwarn-framesize
13776 Emit a warning if the current function exceeds the given frame size.  Because
13777 this is a compile time check it doesn't need to be a real problem when the program
13778 runs.  It is intended to identify functions which most probably cause
13779 a stack overflow.  It is useful to be used in an environment with limited stack
13780 size e.g.@: the linux kernel.
13781
13782 @item -mwarn-dynamicstack
13783 @opindex mwarn-dynamicstack
13784 Emit a warning if the function calls alloca or uses dynamically
13785 sized arrays.  This is generally a bad idea with a limited stack size.
13786
13787 @item -mstack-guard=@var{stack-guard}
13788 @itemx -mstack-size=@var{stack-size}
13789 @opindex mstack-guard
13790 @opindex mstack-size
13791 If these options are provided the s390 back end emits additional instructions in
13792 the function prologue which trigger a trap if the stack size is @var{stack-guard}
13793 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
13794 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
13795 the frame size of the compiled function is chosen.
13796 These options are intended to be used to help debugging stack overflow problems.
13797 The additionally emitted code causes only little overhead and hence can also be
13798 used in production like systems without greater performance degradation.  The given
13799 values have to be exact powers of 2 and @var{stack-size} has to be greater than
13800 @var{stack-guard} without exceeding 64k.
13801 In order to be efficient the extra code makes the assumption that the stack starts
13802 at an address aligned to the value given by @var{stack-size}.
13803 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
13804 @end table
13805
13806 @node Score Options
13807 @subsection Score Options
13808 @cindex Score Options
13809
13810 These options are defined for Score implementations:
13811
13812 @table @gcctabopt
13813 @item -meb
13814 @opindex meb
13815 Compile code for big endian mode.  This is the default.
13816
13817 @item -mel
13818 @opindex mel
13819 Compile code for little endian mode. 
13820
13821 @item -mnhwloop
13822 @opindex mnhwloop
13823 Disable generate bcnz instruction.
13824
13825 @item -muls
13826 @opindex muls
13827 Enable generate unaligned load and store instruction.
13828
13829 @item -mmac
13830 @opindex mmac
13831 Enable the use of multiply-accumulate instructions. Disabled by default. 
13832
13833 @item -mscore5
13834 @opindex mscore5
13835 Specify the SCORE5 as the target architecture.
13836
13837 @item -mscore5u
13838 @opindex mscore5u
13839 Specify the SCORE5U of the target architecture.
13840
13841 @item -mscore7
13842 @opindex mscore7
13843 Specify the SCORE7 as the target architecture. This is the default.
13844
13845 @item -mscore7d
13846 @opindex mscore7d
13847 Specify the SCORE7D as the target architecture.
13848 @end table
13849
13850 @node SH Options
13851 @subsection SH Options
13852
13853 These @samp{-m} options are defined for the SH implementations:
13854
13855 @table @gcctabopt
13856 @item -m1
13857 @opindex m1
13858 Generate code for the SH1.
13859
13860 @item -m2
13861 @opindex m2
13862 Generate code for the SH2.
13863
13864 @item -m2e
13865 Generate code for the SH2e.
13866
13867 @item -m3
13868 @opindex m3
13869 Generate code for the SH3.
13870
13871 @item -m3e
13872 @opindex m3e
13873 Generate code for the SH3e.
13874
13875 @item -m4-nofpu
13876 @opindex m4-nofpu
13877 Generate code for the SH4 without a floating-point unit.
13878
13879 @item -m4-single-only
13880 @opindex m4-single-only
13881 Generate code for the SH4 with a floating-point unit that only
13882 supports single-precision arithmetic.
13883
13884 @item -m4-single
13885 @opindex m4-single
13886 Generate code for the SH4 assuming the floating-point unit is in
13887 single-precision mode by default.
13888
13889 @item -m4
13890 @opindex m4
13891 Generate code for the SH4.
13892
13893 @item -m4a-nofpu
13894 @opindex m4a-nofpu
13895 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
13896 floating-point unit is not used.
13897
13898 @item -m4a-single-only
13899 @opindex m4a-single-only
13900 Generate code for the SH4a, in such a way that no double-precision
13901 floating point operations are used.
13902
13903 @item -m4a-single
13904 @opindex m4a-single
13905 Generate code for the SH4a assuming the floating-point unit is in
13906 single-precision mode by default.
13907
13908 @item -m4a
13909 @opindex m4a
13910 Generate code for the SH4a.
13911
13912 @item -m4al
13913 @opindex m4al
13914 Same as @option{-m4a-nofpu}, except that it implicitly passes
13915 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
13916 instructions at the moment.
13917
13918 @item -mb
13919 @opindex mb
13920 Compile code for the processor in big endian mode.
13921
13922 @item -ml
13923 @opindex ml
13924 Compile code for the processor in little endian mode.
13925
13926 @item -mdalign
13927 @opindex mdalign
13928 Align doubles at 64-bit boundaries.  Note that this changes the calling
13929 conventions, and thus some functions from the standard C library will
13930 not work unless you recompile it first with @option{-mdalign}.
13931
13932 @item -mrelax
13933 @opindex mrelax
13934 Shorten some address references at link time, when possible; uses the
13935 linker option @option{-relax}.
13936
13937 @item -mbigtable
13938 @opindex mbigtable
13939 Use 32-bit offsets in @code{switch} tables.  The default is to use
13940 16-bit offsets.
13941
13942 @item -mbitops
13943 @opindex mbitops
13944 Enable the use of bit manipulation instructions on SH2A.
13945
13946 @item -mfmovd
13947 @opindex mfmovd
13948 Enable the use of the instruction @code{fmovd}.
13949
13950 @item -mhitachi
13951 @opindex mhitachi
13952 Comply with the calling conventions defined by Renesas.
13953
13954 @item -mrenesas
13955 @opindex mhitachi
13956 Comply with the calling conventions defined by Renesas.
13957
13958 @item -mno-renesas
13959 @opindex mhitachi
13960 Comply with the calling conventions defined for GCC before the Renesas
13961 conventions were available.  This option is the default for all
13962 targets of the SH toolchain except for @samp{sh-symbianelf}.
13963
13964 @item -mnomacsave
13965 @opindex mnomacsave
13966 Mark the @code{MAC} register as call-clobbered, even if
13967 @option{-mhitachi} is given.
13968
13969 @item -mieee
13970 @opindex mieee
13971 Increase IEEE-compliance of floating-point code.
13972 At the moment, this is equivalent to @option{-fno-finite-math-only}.
13973 When generating 16 bit SH opcodes, getting IEEE-conforming results for
13974 comparisons of NANs / infinities incurs extra overhead in every
13975 floating point comparison, therefore the default is set to
13976 @option{-ffinite-math-only}.
13977
13978 @item -minline-ic_invalidate
13979 @opindex minline-ic_invalidate
13980 Inline code to invalidate instruction cache entries after setting up
13981 nested function trampolines.
13982 This option has no effect if -musermode is in effect and the selected
13983 code generation option (e.g. -m4) does not allow the use of the icbi
13984 instruction.
13985 If the selected code generation option does not allow the use of the icbi
13986 instruction, and -musermode is not in effect, the inlined code will
13987 manipulate the instruction cache address array directly with an associative
13988 write.  This not only requires privileged mode, but it will also
13989 fail if the cache line had been mapped via the TLB and has become unmapped.
13990
13991 @item -misize
13992 @opindex misize
13993 Dump instruction size and location in the assembly code.
13994
13995 @item -mpadstruct
13996 @opindex mpadstruct
13997 This option is deprecated.  It pads structures to multiple of 4 bytes,
13998 which is incompatible with the SH ABI@.
13999
14000 @item -mspace
14001 @opindex mspace
14002 Optimize for space instead of speed.  Implied by @option{-Os}.
14003
14004 @item -mprefergot
14005 @opindex mprefergot
14006 When generating position-independent code, emit function calls using
14007 the Global Offset Table instead of the Procedure Linkage Table.
14008
14009 @item -musermode
14010 @opindex musermode
14011 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
14012 if the inlined code would not work in user mode.
14013 This is the default when the target is @code{sh-*-linux*}.
14014
14015 @item -multcost=@var{number}
14016 @opindex multcost=@var{number}
14017 Set the cost to assume for a multiply insn.
14018
14019 @item -mdiv=@var{strategy}
14020 @opindex mdiv=@var{strategy}
14021 Set the division strategy to use for SHmedia code.  @var{strategy} must be
14022 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
14023 inv:call2, inv:fp .
14024 "fp" performs the operation in floating point.  This has a very high latency,
14025 but needs only a few instructions, so it might be a good choice if
14026 your code has enough easily exploitable ILP to allow the compiler to
14027 schedule the floating point instructions together with other instructions.
14028 Division by zero causes a floating point exception.
14029 "inv" uses integer operations to calculate the inverse of the divisor,
14030 and then multiplies the dividend with the inverse.  This strategy allows
14031 cse and hoisting of the inverse calculation.  Division by zero calculates
14032 an unspecified result, but does not trap.
14033 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
14034 have been found, or if the entire operation has been hoisted to the same
14035 place, the last stages of the inverse calculation are intertwined with the
14036 final multiply to reduce the overall latency, at the expense of using a few
14037 more instructions, and thus offering fewer scheduling opportunities with
14038 other code.
14039 "call" calls a library function that usually implements the inv:minlat
14040 strategy.
14041 This gives high code density for m5-*media-nofpu compilations.
14042 "call2" uses a different entry point of the same library function, where it
14043 assumes that a pointer to a lookup table has already been set up, which
14044 exposes the pointer load to cse / code hoisting optimizations.
14045 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
14046 code generation, but if the code stays unoptimized, revert to the "call",
14047 "call2", or "fp" strategies, respectively.  Note that the
14048 potentially-trapping side effect of division by zero is carried by a
14049 separate instruction, so it is possible that all the integer instructions
14050 are hoisted out, but the marker for the side effect stays where it is.
14051 A recombination to fp operations or a call is not possible in that case.
14052 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
14053 that the inverse calculation was nor separated from the multiply, they speed
14054 up division where the dividend fits into 20 bits (plus sign where applicable),
14055 by inserting a test to skip a number of operations in this case; this test
14056 slows down the case of larger dividends.  inv20u assumes the case of a such
14057 a small dividend to be unlikely, and inv20l assumes it to be likely.
14058
14059 @item -mdivsi3_libfunc=@var{name}
14060 @opindex mdivsi3_libfunc=@var{name}
14061 Set the name of the library function used for 32 bit signed division to
14062 @var{name}.  This only affect the name used in the call and inv:call
14063 division strategies, and the compiler will still expect the same
14064 sets of input/output/clobbered registers as if this option was not present.
14065
14066 @item -madjust-unroll
14067 @opindex madjust-unroll
14068 Throttle unrolling to avoid thrashing target registers.
14069 This option only has an effect if the gcc code base supports the
14070 TARGET_ADJUST_UNROLL_MAX target hook.
14071
14072 @item -mindexed-addressing
14073 @opindex mindexed-addressing
14074 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
14075 This is only safe if the hardware and/or OS implement 32 bit wrap-around
14076 semantics for the indexed addressing mode.  The architecture allows the
14077 implementation of processors with 64 bit MMU, which the OS could use to
14078 get 32 bit addressing, but since no current hardware implementation supports
14079 this or any other way to make the indexed addressing mode safe to use in
14080 the 32 bit ABI, the default is -mno-indexed-addressing.
14081
14082 @item -mgettrcost=@var{number}
14083 @opindex mgettrcost=@var{number}
14084 Set the cost assumed for the gettr instruction to @var{number}.
14085 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
14086
14087 @item -mpt-fixed
14088 @opindex mpt-fixed
14089 Assume pt* instructions won't trap.  This will generally generate better
14090 scheduled code, but is unsafe on current hardware.  The current architecture
14091 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
14092 This has the unintentional effect of making it unsafe to schedule ptabs /
14093 ptrel before a branch, or hoist it out of a loop.  For example,
14094 __do_global_ctors, a part of libgcc that runs constructors at program
14095 startup, calls functions in a list which is delimited by @minus{}1.  With the
14096 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
14097 That means that all the constructors will be run a bit quicker, but when
14098 the loop comes to the end of the list, the program crashes because ptabs
14099 loads @minus{}1 into a target register.  Since this option is unsafe for any
14100 hardware implementing the current architecture specification, the default
14101 is -mno-pt-fixed.  Unless the user specifies a specific cost with
14102 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
14103 this deters register allocation using target registers for storing
14104 ordinary integers.
14105
14106 @item -minvalid-symbols
14107 @opindex minvalid-symbols
14108 Assume symbols might be invalid.  Ordinary function symbols generated by
14109 the compiler will always be valid to load with movi/shori/ptabs or
14110 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
14111 to generate symbols that will cause ptabs / ptrel to trap.
14112 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
14113 It will then prevent cross-basic-block cse, hoisting and most scheduling
14114 of symbol loads.  The default is @option{-mno-invalid-symbols}.
14115 @end table
14116
14117 @node SPARC Options
14118 @subsection SPARC Options
14119 @cindex SPARC options
14120
14121 These @samp{-m} options are supported on the SPARC:
14122
14123 @table @gcctabopt
14124 @item -mno-app-regs
14125 @itemx -mapp-regs
14126 @opindex mno-app-regs
14127 @opindex mapp-regs
14128 Specify @option{-mapp-regs} to generate output using the global registers
14129 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
14130 is the default.
14131
14132 To be fully SVR4 ABI compliant at the cost of some performance loss,
14133 specify @option{-mno-app-regs}.  You should compile libraries and system
14134 software with this option.
14135
14136 @item -mfpu
14137 @itemx -mhard-float
14138 @opindex mfpu
14139 @opindex mhard-float
14140 Generate output containing floating point instructions.  This is the
14141 default.
14142
14143 @item -mno-fpu
14144 @itemx -msoft-float
14145 @opindex mno-fpu
14146 @opindex msoft-float
14147 Generate output containing library calls for floating point.
14148 @strong{Warning:} the requisite libraries are not available for all SPARC
14149 targets.  Normally the facilities of the machine's usual C compiler are
14150 used, but this cannot be done directly in cross-compilation.  You must make
14151 your own arrangements to provide suitable library functions for
14152 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
14153 @samp{sparclite-*-*} do provide software floating point support.
14154
14155 @option{-msoft-float} changes the calling convention in the output file;
14156 therefore, it is only useful if you compile @emph{all} of a program with
14157 this option.  In particular, you need to compile @file{libgcc.a}, the
14158 library that comes with GCC, with @option{-msoft-float} in order for
14159 this to work.
14160
14161 @item -mhard-quad-float
14162 @opindex mhard-quad-float
14163 Generate output containing quad-word (long double) floating point
14164 instructions.
14165
14166 @item -msoft-quad-float
14167 @opindex msoft-quad-float
14168 Generate output containing library calls for quad-word (long double)
14169 floating point instructions.  The functions called are those specified
14170 in the SPARC ABI@.  This is the default.
14171
14172 As of this writing, there are no SPARC implementations that have hardware
14173 support for the quad-word floating point instructions.  They all invoke
14174 a trap handler for one of these instructions, and then the trap handler
14175 emulates the effect of the instruction.  Because of the trap handler overhead,
14176 this is much slower than calling the ABI library routines.  Thus the
14177 @option{-msoft-quad-float} option is the default.
14178
14179 @item -mno-unaligned-doubles
14180 @itemx -munaligned-doubles
14181 @opindex mno-unaligned-doubles
14182 @opindex munaligned-doubles
14183 Assume that doubles have 8 byte alignment.  This is the default.
14184
14185 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
14186 alignment only if they are contained in another type, or if they have an
14187 absolute address.  Otherwise, it assumes they have 4 byte alignment.
14188 Specifying this option avoids some rare compatibility problems with code
14189 generated by other compilers.  It is not the default because it results
14190 in a performance loss, especially for floating point code.
14191
14192 @item -mno-faster-structs
14193 @itemx -mfaster-structs
14194 @opindex mno-faster-structs
14195 @opindex mfaster-structs
14196 With @option{-mfaster-structs}, the compiler assumes that structures
14197 should have 8 byte alignment.  This enables the use of pairs of
14198 @code{ldd} and @code{std} instructions for copies in structure
14199 assignment, in place of twice as many @code{ld} and @code{st} pairs.
14200 However, the use of this changed alignment directly violates the SPARC
14201 ABI@.  Thus, it's intended only for use on targets where the developer
14202 acknowledges that their resulting code will not be directly in line with
14203 the rules of the ABI@.
14204
14205 @item -mimpure-text
14206 @opindex mimpure-text
14207 @option{-mimpure-text}, used in addition to @option{-shared}, tells
14208 the compiler to not pass @option{-z text} to the linker when linking a
14209 shared object.  Using this option, you can link position-dependent
14210 code into a shared object.
14211
14212 @option{-mimpure-text} suppresses the ``relocations remain against
14213 allocatable but non-writable sections'' linker error message.
14214 However, the necessary relocations will trigger copy-on-write, and the
14215 shared object is not actually shared across processes.  Instead of
14216 using @option{-mimpure-text}, you should compile all source code with
14217 @option{-fpic} or @option{-fPIC}.
14218
14219 This option is only available on SunOS and Solaris.
14220
14221 @item -mcpu=@var{cpu_type}
14222 @opindex mcpu
14223 Set the instruction set, register set, and instruction scheduling parameters
14224 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
14225 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
14226 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
14227 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
14228 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
14229
14230 Default instruction scheduling parameters are used for values that select
14231 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
14232 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
14233
14234 Here is a list of each supported architecture and their supported
14235 implementations.
14236
14237 @smallexample
14238     v7:             cypress
14239     v8:             supersparc, hypersparc
14240     sparclite:      f930, f934, sparclite86x
14241     sparclet:       tsc701
14242     v9:             ultrasparc, ultrasparc3, niagara, niagara2
14243 @end smallexample
14244
14245 By default (unless configured otherwise), GCC generates code for the V7
14246 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
14247 additionally optimizes it for the Cypress CY7C602 chip, as used in the
14248 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
14249 SPARCStation 1, 2, IPX etc.
14250
14251 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
14252 architecture.  The only difference from V7 code is that the compiler emits
14253 the integer multiply and integer divide instructions which exist in SPARC-V8
14254 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
14255 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
14256 2000 series.
14257
14258 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
14259 the SPARC architecture.  This adds the integer multiply, integer divide step
14260 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
14261 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
14262 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
14263 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
14264 MB86934 chip, which is the more recent SPARClite with FPU@.
14265
14266 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
14267 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
14268 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
14269 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
14270 optimizes it for the TEMIC SPARClet chip.
14271
14272 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
14273 architecture.  This adds 64-bit integer and floating-point move instructions,
14274 3 additional floating-point condition code registers and conditional move
14275 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
14276 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
14277 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
14278 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
14279 @option{-mcpu=niagara}, the compiler additionally optimizes it for
14280 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
14281 additionally optimizes it for Sun UltraSPARC T2 chips.
14282
14283 @item -mtune=@var{cpu_type}
14284 @opindex mtune
14285 Set the instruction scheduling parameters for machine type
14286 @var{cpu_type}, but do not set the instruction set or register set that the
14287 option @option{-mcpu=@var{cpu_type}} would.
14288
14289 The same values for @option{-mcpu=@var{cpu_type}} can be used for
14290 @option{-mtune=@var{cpu_type}}, but the only useful values are those
14291 that select a particular cpu implementation.  Those are @samp{cypress},
14292 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
14293 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
14294 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
14295
14296 @item -mv8plus
14297 @itemx -mno-v8plus
14298 @opindex mv8plus
14299 @opindex mno-v8plus
14300 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
14301 difference from the V8 ABI is that the global and out registers are
14302 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
14303 mode for all SPARC-V9 processors.
14304
14305 @item -mvis
14306 @itemx -mno-vis
14307 @opindex mvis
14308 @opindex mno-vis
14309 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
14310 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
14311 @end table
14312
14313 These @samp{-m} options are supported in addition to the above
14314 on SPARC-V9 processors in 64-bit environments:
14315
14316 @table @gcctabopt
14317 @item -mlittle-endian
14318 @opindex mlittle-endian
14319 Generate code for a processor running in little-endian mode.  It is only
14320 available for a few configurations and most notably not on Solaris and Linux.
14321
14322 @item -m32
14323 @itemx -m64
14324 @opindex m32
14325 @opindex m64
14326 Generate code for a 32-bit or 64-bit environment.
14327 The 32-bit environment sets int, long and pointer to 32 bits.
14328 The 64-bit environment sets int to 32 bits and long and pointer
14329 to 64 bits.
14330
14331 @item -mcmodel=medlow
14332 @opindex mcmodel=medlow
14333 Generate code for the Medium/Low code model: 64-bit addresses, programs
14334 must be linked in the low 32 bits of memory.  Programs can be statically
14335 or dynamically linked.
14336
14337 @item -mcmodel=medmid
14338 @opindex mcmodel=medmid
14339 Generate code for the Medium/Middle code model: 64-bit addresses, programs
14340 must be linked in the low 44 bits of memory, the text and data segments must
14341 be less than 2GB in size and the data segment must be located within 2GB of
14342 the text segment.
14343
14344 @item -mcmodel=medany
14345 @opindex mcmodel=medany
14346 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
14347 may be linked anywhere in memory, the text and data segments must be less
14348 than 2GB in size and the data segment must be located within 2GB of the
14349 text segment.
14350
14351 @item -mcmodel=embmedany
14352 @opindex mcmodel=embmedany
14353 Generate code for the Medium/Anywhere code model for embedded systems:
14354 64-bit addresses, the text and data segments must be less than 2GB in
14355 size, both starting anywhere in memory (determined at link time).  The
14356 global register %g4 points to the base of the data segment.  Programs
14357 are statically linked and PIC is not supported.
14358
14359 @item -mstack-bias
14360 @itemx -mno-stack-bias
14361 @opindex mstack-bias
14362 @opindex mno-stack-bias
14363 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
14364 frame pointer if present, are offset by @minus{}2047 which must be added back
14365 when making stack frame references.  This is the default in 64-bit mode.
14366 Otherwise, assume no such offset is present.
14367 @end table
14368
14369 These switches are supported in addition to the above on Solaris:
14370
14371 @table @gcctabopt
14372 @item -threads
14373 @opindex threads
14374 Add support for multithreading using the Solaris threads library.  This
14375 option sets flags for both the preprocessor and linker.  This option does
14376 not affect the thread safety of object code produced by the compiler or
14377 that of libraries supplied with it.
14378
14379 @item -pthreads
14380 @opindex pthreads
14381 Add support for multithreading using the POSIX threads library.  This
14382 option sets flags for both the preprocessor and linker.  This option does
14383 not affect the thread safety of object code produced  by the compiler or
14384 that of libraries supplied with it.
14385
14386 @item -pthread
14387 @opindex pthread
14388 This is a synonym for @option{-pthreads}.
14389 @end table
14390
14391 @node SPU Options
14392 @subsection SPU Options
14393 @cindex SPU options
14394
14395 These @samp{-m} options are supported on the SPU:
14396
14397 @table @gcctabopt
14398 @item -mwarn-reloc
14399 @itemx -merror-reloc
14400 @opindex mwarn-reloc
14401 @opindex merror-reloc
14402
14403 The loader for SPU does not handle dynamic relocations.  By default, GCC
14404 will give an error when it generates code that requires a dynamic
14405 relocation.  @option{-mno-error-reloc} disables the error,
14406 @option{-mwarn-reloc} will generate a warning instead.
14407
14408 @item -msafe-dma
14409 @itemx -munsafe-dma
14410 @opindex msafe-dma
14411 @opindex munsafe-dma
14412
14413 Instructions which initiate or test completion of DMA must not be
14414 reordered with respect to loads and stores of the memory which is being
14415 accessed.  Users typically address this problem using the volatile
14416 keyword, but that can lead to inefficient code in places where the
14417 memory is known to not change.  Rather than mark the memory as volatile
14418 we treat the DMA instructions as potentially effecting all memory.  With
14419 @option{-munsafe-dma} users must use the volatile keyword to protect
14420 memory accesses.
14421
14422 @item -mbranch-hints
14423 @opindex mbranch-hints
14424
14425 By default, GCC will generate a branch hint instruction to avoid
14426 pipeline stalls for always taken or probably taken branches.  A hint
14427 will not be generated closer than 8 instructions away from its branch.
14428 There is little reason to disable them, except for debugging purposes,
14429 or to make an object a little bit smaller.
14430
14431 @item -msmall-mem
14432 @itemx -mlarge-mem
14433 @opindex msmall-mem
14434 @opindex mlarge-mem
14435
14436 By default, GCC generates code assuming that addresses are never larger
14437 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
14438 a full 32 bit address.
14439
14440 @item -mstdmain
14441 @opindex mstdmain
14442
14443 By default, GCC links against startup code that assumes the SPU-style
14444 main function interface (which has an unconventional parameter list).
14445 With @option{-mstdmain}, GCC will link your program against startup
14446 code that assumes a C99-style interface to @code{main}, including a
14447 local copy of @code{argv} strings.
14448
14449 @item -mfixed-range=@var{register-range}
14450 @opindex mfixed-range
14451 Generate code treating the given register range as fixed registers.
14452 A fixed register is one that the register allocator can not use.  This is
14453 useful when compiling kernel code.  A register range is specified as
14454 two registers separated by a dash.  Multiple register ranges can be
14455 specified separated by a comma.
14456
14457 @end table
14458
14459 @node System V Options
14460 @subsection Options for System V
14461
14462 These additional options are available on System V Release 4 for
14463 compatibility with other compilers on those systems:
14464
14465 @table @gcctabopt
14466 @item -G
14467 @opindex G
14468 Create a shared object.
14469 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
14470
14471 @item -Qy
14472 @opindex Qy
14473 Identify the versions of each tool used by the compiler, in a
14474 @code{.ident} assembler directive in the output.
14475
14476 @item -Qn
14477 @opindex Qn
14478 Refrain from adding @code{.ident} directives to the output file (this is
14479 the default).
14480
14481 @item -YP,@var{dirs}
14482 @opindex YP
14483 Search the directories @var{dirs}, and no others, for libraries
14484 specified with @option{-l}.
14485
14486 @item -Ym,@var{dir}
14487 @opindex Ym
14488 Look in the directory @var{dir} to find the M4 preprocessor.
14489 The assembler uses this option.
14490 @c This is supposed to go with a -Yd for predefined M4 macro files, but
14491 @c the generic assembler that comes with Solaris takes just -Ym.
14492 @end table
14493
14494 @node V850 Options
14495 @subsection V850 Options
14496 @cindex V850 Options
14497
14498 These @samp{-m} options are defined for V850 implementations:
14499
14500 @table @gcctabopt
14501 @item -mlong-calls
14502 @itemx -mno-long-calls
14503 @opindex mlong-calls
14504 @opindex mno-long-calls
14505 Treat all calls as being far away (near).  If calls are assumed to be
14506 far away, the compiler will always load the functions address up into a
14507 register, and call indirect through the pointer.
14508
14509 @item -mno-ep
14510 @itemx -mep
14511 @opindex mno-ep
14512 @opindex mep
14513 Do not optimize (do optimize) basic blocks that use the same index
14514 pointer 4 or more times to copy pointer into the @code{ep} register, and
14515 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
14516 option is on by default if you optimize.
14517
14518 @item -mno-prolog-function
14519 @itemx -mprolog-function
14520 @opindex mno-prolog-function
14521 @opindex mprolog-function
14522 Do not use (do use) external functions to save and restore registers
14523 at the prologue and epilogue of a function.  The external functions
14524 are slower, but use less code space if more than one function saves
14525 the same number of registers.  The @option{-mprolog-function} option
14526 is on by default if you optimize.
14527
14528 @item -mspace
14529 @opindex mspace
14530 Try to make the code as small as possible.  At present, this just turns
14531 on the @option{-mep} and @option{-mprolog-function} options.
14532
14533 @item -mtda=@var{n}
14534 @opindex mtda
14535 Put static or global variables whose size is @var{n} bytes or less into
14536 the tiny data area that register @code{ep} points to.  The tiny data
14537 area can hold up to 256 bytes in total (128 bytes for byte references).
14538
14539 @item -msda=@var{n}
14540 @opindex msda
14541 Put static or global variables whose size is @var{n} bytes or less into
14542 the small data area that register @code{gp} points to.  The small data
14543 area can hold up to 64 kilobytes.
14544
14545 @item -mzda=@var{n}
14546 @opindex mzda
14547 Put static or global variables whose size is @var{n} bytes or less into
14548 the first 32 kilobytes of memory.
14549
14550 @item -mv850
14551 @opindex mv850
14552 Specify that the target processor is the V850.
14553
14554 @item -mbig-switch
14555 @opindex mbig-switch
14556 Generate code suitable for big switch tables.  Use this option only if
14557 the assembler/linker complain about out of range branches within a switch
14558 table.
14559
14560 @item -mapp-regs
14561 @opindex mapp-regs
14562 This option will cause r2 and r5 to be used in the code generated by
14563 the compiler.  This setting is the default.
14564
14565 @item -mno-app-regs
14566 @opindex mno-app-regs
14567 This option will cause r2 and r5 to be treated as fixed registers.
14568
14569 @item -mv850e1
14570 @opindex mv850e1
14571 Specify that the target processor is the V850E1.  The preprocessor
14572 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
14573 this option is used.
14574
14575 @item -mv850e
14576 @opindex mv850e
14577 Specify that the target processor is the V850E@.  The preprocessor
14578 constant @samp{__v850e__} will be defined if this option is used.
14579
14580 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
14581 are defined then a default target processor will be chosen and the
14582 relevant @samp{__v850*__} preprocessor constant will be defined.
14583
14584 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
14585 defined, regardless of which processor variant is the target.
14586
14587 @item -mdisable-callt
14588 @opindex mdisable-callt
14589 This option will suppress generation of the CALLT instruction for the
14590 v850e and v850e1 flavors of the v850 architecture.  The default is
14591 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
14592
14593 @end table
14594
14595 @node VAX Options
14596 @subsection VAX Options
14597 @cindex VAX options
14598
14599 These @samp{-m} options are defined for the VAX:
14600
14601 @table @gcctabopt
14602 @item -munix
14603 @opindex munix
14604 Do not output certain jump instructions (@code{aobleq} and so on)
14605 that the Unix assembler for the VAX cannot handle across long
14606 ranges.
14607
14608 @item -mgnu
14609 @opindex mgnu
14610 Do output those jump instructions, on the assumption that you
14611 will assemble with the GNU assembler.
14612
14613 @item -mg
14614 @opindex mg
14615 Output code for g-format floating point numbers instead of d-format.
14616 @end table
14617
14618 @node VxWorks Options
14619 @subsection VxWorks Options
14620 @cindex VxWorks Options
14621
14622 The options in this section are defined for all VxWorks targets.
14623 Options specific to the target hardware are listed with the other
14624 options for that target.
14625
14626 @table @gcctabopt
14627 @item -mrtp
14628 @opindex mrtp
14629 GCC can generate code for both VxWorks kernels and real time processes
14630 (RTPs).  This option switches from the former to the latter.  It also
14631 defines the preprocessor macro @code{__RTP__}.
14632
14633 @item -non-static
14634 @opindex non-static
14635 Link an RTP executable against shared libraries rather than static
14636 libraries.  The options @option{-static} and @option{-shared} can
14637 also be used for RTPs (@pxref{Link Options}); @option{-static}
14638 is the default.
14639
14640 @item -Bstatic
14641 @itemx -Bdynamic
14642 @opindex Bstatic
14643 @opindex Bdynamic
14644 These options are passed down to the linker.  They are defined for
14645 compatibility with Diab.
14646
14647 @item -Xbind-lazy
14648 @opindex Xbind-lazy
14649 Enable lazy binding of function calls.  This option is equivalent to
14650 @option{-Wl,-z,now} and is defined for compatibility with Diab.
14651
14652 @item -Xbind-now
14653 @opindex Xbind-now
14654 Disable lazy binding of function calls.  This option is the default and
14655 is defined for compatibility with Diab.
14656 @end table
14657
14658 @node x86-64 Options
14659 @subsection x86-64 Options
14660 @cindex x86-64 options
14661
14662 These are listed under @xref{i386 and x86-64 Options}.
14663
14664 @node Xstormy16 Options
14665 @subsection Xstormy16 Options
14666 @cindex Xstormy16 Options
14667
14668 These options are defined for Xstormy16:
14669
14670 @table @gcctabopt
14671 @item -msim
14672 @opindex msim
14673 Choose startup files and linker script suitable for the simulator.
14674 @end table
14675
14676 @node Xtensa Options
14677 @subsection Xtensa Options
14678 @cindex Xtensa Options
14679
14680 These options are supported for Xtensa targets:
14681
14682 @table @gcctabopt
14683 @item -mconst16
14684 @itemx -mno-const16
14685 @opindex mconst16
14686 @opindex mno-const16
14687 Enable or disable use of @code{CONST16} instructions for loading
14688 constant values.  The @code{CONST16} instruction is currently not a
14689 standard option from Tensilica.  When enabled, @code{CONST16}
14690 instructions are always used in place of the standard @code{L32R}
14691 instructions.  The use of @code{CONST16} is enabled by default only if
14692 the @code{L32R} instruction is not available.
14693
14694 @item -mfused-madd
14695 @itemx -mno-fused-madd
14696 @opindex mfused-madd
14697 @opindex mno-fused-madd
14698 Enable or disable use of fused multiply/add and multiply/subtract
14699 instructions in the floating-point option.  This has no effect if the
14700 floating-point option is not also enabled.  Disabling fused multiply/add
14701 and multiply/subtract instructions forces the compiler to use separate
14702 instructions for the multiply and add/subtract operations.  This may be
14703 desirable in some cases where strict IEEE 754-compliant results are
14704 required: the fused multiply add/subtract instructions do not round the
14705 intermediate result, thereby producing results with @emph{more} bits of
14706 precision than specified by the IEEE standard.  Disabling fused multiply
14707 add/subtract instructions also ensures that the program output is not
14708 sensitive to the compiler's ability to combine multiply and add/subtract
14709 operations.
14710
14711 @item -mserialize-volatile
14712 @itemx -mno-serialize-volatile
14713 @opindex mserialize-volatile
14714 @opindex mno-serialize-volatile
14715 When this option is enabled, GCC inserts @code{MEMW} instructions before
14716 @code{volatile} memory references to guarantee sequential consistency.
14717 The default is @option{-mserialize-volatile}.  Use
14718 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
14719
14720 @item -mtext-section-literals
14721 @itemx -mno-text-section-literals
14722 @opindex mtext-section-literals
14723 @opindex mno-text-section-literals
14724 Control the treatment of literal pools.  The default is
14725 @option{-mno-text-section-literals}, which places literals in a separate
14726 section in the output file.  This allows the literal pool to be placed
14727 in a data RAM/ROM, and it also allows the linker to combine literal
14728 pools from separate object files to remove redundant literals and
14729 improve code size.  With @option{-mtext-section-literals}, the literals
14730 are interspersed in the text section in order to keep them as close as
14731 possible to their references.  This may be necessary for large assembly
14732 files.
14733
14734 @item -mtarget-align
14735 @itemx -mno-target-align
14736 @opindex mtarget-align
14737 @opindex mno-target-align
14738 When this option is enabled, GCC instructs the assembler to
14739 automatically align instructions to reduce branch penalties at the
14740 expense of some code density.  The assembler attempts to widen density
14741 instructions to align branch targets and the instructions following call
14742 instructions.  If there are not enough preceding safe density
14743 instructions to align a target, no widening will be performed.  The
14744 default is @option{-mtarget-align}.  These options do not affect the
14745 treatment of auto-aligned instructions like @code{LOOP}, which the
14746 assembler will always align, either by widening density instructions or
14747 by inserting no-op instructions.
14748
14749 @item -mlongcalls
14750 @itemx -mno-longcalls
14751 @opindex mlongcalls
14752 @opindex mno-longcalls
14753 When this option is enabled, GCC instructs the assembler to translate
14754 direct calls to indirect calls unless it can determine that the target
14755 of a direct call is in the range allowed by the call instruction.  This
14756 translation typically occurs for calls to functions in other source
14757 files.  Specifically, the assembler translates a direct @code{CALL}
14758 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
14759 The default is @option{-mno-longcalls}.  This option should be used in
14760 programs where the call target can potentially be out of range.  This
14761 option is implemented in the assembler, not the compiler, so the
14762 assembly code generated by GCC will still show direct call
14763 instructions---look at the disassembled object code to see the actual
14764 instructions.  Note that the assembler will use an indirect call for
14765 every cross-file call, not just those that really will be out of range.
14766 @end table
14767
14768 @node zSeries Options
14769 @subsection zSeries Options
14770 @cindex zSeries options
14771
14772 These are listed under @xref{S/390 and zSeries Options}.
14773
14774 @node Code Gen Options
14775 @section Options for Code Generation Conventions
14776 @cindex code generation conventions
14777 @cindex options, code generation
14778 @cindex run-time options
14779
14780 These machine-independent options control the interface conventions
14781 used in code generation.
14782
14783 Most of them have both positive and negative forms; the negative form
14784 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
14785 one of the forms is listed---the one which is not the default.  You
14786 can figure out the other form by either removing @samp{no-} or adding
14787 it.
14788
14789 @table @gcctabopt
14790 @item -fbounds-check
14791 @opindex fbounds-check
14792 For front-ends that support it, generate additional code to check that
14793 indices used to access arrays are within the declared range.  This is
14794 currently only supported by the Java and Fortran front-ends, where
14795 this option defaults to true and false respectively.
14796
14797 @item -ftrapv
14798 @opindex ftrapv
14799 This option generates traps for signed overflow on addition, subtraction,
14800 multiplication operations.
14801
14802 @item -fwrapv
14803 @opindex fwrapv
14804 This option instructs the compiler to assume that signed arithmetic
14805 overflow of addition, subtraction and multiplication wraps around
14806 using twos-complement representation.  This flag enables some optimizations
14807 and disables others.  This option is enabled by default for the Java
14808 front-end, as required by the Java language specification.
14809
14810 @item -fexceptions
14811 @opindex fexceptions
14812 Enable exception handling.  Generates extra code needed to propagate
14813 exceptions.  For some targets, this implies GCC will generate frame
14814 unwind information for all functions, which can produce significant data
14815 size overhead, although it does not affect execution.  If you do not
14816 specify this option, GCC will enable it by default for languages like
14817 C++ which normally require exception handling, and disable it for
14818 languages like C that do not normally require it.  However, you may need
14819 to enable this option when compiling C code that needs to interoperate
14820 properly with exception handlers written in C++.  You may also wish to
14821 disable this option if you are compiling older C++ programs that don't
14822 use exception handling.
14823
14824 @item -fnon-call-exceptions
14825 @opindex fnon-call-exceptions
14826 Generate code that allows trapping instructions to throw exceptions.
14827 Note that this requires platform-specific runtime support that does
14828 not exist everywhere.  Moreover, it only allows @emph{trapping}
14829 instructions to throw exceptions, i.e.@: memory references or floating
14830 point instructions.  It does not allow exceptions to be thrown from
14831 arbitrary signal handlers such as @code{SIGALRM}.
14832
14833 @item -funwind-tables
14834 @opindex funwind-tables
14835 Similar to @option{-fexceptions}, except that it will just generate any needed
14836 static data, but will not affect the generated code in any other way.
14837 You will normally not enable this option; instead, a language processor
14838 that needs this handling would enable it on your behalf.
14839
14840 @item -fasynchronous-unwind-tables
14841 @opindex fasynchronous-unwind-tables
14842 Generate unwind table in dwarf2 format, if supported by target machine.  The
14843 table is exact at each instruction boundary, so it can be used for stack
14844 unwinding from asynchronous events (such as debugger or garbage collector).
14845
14846 @item -fpcc-struct-return
14847 @opindex fpcc-struct-return
14848 Return ``short'' @code{struct} and @code{union} values in memory like
14849 longer ones, rather than in registers.  This convention is less
14850 efficient, but it has the advantage of allowing intercallability between
14851 GCC-compiled files and files compiled with other compilers, particularly
14852 the Portable C Compiler (pcc).
14853
14854 The precise convention for returning structures in memory depends
14855 on the target configuration macros.
14856
14857 Short structures and unions are those whose size and alignment match
14858 that of some integer type.
14859
14860 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
14861 switch is not binary compatible with code compiled with the
14862 @option{-freg-struct-return} switch.
14863 Use it to conform to a non-default application binary interface.
14864
14865 @item -freg-struct-return
14866 @opindex freg-struct-return
14867 Return @code{struct} and @code{union} values in registers when possible.
14868 This is more efficient for small structures than
14869 @option{-fpcc-struct-return}.
14870
14871 If you specify neither @option{-fpcc-struct-return} nor
14872 @option{-freg-struct-return}, GCC defaults to whichever convention is
14873 standard for the target.  If there is no standard convention, GCC
14874 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
14875 the principal compiler.  In those cases, we can choose the standard, and
14876 we chose the more efficient register return alternative.
14877
14878 @strong{Warning:} code compiled with the @option{-freg-struct-return}
14879 switch is not binary compatible with code compiled with the
14880 @option{-fpcc-struct-return} switch.
14881 Use it to conform to a non-default application binary interface.
14882
14883 @item -fshort-enums
14884 @opindex fshort-enums
14885 Allocate to an @code{enum} type only as many bytes as it needs for the
14886 declared range of possible values.  Specifically, the @code{enum} type
14887 will be equivalent to the smallest integer type which has enough room.
14888
14889 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
14890 code that is not binary compatible with code generated without that switch.
14891 Use it to conform to a non-default application binary interface.
14892
14893 @item -fshort-double
14894 @opindex fshort-double
14895 Use the same size for @code{double} as for @code{float}.
14896
14897 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
14898 code that is not binary compatible with code generated without that switch.
14899 Use it to conform to a non-default application binary interface.
14900
14901 @item -fshort-wchar
14902 @opindex fshort-wchar
14903 Override the underlying type for @samp{wchar_t} to be @samp{short
14904 unsigned int} instead of the default for the target.  This option is
14905 useful for building programs to run under WINE@.
14906
14907 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
14908 code that is not binary compatible with code generated without that switch.
14909 Use it to conform to a non-default application binary interface.
14910
14911 @item -fno-common
14912 @opindex fno-common
14913 In C, allocate even uninitialized global variables in the data section of the
14914 object file, rather than generating them as common blocks.  This has the
14915 effect that if the same variable is declared (without @code{extern}) in
14916 two different compilations, you will get an error when you link them.
14917 The only reason this might be useful is if you wish to verify that the
14918 program will work on other systems which always work this way.
14919
14920 @item -fno-ident
14921 @opindex fno-ident
14922 Ignore the @samp{#ident} directive.
14923
14924 @item -finhibit-size-directive
14925 @opindex finhibit-size-directive
14926 Don't output a @code{.size} assembler directive, or anything else that
14927 would cause trouble if the function is split in the middle, and the
14928 two halves are placed at locations far apart in memory.  This option is
14929 used when compiling @file{crtstuff.c}; you should not need to use it
14930 for anything else.
14931
14932 @item -fverbose-asm
14933 @opindex fverbose-asm
14934 Put extra commentary information in the generated assembly code to
14935 make it more readable.  This option is generally only of use to those
14936 who actually need to read the generated assembly code (perhaps while
14937 debugging the compiler itself).
14938
14939 @option{-fno-verbose-asm}, the default, causes the
14940 extra information to be omitted and is useful when comparing two assembler
14941 files.
14942
14943 @item -frecord-gcc-switches
14944 @opindex frecord-gcc-switches
14945 This switch causes the command line that was used to invoke the
14946 compiler to be recorded into the object file that is being created.
14947 This switch is only implemented on some targets and the exact format
14948 of the recording is target and binary file format dependent, but it
14949 usually takes the form of a section containing ASCII text.  This
14950 switch is related to the @option{-fverbose-asm} switch, but that
14951 switch only records information in the assembler output file as
14952 comments, so it never reaches the object file.
14953
14954 @item -fpic
14955 @opindex fpic
14956 @cindex global offset table
14957 @cindex PIC
14958 Generate position-independent code (PIC) suitable for use in a shared
14959 library, if supported for the target machine.  Such code accesses all
14960 constant addresses through a global offset table (GOT)@.  The dynamic
14961 loader resolves the GOT entries when the program starts (the dynamic
14962 loader is not part of GCC; it is part of the operating system).  If
14963 the GOT size for the linked executable exceeds a machine-specific
14964 maximum size, you get an error message from the linker indicating that
14965 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
14966 instead.  (These maximums are 8k on the SPARC and 32k
14967 on the m68k and RS/6000.  The 386 has no such limit.)
14968
14969 Position-independent code requires special support, and therefore works
14970 only on certain machines.  For the 386, GCC supports PIC for System V
14971 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
14972 position-independent.
14973
14974 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
14975 are defined to 1.
14976
14977 @item -fPIC
14978 @opindex fPIC
14979 If supported for the target machine, emit position-independent code,
14980 suitable for dynamic linking and avoiding any limit on the size of the
14981 global offset table.  This option makes a difference on the m68k,
14982 PowerPC and SPARC@.
14983
14984 Position-independent code requires special support, and therefore works
14985 only on certain machines.
14986
14987 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
14988 are defined to 2.
14989
14990 @item -fpie
14991 @itemx -fPIE
14992 @opindex fpie
14993 @opindex fPIE
14994 These options are similar to @option{-fpic} and @option{-fPIC}, but
14995 generated position independent code can be only linked into executables.
14996 Usually these options are used when @option{-pie} GCC option will be
14997 used during linking.
14998
14999 @option{-fpie} and @option{-fPIE} both define the macros
15000 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
15001 for @option{-fpie} and 2 for @option{-fPIE}.
15002
15003 @item -fno-jump-tables
15004 @opindex fno-jump-tables
15005 Do not use jump tables for switch statements even where it would be
15006 more efficient than other code generation strategies.  This option is
15007 of use in conjunction with @option{-fpic} or @option{-fPIC} for
15008 building code which forms part of a dynamic linker and cannot
15009 reference the address of a jump table.  On some targets, jump tables
15010 do not require a GOT and this option is not needed.
15011
15012 @item -ffixed-@var{reg}
15013 @opindex ffixed
15014 Treat the register named @var{reg} as a fixed register; generated code
15015 should never refer to it (except perhaps as a stack pointer, frame
15016 pointer or in some other fixed role).
15017
15018 @var{reg} must be the name of a register.  The register names accepted
15019 are machine-specific and are defined in the @code{REGISTER_NAMES}
15020 macro in the machine description macro file.
15021
15022 This flag does not have a negative form, because it specifies a
15023 three-way choice.
15024
15025 @item -fcall-used-@var{reg}
15026 @opindex fcall-used
15027 Treat the register named @var{reg} as an allocable register that is
15028 clobbered by function calls.  It may be allocated for temporaries or
15029 variables that do not live across a call.  Functions compiled this way
15030 will not save and restore the register @var{reg}.
15031
15032 It is an error to used this flag with the frame pointer or stack pointer.
15033 Use of this flag for other registers that have fixed pervasive roles in
15034 the machine's execution model will produce disastrous results.
15035
15036 This flag does not have a negative form, because it specifies a
15037 three-way choice.
15038
15039 @item -fcall-saved-@var{reg}
15040 @opindex fcall-saved
15041 Treat the register named @var{reg} as an allocable register saved by
15042 functions.  It may be allocated even for temporaries or variables that
15043 live across a call.  Functions compiled this way will save and restore
15044 the register @var{reg} if they use it.
15045
15046 It is an error to used this flag with the frame pointer or stack pointer.
15047 Use of this flag for other registers that have fixed pervasive roles in
15048 the machine's execution model will produce disastrous results.
15049
15050 A different sort of disaster will result from the use of this flag for
15051 a register in which function values may be returned.
15052
15053 This flag does not have a negative form, because it specifies a
15054 three-way choice.
15055
15056 @item -fpack-struct[=@var{n}]
15057 @opindex fpack-struct
15058 Without a value specified, pack all structure members together without
15059 holes.  When a value is specified (which must be a small power of two), pack
15060 structure members according to this value, representing the maximum
15061 alignment (that is, objects with default alignment requirements larger than
15062 this will be output potentially unaligned at the next fitting location.
15063
15064 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
15065 code that is not binary compatible with code generated without that switch.
15066 Additionally, it makes the code suboptimal.
15067 Use it to conform to a non-default application binary interface.
15068
15069 @item -finstrument-functions
15070 @opindex finstrument-functions
15071 Generate instrumentation calls for entry and exit to functions.  Just
15072 after function entry and just before function exit, the following
15073 profiling functions will be called with the address of the current
15074 function and its call site.  (On some platforms,
15075 @code{__builtin_return_address} does not work beyond the current
15076 function, so the call site information may not be available to the
15077 profiling functions otherwise.)
15078
15079 @smallexample
15080 void __cyg_profile_func_enter (void *this_fn,
15081                                void *call_site);
15082 void __cyg_profile_func_exit  (void *this_fn,
15083                                void *call_site);
15084 @end smallexample
15085
15086 The first argument is the address of the start of the current function,
15087 which may be looked up exactly in the symbol table.
15088
15089 This instrumentation is also done for functions expanded inline in other
15090 functions.  The profiling calls will indicate where, conceptually, the
15091 inline function is entered and exited.  This means that addressable
15092 versions of such functions must be available.  If all your uses of a
15093 function are expanded inline, this may mean an additional expansion of
15094 code size.  If you use @samp{extern inline} in your C code, an
15095 addressable version of such functions must be provided.  (This is
15096 normally the case anyways, but if you get lucky and the optimizer always
15097 expands the functions inline, you might have gotten away without
15098 providing static copies.)
15099
15100 A function may be given the attribute @code{no_instrument_function}, in
15101 which case this instrumentation will not be done.  This can be used, for
15102 example, for the profiling functions listed above, high-priority
15103 interrupt routines, and any functions from which the profiling functions
15104 cannot safely be called (perhaps signal handlers, if the profiling
15105 routines generate output or allocate memory).
15106
15107 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
15108 @opindex finstrument-functions-exclude-file-list
15109
15110 Set the list of functions that are excluded from instrumentation (see
15111 the description of @code{-finstrument-functions}).  If the file that
15112 contains a function definition matches with one of @var{file}, then
15113 that function is not instrumented.  The match is done on substrings:
15114 if the @var{file} parameter is a substring of the file name, it is
15115 considered to be a match.
15116
15117 For example,
15118 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
15119 will exclude any inline function defined in files whose pathnames
15120 contain @code{/bits/stl} or @code{include/sys}.
15121
15122 If, for some reason, you want to include letter @code{','} in one of
15123 @var{sym}, write @code{'\,'}. For example,
15124 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
15125 (note the single quote surrounding the option).
15126
15127 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
15128 @opindex finstrument-functions-exclude-function-list
15129
15130 This is similar to @code{-finstrument-functions-exclude-file-list},
15131 but this option sets the list of function names to be excluded from
15132 instrumentation.  The function name to be matched is its user-visible
15133 name, such as @code{vector<int> blah(const vector<int> &)}, not the
15134 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
15135 match is done on substrings: if the @var{sym} parameter is a substring
15136 of the function name, it is considered to be a match.
15137
15138 @item -fstack-check
15139 @opindex fstack-check
15140 Generate code to verify that you do not go beyond the boundary of the
15141 stack.  You should specify this flag if you are running in an
15142 environment with multiple threads, but only rarely need to specify it in
15143 a single-threaded environment since stack overflow is automatically
15144 detected on nearly all systems if there is only one stack.
15145
15146 Note that this switch does not actually cause checking to be done; the
15147 operating system must do that.  The switch causes generation of code
15148 to ensure that the operating system sees the stack being extended.
15149
15150 @item -fstack-limit-register=@var{reg}
15151 @itemx -fstack-limit-symbol=@var{sym}
15152 @itemx -fno-stack-limit
15153 @opindex fstack-limit-register
15154 @opindex fstack-limit-symbol
15155 @opindex fno-stack-limit
15156 Generate code to ensure that the stack does not grow beyond a certain value,
15157 either the value of a register or the address of a symbol.  If the stack
15158 would grow beyond the value, a signal is raised.  For most targets,
15159 the signal is raised before the stack overruns the boundary, so
15160 it is possible to catch the signal without taking special precautions.
15161
15162 For instance, if the stack starts at absolute address @samp{0x80000000}
15163 and grows downwards, you can use the flags
15164 @option{-fstack-limit-symbol=__stack_limit} and
15165 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
15166 of 128KB@.  Note that this may only work with the GNU linker.
15167
15168 @cindex aliasing of parameters
15169 @cindex parameters, aliased
15170 @item -fargument-alias
15171 @itemx -fargument-noalias
15172 @itemx -fargument-noalias-global
15173 @itemx -fargument-noalias-anything
15174 @opindex fargument-alias
15175 @opindex fargument-noalias
15176 @opindex fargument-noalias-global
15177 @opindex fargument-noalias-anything
15178 Specify the possible relationships among parameters and between
15179 parameters and global data.
15180
15181 @option{-fargument-alias} specifies that arguments (parameters) may
15182 alias each other and may alias global storage.@*
15183 @option{-fargument-noalias} specifies that arguments do not alias
15184 each other, but may alias global storage.@*
15185 @option{-fargument-noalias-global} specifies that arguments do not
15186 alias each other and do not alias global storage.
15187 @option{-fargument-noalias-anything} specifies that arguments do not
15188 alias any other storage.
15189
15190 Each language will automatically use whatever option is required by
15191 the language standard.  You should not need to use these options yourself.
15192
15193 @item -fleading-underscore
15194 @opindex fleading-underscore
15195 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
15196 change the way C symbols are represented in the object file.  One use
15197 is to help link with legacy assembly code.
15198
15199 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
15200 generate code that is not binary compatible with code generated without that
15201 switch.  Use it to conform to a non-default application binary interface.
15202 Not all targets provide complete support for this switch.
15203
15204 @item -ftls-model=@var{model}
15205 @opindex ftls-model
15206 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
15207 The @var{model} argument should be one of @code{global-dynamic},
15208 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
15209
15210 The default without @option{-fpic} is @code{initial-exec}; with
15211 @option{-fpic} the default is @code{global-dynamic}.
15212
15213 @item -fvisibility=@var{default|internal|hidden|protected}
15214 @opindex fvisibility
15215 Set the default ELF image symbol visibility to the specified option---all
15216 symbols will be marked with this unless overridden within the code.
15217 Using this feature can very substantially improve linking and
15218 load times of shared object libraries, produce more optimized
15219 code, provide near-perfect API export and prevent symbol clashes.
15220 It is @strong{strongly} recommended that you use this in any shared objects
15221 you distribute.
15222
15223 Despite the nomenclature, @code{default} always means public ie;
15224 available to be linked against from outside the shared object.
15225 @code{protected} and @code{internal} are pretty useless in real-world
15226 usage so the only other commonly used option will be @code{hidden}.
15227 The default if @option{-fvisibility} isn't specified is
15228 @code{default}, i.e., make every
15229 symbol public---this causes the same behavior as previous versions of
15230 GCC@.
15231
15232 A good explanation of the benefits offered by ensuring ELF
15233 symbols have the correct visibility is given by ``How To Write
15234 Shared Libraries'' by Ulrich Drepper (which can be found at
15235 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
15236 solution made possible by this option to marking things hidden when
15237 the default is public is to make the default hidden and mark things
15238 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
15239 and @code{__attribute__ ((visibility("default")))} instead of
15240 @code{__declspec(dllexport)} you get almost identical semantics with
15241 identical syntax.  This is a great boon to those working with
15242 cross-platform projects.
15243
15244 For those adding visibility support to existing code, you may find
15245 @samp{#pragma GCC visibility} of use.  This works by you enclosing
15246 the declarations you wish to set visibility for with (for example)
15247 @samp{#pragma GCC visibility push(hidden)} and
15248 @samp{#pragma GCC visibility pop}.
15249 Bear in mind that symbol visibility should be viewed @strong{as
15250 part of the API interface contract} and thus all new code should
15251 always specify visibility when it is not the default ie; declarations
15252 only for use within the local DSO should @strong{always} be marked explicitly
15253 as hidden as so to avoid PLT indirection overheads---making this
15254 abundantly clear also aids readability and self-documentation of the code.
15255 Note that due to ISO C++ specification requirements, operator new and
15256 operator delete must always be of default visibility.
15257
15258 Be aware that headers from outside your project, in particular system
15259 headers and headers from any other library you use, may not be
15260 expecting to be compiled with visibility other than the default.  You
15261 may need to explicitly say @samp{#pragma GCC visibility push(default)}
15262 before including any such headers.
15263
15264 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
15265 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
15266 no modifications.  However, this means that calls to @samp{extern}
15267 functions with no explicit visibility will use the PLT, so it is more
15268 effective to use @samp{__attribute ((visibility))} and/or
15269 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
15270 declarations should be treated as hidden.
15271
15272 Note that @samp{-fvisibility} does affect C++ vague linkage
15273 entities. This means that, for instance, an exception class that will
15274 be thrown between DSOs must be explicitly marked with default
15275 visibility so that the @samp{type_info} nodes will be unified between
15276 the DSOs.
15277
15278 An overview of these techniques, their benefits and how to use them
15279 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
15280
15281 @end table
15282
15283 @c man end
15284
15285 @node Environment Variables
15286 @section Environment Variables Affecting GCC
15287 @cindex environment variables
15288
15289 @c man begin ENVIRONMENT
15290 This section describes several environment variables that affect how GCC
15291 operates.  Some of them work by specifying directories or prefixes to use
15292 when searching for various kinds of files.  Some are used to specify other
15293 aspects of the compilation environment.
15294
15295 Note that you can also specify places to search using options such as
15296 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
15297 take precedence over places specified using environment variables, which
15298 in turn take precedence over those specified by the configuration of GCC@.
15299 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
15300 GNU Compiler Collection (GCC) Internals}.
15301
15302 @table @env
15303 @item LANG
15304 @itemx LC_CTYPE
15305 @c @itemx LC_COLLATE
15306 @itemx LC_MESSAGES
15307 @c @itemx LC_MONETARY
15308 @c @itemx LC_NUMERIC
15309 @c @itemx LC_TIME
15310 @itemx LC_ALL
15311 @findex LANG
15312 @findex LC_CTYPE
15313 @c @findex LC_COLLATE
15314 @findex LC_MESSAGES
15315 @c @findex LC_MONETARY
15316 @c @findex LC_NUMERIC
15317 @c @findex LC_TIME
15318 @findex LC_ALL
15319 @cindex locale
15320 These environment variables control the way that GCC uses
15321 localization information that allow GCC to work with different
15322 national conventions.  GCC inspects the locale categories
15323 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
15324 so.  These locale categories can be set to any value supported by your
15325 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
15326 Kingdom encoded in UTF-8.
15327
15328 The @env{LC_CTYPE} environment variable specifies character
15329 classification.  GCC uses it to determine the character boundaries in
15330 a string; this is needed for some multibyte encodings that contain quote
15331 and escape characters that would otherwise be interpreted as a string
15332 end or escape.
15333
15334 The @env{LC_MESSAGES} environment variable specifies the language to
15335 use in diagnostic messages.
15336
15337 If the @env{LC_ALL} environment variable is set, it overrides the value
15338 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
15339 and @env{LC_MESSAGES} default to the value of the @env{LANG}
15340 environment variable.  If none of these variables are set, GCC
15341 defaults to traditional C English behavior.
15342
15343 @item TMPDIR
15344 @findex TMPDIR
15345 If @env{TMPDIR} is set, it specifies the directory to use for temporary
15346 files.  GCC uses temporary files to hold the output of one stage of
15347 compilation which is to be used as input to the next stage: for example,
15348 the output of the preprocessor, which is the input to the compiler
15349 proper.
15350
15351 @item GCC_EXEC_PREFIX
15352 @findex GCC_EXEC_PREFIX
15353 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
15354 names of the subprograms executed by the compiler.  No slash is added
15355 when this prefix is combined with the name of a subprogram, but you can
15356 specify a prefix that ends with a slash if you wish.
15357
15358 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
15359 an appropriate prefix to use based on the pathname it was invoked with.
15360
15361 If GCC cannot find the subprogram using the specified prefix, it
15362 tries looking in the usual places for the subprogram.
15363
15364 The default value of @env{GCC_EXEC_PREFIX} is
15365 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
15366 the installed compiler. In many cases @var{prefix} is the value
15367 of @code{prefix} when you ran the @file{configure} script.
15368
15369 Other prefixes specified with @option{-B} take precedence over this prefix.
15370
15371 This prefix is also used for finding files such as @file{crt0.o} that are
15372 used for linking.
15373
15374 In addition, the prefix is used in an unusual way in finding the
15375 directories to search for header files.  For each of the standard
15376 directories whose name normally begins with @samp{/usr/local/lib/gcc}
15377 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
15378 replacing that beginning with the specified prefix to produce an
15379 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
15380 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
15381 These alternate directories are searched first; the standard directories
15382 come next. If a standard directory begins with the configured
15383 @var{prefix} then the value of @var{prefix} is replaced by
15384 @env{GCC_EXEC_PREFIX} when looking for header files.
15385
15386 @item COMPILER_PATH
15387 @findex COMPILER_PATH
15388 The value of @env{COMPILER_PATH} is a colon-separated list of
15389 directories, much like @env{PATH}.  GCC tries the directories thus
15390 specified when searching for subprograms, if it can't find the
15391 subprograms using @env{GCC_EXEC_PREFIX}.
15392
15393 @item LIBRARY_PATH
15394 @findex LIBRARY_PATH
15395 The value of @env{LIBRARY_PATH} is a colon-separated list of
15396 directories, much like @env{PATH}.  When configured as a native compiler,
15397 GCC tries the directories thus specified when searching for special
15398 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
15399 using GCC also uses these directories when searching for ordinary
15400 libraries for the @option{-l} option (but directories specified with
15401 @option{-L} come first).
15402
15403 @item LANG
15404 @findex LANG
15405 @cindex locale definition
15406 This variable is used to pass locale information to the compiler.  One way in
15407 which this information is used is to determine the character set to be used
15408 when character literals, string literals and comments are parsed in C and C++.
15409 When the compiler is configured to allow multibyte characters,
15410 the following values for @env{LANG} are recognized:
15411
15412 @table @samp
15413 @item C-JIS
15414 Recognize JIS characters.
15415 @item C-SJIS
15416 Recognize SJIS characters.
15417 @item C-EUCJP
15418 Recognize EUCJP characters.
15419 @end table
15420
15421 If @env{LANG} is not defined, or if it has some other value, then the
15422 compiler will use mblen and mbtowc as defined by the default locale to
15423 recognize and translate multibyte characters.
15424 @end table
15425
15426 @noindent
15427 Some additional environments variables affect the behavior of the
15428 preprocessor.
15429
15430 @include cppenv.texi
15431
15432 @c man end
15433
15434 @node Precompiled Headers
15435 @section Using Precompiled Headers
15436 @cindex precompiled headers
15437 @cindex speed of compilation
15438
15439 Often large projects have many header files that are included in every
15440 source file.  The time the compiler takes to process these header files
15441 over and over again can account for nearly all of the time required to
15442 build the project.  To make builds faster, GCC allows users to
15443 `precompile' a header file; then, if builds can use the precompiled
15444 header file they will be much faster.
15445
15446 To create a precompiled header file, simply compile it as you would any
15447 other file, if necessary using the @option{-x} option to make the driver
15448 treat it as a C or C++ header file.  You will probably want to use a
15449 tool like @command{make} to keep the precompiled header up-to-date when
15450 the headers it contains change.
15451
15452 A precompiled header file will be searched for when @code{#include} is
15453 seen in the compilation.  As it searches for the included file
15454 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
15455 compiler looks for a precompiled header in each directory just before it
15456 looks for the include file in that directory.  The name searched for is
15457 the name specified in the @code{#include} with @samp{.gch} appended.  If
15458 the precompiled header file can't be used, it is ignored.
15459
15460 For instance, if you have @code{#include "all.h"}, and you have
15461 @file{all.h.gch} in the same directory as @file{all.h}, then the
15462 precompiled header file will be used if possible, and the original
15463 header will be used otherwise.
15464
15465 Alternatively, you might decide to put the precompiled header file in a
15466 directory and use @option{-I} to ensure that directory is searched
15467 before (or instead of) the directory containing the original header.
15468 Then, if you want to check that the precompiled header file is always
15469 used, you can put a file of the same name as the original header in this
15470 directory containing an @code{#error} command.
15471
15472 This also works with @option{-include}.  So yet another way to use
15473 precompiled headers, good for projects not designed with precompiled
15474 header files in mind, is to simply take most of the header files used by
15475 a project, include them from another header file, precompile that header
15476 file, and @option{-include} the precompiled header.  If the header files
15477 have guards against multiple inclusion, they will be skipped because
15478 they've already been included (in the precompiled header).
15479
15480 If you need to precompile the same header file for different
15481 languages, targets, or compiler options, you can instead make a
15482 @emph{directory} named like @file{all.h.gch}, and put each precompiled
15483 header in the directory, perhaps using @option{-o}.  It doesn't matter
15484 what you call the files in the directory, every precompiled header in
15485 the directory will be considered.  The first precompiled header
15486 encountered in the directory that is valid for this compilation will
15487 be used; they're searched in no particular order.
15488
15489 There are many other possibilities, limited only by your imagination,
15490 good sense, and the constraints of your build system.
15491
15492 A precompiled header file can be used only when these conditions apply:
15493
15494 @itemize
15495 @item
15496 Only one precompiled header can be used in a particular compilation.
15497
15498 @item
15499 A precompiled header can't be used once the first C token is seen.  You
15500 can have preprocessor directives before a precompiled header; you can
15501 even include a precompiled header from inside another header, so long as
15502 there are no C tokens before the @code{#include}.
15503
15504 @item
15505 The precompiled header file must be produced for the same language as
15506 the current compilation.  You can't use a C precompiled header for a C++
15507 compilation.
15508
15509 @item
15510 The precompiled header file must have been produced by the same compiler
15511 binary as the current compilation is using.
15512
15513 @item
15514 Any macros defined before the precompiled header is included must
15515 either be defined in the same way as when the precompiled header was
15516 generated, or must not affect the precompiled header, which usually
15517 means that they don't appear in the precompiled header at all.
15518
15519 The @option{-D} option is one way to define a macro before a
15520 precompiled header is included; using a @code{#define} can also do it.
15521 There are also some options that define macros implicitly, like
15522 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
15523 defined this way.
15524
15525 @item If debugging information is output when using the precompiled
15526 header, using @option{-g} or similar, the same kind of debugging information
15527 must have been output when building the precompiled header.  However,
15528 a precompiled header built using @option{-g} can be used in a compilation
15529 when no debugging information is being output.
15530
15531 @item The same @option{-m} options must generally be used when building
15532 and using the precompiled header.  @xref{Submodel Options},
15533 for any cases where this rule is relaxed.
15534
15535 @item Each of the following options must be the same when building and using
15536 the precompiled header:
15537
15538 @gccoptlist{-fexceptions -funit-at-a-time}
15539
15540 @item
15541 Some other command-line options starting with @option{-f},
15542 @option{-p}, or @option{-O} must be defined in the same way as when
15543 the precompiled header was generated.  At present, it's not clear
15544 which options are safe to change and which are not; the safest choice
15545 is to use exactly the same options when generating and using the
15546 precompiled header.  The following are known to be safe:
15547
15548 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
15549 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
15550 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
15551 -pedantic-errors}
15552
15553 @end itemize
15554
15555 For all of these except the last, the compiler will automatically
15556 ignore the precompiled header if the conditions aren't met.  If you
15557 find an option combination that doesn't work and doesn't cause the
15558 precompiled header to be ignored, please consider filing a bug report,
15559 see @ref{Bugs}.
15560
15561 If you do use differing options when generating and using the
15562 precompiled header, the actual behavior will be a mixture of the
15563 behavior for the options.  For instance, if you use @option{-g} to
15564 generate the precompiled header but not when using it, you may or may
15565 not get debugging information for routines in the precompiled header.
15566
15567 @node Running Protoize
15568 @section Running Protoize
15569
15570 The program @code{protoize} is an optional part of GCC@.  You can use
15571 it to add prototypes to a program, thus converting the program to ISO
15572 C in one respect.  The companion program @code{unprotoize} does the
15573 reverse: it removes argument types from any prototypes that are found.
15574
15575 When you run these programs, you must specify a set of source files as
15576 command line arguments.  The conversion programs start out by compiling
15577 these files to see what functions they define.  The information gathered
15578 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
15579
15580 After scanning comes actual conversion.  The specified files are all
15581 eligible to be converted; any files they include (whether sources or
15582 just headers) are eligible as well.
15583
15584 But not all the eligible files are converted.  By default,
15585 @code{protoize} and @code{unprotoize} convert only source and header
15586 files in the current directory.  You can specify additional directories
15587 whose files should be converted with the @option{-d @var{directory}}
15588 option.  You can also specify particular files to exclude with the
15589 @option{-x @var{file}} option.  A file is converted if it is eligible, its
15590 directory name matches one of the specified directory names, and its
15591 name within the directory has not been excluded.
15592
15593 Basic conversion with @code{protoize} consists of rewriting most
15594 function definitions and function declarations to specify the types of
15595 the arguments.  The only ones not rewritten are those for varargs
15596 functions.
15597
15598 @code{protoize} optionally inserts prototype declarations at the
15599 beginning of the source file, to make them available for any calls that
15600 precede the function's definition.  Or it can insert prototype
15601 declarations with block scope in the blocks where undeclared functions
15602 are called.
15603
15604 Basic conversion with @code{unprotoize} consists of rewriting most
15605 function declarations to remove any argument types, and rewriting
15606 function definitions to the old-style pre-ISO form.
15607
15608 Both conversion programs print a warning for any function declaration or
15609 definition that they can't convert.  You can suppress these warnings
15610 with @option{-q}.
15611
15612 The output from @code{protoize} or @code{unprotoize} replaces the
15613 original source file.  The original file is renamed to a name ending
15614 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
15615 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
15616 for DOS) file already exists, then the source file is simply discarded.
15617
15618 @code{protoize} and @code{unprotoize} both depend on GCC itself to
15619 scan the program and collect information about the functions it uses.
15620 So neither of these programs will work until GCC is installed.
15621
15622 Here is a table of the options you can use with @code{protoize} and
15623 @code{unprotoize}.  Each option works with both programs unless
15624 otherwise stated.
15625
15626 @table @code
15627 @item -B @var{directory}
15628 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
15629 usual directory (normally @file{/usr/local/lib}).  This file contains
15630 prototype information about standard system functions.  This option
15631 applies only to @code{protoize}.
15632
15633 @item -c @var{compilation-options}
15634 Use @var{compilation-options} as the options when running @command{gcc} to
15635 produce the @samp{.X} files.  The special option @option{-aux-info} is
15636 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
15637
15638 Note that the compilation options must be given as a single argument to
15639 @code{protoize} or @code{unprotoize}.  If you want to specify several
15640 @command{gcc} options, you must quote the entire set of compilation options
15641 to make them a single word in the shell.
15642
15643 There are certain @command{gcc} arguments that you cannot use, because they
15644 would produce the wrong kind of output.  These include @option{-g},
15645 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
15646 the @var{compilation-options}, they are ignored.
15647
15648 @item -C
15649 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
15650 systems) instead of @samp{.c}.  This is convenient if you are converting
15651 a C program to C++.  This option applies only to @code{protoize}.
15652
15653 @item -g
15654 Add explicit global declarations.  This means inserting explicit
15655 declarations at the beginning of each source file for each function
15656 that is called in the file and was not declared.  These declarations
15657 precede the first function definition that contains a call to an
15658 undeclared function.  This option applies only to @code{protoize}.
15659
15660 @item -i @var{string}
15661 Indent old-style parameter declarations with the string @var{string}.
15662 This option applies only to @code{protoize}.
15663
15664 @code{unprotoize} converts prototyped function definitions to old-style
15665 function definitions, where the arguments are declared between the
15666 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
15667 uses five spaces as the indentation.  If you want to indent with just
15668 one space instead, use @option{-i " "}.
15669
15670 @item -k
15671 Keep the @samp{.X} files.  Normally, they are deleted after conversion
15672 is finished.
15673
15674 @item -l
15675 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
15676 a prototype declaration for each function in each block which calls the
15677 function without any declaration.  This option applies only to
15678 @code{protoize}.
15679
15680 @item -n
15681 Make no real changes.  This mode just prints information about the conversions
15682 that would have been done without @option{-n}.
15683
15684 @item -N
15685 Make no @samp{.save} files.  The original files are simply deleted.
15686 Use this option with caution.
15687
15688 @item -p @var{program}
15689 Use the program @var{program} as the compiler.  Normally, the name
15690 @file{gcc} is used.
15691
15692 @item -q
15693 Work quietly.  Most warnings are suppressed.
15694
15695 @item -v
15696 Print the version number, just like @option{-v} for @command{gcc}.
15697 @end table
15698
15699 If you need special compiler options to compile one of your program's
15700 source files, then you should generate that file's @samp{.X} file
15701 specially, by running @command{gcc} on that source file with the
15702 appropriate options and the option @option{-aux-info}.  Then run
15703 @code{protoize} on the entire set of files.  @code{protoize} will use
15704 the existing @samp{.X} file because it is newer than the source file.
15705 For example:
15706
15707 @smallexample
15708 gcc -Dfoo=bar file1.c -aux-info file1.X
15709 protoize *.c
15710 @end smallexample
15711
15712 @noindent
15713 You need to include the special files along with the rest in the
15714 @code{protoize} command, even though their @samp{.X} files already
15715 exist, because otherwise they won't get converted.
15716
15717 @xref{Protoize Caveats}, for more information on how to use
15718 @code{protoize} successfully.