Merged r158704 through r158906 into branch.
[official-gcc.git] / gcc / doc / invoke.texi
blobfefb0abd1d55e974c355ce5b261d1572c4528927
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
3 @c Free Software Foundation, Inc.
4 @c This is part of the GCC manual.
5 @c For copying conditions, see the file gcc.texi.
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
14 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
15 Free Software Foundation, Inc.
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.
25 (a) The FSF's Front-Cover Text is:
27      A GNU Manual
29 (b) The FSF's Back-Cover Text is:
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{}
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
67 @node Invoking GCC
68 @chapter GCC Command Options
69 @cindex GCC command options
70 @cindex command options
71 @cindex options, GCC command
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.
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.
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.
92 @cindex C++ compilation options
93 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
94 options for compiling C++ programs.
96 @cindex grouping options
97 @cindex options, grouping
98 The @command{gcc} program accepts options and file names as operands.  Many
99 options have multi-letter names; therefore multiple single-letter options
100 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
101 -v}}.
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.
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.
118 @c man end
120 @xref{Option Index}, for an index to GCC's options.
122 @menu
123 * Option Summary::      Brief list of all options, without explanations.
124 * Overall Options::     Controlling the kind of output:
125                         an executable, object files, assembler files,
126                         or preprocessed source.
127 * Invoking G++::        Compiling C++ programs.
128 * C Dialect Options::   Controlling the variant of C language compiled.
129 * C++ Dialect Options:: Variations on C++.
130 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
131                         and Objective-C++.
132 * Language Independent Options:: Controlling how diagnostics should be
133                         formatted.
134 * Warning Options::     How picky should the compiler be?
135 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
136 * Optimize Options::    How much optimization?
137 * Preprocessor Options:: Controlling header files and macro definitions.
138                          Also, getting dependency information for Make.
139 * Assembler Options::   Passing options to the assembler.
140 * Link Options::        Specifying libraries and so on.
141 * Directory Options::   Where to find header files and libraries.
142                         Where to find the compiler executable files.
143 * Spec Files::          How to pass switches to sub-processes.
144 * Target Options::      Running a cross-compiler, or an old version of GCC.
145 * Submodel Options::    Specifying minor hardware or convention variations,
146                         such as 68010 vs 68020.
147 * Code Gen Options::    Specifying conventions for function calls, data layout
148                         and register usage.
149 * Environment Variables:: Env vars that affect GCC.
150 * Precompiled Headers:: Compiling a header once, and using it many times.
151 @end menu
153 @c man begin OPTIONS
155 @node Option Summary
156 @section Option Summary
158 Here is a summary of all the options, grouped by type.  Explanations are
159 in the following sections.
161 @table @emph
162 @item Overall Options
163 @xref{Overall Options,,Options Controlling the Kind of Output}.
164 @gccoptlist{-c  -S  -E  -o @var{file}  -combine  -no-canonical-prefixes  @gol
165 -pipe  -pass-exit-codes  @gol
166 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
167 --version -wrapper@@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}}
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}
180 @item C++ Language Options
181 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
182 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
183 -fconserve-space  -ffriend-injection @gol
184 -fno-elide-constructors @gol
185 -fno-enforce-eh-specs @gol
186 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
187 -fno-implicit-templates @gol
188 -fno-implicit-inline-templates @gol
189 -fno-implement-inlines  -fms-extensions @gol
190 -fno-nonansi-builtins  -fno-operator-names @gol
191 -fno-optional-diags  -fpermissive @gol
192 -fno-pretty-templates @gol
193 -frepo  -fno-rtti  -fstats  -ftemplate-depth=@var{n} @gol
194 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
195 -fno-default-inline  -fvisibility-inlines-hidden @gol
196 -fvisibility-ms-compat @gol
197 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
198 -Wnon-virtual-dtor  -Wreorder @gol
199 -Weffc++  -Wstrict-null-sentinel @gol
200 -Wno-non-template-friend  -Wold-style-cast @gol
201 -Woverloaded-virtual  -Wno-pmf-conversions @gol
202 -Wsign-promo}
204 @item Objective-C and Objective-C++ Language Options
205 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
206 Objective-C and Objective-C++ Dialects}.
207 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
208 -fgnu-runtime  -fnext-runtime @gol
209 -fno-nil-receivers @gol
210 -fobjc-call-cxx-cdtors @gol
211 -fobjc-direct-dispatch @gol
212 -fobjc-exceptions @gol
213 -fobjc-gc @gol
214 -freplace-objc-classes @gol
215 -fzero-link @gol
216 -gen-decls @gol
217 -Wassign-intercept @gol
218 -Wno-protocol  -Wselector @gol
219 -Wstrict-selector-match @gol
220 -Wundeclared-selector}
222 @item Language Independent Options
223 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
224 @gccoptlist{-fmessage-length=@var{n}  @gol
225 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
226 -fdiagnostics-show-option}
228 @item Warning Options
229 @xref{Warning Options,,Options to Request or Suppress Warnings}.
230 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
231 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
232 -Wno-attributes -Wno-builtin-macro-redefined @gol
233 -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
234 -Wchar-subscripts -Wclobbered  -Wcomment @gol
235 -Wconversion  -Wcoverage-mismatch  -Wcpp  -Wno-deprecated  @gol
236 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
237 -Wno-div-by-zero -Wempty-body  -Wenum-compare -Wno-endif-labels @gol
238 -Werror  -Werror=* @gol
239 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
240 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
241 -Wformat-security  -Wformat-y2k @gol
242 -Wframe-larger-than=@var{len} -Wjump-misses-init -Wignored-qualifiers @gol
243 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
244 -Winit-self  -Winline @gol
245 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
246 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
247 -Wlogical-op -Wlong-long @gol
248 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
249 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
250 -Wmissing-noreturn  -Wno-mudflap @gol
251 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
252 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
253 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
254 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
255 -Wredundant-decls @gol
256 -Wreturn-type  -Wsequence-point  -Wshadow @gol
257 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
258 -Wstrict-aliasing -Wstrict-aliasing=n @gol
259 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
260 -Wsuggest-attribute=@r{[}const@r{|}pure@r{]} @gol
261 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
262 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
263 -Wunknown-pragmas  -Wno-pragmas @gol
264 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
265 -Wunused-label  -Wunused-parameter -Wno-unused-result -Wunused-value  -Wunused-variable @gol
266 -Wunused-but-set-parameter -Wunused-but-set-variable -Wvariadic-macros -Wvla @gol
267 -Wvolatile-register-var  -Wwrite-strings}
269 @item C and Objective-C-only Warning Options
270 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
271 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
272 -Wold-style-declaration  -Wold-style-definition @gol
273 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
274 -Wdeclaration-after-statement -Wpointer-sign}
276 @item Debugging Options
277 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
278 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
279 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
280 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
281 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
282 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
283 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
284 -fdump-statistics @gol
285 -fdump-tree-all @gol
286 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
287 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
289 -fdump-tree-ch @gol
290 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
299 -fdump-tree-nrv -fdump-tree-vect @gol
300 -fdump-tree-sink @gol
301 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
302 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
303 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
304 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
305 -ftree-vectorizer-verbose=@var{n} @gol
306 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
307 -fdump-final-insns=@var{file} @gol
308 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
309 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
310 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
311 -fenable-icf-debug @gol
312 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
313 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
314 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
315 -ftest-coverage  -ftime-report -fvar-tracking @gol
316 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
317 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
318 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
319 -gvms  -gxcoff  -gxcoff+ @gol
320 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
321 -fdebug-prefix-map=@var{old}=@var{new} @gol
322 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
323 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
324 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
325 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
326 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
327 -print-sysroot -print-sysroot-headers-suffix @gol
328 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
330 @item Optimization Options
331 @xref{Optimize Options,,Options that Control Optimization}.
332 @gccoptlist{
333 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
334 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
335 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
336 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
337 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
338 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
339 -fdata-sections -fdce -fdce @gol
340 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
341 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
342 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
343 -fforward-propagate -ffunction-sections @gol
344 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
345 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
346 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
347 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol
348 -fipa-profile -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
349 -fipa-type-escape -fira-algorithm=@var{algorithm} @gol
350 -fira-region=@var{region} -fira-coalesce @gol
351 -fira-loop-pressure -fno-ira-share-save-slots @gol
352 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
353 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
354 -floop-block -floop-interchange -floop-strip-mine -fgraphite-identity @gol
355 -floop-parallelize-all -flto -flto-compression-level -flto-report -fltrans @gol
356 -fltrans-output-list -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
357 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
358 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
359 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
360 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
361 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
362 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
363 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
364 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
365 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
366 -fprofile-generate=@var{path} @gol
367 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
368 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
369 -freorder-blocks-and-partition -freorder-functions @gol
370 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
371 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
372 -fsched-spec-load -fsched-spec-load-dangerous @gol
373 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
374 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
375 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
376 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
377 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
378 -fselective-scheduling -fselective-scheduling2 @gol
379 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
380 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
381 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
382 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
383 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
384 -ftree-copyrename -ftree-dce @gol
385 -ftree-dominator-opts -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-im @gol
386 -ftree-phiprop -ftree-loop-distribution @gol
387 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
388 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
389 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
390 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
391 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
392 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
393 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
394 -fwhole-program -fwhopr -fwpa -fuse-linker-plugin @gol
395 --param @var{name}=@var{value}
396 -O  -O0  -O1  -O2  -O3  -Os}
398 @item Preprocessor Options
399 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
400 @gccoptlist{-A@var{question}=@var{answer} @gol
401 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
402 -C  -dD  -dI  -dM  -dN @gol
403 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
404 -idirafter @var{dir} @gol
405 -include @var{file}  -imacros @var{file} @gol
406 -iprefix @var{file}  -iwithprefix @var{dir} @gol
407 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
408 -imultilib @var{dir} -isysroot @var{dir} @gol
409 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
410 -P  -fworking-directory  -remap @gol
411 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
412 -Xpreprocessor @var{option}}
414 @item Assembler Option
415 @xref{Assembler Options,,Passing Options to the Assembler}.
416 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
418 @item Linker Options
419 @xref{Link Options,,Options for Linking}.
420 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
421 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
422 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
423 -shared-libgcc  -symbolic @gol
424 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
425 -u @var{symbol}}
427 @item Directory Options
428 @xref{Directory Options,,Options for Directory Search}.
429 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir}}
430 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I-
431 --sysroot=@var{dir}
433 @item Machine Dependent Options
434 @xref{Submodel Options,,Hardware Models and Configurations}.
435 @c This list is ordered alphanumerically by subsection name.
436 @c Try and put the significant identifier (CPU or system) first,
437 @c so users have a clue at guessing where the ones they want will be.
439 @emph{ARC Options}
440 @gccoptlist{-EB  -EL @gol
441 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
442 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
444 @emph{ARM Options}
445 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
446 -mabi=@var{name} @gol
447 -mapcs-stack-check  -mno-apcs-stack-check @gol
448 -mapcs-float  -mno-apcs-float @gol
449 -mapcs-reentrant  -mno-apcs-reentrant @gol
450 -msched-prolog  -mno-sched-prolog @gol
451 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
452 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
453 -mfp16-format=@var{name}
454 -mthumb-interwork  -mno-thumb-interwork @gol
455 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
456 -mstructure-size-boundary=@var{n} @gol
457 -mabort-on-noreturn @gol
458 -mlong-calls  -mno-long-calls @gol
459 -msingle-pic-base  -mno-single-pic-base @gol
460 -mpic-register=@var{reg} @gol
461 -mnop-fun-dllimport @gol
462 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
463 -mpoke-function-name @gol
464 -mthumb  -marm @gol
465 -mtpcs-frame  -mtpcs-leaf-frame @gol
466 -mcaller-super-interworking  -mcallee-super-interworking @gol
467 -mtp=@var{name} @gol
468 -mword-relocations @gol
469 -mfix-cortex-m3-ldrd}
471 @emph{AVR Options}
472 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
473 -mcall-prologues  -mtiny-stack  -mint8}
475 @emph{Blackfin Options}
476 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
477 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
478 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
479 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
480 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
481 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
482 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
483 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
484 -micplb}
486 @emph{CRIS Options}
487 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
488 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
489 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
490 -mstack-align  -mdata-align  -mconst-align @gol
491 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
492 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
493 -mmul-bug-workaround  -mno-mul-bug-workaround}
495 @emph{CRX Options}
496 @gccoptlist{-mmac -mpush-args}
498 @emph{Darwin Options}
499 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
500 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
501 -client_name  -compatibility_version  -current_version @gol
502 -dead_strip @gol
503 -dependency-file  -dylib_file  -dylinker_install_name @gol
504 -dynamic  -dynamiclib  -exported_symbols_list @gol
505 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
506 -force_flat_namespace  -headerpad_max_install_names @gol
507 -iframework @gol
508 -image_base  -init  -install_name  -keep_private_externs @gol
509 -multi_module  -multiply_defined  -multiply_defined_unused @gol
510 -noall_load   -no_dead_strip_inits_and_terms @gol
511 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
512 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
513 -private_bundle  -read_only_relocs  -sectalign @gol
514 -sectobjectsymbols  -whyload  -seg1addr @gol
515 -sectcreate  -sectobjectsymbols  -sectorder @gol
516 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
517 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
518 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
519 -single_module  -static  -sub_library  -sub_umbrella @gol
520 -twolevel_namespace  -umbrella  -undefined @gol
521 -unexported_symbols_list  -weak_reference_mismatches @gol
522 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
523 -mkernel -mone-byte-bool}
525 @emph{DEC Alpha Options}
526 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
527 -mieee  -mieee-with-inexact  -mieee-conformant @gol
528 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
529 -mtrap-precision=@var{mode}  -mbuild-constants @gol
530 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
531 -mbwx  -mmax  -mfix  -mcix @gol
532 -mfloat-vax  -mfloat-ieee @gol
533 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
534 -msmall-text  -mlarge-text @gol
535 -mmemory-latency=@var{time}}
537 @emph{DEC Alpha/VMS Options}
538 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
540 @emph{FR30 Options}
541 @gccoptlist{-msmall-model -mno-lsim}
543 @emph{FRV Options}
544 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
545 -mhard-float  -msoft-float @gol
546 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
547 -mdouble  -mno-double @gol
548 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
549 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
550 -mlinked-fp  -mlong-calls  -malign-labels @gol
551 -mlibrary-pic  -macc-4  -macc-8 @gol
552 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
553 -moptimize-membar -mno-optimize-membar @gol
554 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
555 -mvliw-branch  -mno-vliw-branch @gol
556 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
557 -mno-nested-cond-exec  -mtomcat-stats @gol
558 -mTLS -mtls @gol
559 -mcpu=@var{cpu}}
561 @emph{GNU/Linux Options}
562 @gccoptlist{-muclibc}
564 @emph{H8/300 Options}
565 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
567 @emph{HPPA Options}
568 @gccoptlist{-march=@var{architecture-type} @gol
569 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
570 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
571 -mfixed-range=@var{register-range} @gol
572 -mjump-in-delay -mlinker-opt -mlong-calls @gol
573 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
574 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
575 -mno-jump-in-delay  -mno-long-load-store @gol
576 -mno-portable-runtime  -mno-soft-float @gol
577 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
578 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
579 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
580 -munix=@var{unix-std}  -nolibdld  -static  -threads}
582 @emph{i386 and x86-64 Options}
583 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
584 -mfpmath=@var{unit} @gol
585 -masm=@var{dialect}  -mno-fancy-math-387 @gol
586 -mno-fp-ret-in-387  -msoft-float @gol
587 -mno-wide-multiply  -mrtd  -malign-double @gol
588 -mpreferred-stack-boundary=@var{num}
589 -mincoming-stack-boundary=@var{num}
590 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
591 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
592 -maes -mpclmul -mfused-madd @gol
593 -msse4a -m3dnow -mpopcnt -mabm -mfma4 -mxop -mlwp @gol
594 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
595 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
596 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
597 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
598 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
599 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
600 -mcmodel=@var{code-model} -mabi=@var{name} @gol
601 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
602 -msse2avx}
604 @emph{IA-64 Options}
605 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
606 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
607 -mconstant-gp  -mauto-pic  -mfused-madd @gol
608 -minline-float-divide-min-latency @gol
609 -minline-float-divide-max-throughput @gol
610 -mno-inline-float-divide @gol
611 -minline-int-divide-min-latency @gol
612 -minline-int-divide-max-throughput  @gol
613 -mno-inline-int-divide @gol
614 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
615 -mno-inline-sqrt @gol
616 -mdwarf2-asm -mearly-stop-bits @gol
617 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
618 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
619 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
620 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
621 -msched-spec-ldc -msched-spec-control-ldc @gol
622 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
623 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
624 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
625 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
627 @emph{IA-64/VMS Options}
628 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
630 @emph{LM32 Options}
631 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
632 -msign-extend-enabled -muser-enabled}
634 @emph{M32R/D Options}
635 @gccoptlist{-m32r2 -m32rx -m32r @gol
636 -mdebug @gol
637 -malign-loops -mno-align-loops @gol
638 -missue-rate=@var{number} @gol
639 -mbranch-cost=@var{number} @gol
640 -mmodel=@var{code-size-model-type} @gol
641 -msdata=@var{sdata-type} @gol
642 -mno-flush-func -mflush-func=@var{name} @gol
643 -mno-flush-trap -mflush-trap=@var{number} @gol
644 -G @var{num}}
646 @emph{M32C Options}
647 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
649 @emph{M680x0 Options}
650 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
651 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
652 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
653 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
654 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
655 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
656 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
657 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
658 -mxgot -mno-xgot}
660 @emph{M68hc1x Options}
661 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
662 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
663 -msoft-reg-count=@var{count}}
665 @emph{MCore Options}
666 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
667 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
668 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
669 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
670 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
672 @emph{MeP Options}
673 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
674 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
675 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
676 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
677 -mtiny=@var{n}}
679 @emph{MIPS Options}
680 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
681 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
682 -mips64  -mips64r2 @gol
683 -mips16  -mno-mips16  -mflip-mips16 @gol
684 -minterlink-mips16  -mno-interlink-mips16 @gol
685 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
686 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
687 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
688 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
689 -mfpu=@var{fpu-type} @gol
690 -msmartmips  -mno-smartmips @gol
691 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
692 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
693 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
694 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
695 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
696 -membedded-data  -mno-embedded-data @gol
697 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
698 -mcode-readable=@var{setting} @gol
699 -msplit-addresses  -mno-split-addresses @gol
700 -mexplicit-relocs  -mno-explicit-relocs @gol
701 -mcheck-zero-division  -mno-check-zero-division @gol
702 -mdivide-traps  -mdivide-breaks @gol
703 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
704 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
705 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
706 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
707 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
708 -mflush-func=@var{func}  -mno-flush-func @gol
709 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
710 -mfp-exceptions -mno-fp-exceptions @gol
711 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
712 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
714 @emph{MMIX Options}
715 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
716 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
717 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
718 -mno-base-addresses  -msingle-exit  -mno-single-exit}
720 @emph{MN10300 Options}
721 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
722 -mam33  -mno-am33 @gol
723 -mam33-2  -mno-am33-2 @gol
724 -mreturn-pointer-on-d0 @gol
725 -mno-crt0  -mrelax}
727 @emph{PDP-11 Options}
728 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
729 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
730 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
731 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
732 -mbranch-expensive  -mbranch-cheap @gol
733 -msplit  -mno-split  -munix-asm  -mdec-asm}
735 @emph{picoChip Options}
736 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
737 -msymbol-as-address -mno-inefficient-warnings}
739 @emph{PowerPC Options}
740 See RS/6000 and PowerPC Options.
742 @emph{RS/6000 and PowerPC Options}
743 @gccoptlist{-mcpu=@var{cpu-type} @gol
744 -mtune=@var{cpu-type} @gol
745 -mpower  -mno-power  -mpower2  -mno-power2 @gol
746 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
747 -maltivec  -mno-altivec @gol
748 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
749 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
750 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
751 -mfprnd  -mno-fprnd @gol
752 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
753 -mnew-mnemonics  -mold-mnemonics @gol
754 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
755 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
756 -malign-power  -malign-natural @gol
757 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
758 -msingle-float -mdouble-float -msimple-fpu @gol
759 -mstring  -mno-string  -mupdate  -mno-update @gol
760 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
761 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
762 -mstrict-align  -mno-strict-align  -mrelocatable @gol
763 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
764 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
765 -mdynamic-no-pic  -maltivec -mswdiv @gol
766 -mprioritize-restricted-insns=@var{priority} @gol
767 -msched-costly-dep=@var{dependence_type} @gol
768 -minsert-sched-nops=@var{scheme} @gol
769 -mcall-sysv  -mcall-netbsd @gol
770 -maix-struct-return  -msvr4-struct-return @gol
771 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
772 -misel -mno-isel @gol
773 -misel=yes  -misel=no @gol
774 -mspe -mno-spe @gol
775 -mspe=yes  -mspe=no @gol
776 -mpaired @gol
777 -mgen-cell-microcode -mwarn-cell-microcode @gol
778 -mvrsave -mno-vrsave @gol
779 -mmulhw -mno-mulhw @gol
780 -mdlmzb -mno-dlmzb @gol
781 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
782 -mprototype  -mno-prototype @gol
783 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
784 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
786 @emph{RX Options}
787 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
788 -mcpu= -patch=@gol
789 -mbig-endian-data -mlittle-endian-data @gol
790 -msmall-data @gol
791 -msim  -mno-sim@gol
792 -mas100-syntax -mno-as100-syntax@gol
793 -mrelax@gol
794 -mmax-constant-size=@gol
795 -mint-register=@gol
796 -msave-acc-in-interrupts}
798 @emph{S/390 and zSeries Options}
799 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
800 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
801 -mlong-double-64 -mlong-double-128 @gol
802 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
803 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
804 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
805 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
806 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
808 @emph{Score Options}
809 @gccoptlist{-meb -mel @gol
810 -mnhwloop @gol
811 -muls @gol
812 -mmac @gol
813 -mscore5 -mscore5u -mscore7 -mscore7d}
815 @emph{SH Options}
816 @gccoptlist{-m1  -m2  -m2e @gol
817 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
818 -m3  -m3e @gol
819 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
820 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
821 -m5-64media  -m5-64media-nofpu @gol
822 -m5-32media  -m5-32media-nofpu @gol
823 -m5-compact  -m5-compact-nofpu @gol
824 -mb  -ml  -mdalign  -mrelax @gol
825 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
826 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
827 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
828 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
829 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
830 -maccumulate-outgoing-args -minvalid-symbols}
832 @emph{SPARC Options}
833 @gccoptlist{-mcpu=@var{cpu-type} @gol
834 -mtune=@var{cpu-type} @gol
835 -mcmodel=@var{code-model} @gol
836 -m32  -m64  -mapp-regs  -mno-app-regs @gol
837 -mfaster-structs  -mno-faster-structs @gol
838 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
839 -mhard-quad-float  -msoft-quad-float @gol
840 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
841 -mstack-bias  -mno-stack-bias @gol
842 -munaligned-doubles  -mno-unaligned-doubles @gol
843 -mv8plus  -mno-v8plus  -mvis  -mno-vis
844 -threads -pthreads -pthread}
846 @emph{SPU Options}
847 @gccoptlist{-mwarn-reloc -merror-reloc @gol
848 -msafe-dma -munsafe-dma @gol
849 -mbranch-hints @gol
850 -msmall-mem -mlarge-mem -mstdmain @gol
851 -mfixed-range=@var{register-range} @gol
852 -mea32 -mea64 @gol
853 -maddress-space-conversion -mno-address-space-conversion @gol
854 -mcache-size=@var{cache-size} @gol
855 -matomic-updates -mno-atomic-updates}
857 @emph{System V Options}
858 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
860 @emph{V850 Options}
861 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
862 -mprolog-function  -mno-prolog-function  -mspace @gol
863 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
864 -mapp-regs  -mno-app-regs @gol
865 -mdisable-callt  -mno-disable-callt @gol
866 -mv850e1 @gol
867 -mv850e @gol
868 -mv850  -mbig-switch}
870 @emph{VAX Options}
871 @gccoptlist{-mg  -mgnu  -munix}
873 @emph{VxWorks Options}
874 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
875 -Xbind-lazy  -Xbind-now}
877 @emph{x86-64 Options}
878 See i386 and x86-64 Options.
880 @emph{i386 and x86-64 Windows Options}
881 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
882 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows
883 -fno-set-stack-executable}
885 @emph{Xstormy16 Options}
886 @gccoptlist{-msim}
888 @emph{Xtensa Options}
889 @gccoptlist{-mconst16 -mno-const16 @gol
890 -mfused-madd  -mno-fused-madd @gol
891 -mserialize-volatile  -mno-serialize-volatile @gol
892 -mtext-section-literals  -mno-text-section-literals @gol
893 -mtarget-align  -mno-target-align @gol
894 -mlongcalls  -mno-longcalls}
896 @emph{zSeries Options}
897 See S/390 and zSeries Options.
899 @item Code Generation Options
900 @xref{Code Gen Options,,Options for Code Generation Conventions}.
901 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
902 -ffixed-@var{reg}  -fexceptions @gol
903 -fnon-call-exceptions  -funwind-tables @gol
904 -fasynchronous-unwind-tables @gol
905 -finhibit-size-directive  -finstrument-functions @gol
906 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
907 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
908 -fno-common  -fno-ident @gol
909 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
910 -fno-jump-tables @gol
911 -frecord-gcc-switches @gol
912 -freg-struct-return  -fshort-enums @gol
913 -fshort-double  -fshort-wchar @gol
914 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
915 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
916 -fno-stack-limit @gol
917 -fleading-underscore  -ftls-model=@var{model} @gol
918 -ftrapv  -fwrapv  -fbounds-check @gol
919 -fvisibility}
920 @end table
922 @menu
923 * Overall Options::     Controlling the kind of output:
924                         an executable, object files, assembler files,
925                         or preprocessed source.
926 * C Dialect Options::   Controlling the variant of C language compiled.
927 * C++ Dialect Options:: Variations on C++.
928 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
929                         and Objective-C++.
930 * Language Independent Options:: Controlling how diagnostics should be
931                         formatted.
932 * Warning Options::     How picky should the compiler be?
933 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
934 * Optimize Options::    How much optimization?
935 * Preprocessor Options:: Controlling header files and macro definitions.
936                          Also, getting dependency information for Make.
937 * Assembler Options::   Passing options to the assembler.
938 * Link Options::        Specifying libraries and so on.
939 * Directory Options::   Where to find header files and libraries.
940                         Where to find the compiler executable files.
941 * Spec Files::          How to pass switches to sub-processes.
942 * Target Options::      Running a cross-compiler, or an old version of GCC.
943 @end menu
945 @node Overall Options
946 @section Options Controlling the Kind of Output
948 Compilation can involve up to four stages: preprocessing, compilation
949 proper, assembly and linking, always in that order.  GCC is capable of
950 preprocessing and compiling several files either into several
951 assembler input files, or into one assembler input file; then each
952 assembler input file produces an object file, and linking combines all
953 the object files (those newly compiled, and those specified as input)
954 into an executable file.
956 @cindex file name suffix
957 For any given input file, the file name suffix determines what kind of
958 compilation is done:
960 @table @gcctabopt
961 @item @var{file}.c
962 C source code which must be preprocessed.
964 @item @var{file}.i
965 C source code which should not be preprocessed.
967 @item @var{file}.ii
968 C++ source code which should not be preprocessed.
970 @item @var{file}.m
971 Objective-C source code.  Note that you must link with the @file{libobjc}
972 library to make an Objective-C program work.
974 @item @var{file}.mi
975 Objective-C source code which should not be preprocessed.
977 @item @var{file}.mm
978 @itemx @var{file}.M
979 Objective-C++ source code.  Note that you must link with the @file{libobjc}
980 library to make an Objective-C++ program work.  Note that @samp{.M} refers
981 to a literal capital M@.
983 @item @var{file}.mii
984 Objective-C++ source code which should not be preprocessed.
986 @item @var{file}.h
987 C, C++, Objective-C or Objective-C++ header file to be turned into a
988 precompiled header.
990 @item @var{file}.cc
991 @itemx @var{file}.cp
992 @itemx @var{file}.cxx
993 @itemx @var{file}.cpp
994 @itemx @var{file}.CPP
995 @itemx @var{file}.c++
996 @itemx @var{file}.C
997 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
998 the last two letters must both be literally @samp{x}.  Likewise,
999 @samp{.C} refers to a literal capital C@.
1001 @item @var{file}.mm
1002 @itemx @var{file}.M
1003 Objective-C++ source code which must be preprocessed.
1005 @item @var{file}.mii
1006 Objective-C++ source code which should not be preprocessed.
1008 @item @var{file}.hh
1009 @itemx @var{file}.H
1010 @itemx @var{file}.hp
1011 @itemx @var{file}.hxx
1012 @itemx @var{file}.hpp
1013 @itemx @var{file}.HPP
1014 @itemx @var{file}.h++
1015 @itemx @var{file}.tcc
1016 C++ header file to be turned into a precompiled header.
1018 @item @var{file}.f
1019 @itemx @var{file}.for
1020 @itemx @var{file}.ftn
1021 Fixed form Fortran source code which should not be preprocessed.
1023 @item @var{file}.F
1024 @itemx @var{file}.FOR
1025 @itemx @var{file}.fpp
1026 @itemx @var{file}.FPP
1027 @itemx @var{file}.FTN
1028 Fixed form Fortran source code which must be preprocessed (with the traditional
1029 preprocessor).
1031 @item @var{file}.f90
1032 @itemx @var{file}.f95
1033 @itemx @var{file}.f03
1034 @itemx @var{file}.f08
1035 Free form Fortran source code which should not be preprocessed.
1037 @item @var{file}.F90
1038 @itemx @var{file}.F95
1039 @itemx @var{file}.F03
1040 @itemx @var{file}.F08
1041 Free form Fortran source code which must be preprocessed (with the
1042 traditional preprocessor).
1044 @c FIXME: Descriptions of Java file types.
1045 @c @var{file}.java
1046 @c @var{file}.class
1047 @c @var{file}.zip
1048 @c @var{file}.jar
1050 @item @var{file}.ads
1051 Ada source code file which contains a library unit declaration (a
1052 declaration of a package, subprogram, or generic, or a generic
1053 instantiation), or a library unit renaming declaration (a package,
1054 generic, or subprogram renaming declaration).  Such files are also
1055 called @dfn{specs}.
1057 @item @var{file}.adb
1058 Ada source code file containing a library unit body (a subprogram or
1059 package body).  Such files are also called @dfn{bodies}.
1061 @c GCC also knows about some suffixes for languages not yet included:
1062 @c Pascal:
1063 @c @var{file}.p
1064 @c @var{file}.pas
1065 @c Ratfor:
1066 @c @var{file}.r
1068 @item @var{file}.s
1069 Assembler code.
1071 @item @var{file}.S
1072 @itemx @var{file}.sx
1073 Assembler code which must be preprocessed.
1075 @item @var{other}
1076 An object file to be fed straight into linking.
1077 Any file name with no recognized suffix is treated this way.
1078 @end table
1080 @opindex x
1081 You can specify the input language explicitly with the @option{-x} option:
1083 @table @gcctabopt
1084 @item -x @var{language}
1085 Specify explicitly the @var{language} for the following input files
1086 (rather than letting the compiler choose a default based on the file
1087 name suffix).  This option applies to all following input files until
1088 the next @option{-x} option.  Possible values for @var{language} are:
1089 @smallexample
1090 c  c-header  c-cpp-output
1091 c++  c++-header  c++-cpp-output
1092 objective-c  objective-c-header  objective-c-cpp-output
1093 objective-c++ objective-c++-header objective-c++-cpp-output
1094 assembler  assembler-with-cpp
1096 f77  f77-cpp-input f95  f95-cpp-input
1097 java
1098 @end smallexample
1100 @item -x none
1101 Turn off any specification of a language, so that subsequent files are
1102 handled according to their file name suffixes (as they are if @option{-x}
1103 has not been used at all).
1105 @item -pass-exit-codes
1106 @opindex pass-exit-codes
1107 Normally the @command{gcc} program will exit with the code of 1 if any
1108 phase of the compiler returns a non-success return code.  If you specify
1109 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1110 numerically highest error produced by any phase that returned an error
1111 indication.  The C, C++, and Fortran frontends return 4, if an internal
1112 compiler error is encountered.
1113 @end table
1115 If you only want some of the stages of compilation, you can use
1116 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1117 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1118 @command{gcc} is to stop.  Note that some combinations (for example,
1119 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1121 @table @gcctabopt
1122 @item -c
1123 @opindex c
1124 Compile or assemble the source files, but do not link.  The linking
1125 stage simply is not done.  The ultimate output is in the form of an
1126 object file for each source file.
1128 By default, the object file name for a source file is made by replacing
1129 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1131 Unrecognized input files, not requiring compilation or assembly, are
1132 ignored.
1134 @item -S
1135 @opindex S
1136 Stop after the stage of compilation proper; do not assemble.  The output
1137 is in the form of an assembler code file for each non-assembler input
1138 file specified.
1140 By default, the assembler file name for a source file is made by
1141 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1143 Input files that don't require compilation are ignored.
1145 @item -E
1146 @opindex E
1147 Stop after the preprocessing stage; do not run the compiler proper.  The
1148 output is in the form of preprocessed source code, which is sent to the
1149 standard output.
1151 Input files which don't require preprocessing are ignored.
1153 @cindex output file option
1154 @item -o @var{file}
1155 @opindex o
1156 Place output in file @var{file}.  This applies regardless to whatever
1157 sort of output is being produced, whether it be an executable file,
1158 an object file, an assembler file or preprocessed C code.
1160 If @option{-o} is not specified, the default is to put an executable
1161 file in @file{a.out}, the object file for
1162 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1163 assembler file in @file{@var{source}.s}, a precompiled header file in
1164 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1165 standard output.
1167 @item -v
1168 @opindex v
1169 Print (on standard error output) the commands executed to run the stages
1170 of compilation.  Also print the version number of the compiler driver
1171 program and of the preprocessor and the compiler proper.
1173 @item -###
1174 @opindex ###
1175 Like @option{-v} except the commands are not executed and all command
1176 arguments are quoted.  This is useful for shell scripts to capture the
1177 driver-generated command lines.
1179 @item -pipe
1180 @opindex pipe
1181 Use pipes rather than temporary files for communication between the
1182 various stages of compilation.  This fails to work on some systems where
1183 the assembler is unable to read from a pipe; but the GNU assembler has
1184 no trouble.
1186 @item -combine
1187 @opindex combine
1188 If you are compiling multiple source files, this option tells the driver
1189 to pass all the source files to the compiler at once (for those
1190 languages for which the compiler can handle this).  This will allow
1191 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1192 language for which this is supported is C@.  If you pass source files for
1193 multiple languages to the driver, using this option, the driver will invoke
1194 the compiler(s) that support IMA once each, passing each compiler all the
1195 source files appropriate for it.  For those languages that do not support
1196 IMA this option will be ignored, and the compiler will be invoked once for
1197 each source file in that language.  If you use this option in conjunction
1198 with @option{-save-temps}, the compiler will generate multiple
1199 pre-processed files
1200 (one for each source file), but only one (combined) @file{.o} or
1201 @file{.s} file.
1203 @item --help
1204 @opindex help
1205 Print (on the standard output) a description of the command line options
1206 understood by @command{gcc}.  If the @option{-v} option is also specified
1207 then @option{--help} will also be passed on to the various processes
1208 invoked by @command{gcc}, so that they can display the command line options
1209 they accept.  If the @option{-Wextra} option has also been specified
1210 (prior to the @option{--help} option), then command line options which
1211 have no documentation associated with them will also be displayed.
1213 @item --target-help
1214 @opindex target-help
1215 Print (on the standard output) a description of target-specific command
1216 line options for each tool.  For some targets extra target-specific
1217 information may also be printed.
1219 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1220 Print (on the standard output) a description of the command line
1221 options understood by the compiler that fit into all specified classes
1222 and qualifiers.  These are the supported classes:
1224 @table @asis
1225 @item @samp{optimizers}
1226 This will display all of the optimization options supported by the
1227 compiler.
1229 @item @samp{warnings}
1230 This will display all of the options controlling warning messages
1231 produced by the compiler.
1233 @item @samp{target}
1234 This will display target-specific options.  Unlike the
1235 @option{--target-help} option however, target-specific options of the
1236 linker and assembler will not be displayed.  This is because those
1237 tools do not currently support the extended @option{--help=} syntax.
1239 @item @samp{params}
1240 This will display the values recognized by the @option{--param}
1241 option.
1243 @item @var{language}
1244 This will display the options supported for @var{language}, where
1245 @var{language} is the name of one of the languages supported in this
1246 version of GCC.
1248 @item @samp{common}
1249 This will display the options that are common to all languages.
1250 @end table
1252 These are the supported qualifiers:
1254 @table @asis
1255 @item @samp{undocumented}
1256 Display only those options which are undocumented.
1258 @item @samp{joined}
1259 Display options which take an argument that appears after an equal
1260 sign in the same continuous piece of text, such as:
1261 @samp{--help=target}.
1263 @item @samp{separate}
1264 Display options which take an argument that appears as a separate word
1265 following the original option, such as: @samp{-o output-file}.
1266 @end table
1268 Thus for example to display all the undocumented target-specific
1269 switches supported by the compiler the following can be used:
1271 @smallexample
1272 --help=target,undocumented
1273 @end smallexample
1275 The sense of a qualifier can be inverted by prefixing it with the
1276 @samp{^} character, so for example to display all binary warning
1277 options (i.e., ones that are either on or off and that do not take an
1278 argument), which have a description the following can be used:
1280 @smallexample
1281 --help=warnings,^joined,^undocumented
1282 @end smallexample
1284 The argument to @option{--help=} should not consist solely of inverted
1285 qualifiers.
1287 Combining several classes is possible, although this usually
1288 restricts the output by so much that there is nothing to display.  One
1289 case where it does work however is when one of the classes is
1290 @var{target}.  So for example to display all the target-specific
1291 optimization options the following can be used:
1293 @smallexample
1294 --help=target,optimizers
1295 @end smallexample
1297 The @option{--help=} option can be repeated on the command line.  Each
1298 successive use will display its requested class of options, skipping
1299 those that have already been displayed.
1301 If the @option{-Q} option appears on the command line before the
1302 @option{--help=} option, then the descriptive text displayed by
1303 @option{--help=} is changed.  Instead of describing the displayed
1304 options, an indication is given as to whether the option is enabled,
1305 disabled or set to a specific value (assuming that the compiler
1306 knows this at the point where the @option{--help=} option is used).
1308 Here is a truncated example from the ARM port of @command{gcc}:
1310 @smallexample
1311   % gcc -Q -mabi=2 --help=target -c
1312   The following options are target specific:
1313   -mabi=                                2
1314   -mabort-on-noreturn                   [disabled]
1315   -mapcs                                [disabled]
1316 @end smallexample
1318 The output is sensitive to the effects of previous command line
1319 options, so for example it is possible to find out which optimizations
1320 are enabled at @option{-O2} by using:
1322 @smallexample
1323 -Q -O2 --help=optimizers
1324 @end smallexample
1326 Alternatively you can discover which binary optimizations are enabled
1327 by @option{-O3} by using:
1329 @smallexample
1330 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1331 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1332 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1333 @end smallexample
1335 @item -no-canonical-prefixes
1336 @opindex no-canonical-prefixes
1337 Do not expand any symbolic links, resolve references to @samp{/../}
1338 or @samp{/./}, or make the path absolute when generating a relative
1339 prefix.
1341 @item --version
1342 @opindex version
1343 Display the version number and copyrights of the invoked GCC@.
1345 @item -wrapper
1346 @opindex wrapper
1347 Invoke all subcommands under a wrapper program. It takes a single
1348 comma separated list as an argument, which will be used to invoke
1349 the wrapper:
1351 @smallexample
1352 gcc -c t.c -wrapper gdb,--args
1353 @end smallexample
1355 This will invoke all subprograms of gcc under "gdb --args",
1356 thus cc1 invocation will be "gdb --args cc1 ...".
1358 @item -fplugin=@var{name}.so
1359 Load the plugin code in file @var{name}.so, assumed to be a
1360 shared object to be dlopen'd by the compiler.  The base name of
1361 the shared object file is used to identify the plugin for the
1362 purposes of argument parsing (See
1363 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1364 Each plugin should define the callback functions specified in the
1365 Plugins API.
1367 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1368 Define an argument called @var{key} with a value of @var{value}
1369 for the plugin called @var{name}.
1371 @include @value{srcdir}/../libiberty/at-file.texi
1372 @end table
1374 @node Invoking G++
1375 @section Compiling C++ Programs
1377 @cindex suffixes for C++ source
1378 @cindex C++ source file suffixes
1379 C++ source files conventionally use one of the suffixes @samp{.C},
1380 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1381 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1382 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1383 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1384 files with these names and compiles them as C++ programs even if you
1385 call the compiler the same way as for compiling C programs (usually
1386 with the name @command{gcc}).
1388 @findex g++
1389 @findex c++
1390 However, the use of @command{gcc} does not add the C++ library.
1391 @command{g++} is a program that calls GCC and treats @samp{.c},
1392 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1393 files unless @option{-x} is used, and automatically specifies linking
1394 against the C++ library.  This program is also useful when
1395 precompiling a C header file with a @samp{.h} extension for use in C++
1396 compilations.  On many systems, @command{g++} is also installed with
1397 the name @command{c++}.
1399 @cindex invoking @command{g++}
1400 When you compile C++ programs, you may specify many of the same
1401 command-line options that you use for compiling programs in any
1402 language; or command-line options meaningful for C and related
1403 languages; or options that are meaningful only for C++ programs.
1404 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1405 explanations of options for languages related to C@.
1406 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1407 explanations of options that are meaningful only for C++ programs.
1409 @node C Dialect Options
1410 @section Options Controlling C Dialect
1411 @cindex dialect options
1412 @cindex language dialect options
1413 @cindex options, dialect
1415 The following options control the dialect of C (or languages derived
1416 from C, such as C++, Objective-C and Objective-C++) that the compiler
1417 accepts:
1419 @table @gcctabopt
1420 @cindex ANSI support
1421 @cindex ISO support
1422 @item -ansi
1423 @opindex ansi
1424 In C mode, this is equivalent to @samp{-std=c90}. In C++ mode, it is
1425 equivalent to @samp{-std=c++98}.
1427 This turns off certain features of GCC that are incompatible with ISO
1428 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1429 such as the @code{asm} and @code{typeof} keywords, and
1430 predefined macros such as @code{unix} and @code{vax} that identify the
1431 type of system you are using.  It also enables the undesirable and
1432 rarely used ISO trigraph feature.  For the C compiler,
1433 it disables recognition of C++ style @samp{//} comments as well as
1434 the @code{inline} keyword.
1436 The alternate keywords @code{__asm__}, @code{__extension__},
1437 @code{__inline__} and @code{__typeof__} continue to work despite
1438 @option{-ansi}.  You would not want to use them in an ISO C program, of
1439 course, but it is useful to put them in header files that might be included
1440 in compilations done with @option{-ansi}.  Alternate predefined macros
1441 such as @code{__unix__} and @code{__vax__} are also available, with or
1442 without @option{-ansi}.
1444 The @option{-ansi} option does not cause non-ISO programs to be
1445 rejected gratuitously.  For that, @option{-pedantic} is required in
1446 addition to @option{-ansi}.  @xref{Warning Options}.
1448 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1449 option is used.  Some header files may notice this macro and refrain
1450 from declaring certain functions or defining certain macros that the
1451 ISO standard doesn't call for; this is to avoid interfering with any
1452 programs that might use these names for other things.
1454 Functions that would normally be built in but do not have semantics
1455 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1456 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1457 built-in functions provided by GCC}, for details of the functions
1458 affected.
1460 @item -std=
1461 @opindex std
1462 Determine the language standard. @xref{Standards,,Language Standards
1463 Supported by GCC}, for details of these standard versions.  This option
1464 is currently only supported when compiling C or C++.
1466 The compiler can accept several base standards, such as @samp{c90} or
1467 @samp{c++98}, and GNU dialects of those standards, such as
1468 @samp{gnu90} or @samp{gnu++98}.  By specifying a base standard, the
1469 compiler will accept all programs following that standard and those
1470 using GNU extensions that do not contradict it.  For example,
1471 @samp{-std=c90} turns off certain features of GCC that are
1472 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1473 keywords, but not other GNU extensions that do not have a meaning in
1474 ISO C90, such as omitting the middle term of a @code{?:}
1475 expression. On the other hand, by specifying a GNU dialect of a
1476 standard, all features the compiler support are enabled, even when
1477 those features change the meaning of the base standard and some
1478 strict-conforming programs may be rejected.  The particular standard
1479 is used by @option{-pedantic} to identify which features are GNU
1480 extensions given that version of the standard. For example
1481 @samp{-std=gnu90 -pedantic} would warn about C++ style @samp{//}
1482 comments, while @samp{-std=gnu99 -pedantic} would not.
1484 A value for this option must be provided; possible values are
1486 @table @samp
1487 @item c90
1488 @itemx c89
1489 @itemx iso9899:1990
1490 Support all ISO C90 programs (certain GNU extensions that conflict
1491 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1493 @item iso9899:199409
1494 ISO C90 as modified in amendment 1.
1496 @item c99
1497 @itemx c9x
1498 @itemx iso9899:1999
1499 @itemx iso9899:199x
1500 ISO C99.  Note that this standard is not yet fully supported; see
1501 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1502 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1504 @item c1x
1505 ISO C1X, the draft of the next revision of the ISO C standard.
1506 Support is limited and experimental and features enabled by this
1507 option may be changed or removed if changed in or removed from the
1508 standard draft.
1510 @item gnu90
1511 @itemx gnu89
1512 GNU dialect of ISO C90 (including some C99 features). This
1513 is the default for C code.
1515 @item gnu99
1516 @itemx gnu9x
1517 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1518 this will become the default.  The name @samp{gnu9x} is deprecated.
1520 @item gnu1x
1521 GNU dialect of ISO C1X.  Support is limited and experimental and
1522 features enabled by this option may be changed or removed if changed
1523 in or removed from the standard draft.
1525 @item c++98
1526 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1527 C++ code.
1529 @item gnu++98
1530 GNU dialect of @option{-std=c++98}.  This is the default for
1531 C++ code.
1533 @item c++0x
1534 The working draft of the upcoming ISO C++0x standard. This option
1535 enables experimental features that are likely to be included in
1536 C++0x. The working draft is constantly changing, and any feature that is
1537 enabled by this flag may be removed from future versions of GCC if it is
1538 not part of the C++0x standard.
1540 @item gnu++0x
1541 GNU dialect of @option{-std=c++0x}. This option enables
1542 experimental features that may be removed in future versions of GCC.
1543 @end table
1545 @item -fgnu89-inline
1546 @opindex fgnu89-inline
1547 The option @option{-fgnu89-inline} tells GCC to use the traditional
1548 GNU semantics for @code{inline} functions when in C99 mode.
1549 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1550 is accepted and ignored by GCC versions 4.1.3 up to but not including
1551 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1552 C99 mode.  Using this option is roughly equivalent to adding the
1553 @code{gnu_inline} function attribute to all inline functions
1554 (@pxref{Function Attributes}).
1556 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1557 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1558 specifies the default behavior).  This option was first supported in
1559 GCC 4.3.  This option is not supported in @option{-std=c90} or
1560 @option{-std=gnu90} mode.
1562 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1563 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1564 in effect for @code{inline} functions.  @xref{Common Predefined
1565 Macros,,,cpp,The C Preprocessor}.
1567 @item -aux-info @var{filename}
1568 @opindex aux-info
1569 Output to the given filename prototyped declarations for all functions
1570 declared and/or defined in a translation unit, including those in header
1571 files.  This option is silently ignored in any language other than C@.
1573 Besides declarations, the file indicates, in comments, the origin of
1574 each declaration (source file and line), whether the declaration was
1575 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1576 @samp{O} for old, respectively, in the first character after the line
1577 number and the colon), and whether it came from a declaration or a
1578 definition (@samp{C} or @samp{F}, respectively, in the following
1579 character).  In the case of function definitions, a K&R-style list of
1580 arguments followed by their declarations is also provided, inside
1581 comments, after the declaration.
1583 @item -fno-asm
1584 @opindex fno-asm
1585 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1586 keyword, so that code can use these words as identifiers.  You can use
1587 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1588 instead.  @option{-ansi} implies @option{-fno-asm}.
1590 In C++, this switch only affects the @code{typeof} keyword, since
1591 @code{asm} and @code{inline} are standard keywords.  You may want to
1592 use the @option{-fno-gnu-keywords} flag instead, which has the same
1593 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1594 switch only affects the @code{asm} and @code{typeof} keywords, since
1595 @code{inline} is a standard keyword in ISO C99.
1597 @item -fno-builtin
1598 @itemx -fno-builtin-@var{function}
1599 @opindex fno-builtin
1600 @cindex built-in functions
1601 Don't recognize built-in functions that do not begin with
1602 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1603 functions provided by GCC}, for details of the functions affected,
1604 including those which are not built-in functions when @option{-ansi} or
1605 @option{-std} options for strict ISO C conformance are used because they
1606 do not have an ISO standard meaning.
1608 GCC normally generates special code to handle certain built-in functions
1609 more efficiently; for instance, calls to @code{alloca} may become single
1610 instructions that adjust the stack directly, and calls to @code{memcpy}
1611 may become inline copy loops.  The resulting code is often both smaller
1612 and faster, but since the function calls no longer appear as such, you
1613 cannot set a breakpoint on those calls, nor can you change the behavior
1614 of the functions by linking with a different library.  In addition,
1615 when a function is recognized as a built-in function, GCC may use
1616 information about that function to warn about problems with calls to
1617 that function, or to generate more efficient code, even if the
1618 resulting code still contains calls to that function.  For example,
1619 warnings are given with @option{-Wformat} for bad calls to
1620 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1621 known not to modify global memory.
1623 With the @option{-fno-builtin-@var{function}} option
1624 only the built-in function @var{function} is
1625 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1626 function is named that is not built-in in this version of GCC, this
1627 option is ignored.  There is no corresponding
1628 @option{-fbuiltin-@var{function}} option; if you wish to enable
1629 built-in functions selectively when using @option{-fno-builtin} or
1630 @option{-ffreestanding}, you may define macros such as:
1632 @smallexample
1633 #define abs(n)          __builtin_abs ((n))
1634 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1635 @end smallexample
1637 @item -fhosted
1638 @opindex fhosted
1639 @cindex hosted environment
1641 Assert that compilation takes place in a hosted environment.  This implies
1642 @option{-fbuiltin}.  A hosted environment is one in which the
1643 entire standard library is available, and in which @code{main} has a return
1644 type of @code{int}.  Examples are nearly everything except a kernel.
1645 This is equivalent to @option{-fno-freestanding}.
1647 @item -ffreestanding
1648 @opindex ffreestanding
1649 @cindex hosted environment
1651 Assert that compilation takes place in a freestanding environment.  This
1652 implies @option{-fno-builtin}.  A freestanding environment
1653 is one in which the standard library may not exist, and program startup may
1654 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1655 This is equivalent to @option{-fno-hosted}.
1657 @xref{Standards,,Language Standards Supported by GCC}, for details of
1658 freestanding and hosted environments.
1660 @item -fopenmp
1661 @opindex fopenmp
1662 @cindex openmp parallel
1663 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1664 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1665 compiler generates parallel code according to the OpenMP Application
1666 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1667 implies @option{-pthread}, and thus is only supported on targets that
1668 have support for @option{-pthread}.
1670 @item -fms-extensions
1671 @opindex fms-extensions
1672 Accept some non-standard constructs used in Microsoft header files.
1674 Some cases of unnamed fields in structures and unions are only
1675 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1676 fields within structs/unions}, for details.
1678 @item -trigraphs
1679 @opindex trigraphs
1680 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1681 options for strict ISO C conformance) implies @option{-trigraphs}.
1683 @item -no-integrated-cpp
1684 @opindex no-integrated-cpp
1685 Performs a compilation in two passes: preprocessing and compiling.  This
1686 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1687 @option{-B} option.  The user supplied compilation step can then add in
1688 an additional preprocessing step after normal preprocessing but before
1689 compiling.  The default is to use the integrated cpp (internal cpp)
1691 The semantics of this option will change if "cc1", "cc1plus", and
1692 "cc1obj" are merged.
1694 @cindex traditional C language
1695 @cindex C language, traditional
1696 @item -traditional
1697 @itemx -traditional-cpp
1698 @opindex traditional-cpp
1699 @opindex traditional
1700 Formerly, these options caused GCC to attempt to emulate a pre-standard
1701 C compiler.  They are now only supported with the @option{-E} switch.
1702 The preprocessor continues to support a pre-standard mode.  See the GNU
1703 CPP manual for details.
1705 @item -fcond-mismatch
1706 @opindex fcond-mismatch
1707 Allow conditional expressions with mismatched types in the second and
1708 third arguments.  The value of such an expression is void.  This option
1709 is not supported for C++.
1711 @item -flax-vector-conversions
1712 @opindex flax-vector-conversions
1713 Allow implicit conversions between vectors with differing numbers of
1714 elements and/or incompatible element types.  This option should not be
1715 used for new code.
1717 @item -funsigned-char
1718 @opindex funsigned-char
1719 Let the type @code{char} be unsigned, like @code{unsigned char}.
1721 Each kind of machine has a default for what @code{char} should
1722 be.  It is either like @code{unsigned char} by default or like
1723 @code{signed char} by default.
1725 Ideally, a portable program should always use @code{signed char} or
1726 @code{unsigned char} when it depends on the signedness of an object.
1727 But many programs have been written to use plain @code{char} and
1728 expect it to be signed, or expect it to be unsigned, depending on the
1729 machines they were written for.  This option, and its inverse, let you
1730 make such a program work with the opposite default.
1732 The type @code{char} is always a distinct type from each of
1733 @code{signed char} or @code{unsigned char}, even though its behavior
1734 is always just like one of those two.
1736 @item -fsigned-char
1737 @opindex fsigned-char
1738 Let the type @code{char} be signed, like @code{signed char}.
1740 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1741 the negative form of @option{-funsigned-char}.  Likewise, the option
1742 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1744 @item -fsigned-bitfields
1745 @itemx -funsigned-bitfields
1746 @itemx -fno-signed-bitfields
1747 @itemx -fno-unsigned-bitfields
1748 @opindex fsigned-bitfields
1749 @opindex funsigned-bitfields
1750 @opindex fno-signed-bitfields
1751 @opindex fno-unsigned-bitfields
1752 These options control whether a bit-field is signed or unsigned, when the
1753 declaration does not use either @code{signed} or @code{unsigned}.  By
1754 default, such a bit-field is signed, because this is consistent: the
1755 basic integer types such as @code{int} are signed types.
1756 @end table
1758 @node C++ Dialect Options
1759 @section Options Controlling C++ Dialect
1761 @cindex compiler options, C++
1762 @cindex C++ options, command line
1763 @cindex options, C++
1764 This section describes the command-line options that are only meaningful
1765 for C++ programs; but you can also use most of the GNU compiler options
1766 regardless of what language your program is in.  For example, you
1767 might compile a file @code{firstClass.C} like this:
1769 @smallexample
1770 g++ -g -frepo -O -c firstClass.C
1771 @end smallexample
1773 @noindent
1774 In this example, only @option{-frepo} is an option meant
1775 only for C++ programs; you can use the other options with any
1776 language supported by GCC@.
1778 Here is a list of options that are @emph{only} for compiling C++ programs:
1780 @table @gcctabopt
1782 @item -fabi-version=@var{n}
1783 @opindex fabi-version
1784 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1785 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1786 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1787 the version that conforms most closely to the C++ ABI specification.
1788 Therefore, the ABI obtained using version 0 will change as ABI bugs
1789 are fixed.
1791 The default is version 2.
1793 Version 3 corrects an error in mangling a constant address as a
1794 template argument.
1796 Version 4 implements a standard mangling for vector types.
1798 See also @option{-Wabi}.
1800 @item -fno-access-control
1801 @opindex fno-access-control
1802 Turn off all access checking.  This switch is mainly useful for working
1803 around bugs in the access control code.
1805 @item -fcheck-new
1806 @opindex fcheck-new
1807 Check that the pointer returned by @code{operator new} is non-null
1808 before attempting to modify the storage allocated.  This check is
1809 normally unnecessary because the C++ standard specifies that
1810 @code{operator new} will only return @code{0} if it is declared
1811 @samp{throw()}, in which case the compiler will always check the
1812 return value even without this option.  In all other cases, when
1813 @code{operator new} has a non-empty exception specification, memory
1814 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1815 @samp{new (nothrow)}.
1817 @item -fconserve-space
1818 @opindex fconserve-space
1819 Put uninitialized or runtime-initialized global variables into the
1820 common segment, as C does.  This saves space in the executable at the
1821 cost of not diagnosing duplicate definitions.  If you compile with this
1822 flag and your program mysteriously crashes after @code{main()} has
1823 completed, you may have an object that is being destroyed twice because
1824 two definitions were merged.
1826 This option is no longer useful on most targets, now that support has
1827 been added for putting variables into BSS without making them common.
1829 @item -fno-deduce-init-list
1830 @opindex fno-deduce-init-list
1831 Disable deduction of a template type parameter as
1832 std::initializer_list from a brace-enclosed initializer list, i.e.
1834 @smallexample
1835 template <class T> auto forward(T t) -> decltype (realfn (t))
1837   return realfn (t);
1840 void f()
1842   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1844 @end smallexample
1846 This option is present because this deduction is an extension to the
1847 current specification in the C++0x working draft, and there was
1848 some concern about potential overload resolution problems.
1850 @item -ffriend-injection
1851 @opindex ffriend-injection
1852 Inject friend functions into the enclosing namespace, so that they are
1853 visible outside the scope of the class in which they are declared.
1854 Friend functions were documented to work this way in the old Annotated
1855 C++ Reference Manual, and versions of G++ before 4.1 always worked
1856 that way.  However, in ISO C++ a friend function which is not declared
1857 in an enclosing scope can only be found using argument dependent
1858 lookup.  This option causes friends to be injected as they were in
1859 earlier releases.
1861 This option is for compatibility, and may be removed in a future
1862 release of G++.
1864 @item -fno-elide-constructors
1865 @opindex fno-elide-constructors
1866 The C++ standard allows an implementation to omit creating a temporary
1867 which is only used to initialize another object of the same type.
1868 Specifying this option disables that optimization, and forces G++ to
1869 call the copy constructor in all cases.
1871 @item -fno-enforce-eh-specs
1872 @opindex fno-enforce-eh-specs
1873 Don't generate code to check for violation of exception specifications
1874 at runtime.  This option violates the C++ standard, but may be useful
1875 for reducing code size in production builds, much like defining
1876 @samp{NDEBUG}.  This does not give user code permission to throw
1877 exceptions in violation of the exception specifications; the compiler
1878 will still optimize based on the specifications, so throwing an
1879 unexpected exception will result in undefined behavior.
1881 @item -ffor-scope
1882 @itemx -fno-for-scope
1883 @opindex ffor-scope
1884 @opindex fno-for-scope
1885 If @option{-ffor-scope} is specified, the scope of variables declared in
1886 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1887 as specified by the C++ standard.
1888 If @option{-fno-for-scope} is specified, the scope of variables declared in
1889 a @i{for-init-statement} extends to the end of the enclosing scope,
1890 as was the case in old versions of G++, and other (traditional)
1891 implementations of C++.
1893 The default if neither flag is given to follow the standard,
1894 but to allow and give a warning for old-style code that would
1895 otherwise be invalid, or have different behavior.
1897 @item -fno-gnu-keywords
1898 @opindex fno-gnu-keywords
1899 Do not recognize @code{typeof} as a keyword, so that code can use this
1900 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1901 @option{-ansi} implies @option{-fno-gnu-keywords}.
1903 @item -fno-implicit-templates
1904 @opindex fno-implicit-templates
1905 Never emit code for non-inline templates which are instantiated
1906 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1907 @xref{Template Instantiation}, for more information.
1909 @item -fno-implicit-inline-templates
1910 @opindex fno-implicit-inline-templates
1911 Don't emit code for implicit instantiations of inline templates, either.
1912 The default is to handle inlines differently so that compiles with and
1913 without optimization will need the same set of explicit instantiations.
1915 @item -fno-implement-inlines
1916 @opindex fno-implement-inlines
1917 To save space, do not emit out-of-line copies of inline functions
1918 controlled by @samp{#pragma implementation}.  This will cause linker
1919 errors if these functions are not inlined everywhere they are called.
1921 @item -fms-extensions
1922 @opindex fms-extensions
1923 Disable pedantic warnings about constructs used in MFC, such as implicit
1924 int and getting a pointer to member function via non-standard syntax.
1926 @item -fno-nonansi-builtins
1927 @opindex fno-nonansi-builtins
1928 Disable built-in declarations of functions that are not mandated by
1929 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1930 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1932 @item -fno-operator-names
1933 @opindex fno-operator-names
1934 Do not treat the operator name keywords @code{and}, @code{bitand},
1935 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1936 synonyms as keywords.
1938 @item -fno-optional-diags
1939 @opindex fno-optional-diags
1940 Disable diagnostics that the standard says a compiler does not need to
1941 issue.  Currently, the only such diagnostic issued by G++ is the one for
1942 a name having multiple meanings within a class.
1944 @item -fpermissive
1945 @opindex fpermissive
1946 Downgrade some diagnostics about nonconformant code from errors to
1947 warnings.  Thus, using @option{-fpermissive} will allow some
1948 nonconforming code to compile.
1950 @item -fno-pretty-templates
1951 @opindex fno-pretty-templates
1952 When an error message refers to a specialization of a function
1953 template, the compiler will normally print the signature of the
1954 template followed by the template arguments and any typedefs or
1955 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1956 rather than @code{void f(int)}) so that it's clear which template is
1957 involved.  When an error message refers to a specialization of a class
1958 template, the compiler will omit any template arguments which match
1959 the default template arguments for that template.  If either of these
1960 behaviors make it harder to understand the error message rather than
1961 easier, using @option{-fno-pretty-templates} will disable them.
1963 @item -frepo
1964 @opindex frepo
1965 Enable automatic template instantiation at link time.  This option also
1966 implies @option{-fno-implicit-templates}.  @xref{Template
1967 Instantiation}, for more information.
1969 @item -fno-rtti
1970 @opindex fno-rtti
1971 Disable generation of information about every class with virtual
1972 functions for use by the C++ runtime type identification features
1973 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1974 of the language, you can save some space by using this flag.  Note that
1975 exception handling uses the same information, but it will generate it as
1976 needed. The @samp{dynamic_cast} operator can still be used for casts that
1977 do not require runtime type information, i.e.@: casts to @code{void *} or to
1978 unambiguous base classes.
1980 @item -fstats
1981 @opindex fstats
1982 Emit statistics about front-end processing at the end of the compilation.
1983 This information is generally only useful to the G++ development team.
1985 @item -ftemplate-depth=@var{n}
1986 @opindex ftemplate-depth
1987 Set the maximum instantiation depth for template classes to @var{n}.
1988 A limit on the template instantiation depth is needed to detect
1989 endless recursions during template class instantiation.  ANSI/ISO C++
1990 conforming programs must not rely on a maximum depth greater than 17
1991 (changed to 1024 in C++0x).
1993 @item -fno-threadsafe-statics
1994 @opindex fno-threadsafe-statics
1995 Do not emit the extra code to use the routines specified in the C++
1996 ABI for thread-safe initialization of local statics.  You can use this
1997 option to reduce code size slightly in code that doesn't need to be
1998 thread-safe.
2000 @item -fuse-cxa-atexit
2001 @opindex fuse-cxa-atexit
2002 Register destructors for objects with static storage duration with the
2003 @code{__cxa_atexit} function rather than the @code{atexit} function.
2004 This option is required for fully standards-compliant handling of static
2005 destructors, but will only work if your C library supports
2006 @code{__cxa_atexit}.
2008 @item -fno-use-cxa-get-exception-ptr
2009 @opindex fno-use-cxa-get-exception-ptr
2010 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2011 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2012 if the runtime routine is not available.
2014 @item -fvisibility-inlines-hidden
2015 @opindex fvisibility-inlines-hidden
2016 This switch declares that the user does not attempt to compare
2017 pointers to inline methods where the addresses of the two functions
2018 were taken in different shared objects.
2020 The effect of this is that GCC may, effectively, mark inline methods with
2021 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2022 appear in the export table of a DSO and do not require a PLT indirection
2023 when used within the DSO@.  Enabling this option can have a dramatic effect
2024 on load and link times of a DSO as it massively reduces the size of the
2025 dynamic export table when the library makes heavy use of templates.
2027 The behavior of this switch is not quite the same as marking the
2028 methods as hidden directly, because it does not affect static variables
2029 local to the function or cause the compiler to deduce that
2030 the function is defined in only one shared object.
2032 You may mark a method as having a visibility explicitly to negate the
2033 effect of the switch for that method.  For example, if you do want to
2034 compare pointers to a particular inline method, you might mark it as
2035 having default visibility.  Marking the enclosing class with explicit
2036 visibility will have no effect.
2038 Explicitly instantiated inline methods are unaffected by this option
2039 as their linkage might otherwise cross a shared library boundary.
2040 @xref{Template Instantiation}.
2042 @item -fvisibility-ms-compat
2043 @opindex fvisibility-ms-compat
2044 This flag attempts to use visibility settings to make GCC's C++
2045 linkage model compatible with that of Microsoft Visual Studio.
2047 The flag makes these changes to GCC's linkage model:
2049 @enumerate
2050 @item
2051 It sets the default visibility to @code{hidden}, like
2052 @option{-fvisibility=hidden}.
2054 @item
2055 Types, but not their members, are not hidden by default.
2057 @item
2058 The One Definition Rule is relaxed for types without explicit
2059 visibility specifications which are defined in more than one different
2060 shared object: those declarations are permitted if they would have
2061 been permitted when this option was not used.
2062 @end enumerate
2064 In new code it is better to use @option{-fvisibility=hidden} and
2065 export those classes which are intended to be externally visible.
2066 Unfortunately it is possible for code to rely, perhaps accidentally,
2067 on the Visual Studio behavior.
2069 Among the consequences of these changes are that static data members
2070 of the same type with the same name but defined in different shared
2071 objects will be different, so changing one will not change the other;
2072 and that pointers to function members defined in different shared
2073 objects may not compare equal.  When this flag is given, it is a
2074 violation of the ODR to define types with the same name differently.
2076 @item -fno-weak
2077 @opindex fno-weak
2078 Do not use weak symbol support, even if it is provided by the linker.
2079 By default, G++ will use weak symbols if they are available.  This
2080 option exists only for testing, and should not be used by end-users;
2081 it will result in inferior code and has no benefits.  This option may
2082 be removed in a future release of G++.
2084 @item -nostdinc++
2085 @opindex nostdinc++
2086 Do not search for header files in the standard directories specific to
2087 C++, but do still search the other standard directories.  (This option
2088 is used when building the C++ library.)
2089 @end table
2091 In addition, these optimization, warning, and code generation options
2092 have meanings only for C++ programs:
2094 @table @gcctabopt
2095 @item -fno-default-inline
2096 @opindex fno-default-inline
2097 Do not assume @samp{inline} for functions defined inside a class scope.
2098 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2099 functions will have linkage like inline functions; they just won't be
2100 inlined by default.
2102 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2103 @opindex Wabi
2104 @opindex Wno-abi
2105 Warn when G++ generates code that is probably not compatible with the
2106 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2107 all such cases, there are probably some cases that are not warned about,
2108 even though G++ is generating incompatible code.  There may also be
2109 cases where warnings are emitted even though the code that is generated
2110 will be compatible.
2112 You should rewrite your code to avoid these warnings if you are
2113 concerned about the fact that code generated by G++ may not be binary
2114 compatible with code generated by other compilers.
2116 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2118 @itemize @bullet
2120 @item
2121 A template with a non-type template parameter of reference type is
2122 mangled incorrectly:
2123 @smallexample
2124 extern int N;
2125 template <int &> struct S @{@};
2126 void n (S<N>) @{2@}
2127 @end smallexample
2129 This is fixed in @option{-fabi-version=3}.
2131 @item
2132 SIMD vector types declared using @code{__attribute ((vector_size))} are
2133 mangled in a non-standard way that does not allow for overloading of
2134 functions taking vectors of different sizes.
2136 The mangling is changed in @option{-fabi-version=4}.
2137 @end itemize
2139 The known incompatibilities in @option{-fabi-version=1} include:
2141 @itemize @bullet
2143 @item
2144 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2145 pack data into the same byte as a base class.  For example:
2147 @smallexample
2148 struct A @{ virtual void f(); int f1 : 1; @};
2149 struct B : public A @{ int f2 : 1; @};
2150 @end smallexample
2152 @noindent
2153 In this case, G++ will place @code{B::f2} into the same byte
2154 as@code{A::f1}; other compilers will not.  You can avoid this problem
2155 by explicitly padding @code{A} so that its size is a multiple of the
2156 byte size on your platform; that will cause G++ and other compilers to
2157 layout @code{B} identically.
2159 @item
2160 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2161 tail padding when laying out virtual bases.  For example:
2163 @smallexample
2164 struct A @{ virtual void f(); char c1; @};
2165 struct B @{ B(); char c2; @};
2166 struct C : public A, public virtual B @{@};
2167 @end smallexample
2169 @noindent
2170 In this case, G++ will not place @code{B} into the tail-padding for
2171 @code{A}; other compilers will.  You can avoid this problem by
2172 explicitly padding @code{A} so that its size is a multiple of its
2173 alignment (ignoring virtual base classes); that will cause G++ and other
2174 compilers to layout @code{C} identically.
2176 @item
2177 Incorrect handling of bit-fields with declared widths greater than that
2178 of their underlying types, when the bit-fields appear in a union.  For
2179 example:
2181 @smallexample
2182 union U @{ int i : 4096; @};
2183 @end smallexample
2185 @noindent
2186 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2187 union too small by the number of bits in an @code{int}.
2189 @item
2190 Empty classes can be placed at incorrect offsets.  For example:
2192 @smallexample
2193 struct A @{@};
2195 struct B @{
2196   A a;
2197   virtual void f ();
2200 struct C : public B, public A @{@};
2201 @end smallexample
2203 @noindent
2204 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2205 it should be placed at offset zero.  G++ mistakenly believes that the
2206 @code{A} data member of @code{B} is already at offset zero.
2208 @item
2209 Names of template functions whose types involve @code{typename} or
2210 template template parameters can be mangled incorrectly.
2212 @smallexample
2213 template <typename Q>
2214 void f(typename Q::X) @{@}
2216 template <template <typename> class Q>
2217 void f(typename Q<int>::X) @{@}
2218 @end smallexample
2220 @noindent
2221 Instantiations of these templates may be mangled incorrectly.
2223 @end itemize
2225 It also warns psABI related changes.  The known psABI changes at this
2226 point include:
2228 @itemize @bullet
2230 @item
2231 For SYSV/x86-64, when passing union with long double, it is changed to
2232 pass in memory as specified in psABI.  For example:
2234 @smallexample
2235 union U @{
2236   long double ld;
2237   int i;
2239 @end smallexample
2241 @noindent
2242 @code{union U} will always be passed in memory.
2244 @end itemize
2246 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2247 @opindex Wctor-dtor-privacy
2248 @opindex Wno-ctor-dtor-privacy
2249 Warn when a class seems unusable because all the constructors or
2250 destructors in that class are private, and it has neither friends nor
2251 public static member functions.
2253 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2254 @opindex Wnon-virtual-dtor
2255 @opindex Wno-non-virtual-dtor
2256 Warn when a class has virtual functions and accessible non-virtual
2257 destructor, in which case it would be possible but unsafe to delete
2258 an instance of a derived class through a pointer to the base class.
2259 This warning is also enabled if -Weffc++ is specified.
2261 @item -Wreorder @r{(C++ and Objective-C++ only)}
2262 @opindex Wreorder
2263 @opindex Wno-reorder
2264 @cindex reordering, warning
2265 @cindex warning for reordering of member initializers
2266 Warn when the order of member initializers given in the code does not
2267 match the order in which they must be executed.  For instance:
2269 @smallexample
2270 struct A @{
2271   int i;
2272   int j;
2273   A(): j (0), i (1) @{ @}
2275 @end smallexample
2277 The compiler will rearrange the member initializers for @samp{i}
2278 and @samp{j} to match the declaration order of the members, emitting
2279 a warning to that effect.  This warning is enabled by @option{-Wall}.
2280 @end table
2282 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2284 @table @gcctabopt
2285 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2286 @opindex Weffc++
2287 @opindex Wno-effc++
2288 Warn about violations of the following style guidelines from Scott Meyers'
2289 @cite{Effective C++} book:
2291 @itemize @bullet
2292 @item
2293 Item 11:  Define a copy constructor and an assignment operator for classes
2294 with dynamically allocated memory.
2296 @item
2297 Item 12:  Prefer initialization to assignment in constructors.
2299 @item
2300 Item 14:  Make destructors virtual in base classes.
2302 @item
2303 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2305 @item
2306 Item 23:  Don't try to return a reference when you must return an object.
2308 @end itemize
2310 Also warn about violations of the following style guidelines from
2311 Scott Meyers' @cite{More Effective C++} book:
2313 @itemize @bullet
2314 @item
2315 Item 6:  Distinguish between prefix and postfix forms of increment and
2316 decrement operators.
2318 @item
2319 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2321 @end itemize
2323 When selecting this option, be aware that the standard library
2324 headers do not obey all of these guidelines; use @samp{grep -v}
2325 to filter out those warnings.
2327 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2328 @opindex Wstrict-null-sentinel
2329 @opindex Wno-strict-null-sentinel
2330 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2331 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2332 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2333 it is guaranteed to be of the same size as a pointer.  But this use is
2334 not portable across different compilers.
2336 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2337 @opindex Wno-non-template-friend
2338 @opindex Wnon-template-friend
2339 Disable warnings when non-templatized friend functions are declared
2340 within a template.  Since the advent of explicit template specification
2341 support in G++, if the name of the friend is an unqualified-id (i.e.,
2342 @samp{friend foo(int)}), the C++ language specification demands that the
2343 friend declare or define an ordinary, nontemplate function.  (Section
2344 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2345 could be interpreted as a particular specialization of a templatized
2346 function.  Because this non-conforming behavior is no longer the default
2347 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2348 check existing code for potential trouble spots and is on by default.
2349 This new compiler behavior can be turned off with
2350 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2351 but disables the helpful warning.
2353 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2354 @opindex Wold-style-cast
2355 @opindex Wno-old-style-cast
2356 Warn if an old-style (C-style) cast to a non-void type is used within
2357 a C++ program.  The new-style casts (@samp{dynamic_cast},
2358 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2359 less vulnerable to unintended effects and much easier to search for.
2361 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2362 @opindex Woverloaded-virtual
2363 @opindex Wno-overloaded-virtual
2364 @cindex overloaded virtual fn, warning
2365 @cindex warning for overloaded virtual fn
2366 Warn when a function declaration hides virtual functions from a
2367 base class.  For example, in:
2369 @smallexample
2370 struct A @{
2371   virtual void f();
2374 struct B: public A @{
2375   void f(int);
2377 @end smallexample
2379 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2380 like:
2382 @smallexample
2383 B* b;
2384 b->f();
2385 @end smallexample
2387 will fail to compile.
2389 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2390 @opindex Wno-pmf-conversions
2391 @opindex Wpmf-conversions
2392 Disable the diagnostic for converting a bound pointer to member function
2393 to a plain pointer.
2395 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2396 @opindex Wsign-promo
2397 @opindex Wno-sign-promo
2398 Warn when overload resolution chooses a promotion from unsigned or
2399 enumerated type to a signed type, over a conversion to an unsigned type of
2400 the same size.  Previous versions of G++ would try to preserve
2401 unsignedness, but the standard mandates the current behavior.
2403 @smallexample
2404 struct A @{
2405   operator int ();
2406   A& operator = (int);
2409 main ()
2411   A a,b;
2412   a = b;
2414 @end smallexample
2416 In this example, G++ will synthesize a default @samp{A& operator =
2417 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2418 @end table
2420 @node Objective-C and Objective-C++ Dialect Options
2421 @section Options Controlling Objective-C and Objective-C++ Dialects
2423 @cindex compiler options, Objective-C and Objective-C++
2424 @cindex Objective-C and Objective-C++ options, command line
2425 @cindex options, Objective-C and Objective-C++
2426 (NOTE: This manual does not describe the Objective-C and Objective-C++
2427 languages themselves.  See @xref{Standards,,Language Standards
2428 Supported by GCC}, for references.)
2430 This section describes the command-line options that are only meaningful
2431 for Objective-C and Objective-C++ programs, but you can also use most of
2432 the language-independent GNU compiler options.
2433 For example, you might compile a file @code{some_class.m} like this:
2435 @smallexample
2436 gcc -g -fgnu-runtime -O -c some_class.m
2437 @end smallexample
2439 @noindent
2440 In this example, @option{-fgnu-runtime} is an option meant only for
2441 Objective-C and Objective-C++ programs; you can use the other options with
2442 any language supported by GCC@.
2444 Note that since Objective-C is an extension of the C language, Objective-C
2445 compilations may also use options specific to the C front-end (e.g.,
2446 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2447 C++-specific options (e.g., @option{-Wabi}).
2449 Here is a list of options that are @emph{only} for compiling Objective-C
2450 and Objective-C++ programs:
2452 @table @gcctabopt
2453 @item -fconstant-string-class=@var{class-name}
2454 @opindex fconstant-string-class
2455 Use @var{class-name} as the name of the class to instantiate for each
2456 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2457 class name is @code{NXConstantString} if the GNU runtime is being used, and
2458 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2459 @option{-fconstant-cfstrings} option, if also present, will override the
2460 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2461 to be laid out as constant CoreFoundation strings.
2463 @item -fgnu-runtime
2464 @opindex fgnu-runtime
2465 Generate object code compatible with the standard GNU Objective-C
2466 runtime.  This is the default for most types of systems.
2468 @item -fnext-runtime
2469 @opindex fnext-runtime
2470 Generate output compatible with the NeXT runtime.  This is the default
2471 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2472 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2473 used.
2475 @item -fno-nil-receivers
2476 @opindex fno-nil-receivers
2477 Assume that all Objective-C message dispatches (e.g.,
2478 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2479 is not @code{nil}.  This allows for more efficient entry points in the runtime
2480 to be used.  Currently, this option is only available in conjunction with
2481 the NeXT runtime on Mac OS X 10.3 and later.
2483 @item -fobjc-call-cxx-cdtors
2484 @opindex fobjc-call-cxx-cdtors
2485 For each Objective-C class, check if any of its instance variables is a
2486 C++ object with a non-trivial default constructor.  If so, synthesize a
2487 special @code{- (id) .cxx_construct} instance method that will run
2488 non-trivial default constructors on any such instance variables, in order,
2489 and then return @code{self}.  Similarly, check if any instance variable
2490 is a C++ object with a non-trivial destructor, and if so, synthesize a
2491 special @code{- (void) .cxx_destruct} method that will run
2492 all such default destructors, in reverse order.
2494 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2495 thusly generated will only operate on instance variables declared in the
2496 current Objective-C class, and not those inherited from superclasses.  It
2497 is the responsibility of the Objective-C runtime to invoke all such methods
2498 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2499 will be invoked by the runtime immediately after a new object
2500 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2501 be invoked immediately before the runtime deallocates an object instance.
2503 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2504 support for invoking the @code{- (id) .cxx_construct} and
2505 @code{- (void) .cxx_destruct} methods.
2507 @item -fobjc-direct-dispatch
2508 @opindex fobjc-direct-dispatch
2509 Allow fast jumps to the message dispatcher.  On Darwin this is
2510 accomplished via the comm page.
2512 @item -fobjc-exceptions
2513 @opindex fobjc-exceptions
2514 Enable syntactic support for structured exception handling in Objective-C,
2515 similar to what is offered by C++ and Java.  This option is
2516 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2517 earlier.
2519 @smallexample
2520   @@try @{
2521     @dots{}
2522        @@throw expr;
2523     @dots{}
2524   @}
2525   @@catch (AnObjCClass *exc) @{
2526     @dots{}
2527       @@throw expr;
2528     @dots{}
2529       @@throw;
2530     @dots{}
2531   @}
2532   @@catch (AnotherClass *exc) @{
2533     @dots{}
2534   @}
2535   @@catch (id allOthers) @{
2536     @dots{}
2537   @}
2538   @@finally @{
2539     @dots{}
2540       @@throw expr;
2541     @dots{}
2542   @}
2543 @end smallexample
2545 The @code{@@throw} statement may appear anywhere in an Objective-C or
2546 Objective-C++ program; when used inside of a @code{@@catch} block, the
2547 @code{@@throw} may appear without an argument (as shown above), in which case
2548 the object caught by the @code{@@catch} will be rethrown.
2550 Note that only (pointers to) Objective-C objects may be thrown and
2551 caught using this scheme.  When an object is thrown, it will be caught
2552 by the nearest @code{@@catch} clause capable of handling objects of that type,
2553 analogously to how @code{catch} blocks work in C++ and Java.  A
2554 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2555 any and all Objective-C exceptions not caught by previous @code{@@catch}
2556 clauses (if any).
2558 The @code{@@finally} clause, if present, will be executed upon exit from the
2559 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2560 regardless of whether any exceptions are thrown, caught or rethrown
2561 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2562 of the @code{finally} clause in Java.
2564 There are several caveats to using the new exception mechanism:
2566 @itemize @bullet
2567 @item
2568 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2569 idioms provided by the @code{NSException} class, the new
2570 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2571 systems, due to additional functionality needed in the (NeXT) Objective-C
2572 runtime.
2574 @item
2575 As mentioned above, the new exceptions do not support handling
2576 types other than Objective-C objects.   Furthermore, when used from
2577 Objective-C++, the Objective-C exception model does not interoperate with C++
2578 exceptions at this time.  This means you cannot @code{@@throw} an exception
2579 from Objective-C and @code{catch} it in C++, or vice versa
2580 (i.e., @code{throw @dots{} @@catch}).
2581 @end itemize
2583 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2584 blocks for thread-safe execution:
2586 @smallexample
2587   @@synchronized (ObjCClass *guard) @{
2588     @dots{}
2589   @}
2590 @end smallexample
2592 Upon entering the @code{@@synchronized} block, a thread of execution shall
2593 first check whether a lock has been placed on the corresponding @code{guard}
2594 object by another thread.  If it has, the current thread shall wait until
2595 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2596 the current thread will place its own lock on it, execute the code contained in
2597 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2598 making @code{guard} available to other threads).
2600 Unlike Java, Objective-C does not allow for entire methods to be marked
2601 @code{@@synchronized}.  Note that throwing exceptions out of
2602 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2603 to be unlocked properly.
2605 @item -fobjc-gc
2606 @opindex fobjc-gc
2607 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2609 @item -freplace-objc-classes
2610 @opindex freplace-objc-classes
2611 Emit a special marker instructing @command{ld(1)} not to statically link in
2612 the resulting object file, and allow @command{dyld(1)} to load it in at
2613 run time instead.  This is used in conjunction with the Fix-and-Continue
2614 debugging mode, where the object file in question may be recompiled and
2615 dynamically reloaded in the course of program execution, without the need
2616 to restart the program itself.  Currently, Fix-and-Continue functionality
2617 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2618 and later.
2620 @item -fzero-link
2621 @opindex fzero-link
2622 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2623 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2624 compile time) with static class references that get initialized at load time,
2625 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2626 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2627 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2628 for individual class implementations to be modified during program execution.
2630 @item -gen-decls
2631 @opindex gen-decls
2632 Dump interface declarations for all classes seen in the source file to a
2633 file named @file{@var{sourcename}.decl}.
2635 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2636 @opindex Wassign-intercept
2637 @opindex Wno-assign-intercept
2638 Warn whenever an Objective-C assignment is being intercepted by the
2639 garbage collector.
2641 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2642 @opindex Wno-protocol
2643 @opindex Wprotocol
2644 If a class is declared to implement a protocol, a warning is issued for
2645 every method in the protocol that is not implemented by the class.  The
2646 default behavior is to issue a warning for every method not explicitly
2647 implemented in the class, even if a method implementation is inherited
2648 from the superclass.  If you use the @option{-Wno-protocol} option, then
2649 methods inherited from the superclass are considered to be implemented,
2650 and no warning is issued for them.
2652 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2653 @opindex Wselector
2654 @opindex Wno-selector
2655 Warn if multiple methods of different types for the same selector are
2656 found during compilation.  The check is performed on the list of methods
2657 in the final stage of compilation.  Additionally, a check is performed
2658 for each selector appearing in a @code{@@selector(@dots{})}
2659 expression, and a corresponding method for that selector has been found
2660 during compilation.  Because these checks scan the method table only at
2661 the end of compilation, these warnings are not produced if the final
2662 stage of compilation is not reached, for example because an error is
2663 found during compilation, or because the @option{-fsyntax-only} option is
2664 being used.
2666 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2667 @opindex Wstrict-selector-match
2668 @opindex Wno-strict-selector-match
2669 Warn if multiple methods with differing argument and/or return types are
2670 found for a given selector when attempting to send a message using this
2671 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2672 is off (which is the default behavior), the compiler will omit such warnings
2673 if any differences found are confined to types which share the same size
2674 and alignment.
2676 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2677 @opindex Wundeclared-selector
2678 @opindex Wno-undeclared-selector
2679 Warn if a @code{@@selector(@dots{})} expression referring to an
2680 undeclared selector is found.  A selector is considered undeclared if no
2681 method with that name has been declared before the
2682 @code{@@selector(@dots{})} expression, either explicitly in an
2683 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2684 an @code{@@implementation} section.  This option always performs its
2685 checks as soon as a @code{@@selector(@dots{})} expression is found,
2686 while @option{-Wselector} only performs its checks in the final stage of
2687 compilation.  This also enforces the coding style convention
2688 that methods and selectors must be declared before being used.
2690 @item -print-objc-runtime-info
2691 @opindex print-objc-runtime-info
2692 Generate C header describing the largest structure that is passed by
2693 value, if any.
2695 @end table
2697 @node Language Independent Options
2698 @section Options to Control Diagnostic Messages Formatting
2699 @cindex options to control diagnostics formatting
2700 @cindex diagnostic messages
2701 @cindex message formatting
2703 Traditionally, diagnostic messages have been formatted irrespective of
2704 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2705 below can be used to control the diagnostic messages formatting
2706 algorithm, e.g.@: how many characters per line, how often source location
2707 information should be reported.  Right now, only the C++ front end can
2708 honor these options.  However it is expected, in the near future, that
2709 the remaining front ends would be able to digest them correctly.
2711 @table @gcctabopt
2712 @item -fmessage-length=@var{n}
2713 @opindex fmessage-length
2714 Try to format error messages so that they fit on lines of about @var{n}
2715 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2716 the front ends supported by GCC@.  If @var{n} is zero, then no
2717 line-wrapping will be done; each error message will appear on a single
2718 line.
2720 @opindex fdiagnostics-show-location
2721 @item -fdiagnostics-show-location=once
2722 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2723 reporter to emit @emph{once} source location information; that is, in
2724 case the message is too long to fit on a single physical line and has to
2725 be wrapped, the source location won't be emitted (as prefix) again,
2726 over and over, in subsequent continuation lines.  This is the default
2727 behavior.
2729 @item -fdiagnostics-show-location=every-line
2730 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2731 messages reporter to emit the same source location information (as
2732 prefix) for physical lines that result from the process of breaking
2733 a message which is too long to fit on a single line.
2735 @item -fdiagnostics-show-option
2736 @opindex fdiagnostics-show-option
2737 This option instructs the diagnostic machinery to add text to each
2738 diagnostic emitted, which indicates which command line option directly
2739 controls that diagnostic, when such an option is known to the
2740 diagnostic machinery.
2742 @item -Wcoverage-mismatch
2743 @opindex Wcoverage-mismatch
2744 Warn if feedback profiles do not match when using the
2745 @option{-fprofile-use} option.
2746 If a source file was changed between @option{-fprofile-gen} and
2747 @option{-fprofile-use}, the files with the profile feedback can fail
2748 to match the source file and GCC can not use the profile feedback
2749 information.  By default, GCC emits an error message in this case.
2750 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2751 error.  GCC does not use appropriate feedback profiles, so using this
2752 option can result in poorly optimized code.  This option is useful
2753 only in the case of very minor changes such as bug fixes to an
2754 existing code-base.
2756 @end table
2758 @node Warning Options
2759 @section Options to Request or Suppress Warnings
2760 @cindex options to control warnings
2761 @cindex warning messages
2762 @cindex messages, warning
2763 @cindex suppressing warnings
2765 Warnings are diagnostic messages that report constructions which
2766 are not inherently erroneous but which are risky or suggest there
2767 may have been an error.
2769 The following language-independent options do not enable specific
2770 warnings but control the kinds of diagnostics produced by GCC.
2772 @table @gcctabopt
2773 @cindex syntax checking
2774 @item -fsyntax-only
2775 @opindex fsyntax-only
2776 Check the code for syntax errors, but don't do anything beyond that.
2778 @item -w
2779 @opindex w
2780 Inhibit all warning messages.
2782 @item -Werror
2783 @opindex Werror
2784 @opindex Wno-error
2785 Make all warnings into errors.
2787 @item -Werror=
2788 @opindex Werror=
2789 @opindex Wno-error=
2790 Make the specified warning into an error.  The specifier for a warning
2791 is appended, for example @option{-Werror=switch} turns the warnings
2792 controlled by @option{-Wswitch} into errors.  This switch takes a
2793 negative form, to be used to negate @option{-Werror} for specific
2794 warnings, for example @option{-Wno-error=switch} makes
2795 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2796 is in effect.  You can use the @option{-fdiagnostics-show-option}
2797 option to have each controllable warning amended with the option which
2798 controls it, to determine what to use with this option.
2800 Note that specifying @option{-Werror=}@var{foo} automatically implies
2801 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2802 imply anything.
2804 @item -Wfatal-errors
2805 @opindex Wfatal-errors
2806 @opindex Wno-fatal-errors
2807 This option causes the compiler to abort compilation on the first error
2808 occurred rather than trying to keep going and printing further error
2809 messages.
2811 @end table
2813 You can request many specific warnings with options beginning
2814 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2815 implicit declarations.  Each of these specific warning options also
2816 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2817 example, @option{-Wno-implicit}.  This manual lists only one of the
2818 two forms, whichever is not the default.  For further,
2819 language-specific options also refer to @ref{C++ Dialect Options} and
2820 @ref{Objective-C and Objective-C++ Dialect Options}.
2822 When an unrecognized warning label is requested (e.g.,
2823 @option{-Wunknown-warning}), GCC will emit a diagnostic stating
2824 that the option is not recognized.  However, if the @samp{-Wno-} form
2825 is used, the behavior is slightly different: No diagnostic will be
2826 produced for @option{-Wno-unknown-warning} unless other diagnostics
2827 are being produced.  This allows the use of new @option{-Wno-} options
2828 with old compilers, but if something goes wrong, the compiler will
2829 warn that an unrecognized option was used.
2831 @table @gcctabopt
2832 @item -pedantic
2833 @opindex pedantic
2834 Issue all the warnings demanded by strict ISO C and ISO C++;
2835 reject all programs that use forbidden extensions, and some other
2836 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2837 version of the ISO C standard specified by any @option{-std} option used.
2839 Valid ISO C and ISO C++ programs should compile properly with or without
2840 this option (though a rare few will require @option{-ansi} or a
2841 @option{-std} option specifying the required version of ISO C)@.  However,
2842 without this option, certain GNU extensions and traditional C and C++
2843 features are supported as well.  With this option, they are rejected.
2845 @option{-pedantic} does not cause warning messages for use of the
2846 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2847 warnings are also disabled in the expression that follows
2848 @code{__extension__}.  However, only system header files should use
2849 these escape routes; application programs should avoid them.
2850 @xref{Alternate Keywords}.
2852 Some users try to use @option{-pedantic} to check programs for strict ISO
2853 C conformance.  They soon find that it does not do quite what they want:
2854 it finds some non-ISO practices, but not all---only those for which
2855 ISO C @emph{requires} a diagnostic, and some others for which
2856 diagnostics have been added.
2858 A feature to report any failure to conform to ISO C might be useful in
2859 some instances, but would require considerable additional work and would
2860 be quite different from @option{-pedantic}.  We don't have plans to
2861 support such a feature in the near future.
2863 Where the standard specified with @option{-std} represents a GNU
2864 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
2865 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2866 extended dialect is based.  Warnings from @option{-pedantic} are given
2867 where they are required by the base standard.  (It would not make sense
2868 for such warnings to be given only for features not in the specified GNU
2869 C dialect, since by definition the GNU dialects of C include all
2870 features the compiler supports with the given option, and there would be
2871 nothing to warn about.)
2873 @item -pedantic-errors
2874 @opindex pedantic-errors
2875 Like @option{-pedantic}, except that errors are produced rather than
2876 warnings.
2878 @item -Wall
2879 @opindex Wall
2880 @opindex Wno-all
2881 This enables all the warnings about constructions that some users
2882 consider questionable, and that are easy to avoid (or modify to
2883 prevent the warning), even in conjunction with macros.  This also
2884 enables some language-specific warnings described in @ref{C++ Dialect
2885 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2887 @option{-Wall} turns on the following warning flags:
2889 @gccoptlist{-Waddress   @gol
2890 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2891 -Wc++0x-compat  @gol
2892 -Wchar-subscripts  @gol
2893 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2894 -Wimplicit-int  @gol
2895 -Wimplicit-function-declaration  @gol
2896 -Wcomment  @gol
2897 -Wformat   @gol
2898 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2899 -Wmissing-braces  @gol
2900 -Wnonnull  @gol
2901 -Wparentheses  @gol
2902 -Wpointer-sign  @gol
2903 -Wreorder   @gol
2904 -Wreturn-type  @gol
2905 -Wsequence-point  @gol
2906 -Wsign-compare @r{(only in C++)}  @gol
2907 -Wstrict-aliasing  @gol
2908 -Wstrict-overflow=1  @gol
2909 -Wswitch  @gol
2910 -Wtrigraphs  @gol
2911 -Wuninitialized  @gol
2912 -Wunknown-pragmas  @gol
2913 -Wunused-function  @gol
2914 -Wunused-label     @gol
2915 -Wunused-value     @gol
2916 -Wunused-variable  @gol
2917 -Wvolatile-register-var @gol
2920 Note that some warning flags are not implied by @option{-Wall}.  Some of
2921 them warn about constructions that users generally do not consider
2922 questionable, but which occasionally you might wish to check for;
2923 others warn about constructions that are necessary or hard to avoid in
2924 some cases, and there is no simple way to modify the code to suppress
2925 the warning. Some of them are enabled by @option{-Wextra} but many of
2926 them must be enabled individually.
2928 @item -Wextra
2929 @opindex W
2930 @opindex Wextra
2931 @opindex Wno-extra
2932 This enables some extra warning flags that are not enabled by
2933 @option{-Wall}. (This option used to be called @option{-W}.  The older
2934 name is still supported, but the newer name is more descriptive.)
2936 @gccoptlist{-Wclobbered  @gol
2937 -Wempty-body  @gol
2938 -Wignored-qualifiers @gol
2939 -Wmissing-field-initializers  @gol
2940 -Wmissing-parameter-type @r{(C only)}  @gol
2941 -Wold-style-declaration @r{(C only)}  @gol
2942 -Woverride-init  @gol
2943 -Wsign-compare  @gol
2944 -Wtype-limits  @gol
2945 -Wuninitialized  @gol
2946 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
2947 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2950 The option @option{-Wextra} also prints warning messages for the
2951 following cases:
2953 @itemize @bullet
2955 @item
2956 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2957 @samp{>}, or @samp{>=}.
2959 @item
2960 (C++ only) An enumerator and a non-enumerator both appear in a
2961 conditional expression.
2963 @item
2964 (C++ only) Ambiguous virtual bases.
2966 @item
2967 (C++ only) Subscripting an array which has been declared @samp{register}.
2969 @item
2970 (C++ only) Taking the address of a variable which has been declared
2971 @samp{register}.
2973 @item
2974 (C++ only) A base class is not initialized in a derived class' copy
2975 constructor.
2977 @end itemize
2979 @item -Wchar-subscripts
2980 @opindex Wchar-subscripts
2981 @opindex Wno-char-subscripts
2982 Warn if an array subscript has type @code{char}.  This is a common cause
2983 of error, as programmers often forget that this type is signed on some
2984 machines.
2985 This warning is enabled by @option{-Wall}.
2987 @item -Wcomment
2988 @opindex Wcomment
2989 @opindex Wno-comment
2990 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2991 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2992 This warning is enabled by @option{-Wall}.
2994 @item -Wno-cpp \
2995 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
2997 Suppress warning messages emitted by @code{#warning} directives.
2999 @item -Wformat
3000 @opindex Wformat
3001 @opindex Wno-format
3002 @opindex ffreestanding
3003 @opindex fno-builtin
3004 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3005 the arguments supplied have types appropriate to the format string
3006 specified, and that the conversions specified in the format string make
3007 sense.  This includes standard functions, and others specified by format
3008 attributes (@pxref{Function Attributes}), in the @code{printf},
3009 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3010 not in the C standard) families (or other target-specific families).
3011 Which functions are checked without format attributes having been
3012 specified depends on the standard version selected, and such checks of
3013 functions without the attribute specified are disabled by
3014 @option{-ffreestanding} or @option{-fno-builtin}.
3016 The formats are checked against the format features supported by GNU
3017 libc version 2.2.  These include all ISO C90 and C99 features, as well
3018 as features from the Single Unix Specification and some BSD and GNU
3019 extensions.  Other library implementations may not support all these
3020 features; GCC does not support warning about features that go beyond a
3021 particular library's limitations.  However, if @option{-pedantic} is used
3022 with @option{-Wformat}, warnings will be given about format features not
3023 in the selected standard version (but not for @code{strfmon} formats,
3024 since those are not in any version of the C standard).  @xref{C Dialect
3025 Options,,Options Controlling C Dialect}.
3027 Since @option{-Wformat} also checks for null format arguments for
3028 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3030 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3031 aspects of format checking, the options @option{-Wformat-y2k},
3032 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3033 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3034 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3036 @item -Wformat-y2k
3037 @opindex Wformat-y2k
3038 @opindex Wno-format-y2k
3039 If @option{-Wformat} is specified, also warn about @code{strftime}
3040 formats which may yield only a two-digit year.
3042 @item -Wno-format-contains-nul
3043 @opindex Wno-format-contains-nul
3044 @opindex Wformat-contains-nul
3045 If @option{-Wformat} is specified, do not warn about format strings that
3046 contain NUL bytes.
3048 @item -Wno-format-extra-args
3049 @opindex Wno-format-extra-args
3050 @opindex Wformat-extra-args
3051 If @option{-Wformat} is specified, do not warn about excess arguments to a
3052 @code{printf} or @code{scanf} format function.  The C standard specifies
3053 that such arguments are ignored.
3055 Where the unused arguments lie between used arguments that are
3056 specified with @samp{$} operand number specifications, normally
3057 warnings are still given, since the implementation could not know what
3058 type to pass to @code{va_arg} to skip the unused arguments.  However,
3059 in the case of @code{scanf} formats, this option will suppress the
3060 warning if the unused arguments are all pointers, since the Single
3061 Unix Specification says that such unused arguments are allowed.
3063 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3064 @opindex Wno-format-zero-length
3065 @opindex Wformat-zero-length
3066 If @option{-Wformat} is specified, do not warn about zero-length formats.
3067 The C standard specifies that zero-length formats are allowed.
3069 @item -Wformat-nonliteral
3070 @opindex Wformat-nonliteral
3071 @opindex Wno-format-nonliteral
3072 If @option{-Wformat} is specified, also warn if the format string is not a
3073 string literal and so cannot be checked, unless the format function
3074 takes its format arguments as a @code{va_list}.
3076 @item -Wformat-security
3077 @opindex Wformat-security
3078 @opindex Wno-format-security
3079 If @option{-Wformat} is specified, also warn about uses of format
3080 functions that represent possible security problems.  At present, this
3081 warns about calls to @code{printf} and @code{scanf} functions where the
3082 format string is not a string literal and there are no format arguments,
3083 as in @code{printf (foo);}.  This may be a security hole if the format
3084 string came from untrusted input and contains @samp{%n}.  (This is
3085 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3086 in future warnings may be added to @option{-Wformat-security} that are not
3087 included in @option{-Wformat-nonliteral}.)
3089 @item -Wformat=2
3090 @opindex Wformat=2
3091 @opindex Wno-format=2
3092 Enable @option{-Wformat} plus format checks not included in
3093 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3094 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3096 @item -Wnonnull @r{(C and Objective-C only)}
3097 @opindex Wnonnull
3098 @opindex Wno-nonnull
3099 Warn about passing a null pointer for arguments marked as
3100 requiring a non-null value by the @code{nonnull} function attribute.
3102 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3103 can be disabled with the @option{-Wno-nonnull} option.
3105 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3106 @opindex Winit-self
3107 @opindex Wno-init-self
3108 Warn about uninitialized variables which are initialized with themselves.
3109 Note this option can only be used with the @option{-Wuninitialized} option.
3111 For example, GCC will warn about @code{i} being uninitialized in the
3112 following snippet only when @option{-Winit-self} has been specified:
3113 @smallexample
3114 @group
3115 int f()
3117   int i = i;
3118   return i;
3120 @end group
3121 @end smallexample
3123 @item -Wimplicit-int @r{(C and Objective-C only)}
3124 @opindex Wimplicit-int
3125 @opindex Wno-implicit-int
3126 Warn when a declaration does not specify a type.
3127 This warning is enabled by @option{-Wall}.
3129 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3130 @opindex Wimplicit-function-declaration
3131 @opindex Wno-implicit-function-declaration
3132 Give a warning whenever a function is used before being declared. In
3133 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3134 enabled by default and it is made into an error by
3135 @option{-pedantic-errors}. This warning is also enabled by
3136 @option{-Wall}.
3138 @item -Wimplicit
3139 @opindex Wimplicit
3140 @opindex Wno-implicit
3141 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3142 This warning is enabled by @option{-Wall}.
3144 @item -Wignored-qualifiers @r{(C and C++ only)}
3145 @opindex Wignored-qualifiers
3146 @opindex Wno-ignored-qualifiers
3147 Warn if the return type of a function has a type qualifier
3148 such as @code{const}.  For ISO C such a type qualifier has no effect,
3149 since the value returned by a function is not an lvalue.
3150 For C++, the warning is only emitted for scalar types or @code{void}.
3151 ISO C prohibits qualified @code{void} return types on function
3152 definitions, so such return types always receive a warning
3153 even without this option.
3155 This warning is also enabled by @option{-Wextra}.
3157 @item -Wmain
3158 @opindex Wmain
3159 @opindex Wno-main
3160 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3161 a function with external linkage, returning int, taking either zero
3162 arguments, two, or three arguments of appropriate types.  This warning
3163 is enabled by default in C++ and is enabled by either @option{-Wall}
3164 or @option{-pedantic}.
3166 @item -Wmissing-braces
3167 @opindex Wmissing-braces
3168 @opindex Wno-missing-braces
3169 Warn if an aggregate or union initializer is not fully bracketed.  In
3170 the following example, the initializer for @samp{a} is not fully
3171 bracketed, but that for @samp{b} is fully bracketed.
3173 @smallexample
3174 int a[2][2] = @{ 0, 1, 2, 3 @};
3175 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3176 @end smallexample
3178 This warning is enabled by @option{-Wall}.
3180 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3181 @opindex Wmissing-include-dirs
3182 @opindex Wno-missing-include-dirs
3183 Warn if a user-supplied include directory does not exist.
3185 @item -Wparentheses
3186 @opindex Wparentheses
3187 @opindex Wno-parentheses
3188 Warn if parentheses are omitted in certain contexts, such
3189 as when there is an assignment in a context where a truth value
3190 is expected, or when operators are nested whose precedence people
3191 often get confused about.
3193 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3194 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3195 interpretation from that of ordinary mathematical notation.
3197 Also warn about constructions where there may be confusion to which
3198 @code{if} statement an @code{else} branch belongs.  Here is an example of
3199 such a case:
3201 @smallexample
3202 @group
3204   if (a)
3205     if (b)
3206       foo ();
3207   else
3208     bar ();
3210 @end group
3211 @end smallexample
3213 In C/C++, every @code{else} branch belongs to the innermost possible
3214 @code{if} statement, which in this example is @code{if (b)}.  This is
3215 often not what the programmer expected, as illustrated in the above
3216 example by indentation the programmer chose.  When there is the
3217 potential for this confusion, GCC will issue a warning when this flag
3218 is specified.  To eliminate the warning, add explicit braces around
3219 the innermost @code{if} statement so there is no way the @code{else}
3220 could belong to the enclosing @code{if}.  The resulting code would
3221 look like this:
3223 @smallexample
3224 @group
3226   if (a)
3227     @{
3228       if (b)
3229         foo ();
3230       else
3231         bar ();
3232     @}
3234 @end group
3235 @end smallexample
3237 This warning is enabled by @option{-Wall}.
3239 @item -Wsequence-point
3240 @opindex Wsequence-point
3241 @opindex Wno-sequence-point
3242 Warn about code that may have undefined semantics because of violations
3243 of sequence point rules in the C and C++ standards.
3245 The C and C++ standards defines the order in which expressions in a C/C++
3246 program are evaluated in terms of @dfn{sequence points}, which represent
3247 a partial ordering between the execution of parts of the program: those
3248 executed before the sequence point, and those executed after it.  These
3249 occur after the evaluation of a full expression (one which is not part
3250 of a larger expression), after the evaluation of the first operand of a
3251 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3252 function is called (but after the evaluation of its arguments and the
3253 expression denoting the called function), and in certain other places.
3254 Other than as expressed by the sequence point rules, the order of
3255 evaluation of subexpressions of an expression is not specified.  All
3256 these rules describe only a partial order rather than a total order,
3257 since, for example, if two functions are called within one expression
3258 with no sequence point between them, the order in which the functions
3259 are called is not specified.  However, the standards committee have
3260 ruled that function calls do not overlap.
3262 It is not specified when between sequence points modifications to the
3263 values of objects take effect.  Programs whose behavior depends on this
3264 have undefined behavior; the C and C++ standards specify that ``Between
3265 the previous and next sequence point an object shall have its stored
3266 value modified at most once by the evaluation of an expression.
3267 Furthermore, the prior value shall be read only to determine the value
3268 to be stored.''.  If a program breaks these rules, the results on any
3269 particular implementation are entirely unpredictable.
3271 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3272 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3273 diagnosed by this option, and it may give an occasional false positive
3274 result, but in general it has been found fairly effective at detecting
3275 this sort of problem in programs.
3277 The standard is worded confusingly, therefore there is some debate
3278 over the precise meaning of the sequence point rules in subtle cases.
3279 Links to discussions of the problem, including proposed formal
3280 definitions, may be found on the GCC readings page, at
3281 @w{@uref{http://gcc.gnu.org/readings.html}}.
3283 This warning is enabled by @option{-Wall} for C and C++.
3285 @item -Wreturn-type
3286 @opindex Wreturn-type
3287 @opindex Wno-return-type
3288 Warn whenever a function is defined with a return-type that defaults
3289 to @code{int}.  Also warn about any @code{return} statement with no
3290 return-value in a function whose return-type is not @code{void}
3291 (falling off the end of the function body is considered returning
3292 without a value), and about a @code{return} statement with an
3293 expression in a function whose return-type is @code{void}.
3295 For C++, a function without return type always produces a diagnostic
3296 message, even when @option{-Wno-return-type} is specified.  The only
3297 exceptions are @samp{main} and functions defined in system headers.
3299 This warning is enabled by @option{-Wall}.
3301 @item -Wswitch
3302 @opindex Wswitch
3303 @opindex Wno-switch
3304 Warn whenever a @code{switch} statement has an index of enumerated type
3305 and lacks a @code{case} for one or more of the named codes of that
3306 enumeration.  (The presence of a @code{default} label prevents this
3307 warning.)  @code{case} labels outside the enumeration range also
3308 provoke warnings when this option is used (even if there is a
3309 @code{default} label).
3310 This warning is enabled by @option{-Wall}.
3312 @item -Wswitch-default
3313 @opindex Wswitch-default
3314 @opindex Wno-switch-default
3315 Warn whenever a @code{switch} statement does not have a @code{default}
3316 case.
3318 @item -Wswitch-enum
3319 @opindex Wswitch-enum
3320 @opindex Wno-switch-enum
3321 Warn whenever a @code{switch} statement has an index of enumerated type
3322 and lacks a @code{case} for one or more of the named codes of that
3323 enumeration.  @code{case} labels outside the enumeration range also
3324 provoke warnings when this option is used.  The only difference
3325 between @option{-Wswitch} and this option is that this option gives a
3326 warning about an omitted enumeration code even if there is a
3327 @code{default} label.
3329 @item -Wsync-nand @r{(C and C++ only)}
3330 @opindex Wsync-nand
3331 @opindex Wno-sync-nand
3332 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3333 built-in functions are used.  These functions changed semantics in GCC 4.4.
3335 @item -Wtrigraphs
3336 @opindex Wtrigraphs
3337 @opindex Wno-trigraphs
3338 Warn if any trigraphs are encountered that might change the meaning of
3339 the program (trigraphs within comments are not warned about).
3340 This warning is enabled by @option{-Wall}.
3342 @item -Wunused-but-set-parameter
3343 @opindex Wunused-but-set-parameter
3344 @opindex Wno-unused-but-set-parameter
3345 Warn whenever a function parameter is assigned to, but otherwise unused
3346 (aside from its declaration).
3348 To suppress this warning use the @samp{unused} attribute
3349 (@pxref{Variable Attributes}).
3351 This warning is also enabled by @option{-Wunused} together with
3352 @option{-Wextra}.
3354 @item -Wunused-but-set-variable
3355 @opindex Wunused-but-set-variable
3356 @opindex Wno-unused-but-set-variable
3357 Warn whenever a local variable is assigned to, but otherwise unused
3358 (aside from its declaration).
3359 This warning is enabled by @option{-Wall}.
3361 To suppress this warning use the @samp{unused} attribute
3362 (@pxref{Variable Attributes}).
3364 This warning is also enabled by @option{-Wunused}, which is enabled
3365 by @option{-Wall}.
3367 @item -Wunused-function
3368 @opindex Wunused-function
3369 @opindex Wno-unused-function
3370 Warn whenever a static function is declared but not defined or a
3371 non-inline static function is unused.
3372 This warning is enabled by @option{-Wall}.
3374 @item -Wunused-label
3375 @opindex Wunused-label
3376 @opindex Wno-unused-label
3377 Warn whenever a label is declared but not used.
3378 This warning is enabled by @option{-Wall}.
3380 To suppress this warning use the @samp{unused} attribute
3381 (@pxref{Variable Attributes}).
3383 @item -Wunused-parameter
3384 @opindex Wunused-parameter
3385 @opindex Wno-unused-parameter
3386 Warn whenever a function parameter is unused aside from its declaration.
3388 To suppress this warning use the @samp{unused} attribute
3389 (@pxref{Variable Attributes}).
3391 @item -Wno-unused-result
3392 @opindex Wunused-result
3393 @opindex Wno-unused-result
3394 Do not warn if a caller of a function marked with attribute
3395 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3396 its return value. The default is @option{-Wunused-result}.
3398 @item -Wunused-variable
3399 @opindex Wunused-variable
3400 @opindex Wno-unused-variable
3401 Warn whenever a local variable or non-constant static variable is unused
3402 aside from its declaration.
3403 This warning is enabled by @option{-Wall}.
3405 To suppress this warning use the @samp{unused} attribute
3406 (@pxref{Variable Attributes}).
3408 @item -Wunused-value
3409 @opindex Wunused-value
3410 @opindex Wno-unused-value
3411 Warn whenever a statement computes a result that is explicitly not
3412 used. To suppress this warning cast the unused expression to
3413 @samp{void}. This includes an expression-statement or the left-hand
3414 side of a comma expression that contains no side effects. For example,
3415 an expression such as @samp{x[i,j]} will cause a warning, while
3416 @samp{x[(void)i,j]} will not.
3418 This warning is enabled by @option{-Wall}.
3420 @item -Wunused
3421 @opindex Wunused
3422 @opindex Wno-unused
3423 All the above @option{-Wunused} options combined.
3425 In order to get a warning about an unused function parameter, you must
3426 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3427 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3429 @item -Wuninitialized
3430 @opindex Wuninitialized
3431 @opindex Wno-uninitialized
3432 Warn if an automatic variable is used without first being initialized
3433 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3434 warn if a non-static reference or non-static @samp{const} member
3435 appears in a class without constructors.
3437 If you want to warn about code which uses the uninitialized value of the
3438 variable in its own initializer, use the @option{-Winit-self} option.
3440 These warnings occur for individual uninitialized or clobbered
3441 elements of structure, union or array variables as well as for
3442 variables which are uninitialized or clobbered as a whole.  They do
3443 not occur for variables or elements declared @code{volatile}.  Because
3444 these warnings depend on optimization, the exact variables or elements
3445 for which there are warnings will depend on the precise optimization
3446 options and version of GCC used.
3448 Note that there may be no warning about a variable that is used only
3449 to compute a value that itself is never used, because such
3450 computations may be deleted by data flow analysis before the warnings
3451 are printed.
3453 These warnings are made optional because GCC is not smart
3454 enough to see all the reasons why the code might be correct
3455 despite appearing to have an error.  Here is one example of how
3456 this can happen:
3458 @smallexample
3459 @group
3461   int x;
3462   switch (y)
3463     @{
3464     case 1: x = 1;
3465       break;
3466     case 2: x = 4;
3467       break;
3468     case 3: x = 5;
3469     @}
3470   foo (x);
3472 @end group
3473 @end smallexample
3475 @noindent
3476 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3477 always initialized, but GCC doesn't know this.  Here is
3478 another common case:
3480 @smallexample
3482   int save_y;
3483   if (change_y) save_y = y, y = new_y;
3484   @dots{}
3485   if (change_y) y = save_y;
3487 @end smallexample
3489 @noindent
3490 This has no bug because @code{save_y} is used only if it is set.
3492 @cindex @code{longjmp} warnings
3493 This option also warns when a non-volatile automatic variable might be
3494 changed by a call to @code{longjmp}.  These warnings as well are possible
3495 only in optimizing compilation.
3497 The compiler sees only the calls to @code{setjmp}.  It cannot know
3498 where @code{longjmp} will be called; in fact, a signal handler could
3499 call it at any point in the code.  As a result, you may get a warning
3500 even when there is in fact no problem because @code{longjmp} cannot
3501 in fact be called at the place which would cause a problem.
3503 Some spurious warnings can be avoided if you declare all the functions
3504 you use that never return as @code{noreturn}.  @xref{Function
3505 Attributes}.
3507 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3509 @item -Wunknown-pragmas
3510 @opindex Wunknown-pragmas
3511 @opindex Wno-unknown-pragmas
3512 @cindex warning for unknown pragmas
3513 @cindex unknown pragmas, warning
3514 @cindex pragmas, warning of unknown
3515 Warn when a #pragma directive is encountered which is not understood by
3516 GCC@.  If this command line option is used, warnings will even be issued
3517 for unknown pragmas in system header files.  This is not the case if
3518 the warnings were only enabled by the @option{-Wall} command line option.
3520 @item -Wno-pragmas
3521 @opindex Wno-pragmas
3522 @opindex Wpragmas
3523 Do not warn about misuses of pragmas, such as incorrect parameters,
3524 invalid syntax, or conflicts between pragmas.  See also
3525 @samp{-Wunknown-pragmas}.
3527 @item -Wstrict-aliasing
3528 @opindex Wstrict-aliasing
3529 @opindex Wno-strict-aliasing
3530 This option is only active when @option{-fstrict-aliasing} is active.
3531 It warns about code which might break the strict aliasing rules that the
3532 compiler is using for optimization.  The warning does not catch all
3533 cases, but does attempt to catch the more common pitfalls.  It is
3534 included in @option{-Wall}.
3535 It is equivalent to @option{-Wstrict-aliasing=3}
3537 @item -Wstrict-aliasing=n
3538 @opindex Wstrict-aliasing=n
3539 @opindex Wno-strict-aliasing=n
3540 This option is only active when @option{-fstrict-aliasing} is active.
3541 It warns about code which might break the strict aliasing rules that the
3542 compiler is using for optimization.
3543 Higher levels correspond to higher accuracy (fewer false positives).
3544 Higher levels also correspond to more effort, similar to the way -O works.
3545 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3546 with n=3.
3548 Level 1: Most aggressive, quick, least accurate.
3549 Possibly useful when higher levels
3550 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3551 false negatives.  However, it has many false positives.
3552 Warns for all pointer conversions between possibly incompatible types,
3553 even if never dereferenced.  Runs in the frontend only.
3555 Level 2: Aggressive, quick, not too precise.
3556 May still have many false positives (not as many as level 1 though),
3557 and few false negatives (but possibly more than level 1).
3558 Unlike level 1, it only warns when an address is taken.  Warns about
3559 incomplete types.  Runs in the frontend only.
3561 Level 3 (default for @option{-Wstrict-aliasing}):
3562 Should have very few false positives and few false
3563 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3564 Takes care of the common pun+dereference pattern in the frontend:
3565 @code{*(int*)&some_float}.
3566 If optimization is enabled, it also runs in the backend, where it deals
3567 with multiple statement cases using flow-sensitive points-to information.
3568 Only warns when the converted pointer is dereferenced.
3569 Does not warn about incomplete types.
3571 @item -Wstrict-overflow
3572 @itemx -Wstrict-overflow=@var{n}
3573 @opindex Wstrict-overflow
3574 @opindex Wno-strict-overflow
3575 This option is only active when @option{-fstrict-overflow} is active.
3576 It warns about cases where the compiler optimizes based on the
3577 assumption that signed overflow does not occur.  Note that it does not
3578 warn about all cases where the code might overflow: it only warns
3579 about cases where the compiler implements some optimization.  Thus
3580 this warning depends on the optimization level.
3582 An optimization which assumes that signed overflow does not occur is
3583 perfectly safe if the values of the variables involved are such that
3584 overflow never does, in fact, occur.  Therefore this warning can
3585 easily give a false positive: a warning about code which is not
3586 actually a problem.  To help focus on important issues, several
3587 warning levels are defined.  No warnings are issued for the use of
3588 undefined signed overflow when estimating how many iterations a loop
3589 will require, in particular when determining whether a loop will be
3590 executed at all.
3592 @table @gcctabopt
3593 @item -Wstrict-overflow=1
3594 Warn about cases which are both questionable and easy to avoid.  For
3595 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3596 compiler will simplify this to @code{1}.  This level of
3597 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3598 are not, and must be explicitly requested.
3600 @item -Wstrict-overflow=2
3601 Also warn about other cases where a comparison is simplified to a
3602 constant.  For example: @code{abs (x) >= 0}.  This can only be
3603 simplified when @option{-fstrict-overflow} is in effect, because
3604 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3605 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3606 @option{-Wstrict-overflow=2}.
3608 @item -Wstrict-overflow=3
3609 Also warn about other cases where a comparison is simplified.  For
3610 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3612 @item -Wstrict-overflow=4
3613 Also warn about other simplifications not covered by the above cases.
3614 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3616 @item -Wstrict-overflow=5
3617 Also warn about cases where the compiler reduces the magnitude of a
3618 constant involved in a comparison.  For example: @code{x + 2 > y} will
3619 be simplified to @code{x + 1 >= y}.  This is reported only at the
3620 highest warning level because this simplification applies to many
3621 comparisons, so this warning level will give a very large number of
3622 false positives.
3623 @end table
3625 @item -Wsuggest-attribute=@r{[}const@r{|}pure@r{]}
3626 @opindex Wsuggest-attribute=
3627 @opindex Wno-suggest-attribute=
3628 Warn for cases where adding an attribute may be beneficial. The
3629 attributes currently supported are listed below.
3631 @table @gcctabopt
3632 @item -Wsuggest-attribute=pure
3633 @itemx -Wsuggest-attribute=const
3634 @opindex Wsuggest-attribute=pure
3635 @opindex Wno-suggest-attribute=pure
3636 @opindex Wsuggest-attribute=const
3637 @opindex Wno-suggest-attribute=const
3639 Warn about functions which might be candidates for attributes
3640 @code{pure} or @code{const}.  The compiler only warns for functions
3641 visible in other compilation units or if it cannot prove that the
3642 function returns normally. A function returns normally if it doesn't
3643 contain an infinite loop nor returns abnormally by throwing, calling
3644 @code{abort()} or trapping.  This analysis requires option
3645 @option{-fipa-pure-const}, which is enabled by default at @option{-O}
3646 and higher.  Higher optimization levels improve the accuracy of the
3647 analysis.
3648 @end table
3650 @item -Warray-bounds
3651 @opindex Wno-array-bounds
3652 @opindex Warray-bounds
3653 This option is only active when @option{-ftree-vrp} is active
3654 (default for @option{-O2} and above). It warns about subscripts to arrays
3655 that are always out of bounds. This warning is enabled by @option{-Wall}.
3657 @item -Wno-div-by-zero
3658 @opindex Wno-div-by-zero
3659 @opindex Wdiv-by-zero
3660 Do not warn about compile-time integer division by zero.  Floating point
3661 division by zero is not warned about, as it can be a legitimate way of
3662 obtaining infinities and NaNs.
3664 @item -Wsystem-headers
3665 @opindex Wsystem-headers
3666 @opindex Wno-system-headers
3667 @cindex warnings from system headers
3668 @cindex system headers, warnings from
3669 Print warning messages for constructs found in system header files.
3670 Warnings from system headers are normally suppressed, on the assumption
3671 that they usually do not indicate real problems and would only make the
3672 compiler output harder to read.  Using this command line option tells
3673 GCC to emit warnings from system headers as if they occurred in user
3674 code.  However, note that using @option{-Wall} in conjunction with this
3675 option will @emph{not} warn about unknown pragmas in system
3676 headers---for that, @option{-Wunknown-pragmas} must also be used.
3678 @item -Wfloat-equal
3679 @opindex Wfloat-equal
3680 @opindex Wno-float-equal
3681 Warn if floating point values are used in equality comparisons.
3683 The idea behind this is that sometimes it is convenient (for the
3684 programmer) to consider floating-point values as approximations to
3685 infinitely precise real numbers.  If you are doing this, then you need
3686 to compute (by analyzing the code, or in some other way) the maximum or
3687 likely maximum error that the computation introduces, and allow for it
3688 when performing comparisons (and when producing output, but that's a
3689 different problem).  In particular, instead of testing for equality, you
3690 would check to see whether the two values have ranges that overlap; and
3691 this is done with the relational operators, so equality comparisons are
3692 probably mistaken.
3694 @item -Wtraditional @r{(C and Objective-C only)}
3695 @opindex Wtraditional
3696 @opindex Wno-traditional
3697 Warn about certain constructs that behave differently in traditional and
3698 ISO C@.  Also warn about ISO C constructs that have no traditional C
3699 equivalent, and/or problematic constructs which should be avoided.
3701 @itemize @bullet
3702 @item
3703 Macro parameters that appear within string literals in the macro body.
3704 In traditional C macro replacement takes place within string literals,
3705 but does not in ISO C@.
3707 @item
3708 In traditional C, some preprocessor directives did not exist.
3709 Traditional preprocessors would only consider a line to be a directive
3710 if the @samp{#} appeared in column 1 on the line.  Therefore
3711 @option{-Wtraditional} warns about directives that traditional C
3712 understands but would ignore because the @samp{#} does not appear as the
3713 first character on the line.  It also suggests you hide directives like
3714 @samp{#pragma} not understood by traditional C by indenting them.  Some
3715 traditional implementations would not recognize @samp{#elif}, so it
3716 suggests avoiding it altogether.
3718 @item
3719 A function-like macro that appears without arguments.
3721 @item
3722 The unary plus operator.
3724 @item
3725 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3726 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3727 constants.)  Note, these suffixes appear in macros defined in the system
3728 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3729 Use of these macros in user code might normally lead to spurious
3730 warnings, however GCC's integrated preprocessor has enough context to
3731 avoid warning in these cases.
3733 @item
3734 A function declared external in one block and then used after the end of
3735 the block.
3737 @item
3738 A @code{switch} statement has an operand of type @code{long}.
3740 @item
3741 A non-@code{static} function declaration follows a @code{static} one.
3742 This construct is not accepted by some traditional C compilers.
3744 @item
3745 The ISO type of an integer constant has a different width or
3746 signedness from its traditional type.  This warning is only issued if
3747 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3748 typically represent bit patterns, are not warned about.
3750 @item
3751 Usage of ISO string concatenation is detected.
3753 @item
3754 Initialization of automatic aggregates.
3756 @item
3757 Identifier conflicts with labels.  Traditional C lacks a separate
3758 namespace for labels.
3760 @item
3761 Initialization of unions.  If the initializer is zero, the warning is
3762 omitted.  This is done under the assumption that the zero initializer in
3763 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3764 initializer warnings and relies on default initialization to zero in the
3765 traditional C case.
3767 @item
3768 Conversions by prototypes between fixed/floating point values and vice
3769 versa.  The absence of these prototypes when compiling with traditional
3770 C would cause serious problems.  This is a subset of the possible
3771 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3773 @item
3774 Use of ISO C style function definitions.  This warning intentionally is
3775 @emph{not} issued for prototype declarations or variadic functions
3776 because these ISO C features will appear in your code when using
3777 libiberty's traditional C compatibility macros, @code{PARAMS} and
3778 @code{VPARAMS}.  This warning is also bypassed for nested functions
3779 because that feature is already a GCC extension and thus not relevant to
3780 traditional C compatibility.
3781 @end itemize
3783 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3784 @opindex Wtraditional-conversion
3785 @opindex Wno-traditional-conversion
3786 Warn if a prototype causes a type conversion that is different from what
3787 would happen to the same argument in the absence of a prototype.  This
3788 includes conversions of fixed point to floating and vice versa, and
3789 conversions changing the width or signedness of a fixed point argument
3790 except when the same as the default promotion.
3792 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3793 @opindex Wdeclaration-after-statement
3794 @opindex Wno-declaration-after-statement
3795 Warn when a declaration is found after a statement in a block.  This
3796 construct, known from C++, was introduced with ISO C99 and is by default
3797 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3798 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3800 @item -Wundef
3801 @opindex Wundef
3802 @opindex Wno-undef
3803 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3805 @item -Wno-endif-labels
3806 @opindex Wno-endif-labels
3807 @opindex Wendif-labels
3808 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3810 @item -Wshadow
3811 @opindex Wshadow
3812 @opindex Wno-shadow
3813 Warn whenever a local variable shadows another local variable, parameter or
3814 global variable or whenever a built-in function is shadowed.
3816 @item -Wlarger-than=@var{len}
3817 @opindex Wlarger-than=@var{len}
3818 @opindex Wlarger-than-@var{len}
3819 Warn whenever an object of larger than @var{len} bytes is defined.
3821 @item -Wframe-larger-than=@var{len}
3822 @opindex Wframe-larger-than
3823 Warn if the size of a function frame is larger than @var{len} bytes.
3824 The computation done to determine the stack frame size is approximate
3825 and not conservative.
3826 The actual requirements may be somewhat greater than @var{len}
3827 even if you do not get a warning.  In addition, any space allocated
3828 via @code{alloca}, variable-length arrays, or related constructs
3829 is not included by the compiler when determining
3830 whether or not to issue a warning.
3832 @item -Wunsafe-loop-optimizations
3833 @opindex Wunsafe-loop-optimizations
3834 @opindex Wno-unsafe-loop-optimizations
3835 Warn if the loop cannot be optimized because the compiler could not
3836 assume anything on the bounds of the loop indices.  With
3837 @option{-funsafe-loop-optimizations} warn if the compiler made
3838 such assumptions.
3840 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3841 @opindex Wno-pedantic-ms-format
3842 @opindex Wpedantic-ms-format
3843 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3844 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3845 depending on the MS runtime, when you are using the options @option{-Wformat}
3846 and @option{-pedantic} without gnu-extensions.
3848 @item -Wpointer-arith
3849 @opindex Wpointer-arith
3850 @opindex Wno-pointer-arith
3851 Warn about anything that depends on the ``size of'' a function type or
3852 of @code{void}.  GNU C assigns these types a size of 1, for
3853 convenience in calculations with @code{void *} pointers and pointers
3854 to functions.  In C++, warn also when an arithmetic operation involves
3855 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3857 @item -Wtype-limits
3858 @opindex Wtype-limits
3859 @opindex Wno-type-limits
3860 Warn if a comparison is always true or always false due to the limited
3861 range of the data type, but do not warn for constant expressions.  For
3862 example, warn if an unsigned variable is compared against zero with
3863 @samp{<} or @samp{>=}.  This warning is also enabled by
3864 @option{-Wextra}.
3866 @item -Wbad-function-cast @r{(C and Objective-C only)}
3867 @opindex Wbad-function-cast
3868 @opindex Wno-bad-function-cast
3869 Warn whenever a function call is cast to a non-matching type.
3870 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3872 @item -Wc++-compat @r{(C and Objective-C only)}
3873 Warn about ISO C constructs that are outside of the common subset of
3874 ISO C and ISO C++, e.g.@: request for implicit conversion from
3875 @code{void *} to a pointer to non-@code{void} type.
3877 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3878 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3879 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3880 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3882 @item -Wcast-qual
3883 @opindex Wcast-qual
3884 @opindex Wno-cast-qual
3885 Warn whenever a pointer is cast so as to remove a type qualifier from
3886 the target type.  For example, warn if a @code{const char *} is cast
3887 to an ordinary @code{char *}.
3889 Also warn when making a cast which introduces a type qualifier in an
3890 unsafe way.  For example, casting @code{char **} to @code{const char **}
3891 is unsafe, as in this example:
3893 @smallexample
3894   /* p is char ** value.  */
3895   const char **q = (const char **) p;
3896   /* Assignment of readonly string to const char * is OK.  */
3897   *q = "string";
3898   /* Now char** pointer points to read-only memory.  */
3899   **p = 'b';
3900 @end smallexample
3902 @item -Wcast-align
3903 @opindex Wcast-align
3904 @opindex Wno-cast-align
3905 Warn whenever a pointer is cast such that the required alignment of the
3906 target is increased.  For example, warn if a @code{char *} is cast to
3907 an @code{int *} on machines where integers can only be accessed at
3908 two- or four-byte boundaries.
3910 @item -Wwrite-strings
3911 @opindex Wwrite-strings
3912 @opindex Wno-write-strings
3913 When compiling C, give string constants the type @code{const
3914 char[@var{length}]} so that copying the address of one into a
3915 non-@code{const} @code{char *} pointer will get a warning.  These
3916 warnings will help you find at compile time code that can try to write
3917 into a string constant, but only if you have been very careful about
3918 using @code{const} in declarations and prototypes.  Otherwise, it will
3919 just be a nuisance. This is why we did not make @option{-Wall} request
3920 these warnings.
3922 When compiling C++, warn about the deprecated conversion from string
3923 literals to @code{char *}.  This warning is enabled by default for C++
3924 programs.
3926 @item -Wclobbered
3927 @opindex Wclobbered
3928 @opindex Wno-clobbered
3929 Warn for variables that might be changed by @samp{longjmp} or
3930 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3932 @item -Wconversion
3933 @opindex Wconversion
3934 @opindex Wno-conversion
3935 Warn for implicit conversions that may alter a value. This includes
3936 conversions between real and integer, like @code{abs (x)} when
3937 @code{x} is @code{double}; conversions between signed and unsigned,
3938 like @code{unsigned ui = -1}; and conversions to smaller types, like
3939 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3940 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3941 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3942 conversions between signed and unsigned integers can be disabled by
3943 using @option{-Wno-sign-conversion}.
3945 For C++, also warn for confusing overload resolution for user-defined
3946 conversions; and conversions that will never use a type conversion
3947 operator: conversions to @code{void}, the same type, a base class or a
3948 reference to them. Warnings about conversions between signed and
3949 unsigned integers are disabled by default in C++ unless
3950 @option{-Wsign-conversion} is explicitly enabled.
3952 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
3953 @opindex Wconversion-null
3954 @opindex Wno-conversion-null
3955 Do not warn for conversions between @code{NULL} and non-pointer
3956 types. @option{-Wconversion-null} is enabled by default.
3958 @item -Wempty-body
3959 @opindex Wempty-body
3960 @opindex Wno-empty-body
3961 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3962 while} statement.  This warning is also enabled by @option{-Wextra}.
3964 @item -Wenum-compare
3965 @opindex Wenum-compare
3966 @opindex Wno-enum-compare
3967 Warn about a comparison between values of different enum types. In C++
3968 this warning is enabled by default.  In C this warning is enabled by
3969 @option{-Wall}.
3971 @item -Wjump-misses-init @r{(C, Objective-C only)}
3972 @opindex Wjump-misses-init
3973 @opindex Wno-jump-misses-init
3974 Warn if a @code{goto} statement or a @code{switch} statement jumps
3975 forward across the initialization of a variable, or jumps backward to a
3976 label after the variable has been initialized.  This only warns about
3977 variables which are initialized when they are declared.  This warning is
3978 only supported for C and Objective C; in C++ this sort of branch is an
3979 error in any case.
3981 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
3982 can be disabled with the @option{-Wno-jump-misses-init} option.
3984 @item -Wsign-compare
3985 @opindex Wsign-compare
3986 @opindex Wno-sign-compare
3987 @cindex warning for comparison of signed and unsigned values
3988 @cindex comparison of signed and unsigned values, warning
3989 @cindex signed and unsigned values, comparison warning
3990 Warn when a comparison between signed and unsigned values could produce
3991 an incorrect result when the signed value is converted to unsigned.
3992 This warning is also enabled by @option{-Wextra}; to get the other warnings
3993 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3995 @item -Wsign-conversion
3996 @opindex Wsign-conversion
3997 @opindex Wno-sign-conversion
3998 Warn for implicit conversions that may change the sign of an integer
3999 value, like assigning a signed integer expression to an unsigned
4000 integer variable. An explicit cast silences the warning. In C, this
4001 option is enabled also by @option{-Wconversion}.
4003 @item -Waddress
4004 @opindex Waddress
4005 @opindex Wno-address
4006 Warn about suspicious uses of memory addresses. These include using
4007 the address of a function in a conditional expression, such as
4008 @code{void func(void); if (func)}, and comparisons against the memory
4009 address of a string literal, such as @code{if (x == "abc")}.  Such
4010 uses typically indicate a programmer error: the address of a function
4011 always evaluates to true, so their use in a conditional usually
4012 indicate that the programmer forgot the parentheses in a function
4013 call; and comparisons against string literals result in unspecified
4014 behavior and are not portable in C, so they usually indicate that the
4015 programmer intended to use @code{strcmp}.  This warning is enabled by
4016 @option{-Wall}.
4018 @item -Wlogical-op
4019 @opindex Wlogical-op
4020 @opindex Wno-logical-op
4021 Warn about suspicious uses of logical operators in expressions.
4022 This includes using logical operators in contexts where a
4023 bit-wise operator is likely to be expected.
4025 @item -Waggregate-return
4026 @opindex Waggregate-return
4027 @opindex Wno-aggregate-return
4028 Warn if any functions that return structures or unions are defined or
4029 called.  (In languages where you can return an array, this also elicits
4030 a warning.)
4032 @item -Wno-attributes
4033 @opindex Wno-attributes
4034 @opindex Wattributes
4035 Do not warn if an unexpected @code{__attribute__} is used, such as
4036 unrecognized attributes, function attributes applied to variables,
4037 etc.  This will not stop errors for incorrect use of supported
4038 attributes.
4040 @item -Wno-builtin-macro-redefined
4041 @opindex Wno-builtin-macro-redefined
4042 @opindex Wbuiltin-macro-redefined
4043 Do not warn if certain built-in macros are redefined.  This suppresses
4044 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4045 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4047 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4048 @opindex Wstrict-prototypes
4049 @opindex Wno-strict-prototypes
4050 Warn if a function is declared or defined without specifying the
4051 argument types.  (An old-style function definition is permitted without
4052 a warning if preceded by a declaration which specifies the argument
4053 types.)
4055 @item -Wold-style-declaration @r{(C and Objective-C only)}
4056 @opindex Wold-style-declaration
4057 @opindex Wno-old-style-declaration
4058 Warn for obsolescent usages, according to the C Standard, in a
4059 declaration. For example, warn if storage-class specifiers like
4060 @code{static} are not the first things in a declaration.  This warning
4061 is also enabled by @option{-Wextra}.
4063 @item -Wold-style-definition @r{(C and Objective-C only)}
4064 @opindex Wold-style-definition
4065 @opindex Wno-old-style-definition
4066 Warn if an old-style function definition is used.  A warning is given
4067 even if there is a previous prototype.
4069 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4070 @opindex Wmissing-parameter-type
4071 @opindex Wno-missing-parameter-type
4072 A function parameter is declared without a type specifier in K&R-style
4073 functions:
4075 @smallexample
4076 void foo(bar) @{ @}
4077 @end smallexample
4079 This warning is also enabled by @option{-Wextra}.
4081 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4082 @opindex Wmissing-prototypes
4083 @opindex Wno-missing-prototypes
4084 Warn if a global function is defined without a previous prototype
4085 declaration.  This warning is issued even if the definition itself
4086 provides a prototype.  The aim is to detect global functions that fail
4087 to be declared in header files.
4089 @item -Wmissing-declarations
4090 @opindex Wmissing-declarations
4091 @opindex Wno-missing-declarations
4092 Warn if a global function is defined without a previous declaration.
4093 Do so even if the definition itself provides a prototype.
4094 Use this option to detect global functions that are not declared in
4095 header files.  In C++, no warnings are issued for function templates,
4096 or for inline functions, or for functions in anonymous namespaces.
4098 @item -Wmissing-field-initializers
4099 @opindex Wmissing-field-initializers
4100 @opindex Wno-missing-field-initializers
4101 @opindex W
4102 @opindex Wextra
4103 @opindex Wno-extra
4104 Warn if a structure's initializer has some fields missing.  For
4105 example, the following code would cause such a warning, because
4106 @code{x.h} is implicitly zero:
4108 @smallexample
4109 struct s @{ int f, g, h; @};
4110 struct s x = @{ 3, 4 @};
4111 @end smallexample
4113 This option does not warn about designated initializers, so the following
4114 modification would not trigger a warning:
4116 @smallexample
4117 struct s @{ int f, g, h; @};
4118 struct s x = @{ .f = 3, .g = 4 @};
4119 @end smallexample
4121 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4122 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4124 @item -Wmissing-noreturn
4125 @opindex Wmissing-noreturn
4126 @opindex Wno-missing-noreturn
4127 Warn about functions which might be candidates for attribute @code{noreturn}.
4128 Note these are only possible candidates, not absolute ones.  Care should
4129 be taken to manually verify functions actually do not ever return before
4130 adding the @code{noreturn} attribute, otherwise subtle code generation
4131 bugs could be introduced.  You will not get a warning for @code{main} in
4132 hosted C environments.
4134 @item -Wmissing-format-attribute
4135 @opindex Wmissing-format-attribute
4136 @opindex Wno-missing-format-attribute
4137 @opindex Wformat
4138 @opindex Wno-format
4139 Warn about function pointers which might be candidates for @code{format}
4140 attributes.  Note these are only possible candidates, not absolute ones.
4141 GCC will guess that function pointers with @code{format} attributes that
4142 are used in assignment, initialization, parameter passing or return
4143 statements should have a corresponding @code{format} attribute in the
4144 resulting type.  I.e.@: the left-hand side of the assignment or
4145 initialization, the type of the parameter variable, or the return type
4146 of the containing function respectively should also have a @code{format}
4147 attribute to avoid the warning.
4149 GCC will also warn about function definitions which might be
4150 candidates for @code{format} attributes.  Again, these are only
4151 possible candidates.  GCC will guess that @code{format} attributes
4152 might be appropriate for any function that calls a function like
4153 @code{vprintf} or @code{vscanf}, but this might not always be the
4154 case, and some functions for which @code{format} attributes are
4155 appropriate may not be detected.
4157 @item -Wno-multichar
4158 @opindex Wno-multichar
4159 @opindex Wmultichar
4160 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4161 Usually they indicate a typo in the user's code, as they have
4162 implementation-defined values, and should not be used in portable code.
4164 @item -Wnormalized=<none|id|nfc|nfkc>
4165 @opindex Wnormalized=
4166 @cindex NFC
4167 @cindex NFKC
4168 @cindex character set, input normalization
4169 In ISO C and ISO C++, two identifiers are different if they are
4170 different sequences of characters.  However, sometimes when characters
4171 outside the basic ASCII character set are used, you can have two
4172 different character sequences that look the same.  To avoid confusion,
4173 the ISO 10646 standard sets out some @dfn{normalization rules} which
4174 when applied ensure that two sequences that look the same are turned into
4175 the same sequence.  GCC can warn you if you are using identifiers which
4176 have not been normalized; this option controls that warning.
4178 There are four levels of warning that GCC supports.  The default is
4179 @option{-Wnormalized=nfc}, which warns about any identifier which is
4180 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4181 recommended form for most uses.
4183 Unfortunately, there are some characters which ISO C and ISO C++ allow
4184 in identifiers that when turned into NFC aren't allowable as
4185 identifiers.  That is, there's no way to use these symbols in portable
4186 ISO C or C++ and have all your identifiers in NFC@.
4187 @option{-Wnormalized=id} suppresses the warning for these characters.
4188 It is hoped that future versions of the standards involved will correct
4189 this, which is why this option is not the default.
4191 You can switch the warning off for all characters by writing
4192 @option{-Wnormalized=none}.  You would only want to do this if you
4193 were using some other normalization scheme (like ``D''), because
4194 otherwise you can easily create bugs that are literally impossible to see.
4196 Some characters in ISO 10646 have distinct meanings but look identical
4197 in some fonts or display methodologies, especially once formatting has
4198 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4199 LETTER N'', will display just like a regular @code{n} which has been
4200 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4201 normalization scheme to convert all these into a standard form as
4202 well, and GCC will warn if your code is not in NFKC if you use
4203 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4204 about every identifier that contains the letter O because it might be
4205 confused with the digit 0, and so is not the default, but may be
4206 useful as a local coding convention if the programming environment is
4207 unable to be fixed to display these characters distinctly.
4209 @item -Wno-deprecated
4210 @opindex Wno-deprecated
4211 @opindex Wdeprecated
4212 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4214 @item -Wno-deprecated-declarations
4215 @opindex Wno-deprecated-declarations
4216 @opindex Wdeprecated-declarations
4217 Do not warn about uses of functions (@pxref{Function Attributes}),
4218 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4219 Attributes}) marked as deprecated by using the @code{deprecated}
4220 attribute.
4222 @item -Wno-overflow
4223 @opindex Wno-overflow
4224 @opindex Woverflow
4225 Do not warn about compile-time overflow in constant expressions.
4227 @item -Woverride-init @r{(C and Objective-C only)}
4228 @opindex Woverride-init
4229 @opindex Wno-override-init
4230 @opindex W
4231 @opindex Wextra
4232 @opindex Wno-extra
4233 Warn if an initialized field without side effects is overridden when
4234 using designated initializers (@pxref{Designated Inits, , Designated
4235 Initializers}).
4237 This warning is included in @option{-Wextra}.  To get other
4238 @option{-Wextra} warnings without this one, use @samp{-Wextra
4239 -Wno-override-init}.
4241 @item -Wpacked
4242 @opindex Wpacked
4243 @opindex Wno-packed
4244 Warn if a structure is given the packed attribute, but the packed
4245 attribute has no effect on the layout or size of the structure.
4246 Such structures may be mis-aligned for little benefit.  For
4247 instance, in this code, the variable @code{f.x} in @code{struct bar}
4248 will be misaligned even though @code{struct bar} does not itself
4249 have the packed attribute:
4251 @smallexample
4252 @group
4253 struct foo @{
4254   int x;
4255   char a, b, c, d;
4256 @} __attribute__((packed));
4257 struct bar @{
4258   char z;
4259   struct foo f;
4261 @end group
4262 @end smallexample
4264 @item -Wpacked-bitfield-compat
4265 @opindex Wpacked-bitfield-compat
4266 @opindex Wno-packed-bitfield-compat
4267 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4268 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4269 the change can lead to differences in the structure layout.  GCC
4270 informs you when the offset of such a field has changed in GCC 4.4.
4271 For example there is no longer a 4-bit padding between field @code{a}
4272 and @code{b} in this structure:
4274 @smallexample
4275 struct foo
4277   char a:4;
4278   char b:8;
4279 @} __attribute__ ((packed));
4280 @end smallexample
4282 This warning is enabled by default.  Use
4283 @option{-Wno-packed-bitfield-compat} to disable this warning.
4285 @item -Wpadded
4286 @opindex Wpadded
4287 @opindex Wno-padded
4288 Warn if padding is included in a structure, either to align an element
4289 of the structure or to align the whole structure.  Sometimes when this
4290 happens it is possible to rearrange the fields of the structure to
4291 reduce the padding and so make the structure smaller.
4293 @item -Wredundant-decls
4294 @opindex Wredundant-decls
4295 @opindex Wno-redundant-decls
4296 Warn if anything is declared more than once in the same scope, even in
4297 cases where multiple declaration is valid and changes nothing.
4299 @item -Wnested-externs @r{(C and Objective-C only)}
4300 @opindex Wnested-externs
4301 @opindex Wno-nested-externs
4302 Warn if an @code{extern} declaration is encountered within a function.
4304 @item -Winline
4305 @opindex Winline
4306 @opindex Wno-inline
4307 Warn if a function can not be inlined and it was declared as inline.
4308 Even with this option, the compiler will not warn about failures to
4309 inline functions declared in system headers.
4311 The compiler uses a variety of heuristics to determine whether or not
4312 to inline a function.  For example, the compiler takes into account
4313 the size of the function being inlined and the amount of inlining
4314 that has already been done in the current function.  Therefore,
4315 seemingly insignificant changes in the source program can cause the
4316 warnings produced by @option{-Winline} to appear or disappear.
4318 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4319 @opindex Wno-invalid-offsetof
4320 @opindex Winvalid-offsetof
4321 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4322 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4323 to a non-POD type is undefined.  In existing C++ implementations,
4324 however, @samp{offsetof} typically gives meaningful results even when
4325 applied to certain kinds of non-POD types. (Such as a simple
4326 @samp{struct} that fails to be a POD type only by virtue of having a
4327 constructor.)  This flag is for users who are aware that they are
4328 writing nonportable code and who have deliberately chosen to ignore the
4329 warning about it.
4331 The restrictions on @samp{offsetof} may be relaxed in a future version
4332 of the C++ standard.
4334 @item -Wno-int-to-pointer-cast
4335 @opindex Wno-int-to-pointer-cast
4336 @opindex Wint-to-pointer-cast
4337 Suppress warnings from casts to pointer type of an integer of a
4338 different size. In C++, casting to a pointer type of smaller size is
4339 an error. @option{Wint-to-pointer-cast} is enabled by default.
4342 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4343 @opindex Wno-pointer-to-int-cast
4344 @opindex Wpointer-to-int-cast
4345 Suppress warnings from casts from a pointer to an integer type of a
4346 different size.
4348 @item -Winvalid-pch
4349 @opindex Winvalid-pch
4350 @opindex Wno-invalid-pch
4351 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4352 the search path but can't be used.
4354 @item -Wlong-long
4355 @opindex Wlong-long
4356 @opindex Wno-long-long
4357 Warn if @samp{long long} type is used.  This is enabled by either
4358 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4359 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4361 @item -Wvariadic-macros
4362 @opindex Wvariadic-macros
4363 @opindex Wno-variadic-macros
4364 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4365 alternate syntax when in pedantic ISO C99 mode.  This is default.
4366 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4368 @item -Wvla
4369 @opindex Wvla
4370 @opindex Wno-vla
4371 Warn if variable length array is used in the code.
4372 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4373 the variable length array.
4375 @item -Wvolatile-register-var
4376 @opindex Wvolatile-register-var
4377 @opindex Wno-volatile-register-var
4378 Warn if a register variable is declared volatile.  The volatile
4379 modifier does not inhibit all optimizations that may eliminate reads
4380 and/or writes to register variables.  This warning is enabled by
4381 @option{-Wall}.
4383 @item -Wdisabled-optimization
4384 @opindex Wdisabled-optimization
4385 @opindex Wno-disabled-optimization
4386 Warn if a requested optimization pass is disabled.  This warning does
4387 not generally indicate that there is anything wrong with your code; it
4388 merely indicates that GCC's optimizers were unable to handle the code
4389 effectively.  Often, the problem is that your code is too big or too
4390 complex; GCC will refuse to optimize programs when the optimization
4391 itself is likely to take inordinate amounts of time.
4393 @item -Wpointer-sign @r{(C and Objective-C only)}
4394 @opindex Wpointer-sign
4395 @opindex Wno-pointer-sign
4396 Warn for pointer argument passing or assignment with different signedness.
4397 This option is only supported for C and Objective-C@.  It is implied by
4398 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4399 @option{-Wno-pointer-sign}.
4401 @item -Wstack-protector
4402 @opindex Wstack-protector
4403 @opindex Wno-stack-protector
4404 This option is only active when @option{-fstack-protector} is active.  It
4405 warns about functions that will not be protected against stack smashing.
4407 @item -Wno-mudflap
4408 @opindex Wno-mudflap
4409 Suppress warnings about constructs that cannot be instrumented by
4410 @option{-fmudflap}.
4412 @item -Woverlength-strings
4413 @opindex Woverlength-strings
4414 @opindex Wno-overlength-strings
4415 Warn about string constants which are longer than the ``minimum
4416 maximum'' length specified in the C standard.  Modern compilers
4417 generally allow string constants which are much longer than the
4418 standard's minimum limit, but very portable programs should avoid
4419 using longer strings.
4421 The limit applies @emph{after} string constant concatenation, and does
4422 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4423 C99, it was raised to 4095.  C++98 does not specify a normative
4424 minimum maximum, so we do not diagnose overlength strings in C++@.
4426 This option is implied by @option{-pedantic}, and can be disabled with
4427 @option{-Wno-overlength-strings}.
4429 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4430 @opindex Wunsuffixed-float-constants
4432 GCC will issue a warning for any floating constant that does not have
4433 a suffix.  When used together with @option{-Wsystem-headers} it will
4434 warn about such constants in system header files.  This can be useful
4435 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4436 from the decimal floating-point extension to C99.
4437 @end table
4439 @node Debugging Options
4440 @section Options for Debugging Your Program or GCC
4441 @cindex options, debugging
4442 @cindex debugging information options
4444 GCC has various special options that are used for debugging
4445 either your program or GCC:
4447 @table @gcctabopt
4448 @item -g
4449 @opindex g
4450 Produce debugging information in the operating system's native format
4451 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4452 information.
4454 On most systems that use stabs format, @option{-g} enables use of extra
4455 debugging information that only GDB can use; this extra information
4456 makes debugging work better in GDB but will probably make other debuggers
4457 crash or
4458 refuse to read the program.  If you want to control for certain whether
4459 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4460 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4462 GCC allows you to use @option{-g} with
4463 @option{-O}.  The shortcuts taken by optimized code may occasionally
4464 produce surprising results: some variables you declared may not exist
4465 at all; flow of control may briefly move where you did not expect it;
4466 some statements may not be executed because they compute constant
4467 results or their values were already at hand; some statements may
4468 execute in different places because they were moved out of loops.
4470 Nevertheless it proves possible to debug optimized output.  This makes
4471 it reasonable to use the optimizer for programs that might have bugs.
4473 The following options are useful when GCC is generated with the
4474 capability for more than one debugging format.
4476 @item -ggdb
4477 @opindex ggdb
4478 Produce debugging information for use by GDB@.  This means to use the
4479 most expressive format available (DWARF 2, stabs, or the native format
4480 if neither of those are supported), including GDB extensions if at all
4481 possible.
4483 @item -gstabs
4484 @opindex gstabs
4485 Produce debugging information in stabs format (if that is supported),
4486 without GDB extensions.  This is the format used by DBX on most BSD
4487 systems.  On MIPS, Alpha and System V Release 4 systems this option
4488 produces stabs debugging output which is not understood by DBX or SDB@.
4489 On System V Release 4 systems this option requires the GNU assembler.
4491 @item -feliminate-unused-debug-symbols
4492 @opindex feliminate-unused-debug-symbols
4493 Produce debugging information in stabs format (if that is supported),
4494 for only symbols that are actually used.
4496 @item -femit-class-debug-always
4497 Instead of emitting debugging information for a C++ class in only one
4498 object file, emit it in all object files using the class.  This option
4499 should be used only with debuggers that are unable to handle the way GCC
4500 normally emits debugging information for classes because using this
4501 option will increase the size of debugging information by as much as a
4502 factor of two.
4504 @item -gstabs+
4505 @opindex gstabs+
4506 Produce debugging information in stabs format (if that is supported),
4507 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4508 use of these extensions is likely to make other debuggers crash or
4509 refuse to read the program.
4511 @item -gcoff
4512 @opindex gcoff
4513 Produce debugging information in COFF format (if that is supported).
4514 This is the format used by SDB on most System V systems prior to
4515 System V Release 4.
4517 @item -gxcoff
4518 @opindex gxcoff
4519 Produce debugging information in XCOFF format (if that is supported).
4520 This is the format used by the DBX debugger on IBM RS/6000 systems.
4522 @item -gxcoff+
4523 @opindex gxcoff+
4524 Produce debugging information in XCOFF format (if that is supported),
4525 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4526 use of these extensions is likely to make other debuggers crash or
4527 refuse to read the program, and may cause assemblers other than the GNU
4528 assembler (GAS) to fail with an error.
4530 @item -gdwarf-@var{version}
4531 @opindex gdwarf-@var{version}
4532 Produce debugging information in DWARF format (if that is
4533 supported).  This is the format used by DBX on IRIX 6.  The value
4534 of @var{version} may be either 2, 3 or 4; the default version is 2.
4536 Note that with DWARF version 2 some ports require, and will always
4537 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4539 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4540 for maximum benefit.
4542 @item -gstrict-dwarf
4543 @opindex gstrict-dwarf
4544 Disallow using extensions of later DWARF standard version than selected
4545 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4546 DWARF extensions from later standard versions is allowed.
4548 @item -gno-strict-dwarf
4549 @opindex gno-strict-dwarf
4550 Allow using extensions of later DWARF standard version than selected with
4551 @option{-gdwarf-@var{version}}.
4553 @item -gvms
4554 @opindex gvms
4555 Produce debugging information in VMS debug format (if that is
4556 supported).  This is the format used by DEBUG on VMS systems.
4558 @item -g@var{level}
4559 @itemx -ggdb@var{level}
4560 @itemx -gstabs@var{level}
4561 @itemx -gcoff@var{level}
4562 @itemx -gxcoff@var{level}
4563 @itemx -gvms@var{level}
4564 Request debugging information and also use @var{level} to specify how
4565 much information.  The default level is 2.
4567 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4568 @option{-g}.
4570 Level 1 produces minimal information, enough for making backtraces in
4571 parts of the program that you don't plan to debug.  This includes
4572 descriptions of functions and external variables, but no information
4573 about local variables and no line numbers.
4575 Level 3 includes extra information, such as all the macro definitions
4576 present in the program.  Some debuggers support macro expansion when
4577 you use @option{-g3}.
4579 @option{-gdwarf-2} does not accept a concatenated debug level, because
4580 GCC used to support an option @option{-gdwarf} that meant to generate
4581 debug information in version 1 of the DWARF format (which is very
4582 different from version 2), and it would have been too confusing.  That
4583 debug format is long obsolete, but the option cannot be changed now.
4584 Instead use an additional @option{-g@var{level}} option to change the
4585 debug level for DWARF.
4587 @item -gtoggle
4588 @opindex gtoggle
4589 Turn off generation of debug info, if leaving out this option would have
4590 generated it, or turn it on at level 2 otherwise.  The position of this
4591 argument in the command line does not matter, it takes effect after all
4592 other options are processed, and it does so only once, no matter how
4593 many times it is given.  This is mainly intended to be used with
4594 @option{-fcompare-debug}.
4596 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4597 @opindex fdump-final-insns
4598 Dump the final internal representation (RTL) to @var{file}.  If the
4599 optional argument is omitted (or if @var{file} is @code{.}), the name
4600 of the dump file will be determined by appending @code{.gkd} to the
4601 compilation output file name.
4603 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4604 @opindex fcompare-debug
4605 @opindex fno-compare-debug
4606 If no error occurs during compilation, run the compiler a second time,
4607 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4608 passed to the second compilation.  Dump the final internal
4609 representation in both compilations, and print an error if they differ.
4611 If the equal sign is omitted, the default @option{-gtoggle} is used.
4613 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4614 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4615 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4616 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4617 is used.
4619 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4620 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4621 of the final representation and the second compilation, preventing even
4622 @env{GCC_COMPARE_DEBUG} from taking effect.
4624 To verify full coverage during @option{-fcompare-debug} testing, set
4625 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4626 which GCC will reject as an invalid option in any actual compilation
4627 (rather than preprocessing, assembly or linking).  To get just a
4628 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4629 not overridden} will do.
4631 @item -fcompare-debug-second
4632 @opindex fcompare-debug-second
4633 This option is implicitly passed to the compiler for the second
4634 compilation requested by @option{-fcompare-debug}, along with options to
4635 silence warnings, and omitting other options that would cause
4636 side-effect compiler outputs to files or to the standard output.  Dump
4637 files and preserved temporary files are renamed so as to contain the
4638 @code{.gk} additional extension during the second compilation, to avoid
4639 overwriting those generated by the first.
4641 When this option is passed to the compiler driver, it causes the
4642 @emph{first} compilation to be skipped, which makes it useful for little
4643 other than debugging the compiler proper.
4645 @item -feliminate-dwarf2-dups
4646 @opindex feliminate-dwarf2-dups
4647 Compress DWARF2 debugging information by eliminating duplicated
4648 information about each symbol.  This option only makes sense when
4649 generating DWARF2 debugging information with @option{-gdwarf-2}.
4651 @item -femit-struct-debug-baseonly
4652 Emit debug information for struct-like types
4653 only when the base name of the compilation source file
4654 matches the base name of file in which the struct was defined.
4656 This option substantially reduces the size of debugging information,
4657 but at significant potential loss in type information to the debugger.
4658 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4659 See @option{-femit-struct-debug-detailed} for more detailed control.
4661 This option works only with DWARF 2.
4663 @item -femit-struct-debug-reduced
4664 Emit debug information for struct-like types
4665 only when the base name of the compilation source file
4666 matches the base name of file in which the type was defined,
4667 unless the struct is a template or defined in a system header.
4669 This option significantly reduces the size of debugging information,
4670 with some potential loss in type information to the debugger.
4671 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4672 See @option{-femit-struct-debug-detailed} for more detailed control.
4674 This option works only with DWARF 2.
4676 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4677 Specify the struct-like types
4678 for which the compiler will generate debug information.
4679 The intent is to reduce duplicate struct debug information
4680 between different object files within the same program.
4682 This option is a detailed version of
4683 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4684 which will serve for most needs.
4686 A specification has the syntax
4687 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4689 The optional first word limits the specification to
4690 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4691 A struct type is used directly when it is the type of a variable, member.
4692 Indirect uses arise through pointers to structs.
4693 That is, when use of an incomplete struct would be legal, the use is indirect.
4694 An example is
4695 @samp{struct one direct; struct two * indirect;}.
4697 The optional second word limits the specification to
4698 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4699 Generic structs are a bit complicated to explain.
4700 For C++, these are non-explicit specializations of template classes,
4701 or non-template classes within the above.
4702 Other programming languages have generics,
4703 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4705 The third word specifies the source files for those
4706 structs for which the compiler will emit debug information.
4707 The values @samp{none} and @samp{any} have the normal meaning.
4708 The value @samp{base} means that
4709 the base of name of the file in which the type declaration appears
4710 must match the base of the name of the main compilation file.
4711 In practice, this means that
4712 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4713 but types declared in other header will not.
4714 The value @samp{sys} means those types satisfying @samp{base}
4715 or declared in system or compiler headers.
4717 You may need to experiment to determine the best settings for your application.
4719 The default is @samp{-femit-struct-debug-detailed=all}.
4721 This option works only with DWARF 2.
4723 @item -fenable-icf-debug
4724 @opindex fenable-icf-debug
4725 Generate additional debug information to support identical code folding (ICF).
4726 This option only works with DWARF version 2 or higher.
4728 @item -fno-merge-debug-strings
4729 @opindex fmerge-debug-strings
4730 @opindex fno-merge-debug-strings
4731 Direct the linker to not merge together strings in the debugging
4732 information which are identical in different object files.  Merging is
4733 not supported by all assemblers or linkers.  Merging decreases the size
4734 of the debug information in the output file at the cost of increasing
4735 link processing time.  Merging is enabled by default.
4737 @item -fdebug-prefix-map=@var{old}=@var{new}
4738 @opindex fdebug-prefix-map
4739 When compiling files in directory @file{@var{old}}, record debugging
4740 information describing them as in @file{@var{new}} instead.
4742 @item -fno-dwarf2-cfi-asm
4743 @opindex fdwarf2-cfi-asm
4744 @opindex fno-dwarf2-cfi-asm
4745 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4746 instead of using GAS @code{.cfi_*} directives.
4748 @cindex @command{prof}
4749 @item -p
4750 @opindex p
4751 Generate extra code to write profile information suitable for the
4752 analysis program @command{prof}.  You must use this option when compiling
4753 the source files you want data about, and you must also use it when
4754 linking.
4756 @cindex @command{gprof}
4757 @item -pg
4758 @opindex pg
4759 Generate extra code to write profile information suitable for the
4760 analysis program @command{gprof}.  You must use this option when compiling
4761 the source files you want data about, and you must also use it when
4762 linking.
4764 @item -Q
4765 @opindex Q
4766 Makes the compiler print out each function name as it is compiled, and
4767 print some statistics about each pass when it finishes.
4769 @item -ftime-report
4770 @opindex ftime-report
4771 Makes the compiler print some statistics about the time consumed by each
4772 pass when it finishes.
4774 @item -fmem-report
4775 @opindex fmem-report
4776 Makes the compiler print some statistics about permanent memory
4777 allocation when it finishes.
4779 @item -fpre-ipa-mem-report
4780 @opindex fpre-ipa-mem-report
4781 @item -fpost-ipa-mem-report
4782 @opindex fpost-ipa-mem-report
4783 Makes the compiler print some statistics about permanent memory
4784 allocation before or after interprocedural optimization.
4786 @item -fprofile-arcs
4787 @opindex fprofile-arcs
4788 Add code so that program flow @dfn{arcs} are instrumented.  During
4789 execution the program records how many times each branch and call is
4790 executed and how many times it is taken or returns.  When the compiled
4791 program exits it saves this data to a file called
4792 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4793 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4794 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4795 @var{auxname} is generated from the name of the output file, if
4796 explicitly specified and it is not the final executable, otherwise it is
4797 the basename of the source file.  In both cases any suffix is removed
4798 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4799 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4800 @xref{Cross-profiling}.
4802 @cindex @command{gcov}
4803 @item --coverage
4804 @opindex coverage
4806 This option is used to compile and link code instrumented for coverage
4807 analysis.  The option is a synonym for @option{-fprofile-arcs}
4808 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4809 linking).  See the documentation for those options for more details.
4811 @itemize
4813 @item
4814 Compile the source files with @option{-fprofile-arcs} plus optimization
4815 and code generation options.  For test coverage analysis, use the
4816 additional @option{-ftest-coverage} option.  You do not need to profile
4817 every source file in a program.
4819 @item
4820 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4821 (the latter implies the former).
4823 @item
4824 Run the program on a representative workload to generate the arc profile
4825 information.  This may be repeated any number of times.  You can run
4826 concurrent instances of your program, and provided that the file system
4827 supports locking, the data files will be correctly updated.  Also
4828 @code{fork} calls are detected and correctly handled (double counting
4829 will not happen).
4831 @item
4832 For profile-directed optimizations, compile the source files again with
4833 the same optimization and code generation options plus
4834 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4835 Control Optimization}).
4837 @item
4838 For test coverage analysis, use @command{gcov} to produce human readable
4839 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4840 @command{gcov} documentation for further information.
4842 @end itemize
4844 With @option{-fprofile-arcs}, for each function of your program GCC
4845 creates a program flow graph, then finds a spanning tree for the graph.
4846 Only arcs that are not on the spanning tree have to be instrumented: the
4847 compiler adds code to count the number of times that these arcs are
4848 executed.  When an arc is the only exit or only entrance to a block, the
4849 instrumentation code can be added to the block; otherwise, a new basic
4850 block must be created to hold the instrumentation code.
4852 @need 2000
4853 @item -ftest-coverage
4854 @opindex ftest-coverage
4855 Produce a notes file that the @command{gcov} code-coverage utility
4856 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4857 show program coverage.  Each source file's note file is called
4858 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4859 above for a description of @var{auxname} and instructions on how to
4860 generate test coverage data.  Coverage data will match the source files
4861 more closely, if you do not optimize.
4863 @item -fdbg-cnt-list
4864 @opindex fdbg-cnt-list
4865 Print the name and the counter upperbound for all debug counters.
4867 @item -fdbg-cnt=@var{counter-value-list}
4868 @opindex fdbg-cnt
4869 Set the internal debug counter upperbound. @var{counter-value-list}
4870 is a comma-separated list of @var{name}:@var{value} pairs
4871 which sets the upperbound of each debug counter @var{name} to @var{value}.
4872 All debug counters have the initial upperbound of @var{UINT_MAX},
4873 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4874 e.g. With -fdbg-cnt=dce:10,tail_call:0
4875 dbg_cnt(dce) will return true only for first 10 invocations
4876 and dbg_cnt(tail_call) will return false always.
4878 @item -d@var{letters}
4879 @itemx -fdump-rtl-@var{pass}
4880 @opindex d
4881 Says to make debugging dumps during compilation at times specified by
4882 @var{letters}.  This is used for debugging the RTL-based passes of the
4883 compiler.  The file names for most of the dumps are made by appending
4884 a pass number and a word to the @var{dumpname}, and the files are
4885 created in the directory of the output file.  @var{dumpname} is
4886 generated from the name of the output file, if explicitly specified
4887 and it is not an executable, otherwise it is the basename of the
4888 source file. These switches may have different effects when
4889 @option{-E} is used for preprocessing.
4891 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4892 @option{-d} option @var{letters}.  Here are the possible
4893 letters for use in @var{pass} and @var{letters}, and their meanings:
4895 @table @gcctabopt
4897 @item -fdump-rtl-alignments
4898 @opindex fdump-rtl-alignments
4899 Dump after branch alignments have been computed.
4901 @item -fdump-rtl-asmcons
4902 @opindex fdump-rtl-asmcons
4903 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4905 @item -fdump-rtl-auto_inc_dec
4906 @opindex fdump-rtl-auto_inc_dec
4907 Dump after auto-inc-dec discovery.  This pass is only run on
4908 architectures that have auto inc or auto dec instructions.
4910 @item -fdump-rtl-barriers
4911 @opindex fdump-rtl-barriers
4912 Dump after cleaning up the barrier instructions.
4914 @item -fdump-rtl-bbpart
4915 @opindex fdump-rtl-bbpart
4916 Dump after partitioning hot and cold basic blocks.
4918 @item -fdump-rtl-bbro
4919 @opindex fdump-rtl-bbro
4920 Dump after block reordering.
4922 @item -fdump-rtl-btl1
4923 @itemx -fdump-rtl-btl2
4924 @opindex fdump-rtl-btl2
4925 @opindex fdump-rtl-btl2
4926 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4927 after the two branch
4928 target load optimization passes.
4930 @item -fdump-rtl-bypass
4931 @opindex fdump-rtl-bypass
4932 Dump after jump bypassing and control flow optimizations.
4934 @item -fdump-rtl-combine
4935 @opindex fdump-rtl-combine
4936 Dump after the RTL instruction combination pass.
4938 @item -fdump-rtl-compgotos
4939 @opindex fdump-rtl-compgotos
4940 Dump after duplicating the computed gotos.
4942 @item -fdump-rtl-ce1
4943 @itemx -fdump-rtl-ce2
4944 @itemx -fdump-rtl-ce3
4945 @opindex fdump-rtl-ce1
4946 @opindex fdump-rtl-ce2
4947 @opindex fdump-rtl-ce3
4948 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
4949 @option{-fdump-rtl-ce3} enable dumping after the three
4950 if conversion passes.
4952 @itemx -fdump-rtl-cprop_hardreg
4953 @opindex fdump-rtl-cprop_hardreg
4954 Dump after hard register copy propagation.
4956 @itemx -fdump-rtl-csa
4957 @opindex fdump-rtl-csa
4958 Dump after combining stack adjustments.
4960 @item -fdump-rtl-cse1
4961 @itemx -fdump-rtl-cse2
4962 @opindex fdump-rtl-cse1
4963 @opindex fdump-rtl-cse2
4964 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
4965 the two common sub-expression elimination passes.
4967 @itemx -fdump-rtl-dce
4968 @opindex fdump-rtl-dce
4969 Dump after the standalone dead code elimination passes.
4971 @itemx -fdump-rtl-dbr
4972 @opindex fdump-rtl-dbr
4973 Dump after delayed branch scheduling.
4975 @item -fdump-rtl-dce1
4976 @itemx -fdump-rtl-dce2
4977 @opindex fdump-rtl-dce1
4978 @opindex fdump-rtl-dce2
4979 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
4980 the two dead store elimination passes.
4982 @item -fdump-rtl-eh
4983 @opindex fdump-rtl-eh
4984 Dump after finalization of EH handling code.
4986 @item -fdump-rtl-eh_ranges
4987 @opindex fdump-rtl-eh_ranges
4988 Dump after conversion of EH handling range regions.
4990 @item -fdump-rtl-expand
4991 @opindex fdump-rtl-expand
4992 Dump after RTL generation.
4994 @item -fdump-rtl-fwprop1
4995 @itemx -fdump-rtl-fwprop2
4996 @opindex fdump-rtl-fwprop1
4997 @opindex fdump-rtl-fwprop2
4998 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
4999 dumping after the two forward propagation passes.
5001 @item -fdump-rtl-gcse1
5002 @itemx -fdump-rtl-gcse2
5003 @opindex fdump-rtl-gcse1
5004 @opindex fdump-rtl-gcse2
5005 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5006 after global common subexpression elimination.
5008 @item -fdump-rtl-init-regs
5009 @opindex fdump-rtl-init-regs
5010 Dump after the initialization of the registers.
5012 @item -fdump-rtl-initvals
5013 @opindex fdump-rtl-initvals
5014 Dump after the computation of the initial value sets.
5016 @itemx -fdump-rtl-into_cfglayout
5017 @opindex fdump-rtl-into_cfglayout
5018 Dump after converting to cfglayout mode.
5020 @item -fdump-rtl-ira
5021 @opindex fdump-rtl-ira
5022 Dump after iterated register allocation.
5024 @item -fdump-rtl-jump
5025 @opindex fdump-rtl-jump
5026 Dump after the second jump optimization.
5028 @item -fdump-rtl-loop2
5029 @opindex fdump-rtl-loop2
5030 @option{-fdump-rtl-loop2} enables dumping after the rtl
5031 loop optimization passes.
5033 @item -fdump-rtl-mach
5034 @opindex fdump-rtl-mach
5035 Dump after performing the machine dependent reorganization pass, if that
5036 pass exists.
5038 @item -fdump-rtl-mode_sw
5039 @opindex fdump-rtl-mode_sw
5040 Dump after removing redundant mode switches.
5042 @item -fdump-rtl-rnreg
5043 @opindex fdump-rtl-rnreg
5044 Dump after register renumbering.
5046 @itemx -fdump-rtl-outof_cfglayout
5047 @opindex fdump-rtl-outof_cfglayout
5048 Dump after converting from cfglayout mode.
5050 @item -fdump-rtl-peephole2
5051 @opindex fdump-rtl-peephole2
5052 Dump after the peephole pass.
5054 @item -fdump-rtl-postreload
5055 @opindex fdump-rtl-postreload
5056 Dump after post-reload optimizations.
5058 @itemx -fdump-rtl-pro_and_epilogue
5059 @opindex fdump-rtl-pro_and_epilogue
5060 Dump after generating the function pro and epilogues.
5062 @item -fdump-rtl-regmove
5063 @opindex fdump-rtl-regmove
5064 Dump after the register move pass.
5066 @item -fdump-rtl-sched1
5067 @itemx -fdump-rtl-sched2
5068 @opindex fdump-rtl-sched1
5069 @opindex fdump-rtl-sched2
5070 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5071 after the basic block scheduling passes.
5073 @item -fdump-rtl-see
5074 @opindex fdump-rtl-see
5075 Dump after sign extension elimination.
5077 @item -fdump-rtl-seqabstr
5078 @opindex fdump-rtl-seqabstr
5079 Dump after common sequence discovery.
5081 @item -fdump-rtl-shorten
5082 @opindex fdump-rtl-shorten
5083 Dump after shortening branches.
5085 @item -fdump-rtl-sibling
5086 @opindex fdump-rtl-sibling
5087 Dump after sibling call optimizations.
5089 @item -fdump-rtl-split1
5090 @itemx -fdump-rtl-split2
5091 @itemx -fdump-rtl-split3
5092 @itemx -fdump-rtl-split4
5093 @itemx -fdump-rtl-split5
5094 @opindex fdump-rtl-split1
5095 @opindex fdump-rtl-split2
5096 @opindex fdump-rtl-split3
5097 @opindex fdump-rtl-split4
5098 @opindex fdump-rtl-split5
5099 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5100 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5101 @option{-fdump-rtl-split5} enable dumping after five rounds of
5102 instruction splitting.
5104 @item -fdump-rtl-sms
5105 @opindex fdump-rtl-sms
5106 Dump after modulo scheduling.  This pass is only run on some
5107 architectures.
5109 @item -fdump-rtl-stack
5110 @opindex fdump-rtl-stack
5111 Dump after conversion from GCC's "flat register file" registers to the
5112 x87's stack-like registers.  This pass is only run on x86 variants.
5114 @item -fdump-rtl-subreg1
5115 @itemx -fdump-rtl-subreg2
5116 @opindex fdump-rtl-subreg1
5117 @opindex fdump-rtl-subreg2
5118 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5119 the two subreg expansion passes.
5121 @item -fdump-rtl-unshare
5122 @opindex fdump-rtl-unshare
5123 Dump after all rtl has been unshared.
5125 @item -fdump-rtl-vartrack
5126 @opindex fdump-rtl-vartrack
5127 Dump after variable tracking.
5129 @item -fdump-rtl-vregs
5130 @opindex fdump-rtl-vregs
5131 Dump after converting virtual registers to hard registers.
5133 @item -fdump-rtl-web
5134 @opindex fdump-rtl-web
5135 Dump after live range splitting.
5137 @item -fdump-rtl-regclass
5138 @itemx -fdump-rtl-subregs_of_mode_init
5139 @itemx -fdump-rtl-subregs_of_mode_finish
5140 @itemx -fdump-rtl-dfinit
5141 @itemx -fdump-rtl-dfinish
5142 @opindex fdump-rtl-regclass
5143 @opindex fdump-rtl-subregs_of_mode_init
5144 @opindex fdump-rtl-subregs_of_mode_finish
5145 @opindex fdump-rtl-dfinit
5146 @opindex fdump-rtl-dfinish
5147 These dumps are defined but always produce empty files.
5149 @item -fdump-rtl-all
5150 @opindex fdump-rtl-all
5151 Produce all the dumps listed above.
5153 @item -dA
5154 @opindex dA
5155 Annotate the assembler output with miscellaneous debugging information.
5157 @item -dD
5158 @opindex dD
5159 Dump all macro definitions, at the end of preprocessing, in addition to
5160 normal output.
5162 @item -dH
5163 @opindex dH
5164 Produce a core dump whenever an error occurs.
5166 @item -dm
5167 @opindex dm
5168 Print statistics on memory usage, at the end of the run, to
5169 standard error.
5171 @item -dp
5172 @opindex dp
5173 Annotate the assembler output with a comment indicating which
5174 pattern and alternative was used.  The length of each instruction is
5175 also printed.
5177 @item -dP
5178 @opindex dP
5179 Dump the RTL in the assembler output as a comment before each instruction.
5180 Also turns on @option{-dp} annotation.
5182 @item -dv
5183 @opindex dv
5184 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5185 dump a representation of the control flow graph suitable for viewing with VCG
5186 to @file{@var{file}.@var{pass}.vcg}.
5188 @item -dx
5189 @opindex dx
5190 Just generate RTL for a function instead of compiling it.  Usually used
5191 with @option{-fdump-rtl-expand}.
5193 @item -dy
5194 @opindex dy
5195 Dump debugging information during parsing, to standard error.
5196 @end table
5198 @item -fdump-noaddr
5199 @opindex fdump-noaddr
5200 When doing debugging dumps, suppress address output.  This makes it more
5201 feasible to use diff on debugging dumps for compiler invocations with
5202 different compiler binaries and/or different
5203 text / bss / data / heap / stack / dso start locations.
5205 @item -fdump-unnumbered
5206 @opindex fdump-unnumbered
5207 When doing debugging dumps, suppress instruction numbers and address output.
5208 This makes it more feasible to use diff on debugging dumps for compiler
5209 invocations with different options, in particular with and without
5210 @option{-g}.
5212 @item -fdump-unnumbered-links
5213 @opindex fdump-unnumbered-links
5214 When doing debugging dumps (see @option{-d} option above), suppress
5215 instruction numbers for the links to the previous and next instructions
5216 in a sequence.
5218 @item -fdump-translation-unit @r{(C++ only)}
5219 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5220 @opindex fdump-translation-unit
5221 Dump a representation of the tree structure for the entire translation
5222 unit to a file.  The file name is made by appending @file{.tu} to the
5223 source file name, and the file is created in the same directory as the
5224 output file.  If the @samp{-@var{options}} form is used, @var{options}
5225 controls the details of the dump as described for the
5226 @option{-fdump-tree} options.
5228 @item -fdump-class-hierarchy @r{(C++ only)}
5229 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5230 @opindex fdump-class-hierarchy
5231 Dump a representation of each class's hierarchy and virtual function
5232 table layout to a file.  The file name is made by appending
5233 @file{.class} to the source file name, and the file is created in the
5234 same directory as the output file.  If the @samp{-@var{options}} form
5235 is used, @var{options} controls the details of the dump as described
5236 for the @option{-fdump-tree} options.
5238 @item -fdump-ipa-@var{switch}
5239 @opindex fdump-ipa
5240 Control the dumping at various stages of inter-procedural analysis
5241 language tree to a file.  The file name is generated by appending a
5242 switch specific suffix to the source file name, and the file is created
5243 in the same directory as the output file.  The following dumps are
5244 possible:
5246 @table @samp
5247 @item all
5248 Enables all inter-procedural analysis dumps.
5250 @item cgraph
5251 Dumps information about call-graph optimization, unused function removal,
5252 and inlining decisions.
5254 @item inline
5255 Dump after function inlining.
5257 @end table
5259 @item -fdump-statistics-@var{option}
5260 @opindex fdump-statistics
5261 Enable and control dumping of pass statistics in a separate file.  The
5262 file name is generated by appending a suffix ending in
5263 @samp{.statistics} to the source file name, and the file is created in
5264 the same directory as the output file.  If the @samp{-@var{option}}
5265 form is used, @samp{-stats} will cause counters to be summed over the
5266 whole compilation unit while @samp{-details} will dump every event as
5267 the passes generate them.  The default with no option is to sum
5268 counters for each function compiled.
5270 @item -fdump-tree-@var{switch}
5271 @itemx -fdump-tree-@var{switch}-@var{options}
5272 @opindex fdump-tree
5273 Control the dumping at various stages of processing the intermediate
5274 language tree to a file.  The file name is generated by appending a
5275 switch specific suffix to the source file name, and the file is
5276 created in the same directory as the output file.  If the
5277 @samp{-@var{options}} form is used, @var{options} is a list of
5278 @samp{-} separated options that control the details of the dump.  Not
5279 all options are applicable to all dumps, those which are not
5280 meaningful will be ignored.  The following options are available
5282 @table @samp
5283 @item address
5284 Print the address of each node.  Usually this is not meaningful as it
5285 changes according to the environment and source file.  Its primary use
5286 is for tying up a dump file with a debug environment.
5287 @item asmname
5288 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5289 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5290 use working backward from mangled names in the assembly file.
5291 @item slim
5292 Inhibit dumping of members of a scope or body of a function merely
5293 because that scope has been reached.  Only dump such items when they
5294 are directly reachable by some other path.  When dumping pretty-printed
5295 trees, this option inhibits dumping the bodies of control structures.
5296 @item raw
5297 Print a raw representation of the tree.  By default, trees are
5298 pretty-printed into a C-like representation.
5299 @item details
5300 Enable more detailed dumps (not honored by every dump option).
5301 @item stats
5302 Enable dumping various statistics about the pass (not honored by every dump
5303 option).
5304 @item blocks
5305 Enable showing basic block boundaries (disabled in raw dumps).
5306 @item vops
5307 Enable showing virtual operands for every statement.
5308 @item lineno
5309 Enable showing line numbers for statements.
5310 @item uid
5311 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5312 @item verbose
5313 Enable showing the tree dump for each statement.
5314 @item eh
5315 Enable showing the EH region number holding each statement.
5316 @item all
5317 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5318 and @option{lineno}.
5319 @end table
5321 The following tree dumps are possible:
5322 @table @samp
5324 @item original
5325 @opindex fdump-tree-original
5326 Dump before any tree based optimization, to @file{@var{file}.original}.
5328 @item optimized
5329 @opindex fdump-tree-optimized
5330 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5332 @item gimple
5333 @opindex fdump-tree-gimple
5334 Dump each function before and after the gimplification pass to a file.  The
5335 file name is made by appending @file{.gimple} to the source file name.
5337 @item cfg
5338 @opindex fdump-tree-cfg
5339 Dump the control flow graph of each function to a file.  The file name is
5340 made by appending @file{.cfg} to the source file name.
5342 @item vcg
5343 @opindex fdump-tree-vcg
5344 Dump the control flow graph of each function to a file in VCG format.  The
5345 file name is made by appending @file{.vcg} to the source file name.  Note
5346 that if the file contains more than one function, the generated file cannot
5347 be used directly by VCG@.  You will need to cut and paste each function's
5348 graph into its own separate file first.
5350 @item ch
5351 @opindex fdump-tree-ch
5352 Dump each function after copying loop headers.  The file name is made by
5353 appending @file{.ch} to the source file name.
5355 @item ssa
5356 @opindex fdump-tree-ssa
5357 Dump SSA related information to a file.  The file name is made by appending
5358 @file{.ssa} to the source file name.
5360 @item alias
5361 @opindex fdump-tree-alias
5362 Dump aliasing information for each function.  The file name is made by
5363 appending @file{.alias} to the source file name.
5365 @item ccp
5366 @opindex fdump-tree-ccp
5367 Dump each function after CCP@.  The file name is made by appending
5368 @file{.ccp} to the source file name.
5370 @item storeccp
5371 @opindex fdump-tree-storeccp
5372 Dump each function after STORE-CCP@.  The file name is made by appending
5373 @file{.storeccp} to the source file name.
5375 @item pre
5376 @opindex fdump-tree-pre
5377 Dump trees after partial redundancy elimination.  The file name is made
5378 by appending @file{.pre} to the source file name.
5380 @item fre
5381 @opindex fdump-tree-fre
5382 Dump trees after full redundancy elimination.  The file name is made
5383 by appending @file{.fre} to the source file name.
5385 @item copyprop
5386 @opindex fdump-tree-copyprop
5387 Dump trees after copy propagation.  The file name is made
5388 by appending @file{.copyprop} to the source file name.
5390 @item store_copyprop
5391 @opindex fdump-tree-store_copyprop
5392 Dump trees after store copy-propagation.  The file name is made
5393 by appending @file{.store_copyprop} to the source file name.
5395 @item dce
5396 @opindex fdump-tree-dce
5397 Dump each function after dead code elimination.  The file name is made by
5398 appending @file{.dce} to the source file name.
5400 @item mudflap
5401 @opindex fdump-tree-mudflap
5402 Dump each function after adding mudflap instrumentation.  The file name is
5403 made by appending @file{.mudflap} to the source file name.
5405 @item sra
5406 @opindex fdump-tree-sra
5407 Dump each function after performing scalar replacement of aggregates.  The
5408 file name is made by appending @file{.sra} to the source file name.
5410 @item sink
5411 @opindex fdump-tree-sink
5412 Dump each function after performing code sinking.  The file name is made
5413 by appending @file{.sink} to the source file name.
5415 @item dom
5416 @opindex fdump-tree-dom
5417 Dump each function after applying dominator tree optimizations.  The file
5418 name is made by appending @file{.dom} to the source file name.
5420 @item dse
5421 @opindex fdump-tree-dse
5422 Dump each function after applying dead store elimination.  The file
5423 name is made by appending @file{.dse} to the source file name.
5425 @item phiopt
5426 @opindex fdump-tree-phiopt
5427 Dump each function after optimizing PHI nodes into straightline code.  The file
5428 name is made by appending @file{.phiopt} to the source file name.
5430 @item forwprop
5431 @opindex fdump-tree-forwprop
5432 Dump each function after forward propagating single use variables.  The file
5433 name is made by appending @file{.forwprop} to the source file name.
5435 @item copyrename
5436 @opindex fdump-tree-copyrename
5437 Dump each function after applying the copy rename optimization.  The file
5438 name is made by appending @file{.copyrename} to the source file name.
5440 @item nrv
5441 @opindex fdump-tree-nrv
5442 Dump each function after applying the named return value optimization on
5443 generic trees.  The file name is made by appending @file{.nrv} to the source
5444 file name.
5446 @item vect
5447 @opindex fdump-tree-vect
5448 Dump each function after applying vectorization of loops.  The file name is
5449 made by appending @file{.vect} to the source file name.
5451 @item slp
5452 @opindex fdump-tree-slp
5453 Dump each function after applying vectorization of basic blocks.  The file name
5454 is made by appending @file{.slp} to the source file name.
5456 @item vrp
5457 @opindex fdump-tree-vrp
5458 Dump each function after Value Range Propagation (VRP).  The file name
5459 is made by appending @file{.vrp} to the source file name.
5461 @item all
5462 @opindex fdump-tree-all
5463 Enable all the available tree dumps with the flags provided in this option.
5464 @end table
5466 @item -ftree-vectorizer-verbose=@var{n}
5467 @opindex ftree-vectorizer-verbose
5468 This option controls the amount of debugging output the vectorizer prints.
5469 This information is written to standard error, unless
5470 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5471 in which case it is output to the usual dump listing file, @file{.vect}.
5472 For @var{n}=0 no diagnostic information is reported.
5473 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5474 and the total number of loops that got vectorized.
5475 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5476 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5477 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5478 level that @option{-fdump-tree-vect-stats} uses.
5479 Higher verbosity levels mean either more information dumped for each
5480 reported loop, or same amount of information reported for more loops:
5481 if @var{n}=3, vectorizer cost model information is reported.
5482 If @var{n}=4, alignment related information is added to the reports.
5483 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5484 memory access-patterns) is added to the reports.
5485 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5486 that did not pass the first analysis phase (i.e., may not be countable, or
5487 may have complicated control-flow).
5488 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5489 If @var{n}=8, SLP related information is added to the reports.
5490 For @var{n}=9, all the information the vectorizer generates during its
5491 analysis and transformation is reported.  This is the same verbosity level
5492 that @option{-fdump-tree-vect-details} uses.
5494 @item -frandom-seed=@var{string}
5495 @opindex frandom-seed
5496 This option provides a seed that GCC uses when it would otherwise use
5497 random numbers.  It is used to generate certain symbol names
5498 that have to be different in every compiled file.  It is also used to
5499 place unique stamps in coverage data files and the object files that
5500 produce them.  You can use the @option{-frandom-seed} option to produce
5501 reproducibly identical object files.
5503 The @var{string} should be different for every file you compile.
5505 @item -fsched-verbose=@var{n}
5506 @opindex fsched-verbose
5507 On targets that use instruction scheduling, this option controls the
5508 amount of debugging output the scheduler prints.  This information is
5509 written to standard error, unless @option{-fdump-rtl-sched1} or
5510 @option{-fdump-rtl-sched2} is specified, in which case it is output
5511 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5512 respectively.  However for @var{n} greater than nine, the output is
5513 always printed to standard error.
5515 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5516 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5517 For @var{n} greater than one, it also output basic block probabilities,
5518 detailed ready list information and unit/insn info.  For @var{n} greater
5519 than two, it includes RTL at abort point, control-flow and regions info.
5520 And for @var{n} over four, @option{-fsched-verbose} also includes
5521 dependence info.
5523 @item -save-temps
5524 @itemx -save-temps=cwd
5525 @opindex save-temps
5526 Store the usual ``temporary'' intermediate files permanently; place them
5527 in the current directory and name them based on the source file.  Thus,
5528 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5529 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5530 preprocessed @file{foo.i} output file even though the compiler now
5531 normally uses an integrated preprocessor.
5533 When used in combination with the @option{-x} command line option,
5534 @option{-save-temps} is sensible enough to avoid over writing an
5535 input source file with the same extension as an intermediate file.
5536 The corresponding intermediate file may be obtained by renaming the
5537 source file before using @option{-save-temps}.
5539 If you invoke GCC in parallel, compiling several different source
5540 files that share a common base name in different subdirectories or the
5541 same source file compiled for multiple output destinations, it is
5542 likely that the different parallel compilers will interfere with each
5543 other, and overwrite the temporary files.  For instance:
5545 @smallexample
5546 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5547 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5548 @end smallexample
5550 may result in @file{foo.i} and @file{foo.o} being written to
5551 simultaneously by both compilers.
5553 @item -save-temps=obj
5554 @opindex save-temps=obj
5555 Store the usual ``temporary'' intermediate files permanently.  If the
5556 @option{-o} option is used, the temporary files are based on the
5557 object file.  If the @option{-o} option is not used, the
5558 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5560 For example:
5562 @smallexample
5563 gcc -save-temps=obj -c foo.c
5564 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5565 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5566 @end smallexample
5568 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5569 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5570 @file{dir2/yfoobar.o}.
5572 @item -time@r{[}=@var{file}@r{]}
5573 @opindex time
5574 Report the CPU time taken by each subprocess in the compilation
5575 sequence.  For C source files, this is the compiler proper and assembler
5576 (plus the linker if linking is done).
5578 Without the specification of an output file, the output looks like this:
5580 @smallexample
5581 # cc1 0.12 0.01
5582 # as 0.00 0.01
5583 @end smallexample
5585 The first number on each line is the ``user time'', that is time spent
5586 executing the program itself.  The second number is ``system time'',
5587 time spent executing operating system routines on behalf of the program.
5588 Both numbers are in seconds.
5590 With the specification of an output file, the output is appended to the
5591 named file, and it looks like this:
5593 @smallexample
5594 0.12 0.01 cc1 @var{options}
5595 0.00 0.01 as @var{options}
5596 @end smallexample
5598 The ``user time'' and the ``system time'' are moved before the program
5599 name, and the options passed to the program are displayed, so that one
5600 can later tell what file was being compiled, and with which options.
5602 @item -fvar-tracking
5603 @opindex fvar-tracking
5604 Run variable tracking pass.  It computes where variables are stored at each
5605 position in code.  Better debugging information is then generated
5606 (if the debugging information format supports this information).
5608 It is enabled by default when compiling with optimization (@option{-Os},
5609 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5610 the debug info format supports it.
5612 @item -fvar-tracking-assignments
5613 @opindex fvar-tracking-assignments
5614 @opindex fno-var-tracking-assignments
5615 Annotate assignments to user variables early in the compilation and
5616 attempt to carry the annotations over throughout the compilation all the
5617 way to the end, in an attempt to improve debug information while
5618 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5620 It can be enabled even if var-tracking is disabled, in which case
5621 annotations will be created and maintained, but discarded at the end.
5623 @item -fvar-tracking-assignments-toggle
5624 @opindex fvar-tracking-assignments-toggle
5625 @opindex fno-var-tracking-assignments-toggle
5626 Toggle @option{-fvar-tracking-assignments}, in the same way that
5627 @option{-gtoggle} toggles @option{-g}.
5629 @item -print-file-name=@var{library}
5630 @opindex print-file-name
5631 Print the full absolute name of the library file @var{library} that
5632 would be used when linking---and don't do anything else.  With this
5633 option, GCC does not compile or link anything; it just prints the
5634 file name.
5636 @item -print-multi-directory
5637 @opindex print-multi-directory
5638 Print the directory name corresponding to the multilib selected by any
5639 other switches present in the command line.  This directory is supposed
5640 to exist in @env{GCC_EXEC_PREFIX}.
5642 @item -print-multi-lib
5643 @opindex print-multi-lib
5644 Print the mapping from multilib directory names to compiler switches
5645 that enable them.  The directory name is separated from the switches by
5646 @samp{;}, and each switch starts with an @samp{@@} instead of the
5647 @samp{-}, without spaces between multiple switches.  This is supposed to
5648 ease shell-processing.
5650 @item -print-multi-os-directory
5651 @opindex print-multi-os-directory
5652 Print the path to OS libraries for the selected
5653 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
5654 present in the @file{lib} subdirectory and no multilibs are used, this is
5655 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5656 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5657 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5658 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5660 @item -print-prog-name=@var{program}
5661 @opindex print-prog-name
5662 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5664 @item -print-libgcc-file-name
5665 @opindex print-libgcc-file-name
5666 Same as @option{-print-file-name=libgcc.a}.
5668 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5669 but you do want to link with @file{libgcc.a}.  You can do
5671 @smallexample
5672 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5673 @end smallexample
5675 @item -print-search-dirs
5676 @opindex print-search-dirs
5677 Print the name of the configured installation directory and a list of
5678 program and library directories @command{gcc} will search---and don't do anything else.
5680 This is useful when @command{gcc} prints the error message
5681 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5682 To resolve this you either need to put @file{cpp0} and the other compiler
5683 components where @command{gcc} expects to find them, or you can set the environment
5684 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5685 Don't forget the trailing @samp{/}.
5686 @xref{Environment Variables}.
5688 @item -print-sysroot
5689 @opindex print-sysroot
5690 Print the target sysroot directory that will be used during
5691 compilation.  This is the target sysroot specified either at configure
5692 time or using the @option{--sysroot} option, possibly with an extra
5693 suffix that depends on compilation options.  If no target sysroot is
5694 specified, the option prints nothing.
5696 @item -print-sysroot-headers-suffix
5697 @opindex print-sysroot-headers-suffix
5698 Print the suffix added to the target sysroot when searching for
5699 headers, or give an error if the compiler is not configured with such
5700 a suffix---and don't do anything else.
5702 @item -dumpmachine
5703 @opindex dumpmachine
5704 Print the compiler's target machine (for example,
5705 @samp{i686-pc-linux-gnu})---and don't do anything else.
5707 @item -dumpversion
5708 @opindex dumpversion
5709 Print the compiler version (for example, @samp{3.0})---and don't do
5710 anything else.
5712 @item -dumpspecs
5713 @opindex dumpspecs
5714 Print the compiler's built-in specs---and don't do anything else.  (This
5715 is used when GCC itself is being built.)  @xref{Spec Files}.
5717 @item -feliminate-unused-debug-types
5718 @opindex feliminate-unused-debug-types
5719 Normally, when producing DWARF2 output, GCC will emit debugging
5720 information for all types declared in a compilation
5721 unit, regardless of whether or not they are actually used
5722 in that compilation unit.  Sometimes this is useful, such as
5723 if, in the debugger, you want to cast a value to a type that is
5724 not actually used in your program (but is declared).  More often,
5725 however, this results in a significant amount of wasted space.
5726 With this option, GCC will avoid producing debug symbol output
5727 for types that are nowhere used in the source file being compiled.
5728 @end table
5730 @node Optimize Options
5731 @section Options That Control Optimization
5732 @cindex optimize options
5733 @cindex options, optimization
5735 These options control various sorts of optimizations.
5737 Without any optimization option, the compiler's goal is to reduce the
5738 cost of compilation and to make debugging produce the expected
5739 results.  Statements are independent: if you stop the program with a
5740 breakpoint between statements, you can then assign a new value to any
5741 variable or change the program counter to any other statement in the
5742 function and get exactly the results you would expect from the source
5743 code.
5745 Turning on optimization flags makes the compiler attempt to improve
5746 the performance and/or code size at the expense of compilation time
5747 and possibly the ability to debug the program.
5749 The compiler performs optimization based on the knowledge it has of the
5750 program.  Compiling multiple files at once to a single output file mode allows
5751 the compiler to use information gained from all of the files when compiling
5752 each of them.
5754 Not all optimizations are controlled directly by a flag.  Only
5755 optimizations that have a flag are listed in this section.
5757 Most optimizations are only enabled if an @option{-O} level is set on
5758 the command line.  Otherwise they are disabled, even if individual             
5759 optimization flags are specified.
5761 Depending on the target and how GCC was configured, a slightly different
5762 set of optimizations may be enabled at each @option{-O} level than
5763 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5764 to find out the exact set of optimizations that are enabled at each level.
5765 @xref{Overall Options}, for examples.
5767 @table @gcctabopt
5768 @item -O
5769 @itemx -O1
5770 @opindex O
5771 @opindex O1
5772 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5773 more memory for a large function.
5775 With @option{-O}, the compiler tries to reduce code size and execution
5776 time, without performing any optimizations that take a great deal of
5777 compilation time.
5779 @option{-O} turns on the following optimization flags:
5780 @gccoptlist{
5781 -fauto-inc-dec @gol
5782 -fcprop-registers @gol
5783 -fdce @gol
5784 -fdefer-pop @gol
5785 -fdelayed-branch @gol
5786 -fdse @gol
5787 -fguess-branch-probability @gol
5788 -fif-conversion2 @gol
5789 -fif-conversion @gol
5790 -fipa-pure-const @gol
5791 -fipa-profile @gol
5792 -fipa-reference @gol
5793 -fmerge-constants
5794 -fsplit-wide-types @gol
5795 -ftree-builtin-call-dce @gol
5796 -ftree-ccp @gol
5797 -ftree-ch @gol
5798 -ftree-copyrename @gol
5799 -ftree-dce @gol
5800 -ftree-dominator-opts @gol
5801 -ftree-dse @gol
5802 -ftree-forwprop @gol
5803 -ftree-fre @gol
5804 -ftree-phiprop @gol
5805 -ftree-sra @gol
5806 -ftree-pta @gol
5807 -ftree-ter @gol
5808 -funit-at-a-time}
5810 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5811 where doing so does not interfere with debugging.
5813 @item -O2
5814 @opindex O2
5815 Optimize even more.  GCC performs nearly all supported optimizations
5816 that do not involve a space-speed tradeoff.
5817 As compared to @option{-O}, this option increases both compilation time
5818 and the performance of the generated code.
5820 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5821 also turns on the following optimization flags:
5822 @gccoptlist{-fthread-jumps @gol
5823 -falign-functions  -falign-jumps @gol
5824 -falign-loops  -falign-labels @gol
5825 -fcaller-saves @gol
5826 -fcrossjumping @gol
5827 -fcse-follow-jumps  -fcse-skip-blocks @gol
5828 -fdelete-null-pointer-checks @gol
5829 -fexpensive-optimizations @gol
5830 -fgcse  -fgcse-lm  @gol
5831 -finline-small-functions @gol
5832 -findirect-inlining @gol
5833 -fipa-sra @gol
5834 -foptimize-sibling-calls @gol
5835 -fpeephole2 @gol
5836 -fregmove @gol
5837 -freorder-blocks  -freorder-functions @gol
5838 -frerun-cse-after-loop  @gol
5839 -fsched-interblock  -fsched-spec @gol
5840 -fschedule-insns  -fschedule-insns2 @gol
5841 -fstrict-aliasing -fstrict-overflow @gol
5842 -ftree-switch-conversion @gol
5843 -ftree-pre @gol
5844 -ftree-vrp}
5846 Please note the warning under @option{-fgcse} about
5847 invoking @option{-O2} on programs that use computed gotos.
5849 @item -O3
5850 @opindex O3
5851 Optimize yet more.  @option{-O3} turns on all optimizations specified
5852 by @option{-O2} and also turns on the @option{-finline-functions},
5853 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5854 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5856 @item -O0
5857 @opindex O0
5858 Reduce compilation time and make debugging produce the expected
5859 results.  This is the default.
5861 @item -Os
5862 @opindex Os
5863 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5864 do not typically increase code size.  It also performs further
5865 optimizations designed to reduce code size.
5867 @option{-Os} disables the following optimization flags:
5868 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5869 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5870 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5872 If you use multiple @option{-O} options, with or without level numbers,
5873 the last such option is the one that is effective.
5874 @end table
5876 Options of the form @option{-f@var{flag}} specify machine-independent
5877 flags.  Most flags have both positive and negative forms; the negative
5878 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5879 below, only one of the forms is listed---the one you typically will
5880 use.  You can figure out the other form by either removing @samp{no-}
5881 or adding it.
5883 The following options control specific optimizations.  They are either
5884 activated by @option{-O} options or are related to ones that are.  You
5885 can use the following flags in the rare cases when ``fine-tuning'' of
5886 optimizations to be performed is desired.
5888 @table @gcctabopt
5889 @item -fno-default-inline
5890 @opindex fno-default-inline
5891 Do not make member functions inline by default merely because they are
5892 defined inside the class scope (C++ only).  Otherwise, when you specify
5893 @w{@option{-O}}, member functions defined inside class scope are compiled
5894 inline by default; i.e., you don't need to add @samp{inline} in front of
5895 the member function name.
5897 @item -fno-defer-pop
5898 @opindex fno-defer-pop
5899 Always pop the arguments to each function call as soon as that function
5900 returns.  For machines which must pop arguments after a function call,
5901 the compiler normally lets arguments accumulate on the stack for several
5902 function calls and pops them all at once.
5904 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5906 @item -fforward-propagate
5907 @opindex fforward-propagate
5908 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5909 instructions and checks if the result can be simplified.  If loop unrolling
5910 is active, two passes are performed and the second is scheduled after
5911 loop unrolling.
5913 This option is enabled by default at optimization levels @option{-O},
5914 @option{-O2}, @option{-O3}, @option{-Os}.
5916 @item -fomit-frame-pointer
5917 @opindex fomit-frame-pointer
5918 Don't keep the frame pointer in a register for functions that
5919 don't need one.  This avoids the instructions to save, set up and
5920 restore frame pointers; it also makes an extra register available
5921 in many functions.  @strong{It also makes debugging impossible on
5922 some machines.}
5924 On some machines, such as the VAX, this flag has no effect, because
5925 the standard calling sequence automatically handles the frame pointer
5926 and nothing is saved by pretending it doesn't exist.  The
5927 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5928 whether a target machine supports this flag.  @xref{Registers,,Register
5929 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5931 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5933 @item -foptimize-sibling-calls
5934 @opindex foptimize-sibling-calls
5935 Optimize sibling and tail recursive calls.
5937 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5939 @item -fno-inline
5940 @opindex fno-inline
5941 Don't pay attention to the @code{inline} keyword.  Normally this option
5942 is used to keep the compiler from expanding any functions inline.
5943 Note that if you are not optimizing, no functions can be expanded inline.
5945 @item -finline-small-functions
5946 @opindex finline-small-functions
5947 Integrate functions into their callers when their body is smaller than expected
5948 function call code (so overall size of program gets smaller).  The compiler
5949 heuristically decides which functions are simple enough to be worth integrating
5950 in this way.
5952 Enabled at level @option{-O2}.
5954 @item -findirect-inlining
5955 @opindex findirect-inlining
5956 Inline also indirect calls that are discovered to be known at compile
5957 time thanks to previous inlining.  This option has any effect only
5958 when inlining itself is turned on by the @option{-finline-functions}
5959 or @option{-finline-small-functions} options.
5961 Enabled at level @option{-O2}.
5963 @item -finline-functions
5964 @opindex finline-functions
5965 Integrate all simple functions into their callers.  The compiler
5966 heuristically decides which functions are simple enough to be worth
5967 integrating in this way.
5969 If all calls to a given function are integrated, and the function is
5970 declared @code{static}, then the function is normally not output as
5971 assembler code in its own right.
5973 Enabled at level @option{-O3}.
5975 @item -finline-functions-called-once
5976 @opindex finline-functions-called-once
5977 Consider all @code{static} functions called once for inlining into their
5978 caller even if they are not marked @code{inline}.  If a call to a given
5979 function is integrated, then the function is not output as assembler code
5980 in its own right.
5982 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
5984 @item -fearly-inlining
5985 @opindex fearly-inlining
5986 Inline functions marked by @code{always_inline} and functions whose body seems
5987 smaller than the function call overhead early before doing
5988 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5989 makes profiling significantly cheaper and usually inlining faster on programs
5990 having large chains of nested wrapper functions.
5992 Enabled by default.
5994 @item -fipa-sra
5995 @opindex fipa-sra
5996 Perform interprocedural scalar replacement of aggregates, removal of
5997 unused parameters and replacement of parameters passed by reference
5998 by parameters passed by value.
6000 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6002 @item -finline-limit=@var{n}
6003 @opindex finline-limit
6004 By default, GCC limits the size of functions that can be inlined.  This flag
6005 allows coarse control of this limit.  @var{n} is the size of functions that
6006 can be inlined in number of pseudo instructions.
6008 Inlining is actually controlled by a number of parameters, which may be
6009 specified individually by using @option{--param @var{name}=@var{value}}.
6010 The @option{-finline-limit=@var{n}} option sets some of these parameters
6011 as follows:
6013 @table @gcctabopt
6014 @item max-inline-insns-single
6015 is set to @var{n}/2.
6016 @item max-inline-insns-auto
6017 is set to @var{n}/2.
6018 @end table
6020 See below for a documentation of the individual
6021 parameters controlling inlining and for the defaults of these parameters.
6023 @emph{Note:} there may be no value to @option{-finline-limit} that results
6024 in default behavior.
6026 @emph{Note:} pseudo instruction represents, in this particular context, an
6027 abstract measurement of function's size.  In no way does it represent a count
6028 of assembly instructions and as such its exact meaning might change from one
6029 release to an another.
6031 @item -fkeep-inline-functions
6032 @opindex fkeep-inline-functions
6033 In C, emit @code{static} functions that are declared @code{inline}
6034 into the object file, even if the function has been inlined into all
6035 of its callers.  This switch does not affect functions using the
6036 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6037 inline functions into the object file.
6039 @item -fkeep-static-consts
6040 @opindex fkeep-static-consts
6041 Emit variables declared @code{static const} when optimization isn't turned
6042 on, even if the variables aren't referenced.
6044 GCC enables this option by default.  If you want to force the compiler to
6045 check if the variable was referenced, regardless of whether or not
6046 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6048 @item -fmerge-constants
6049 @opindex fmerge-constants
6050 Attempt to merge identical constants (string constants and floating point
6051 constants) across compilation units.
6053 This option is the default for optimized compilation if the assembler and
6054 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6055 behavior.
6057 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6059 @item -fmerge-all-constants
6060 @opindex fmerge-all-constants
6061 Attempt to merge identical constants and identical variables.
6063 This option implies @option{-fmerge-constants}.  In addition to
6064 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6065 arrays or initialized constant variables with integral or floating point
6066 types.  Languages like C or C++ require each variable, including multiple
6067 instances of the same variable in recursive calls, to have distinct locations,
6068 so using this option will result in non-conforming
6069 behavior.
6071 @item -fmodulo-sched
6072 @opindex fmodulo-sched
6073 Perform swing modulo scheduling immediately before the first scheduling
6074 pass.  This pass looks at innermost loops and reorders their
6075 instructions by overlapping different iterations.
6077 @item -fmodulo-sched-allow-regmoves
6078 @opindex fmodulo-sched-allow-regmoves
6079 Perform more aggressive SMS based modulo scheduling with register moves
6080 allowed.  By setting this flag certain anti-dependences edges will be
6081 deleted which will trigger the generation of reg-moves based on the
6082 life-range analysis.  This option is effective only with
6083 @option{-fmodulo-sched} enabled.
6085 @item -fno-branch-count-reg
6086 @opindex fno-branch-count-reg
6087 Do not use ``decrement and branch'' instructions on a count register,
6088 but instead generate a sequence of instructions that decrement a
6089 register, compare it against zero, then branch based upon the result.
6090 This option is only meaningful on architectures that support such
6091 instructions, which include x86, PowerPC, IA-64 and S/390.
6093 The default is @option{-fbranch-count-reg}.
6095 @item -fno-function-cse
6096 @opindex fno-function-cse
6097 Do not put function addresses in registers; make each instruction that
6098 calls a constant function contain the function's address explicitly.
6100 This option results in less efficient code, but some strange hacks
6101 that alter the assembler output may be confused by the optimizations
6102 performed when this option is not used.
6104 The default is @option{-ffunction-cse}
6106 @item -fno-zero-initialized-in-bss
6107 @opindex fno-zero-initialized-in-bss
6108 If the target supports a BSS section, GCC by default puts variables that
6109 are initialized to zero into BSS@.  This can save space in the resulting
6110 code.
6112 This option turns off this behavior because some programs explicitly
6113 rely on variables going to the data section.  E.g., so that the
6114 resulting executable can find the beginning of that section and/or make
6115 assumptions based on that.
6117 The default is @option{-fzero-initialized-in-bss}.
6119 @item -fmudflap -fmudflapth -fmudflapir
6120 @opindex fmudflap
6121 @opindex fmudflapth
6122 @opindex fmudflapir
6123 @cindex bounds checking
6124 @cindex mudflap
6125 For front-ends that support it (C and C++), instrument all risky
6126 pointer/array dereferencing operations, some standard library
6127 string/heap functions, and some other associated constructs with
6128 range/validity tests.  Modules so instrumented should be immune to
6129 buffer overflows, invalid heap use, and some other classes of C/C++
6130 programming errors.  The instrumentation relies on a separate runtime
6131 library (@file{libmudflap}), which will be linked into a program if
6132 @option{-fmudflap} is given at link time.  Run-time behavior of the
6133 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6134 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6135 for its options.
6137 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6138 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6139 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6140 instrumentation should ignore pointer reads.  This produces less
6141 instrumentation (and therefore faster execution) and still provides
6142 some protection against outright memory corrupting writes, but allows
6143 erroneously read data to propagate within a program.
6145 @item -fthread-jumps
6146 @opindex fthread-jumps
6147 Perform optimizations where we check to see if a jump branches to a
6148 location where another comparison subsumed by the first is found.  If
6149 so, the first branch is redirected to either the destination of the
6150 second branch or a point immediately following it, depending on whether
6151 the condition is known to be true or false.
6153 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6155 @item -fsplit-wide-types
6156 @opindex fsplit-wide-types
6157 When using a type that occupies multiple registers, such as @code{long
6158 long} on a 32-bit system, split the registers apart and allocate them
6159 independently.  This normally generates better code for those types,
6160 but may make debugging more difficult.
6162 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6163 @option{-Os}.
6165 @item -fcse-follow-jumps
6166 @opindex fcse-follow-jumps
6167 In common subexpression elimination (CSE), scan through jump instructions
6168 when the target of the jump is not reached by any other path.  For
6169 example, when CSE encounters an @code{if} statement with an
6170 @code{else} clause, CSE will follow the jump when the condition
6171 tested is false.
6173 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6175 @item -fcse-skip-blocks
6176 @opindex fcse-skip-blocks
6177 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6178 follow jumps which conditionally skip over blocks.  When CSE
6179 encounters a simple @code{if} statement with no else clause,
6180 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6181 body of the @code{if}.
6183 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6185 @item -frerun-cse-after-loop
6186 @opindex frerun-cse-after-loop
6187 Re-run common subexpression elimination after loop optimizations has been
6188 performed.
6190 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6192 @item -fgcse
6193 @opindex fgcse
6194 Perform a global common subexpression elimination pass.
6195 This pass also performs global constant and copy propagation.
6197 @emph{Note:} When compiling a program using computed gotos, a GCC
6198 extension, you may get better runtime performance if you disable
6199 the global common subexpression elimination pass by adding
6200 @option{-fno-gcse} to the command line.
6202 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6204 @item -fgcse-lm
6205 @opindex fgcse-lm
6206 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6207 attempt to move loads which are only killed by stores into themselves.  This
6208 allows a loop containing a load/store sequence to be changed to a load outside
6209 the loop, and a copy/store within the loop.
6211 Enabled by default when gcse is enabled.
6213 @item -fgcse-sm
6214 @opindex fgcse-sm
6215 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6216 global common subexpression elimination.  This pass will attempt to move
6217 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6218 loops containing a load/store sequence can be changed to a load before
6219 the loop and a store after the loop.
6221 Not enabled at any optimization level.
6223 @item -fgcse-las
6224 @opindex fgcse-las
6225 When @option{-fgcse-las} is enabled, the global common subexpression
6226 elimination pass eliminates redundant loads that come after stores to the
6227 same memory location (both partial and full redundancies).
6229 Not enabled at any optimization level.
6231 @item -fgcse-after-reload
6232 @opindex fgcse-after-reload
6233 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6234 pass is performed after reload.  The purpose of this pass is to cleanup
6235 redundant spilling.
6237 @item -funsafe-loop-optimizations
6238 @opindex funsafe-loop-optimizations
6239 If given, the loop optimizer will assume that loop indices do not
6240 overflow, and that the loops with nontrivial exit condition are not
6241 infinite.  This enables a wider range of loop optimizations even if
6242 the loop optimizer itself cannot prove that these assumptions are valid.
6243 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6244 if it finds this kind of loop.
6246 @item -fcrossjumping
6247 @opindex fcrossjumping
6248 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6249 resulting code may or may not perform better than without cross-jumping.
6251 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6253 @item -fauto-inc-dec
6254 @opindex fauto-inc-dec
6255 Combine increments or decrements of addresses with memory accesses.
6256 This pass is always skipped on architectures that do not have
6257 instructions to support this.  Enabled by default at @option{-O} and
6258 higher on architectures that support this.
6260 @item -fdce
6261 @opindex fdce
6262 Perform dead code elimination (DCE) on RTL@.
6263 Enabled by default at @option{-O} and higher.
6265 @item -fdse
6266 @opindex fdse
6267 Perform dead store elimination (DSE) on RTL@.
6268 Enabled by default at @option{-O} and higher.
6270 @item -fif-conversion
6271 @opindex fif-conversion
6272 Attempt to transform conditional jumps into branch-less equivalents.  This
6273 include use of conditional moves, min, max, set flags and abs instructions, and
6274 some tricks doable by standard arithmetics.  The use of conditional execution
6275 on chips where it is available is controlled by @code{if-conversion2}.
6277 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6279 @item -fif-conversion2
6280 @opindex fif-conversion2
6281 Use conditional execution (where available) to transform conditional jumps into
6282 branch-less equivalents.
6284 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6286 @item -fdelete-null-pointer-checks
6287 @opindex fdelete-null-pointer-checks
6288 Assume that programs cannot safely dereference null pointers, and that
6289 no code or data element resides there.  This enables simple constant
6290 folding optimizations at all optimization levels.  In addition, other
6291 optimization passes in GCC use this flag to control global dataflow
6292 analyses that eliminate useless checks for null pointers; these assume
6293 that if a pointer is checked after it has already been dereferenced,
6294 it cannot be null.
6296 Note however that in some environments this assumption is not true.
6297 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6298 for programs which depend on that behavior.
6300 Some targets, especially embedded ones, disable this option at all levels.
6301 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6302 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6303 are enabled independently at different optimization levels.
6305 @item -fexpensive-optimizations
6306 @opindex fexpensive-optimizations
6307 Perform a number of minor optimizations that are relatively expensive.
6309 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6311 @item -foptimize-register-move
6312 @itemx -fregmove
6313 @opindex foptimize-register-move
6314 @opindex fregmove
6315 Attempt to reassign register numbers in move instructions and as
6316 operands of other simple instructions in order to maximize the amount of
6317 register tying.  This is especially helpful on machines with two-operand
6318 instructions.
6320 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6321 optimization.
6323 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6325 @item -fira-algorithm=@var{algorithm}
6326 Use specified coloring algorithm for the integrated register
6327 allocator.  The @var{algorithm} argument should be @code{priority} or
6328 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6329 the second one specifies Chaitin-Briggs coloring.  The second
6330 algorithm can be unimplemented for some architectures.  If it is
6331 implemented, it is the default because Chaitin-Briggs coloring as a
6332 rule generates a better code.
6334 @item -fira-region=@var{region}
6335 Use specified regions for the integrated register allocator.  The
6336 @var{region} argument should be one of @code{all}, @code{mixed}, or
6337 @code{one}.  The first value means using all loops as register
6338 allocation regions, the second value which is the default means using
6339 all loops except for loops with small register pressure as the
6340 regions, and third one means using all function as a single region.
6341 The first value can give best result for machines with small size and
6342 irregular register set, the third one results in faster and generates
6343 decent code and the smallest size code, and the default value usually
6344 give the best results in most cases and for most architectures.
6346 @item -fira-coalesce
6347 @opindex fira-coalesce
6348 Do optimistic register coalescing.  This option might be profitable for
6349 architectures with big regular register files.
6351 @item -fira-loop-pressure
6352 @opindex fira-loop-pressure
6353 Use IRA to evaluate register pressure in loops for decision to move
6354 loop invariants.  Usage of this option usually results in generation
6355 of faster and smaller code on machines with big register files (>= 32
6356 registers) but it can slow compiler down.
6358 This option is enabled at level @option{-O3} for some targets.
6360 @item -fno-ira-share-save-slots
6361 @opindex fno-ira-share-save-slots
6362 Switch off sharing stack slots used for saving call used hard
6363 registers living through a call.  Each hard register will get a
6364 separate stack slot and as a result function stack frame will be
6365 bigger.
6367 @item -fno-ira-share-spill-slots
6368 @opindex fno-ira-share-spill-slots
6369 Switch off sharing stack slots allocated for pseudo-registers.  Each
6370 pseudo-register which did not get a hard register will get a separate
6371 stack slot and as a result function stack frame will be bigger.
6373 @item -fira-verbose=@var{n}
6374 @opindex fira-verbose
6375 Set up how verbose dump file for the integrated register allocator
6376 will be.  Default value is 5.  If the value is greater or equal to 10,
6377 the dump file will be stderr as if the value were @var{n} minus 10.
6379 @item -fdelayed-branch
6380 @opindex fdelayed-branch
6381 If supported for the target machine, attempt to reorder instructions
6382 to exploit instruction slots available after delayed branch
6383 instructions.
6385 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6387 @item -fschedule-insns
6388 @opindex fschedule-insns
6389 If supported for the target machine, attempt to reorder instructions to
6390 eliminate execution stalls due to required data being unavailable.  This
6391 helps machines that have slow floating point or memory load instructions
6392 by allowing other instructions to be issued until the result of the load
6393 or floating point instruction is required.
6395 Enabled at levels @option{-O2}, @option{-O3}.
6397 @item -fschedule-insns2
6398 @opindex fschedule-insns2
6399 Similar to @option{-fschedule-insns}, but requests an additional pass of
6400 instruction scheduling after register allocation has been done.  This is
6401 especially useful on machines with a relatively small number of
6402 registers and where memory load instructions take more than one cycle.
6404 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6406 @item -fno-sched-interblock
6407 @opindex fno-sched-interblock
6408 Don't schedule instructions across basic blocks.  This is normally
6409 enabled by default when scheduling before register allocation, i.e.@:
6410 with @option{-fschedule-insns} or at @option{-O2} or higher.
6412 @item -fno-sched-spec
6413 @opindex fno-sched-spec
6414 Don't allow speculative motion of non-load instructions.  This is normally
6415 enabled by default when scheduling before register allocation, i.e.@:
6416 with @option{-fschedule-insns} or at @option{-O2} or higher.
6418 @item -fsched-pressure
6419 @opindex fsched-pressure
6420 Enable register pressure sensitive insn scheduling before the register
6421 allocation.  This only makes sense when scheduling before register
6422 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6423 @option{-O2} or higher.  Usage of this option can improve the
6424 generated code and decrease its size by preventing register pressure
6425 increase above the number of available hard registers and as a
6426 consequence register spills in the register allocation.
6428 @item -fsched-spec-load
6429 @opindex fsched-spec-load
6430 Allow speculative motion of some load instructions.  This only makes
6431 sense when scheduling before register allocation, i.e.@: with
6432 @option{-fschedule-insns} or at @option{-O2} or higher.
6434 @item -fsched-spec-load-dangerous
6435 @opindex fsched-spec-load-dangerous
6436 Allow speculative motion of more load instructions.  This only makes
6437 sense when scheduling before register allocation, i.e.@: with
6438 @option{-fschedule-insns} or at @option{-O2} or higher.
6440 @item -fsched-stalled-insns
6441 @itemx -fsched-stalled-insns=@var{n}
6442 @opindex fsched-stalled-insns
6443 Define how many insns (if any) can be moved prematurely from the queue
6444 of stalled insns into the ready list, during the second scheduling pass.
6445 @option{-fno-sched-stalled-insns} means that no insns will be moved
6446 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6447 on how many queued insns can be moved prematurely.
6448 @option{-fsched-stalled-insns} without a value is equivalent to
6449 @option{-fsched-stalled-insns=1}.
6451 @item -fsched-stalled-insns-dep
6452 @itemx -fsched-stalled-insns-dep=@var{n}
6453 @opindex fsched-stalled-insns-dep
6454 Define how many insn groups (cycles) will be examined for a dependency
6455 on a stalled insn that is candidate for premature removal from the queue
6456 of stalled insns.  This has an effect only during the second scheduling pass,
6457 and only if @option{-fsched-stalled-insns} is used.
6458 @option{-fno-sched-stalled-insns-dep} is equivalent to
6459 @option{-fsched-stalled-insns-dep=0}.
6460 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6461 @option{-fsched-stalled-insns-dep=1}.
6463 @item -fsched2-use-superblocks
6464 @opindex fsched2-use-superblocks
6465 When scheduling after register allocation, do use superblock scheduling
6466 algorithm.  Superblock scheduling allows motion across basic block boundaries
6467 resulting on faster schedules.  This option is experimental, as not all machine
6468 descriptions used by GCC model the CPU closely enough to avoid unreliable
6469 results from the algorithm.
6471 This only makes sense when scheduling after register allocation, i.e.@: with
6472 @option{-fschedule-insns2} or at @option{-O2} or higher.
6474 @item -fsched-group-heuristic
6475 @opindex fsched-group-heuristic
6476 Enable the group heuristic in the scheduler.  This heuristic favors 
6477 the instruction that belongs to a schedule group.  This is enabled 
6478 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6479 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6481 @item -fsched-critical-path-heuristic
6482 @opindex fsched-critical-path-heuristic
6483 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6484 instructions on the critical path.  This is enabled by default when 
6485 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6486 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6488 @item -fsched-spec-insn-heuristic
6489 @opindex fsched-spec-insn-heuristic
6490 Enable the speculative instruction heuristic in the scheduler.  This 
6491 heuristic favors speculative instructions with greater dependency weakness.  
6492 This is enabled by default when scheduling is enabled, i.e.@: 
6493 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6494 or at @option{-O2} or higher.
6496 @item -fsched-rank-heuristic
6497 @opindex fsched-rank-heuristic
6498 Enable the rank heuristic in the scheduler.  This heuristic favors 
6499 the instruction belonging to a basic block with greater size or frequency.  
6500 This is enabled by default when scheduling is enabled, i.e.@: 
6501 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6502 at @option{-O2} or higher.
6504 @item -fsched-last-insn-heuristic
6505 @opindex fsched-last-insn-heuristic
6506 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6507 favors the instruction that is less dependent on the last instruction
6508 scheduled.  This is enabled by default when scheduling is enabled, 
6509 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6510 at @option{-O2} or higher.
6512 @item -fsched-dep-count-heuristic
6513 @opindex fsched-dep-count-heuristic
6514 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6515 favors the instruction that has more instructions depending on it.  
6516 This is enabled by default when scheduling is enabled, i.e.@: 
6517 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6518 at @option{-O2} or higher.
6520 @item -freschedule-modulo-scheduled-loops
6521 @opindex freschedule-modulo-scheduled-loops
6522 The modulo scheduling comes before the traditional scheduling, if a loop
6523 was modulo scheduled we may want to prevent the later scheduling passes
6524 from changing its schedule, we use this option to control that.
6526 @item -fselective-scheduling
6527 @opindex fselective-scheduling
6528 Schedule instructions using selective scheduling algorithm.  Selective
6529 scheduling runs instead of the first scheduler pass.
6531 @item -fselective-scheduling2
6532 @opindex fselective-scheduling2
6533 Schedule instructions using selective scheduling algorithm.  Selective
6534 scheduling runs instead of the second scheduler pass.
6536 @item -fsel-sched-pipelining
6537 @opindex fsel-sched-pipelining
6538 Enable software pipelining of innermost loops during selective scheduling.
6539 This option has no effect until one of @option{-fselective-scheduling} or
6540 @option{-fselective-scheduling2} is turned on.
6542 @item -fsel-sched-pipelining-outer-loops
6543 @opindex fsel-sched-pipelining-outer-loops
6544 When pipelining loops during selective scheduling, also pipeline outer loops.
6545 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6547 @item -fcaller-saves
6548 @opindex fcaller-saves
6549 Enable values to be allocated in registers that will be clobbered by
6550 function calls, by emitting extra instructions to save and restore the
6551 registers around such calls.  Such allocation is done only when it
6552 seems to result in better code than would otherwise be produced.
6554 This option is always enabled by default on certain machines, usually
6555 those which have no call-preserved registers to use instead.
6557 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6559 @item -fconserve-stack
6560 @opindex fconserve-stack
6561 Attempt to minimize stack usage.  The compiler will attempt to use less
6562 stack space, even if that makes the program slower.  This option
6563 implies setting the @option{large-stack-frame} parameter to 100
6564 and the @option{large-stack-frame-growth} parameter to 400.
6566 @item -ftree-reassoc
6567 @opindex ftree-reassoc
6568 Perform reassociation on trees.  This flag is enabled by default
6569 at @option{-O} and higher.
6571 @item -ftree-pre
6572 @opindex ftree-pre
6573 Perform partial redundancy elimination (PRE) on trees.  This flag is
6574 enabled by default at @option{-O2} and @option{-O3}.
6576 @item -ftree-forwprop
6577 @opindex ftree-forwprop
6578 Perform forward propagation on trees.  This flag is enabled by default
6579 at @option{-O} and higher.
6581 @item -ftree-fre
6582 @opindex ftree-fre
6583 Perform full redundancy elimination (FRE) on trees.  The difference
6584 between FRE and PRE is that FRE only considers expressions
6585 that are computed on all paths leading to the redundant computation.
6586 This analysis is faster than PRE, though it exposes fewer redundancies.
6587 This flag is enabled by default at @option{-O} and higher.
6589 @item -ftree-phiprop
6590 @opindex ftree-phiprop
6591 Perform hoisting of loads from conditional pointers on trees.  This
6592 pass is enabled by default at @option{-O} and higher.
6594 @item -ftree-copy-prop
6595 @opindex ftree-copy-prop
6596 Perform copy propagation on trees.  This pass eliminates unnecessary
6597 copy operations.  This flag is enabled by default at @option{-O} and
6598 higher.
6600 @item -fipa-pure-const
6601 @opindex fipa-pure-const
6602 Discover which functions are pure or constant.
6603 Enabled by default at @option{-O} and higher.
6605 @item -fipa-reference
6606 @opindex fipa-reference
6607 Discover which static variables do not escape cannot escape the
6608 compilation unit.
6609 Enabled by default at @option{-O} and higher.
6611 @item -fipa-struct-reorg
6612 @opindex fipa-struct-reorg
6613 Perform structure reorganization optimization, that change C-like structures
6614 layout in order to better utilize spatial locality.  This transformation is
6615 affective for programs containing arrays of structures.  Available in two
6616 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6617 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
6618 to provide the safety of this transformation.  It works only in whole program
6619 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6620 enabled.  Structures considered @samp{cold} by this transformation are not
6621 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6623 With this flag, the program debug info reflects a new structure layout.
6625 @item -fipa-pta
6626 @opindex fipa-pta
6627 Perform interprocedural pointer analysis and interprocedural modification
6628 and reference analysis.  This option can cause excessive memory and
6629 compile-time usage on large compilation units.  It is not enabled by
6630 default at any optimization level.
6632 @item -fipa-profile
6633 @opindex fipa-profile
6634 Perform interprocedural profile propagation.  The functions called only from
6635 cold functions are marked as cold. Also functions executed once (such as
6636 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
6637 functions and loop less parts of functions executed once are then optimized for
6638 size.
6639 Enabled by default at @option{-O} and higher.
6641 @item -fipa-cp
6642 @opindex fipa-cp
6643 Perform interprocedural constant propagation.
6644 This optimization analyzes the program to determine when values passed
6645 to functions are constants and then optimizes accordingly.
6646 This optimization can substantially increase performance
6647 if the application has constants passed to functions.
6648 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6650 @item -fipa-cp-clone
6651 @opindex fipa-cp-clone
6652 Perform function cloning to make interprocedural constant propagation stronger.
6653 When enabled, interprocedural constant propagation will perform function cloning
6654 when externally visible function can be called with constant arguments.
6655 Because this optimization can create multiple copies of functions,
6656 it may significantly increase code size
6657 (see @option{--param ipcp-unit-growth=@var{value}}).
6658 This flag is enabled by default at @option{-O3}.
6660 @item -fipa-matrix-reorg
6661 @opindex fipa-matrix-reorg
6662 Perform matrix flattening and transposing.
6663 Matrix flattening tries to replace an @math{m}-dimensional matrix
6664 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6665 This reduces the level of indirection needed for accessing the elements
6666 of the matrix. The second optimization is matrix transposing that
6667 attempts to change the order of the matrix's dimensions in order to
6668 improve cache locality.
6669 Both optimizations need the @option{-fwhole-program} flag.
6670 Transposing is enabled only if profiling information is available.
6672 @item -ftree-sink
6673 @opindex ftree-sink
6674 Perform forward store motion  on trees.  This flag is
6675 enabled by default at @option{-O} and higher.
6677 @item -ftree-ccp
6678 @opindex ftree-ccp
6679 Perform sparse conditional constant propagation (CCP) on trees.  This
6680 pass only operates on local scalar variables and is enabled by default
6681 at @option{-O} and higher.
6683 @item -ftree-switch-conversion
6684 Perform conversion of simple initializations in a switch to
6685 initializations from a scalar array.  This flag is enabled by default
6686 at @option{-O2} and higher.
6688 @item -ftree-dce
6689 @opindex ftree-dce
6690 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6691 default at @option{-O} and higher.
6693 @item -ftree-builtin-call-dce
6694 @opindex ftree-builtin-call-dce
6695 Perform conditional dead code elimination (DCE) for calls to builtin functions
6696 that may set @code{errno} but are otherwise side-effect free.  This flag is
6697 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6698 specified.
6700 @item -ftree-dominator-opts
6701 @opindex ftree-dominator-opts
6702 Perform a variety of simple scalar cleanups (constant/copy
6703 propagation, redundancy elimination, range propagation and expression
6704 simplification) based on a dominator tree traversal.  This also
6705 performs jump threading (to reduce jumps to jumps). This flag is
6706 enabled by default at @option{-O} and higher.
6708 @item -ftree-dse
6709 @opindex ftree-dse
6710 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6711 a memory location which will later be overwritten by another store without
6712 any intervening loads.  In this case the earlier store can be deleted.  This
6713 flag is enabled by default at @option{-O} and higher.
6715 @item -ftree-ch
6716 @opindex ftree-ch
6717 Perform loop header copying on trees.  This is beneficial since it increases
6718 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6719 is enabled by default at @option{-O} and higher.  It is not enabled
6720 for @option{-Os}, since it usually increases code size.
6722 @item -ftree-loop-optimize
6723 @opindex ftree-loop-optimize
6724 Perform loop optimizations on trees.  This flag is enabled by default
6725 at @option{-O} and higher.
6727 @item -ftree-loop-linear
6728 @opindex ftree-loop-linear
6729 Perform linear loop transformations on tree.  This flag can improve cache
6730 performance and allow further loop optimizations to take place.
6732 @item -floop-interchange
6733 Perform loop interchange transformations on loops.  Interchanging two
6734 nested loops switches the inner and outer loops.  For example, given a
6735 loop like:
6736 @smallexample
6737 DO J = 1, M
6738   DO I = 1, N
6739     A(J, I) = A(J, I) * C
6740   ENDDO
6741 ENDDO
6742 @end smallexample
6743 loop interchange will transform the loop as if the user had written:
6744 @smallexample
6745 DO I = 1, N
6746   DO J = 1, M
6747     A(J, I) = A(J, I) * C
6748   ENDDO
6749 ENDDO
6750 @end smallexample
6751 which can be beneficial when @code{N} is larger than the caches,
6752 because in Fortran, the elements of an array are stored in memory
6753 contiguously by column, and the original loop iterates over rows,
6754 potentially creating at each access a cache miss.  This optimization
6755 applies to all the languages supported by GCC and is not limited to
6756 Fortran.  To use this code transformation, GCC has to be configured
6757 with @option{--with-ppl} and @option{--with-cloog} to enable the
6758 Graphite loop transformation infrastructure.
6760 @item -floop-strip-mine
6761 Perform loop strip mining transformations on loops.  Strip mining
6762 splits a loop into two nested loops.  The outer loop has strides
6763 equal to the strip size and the inner loop has strides of the
6764 original loop within a strip.  The strip length can be changed
6765 using the @option{loop-block-tile-size} parameter.  For example,
6766 given a loop like:
6767 @smallexample
6768 DO I = 1, N
6769   A(I) = A(I) + C
6770 ENDDO
6771 @end smallexample
6772 loop strip mining will transform the loop as if the user had written:
6773 @smallexample
6774 DO II = 1, N, 51
6775   DO I = II, min (II + 50, N)
6776     A(I) = A(I) + C
6777   ENDDO
6778 ENDDO
6779 @end smallexample
6780 This optimization applies to all the languages supported by GCC and is
6781 not limited to Fortran.  To use this code transformation, GCC has to
6782 be configured with @option{--with-ppl} and @option{--with-cloog} to
6783 enable the Graphite loop transformation infrastructure.
6785 @item -floop-block
6786 Perform loop blocking transformations on loops.  Blocking strip mines
6787 each loop in the loop nest such that the memory accesses of the
6788 element loops fit inside caches.  The strip length can be changed
6789 using the @option{loop-block-tile-size} parameter.  For example, given
6790 a loop like:
6791 @smallexample
6792 DO I = 1, N
6793   DO J = 1, M
6794     A(J, I) = B(I) + C(J)
6795   ENDDO
6796 ENDDO
6797 @end smallexample
6798 loop blocking will transform the loop as if the user had written:
6799 @smallexample
6800 DO II = 1, N, 51
6801   DO JJ = 1, M, 51
6802     DO I = II, min (II + 50, N)
6803       DO J = JJ, min (JJ + 50, M)
6804         A(J, I) = B(I) + C(J)
6805       ENDDO
6806     ENDDO
6807   ENDDO
6808 ENDDO
6809 @end smallexample
6810 which can be beneficial when @code{M} is larger than the caches,
6811 because the innermost loop will iterate over a smaller amount of data
6812 that can be kept in the caches.  This optimization applies to all the
6813 languages supported by GCC and is not limited to Fortran.  To use this
6814 code transformation, GCC has to be configured with @option{--with-ppl}
6815 and @option{--with-cloog} to enable the Graphite loop transformation
6816 infrastructure.
6818 @item -fgraphite-identity
6819 @opindex fgraphite-identity
6820 Enable the identity transformation for graphite.  For every SCoP we generate
6821 the polyhedral representation and transform it back to gimple.  Using
6822 @option{-fgraphite-identity} we can check the costs or benefits of the
6823 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
6824 are also performed by the code generator CLooG, like index splitting and
6825 dead code elimination in loops.
6827 @item -floop-parallelize-all
6828 Use the Graphite data dependence analysis to identify loops that can
6829 be parallelized.  Parallelize all the loops that can be analyzed to
6830 not contain loop carried dependences without checking that it is
6831 profitable to parallelize the loops.
6833 @item -fcheck-data-deps
6834 @opindex fcheck-data-deps
6835 Compare the results of several data dependence analyzers.  This option
6836 is used for debugging the data dependence analyzers.
6838 @item -ftree-loop-distribution
6839 Perform loop distribution.  This flag can improve cache performance on
6840 big loop bodies and allow further loop optimizations, like
6841 parallelization or vectorization, to take place.  For example, the loop
6842 @smallexample
6843 DO I = 1, N
6844   A(I) = B(I) + C
6845   D(I) = E(I) * F
6846 ENDDO
6847 @end smallexample
6848 is transformed to
6849 @smallexample
6850 DO I = 1, N
6851    A(I) = B(I) + C
6852 ENDDO
6853 DO I = 1, N
6854    D(I) = E(I) * F
6855 ENDDO
6856 @end smallexample
6858 @item -ftree-loop-im
6859 @opindex ftree-loop-im
6860 Perform loop invariant motion on trees.  This pass moves only invariants that
6861 would be hard to handle at RTL level (function calls, operations that expand to
6862 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6863 operands of conditions that are invariant out of the loop, so that we can use
6864 just trivial invariantness analysis in loop unswitching.  The pass also includes
6865 store motion.
6867 @item -ftree-loop-ivcanon
6868 @opindex ftree-loop-ivcanon
6869 Create a canonical counter for number of iterations in the loop for that
6870 determining number of iterations requires complicated analysis.  Later
6871 optimizations then may determine the number easily.  Useful especially
6872 in connection with unrolling.
6874 @item -fivopts
6875 @opindex fivopts
6876 Perform induction variable optimizations (strength reduction, induction
6877 variable merging and induction variable elimination) on trees.
6879 @item -ftree-parallelize-loops=n
6880 @opindex ftree-parallelize-loops
6881 Parallelize loops, i.e., split their iteration space to run in n threads.
6882 This is only possible for loops whose iterations are independent
6883 and can be arbitrarily reordered.  The optimization is only
6884 profitable on multiprocessor machines, for loops that are CPU-intensive,
6885 rather than constrained e.g.@: by memory bandwidth.  This option
6886 implies @option{-pthread}, and thus is only supported on targets
6887 that have support for @option{-pthread}.
6889 @item -ftree-pta
6890 @opindex ftree-pta
6891 Perform function-local points-to analysis on trees.  This flag is
6892 enabled by default at @option{-O} and higher.
6894 @item -ftree-sra
6895 @opindex ftree-sra
6896 Perform scalar replacement of aggregates.  This pass replaces structure
6897 references with scalars to prevent committing structures to memory too
6898 early.  This flag is enabled by default at @option{-O} and higher.
6900 @item -ftree-copyrename
6901 @opindex ftree-copyrename
6902 Perform copy renaming on trees.  This pass attempts to rename compiler
6903 temporaries to other variables at copy locations, usually resulting in
6904 variable names which more closely resemble the original variables.  This flag
6905 is enabled by default at @option{-O} and higher.
6907 @item -ftree-ter
6908 @opindex ftree-ter
6909 Perform temporary expression replacement during the SSA->normal phase.  Single
6910 use/single def temporaries are replaced at their use location with their
6911 defining expression.  This results in non-GIMPLE code, but gives the expanders
6912 much more complex trees to work on resulting in better RTL generation.  This is
6913 enabled by default at @option{-O} and higher.
6915 @item -ftree-vectorize
6916 @opindex ftree-vectorize
6917 Perform loop vectorization on trees. This flag is enabled by default at
6918 @option{-O3}.
6920 @item -ftree-slp-vectorize
6921 @opindex ftree-slp-vectorize
6922 Perform basic block vectorization on trees. This flag is enabled by default at
6923 @option{-O3} and when @option{-ftree-vectorize} is enabled.
6925 @item -ftree-vect-loop-version
6926 @opindex ftree-vect-loop-version
6927 Perform loop versioning when doing loop vectorization on trees.  When a loop
6928 appears to be vectorizable except that data alignment or data dependence cannot
6929 be determined at compile time then vectorized and non-vectorized versions of
6930 the loop are generated along with runtime checks for alignment or dependence
6931 to control which version is executed.  This option is enabled by default
6932 except at level @option{-Os} where it is disabled.
6934 @item -fvect-cost-model
6935 @opindex fvect-cost-model
6936 Enable cost model for vectorization.
6938 @item -ftree-vrp
6939 @opindex ftree-vrp
6940 Perform Value Range Propagation on trees.  This is similar to the
6941 constant propagation pass, but instead of values, ranges of values are
6942 propagated.  This allows the optimizers to remove unnecessary range
6943 checks like array bound checks and null pointer checks.  This is
6944 enabled by default at @option{-O2} and higher.  Null pointer check
6945 elimination is only done if @option{-fdelete-null-pointer-checks} is
6946 enabled.
6948 @item -ftracer
6949 @opindex ftracer
6950 Perform tail duplication to enlarge superblock size.  This transformation
6951 simplifies the control flow of the function allowing other optimizations to do
6952 better job.
6954 @item -funroll-loops
6955 @opindex funroll-loops
6956 Unroll loops whose number of iterations can be determined at compile
6957 time or upon entry to the loop.  @option{-funroll-loops} implies
6958 @option{-frerun-cse-after-loop}.  This option makes code larger,
6959 and may or may not make it run faster.
6961 @item -funroll-all-loops
6962 @opindex funroll-all-loops
6963 Unroll all loops, even if their number of iterations is uncertain when
6964 the loop is entered.  This usually makes programs run more slowly.
6965 @option{-funroll-all-loops} implies the same options as
6966 @option{-funroll-loops},
6968 @item -fsplit-ivs-in-unroller
6969 @opindex fsplit-ivs-in-unroller
6970 Enables expressing of values of induction variables in later iterations
6971 of the unrolled loop using the value in the first iteration.  This breaks
6972 long dependency chains, thus improving efficiency of the scheduling passes.
6974 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6975 same effect.  However in cases the loop body is more complicated than
6976 a single basic block, this is not reliable.  It also does not work at all
6977 on some of the architectures due to restrictions in the CSE pass.
6979 This optimization is enabled by default.
6981 @item -fvariable-expansion-in-unroller
6982 @opindex fvariable-expansion-in-unroller
6983 With this option, the compiler will create multiple copies of some
6984 local variables when unrolling a loop which can result in superior code.
6986 @item -fpredictive-commoning
6987 @opindex fpredictive-commoning
6988 Perform predictive commoning optimization, i.e., reusing computations
6989 (especially memory loads and stores) performed in previous
6990 iterations of loops.
6992 This option is enabled at level @option{-O3}.
6994 @item -fprefetch-loop-arrays
6995 @opindex fprefetch-loop-arrays
6996 If supported by the target machine, generate instructions to prefetch
6997 memory to improve the performance of loops that access large arrays.
6999 This option may generate better or worse code; results are highly
7000 dependent on the structure of loops within the source code.
7002 Disabled at level @option{-Os}.
7004 @item -fno-peephole
7005 @itemx -fno-peephole2
7006 @opindex fno-peephole
7007 @opindex fno-peephole2
7008 Disable any machine-specific peephole optimizations.  The difference
7009 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7010 are implemented in the compiler; some targets use one, some use the
7011 other, a few use both.
7013 @option{-fpeephole} is enabled by default.
7014 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7016 @item -fno-guess-branch-probability
7017 @opindex fno-guess-branch-probability
7018 Do not guess branch probabilities using heuristics.
7020 GCC will use heuristics to guess branch probabilities if they are
7021 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7022 heuristics are based on the control flow graph.  If some branch probabilities
7023 are specified by @samp{__builtin_expect}, then the heuristics will be
7024 used to guess branch probabilities for the rest of the control flow graph,
7025 taking the @samp{__builtin_expect} info into account.  The interactions
7026 between the heuristics and @samp{__builtin_expect} can be complex, and in
7027 some cases, it may be useful to disable the heuristics so that the effects
7028 of @samp{__builtin_expect} are easier to understand.
7030 The default is @option{-fguess-branch-probability} at levels
7031 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7033 @item -freorder-blocks
7034 @opindex freorder-blocks
7035 Reorder basic blocks in the compiled function in order to reduce number of
7036 taken branches and improve code locality.
7038 Enabled at levels @option{-O2}, @option{-O3}.
7040 @item -freorder-blocks-and-partition
7041 @opindex freorder-blocks-and-partition
7042 In addition to reordering basic blocks in the compiled function, in order
7043 to reduce number of taken branches, partitions hot and cold basic blocks
7044 into separate sections of the assembly and .o files, to improve
7045 paging and cache locality performance.
7047 This optimization is automatically turned off in the presence of
7048 exception handling, for linkonce sections, for functions with a user-defined
7049 section attribute and on any architecture that does not support named
7050 sections.
7052 @item -freorder-functions
7053 @opindex freorder-functions
7054 Reorder functions in the object file in order to
7055 improve code locality.  This is implemented by using special
7056 subsections @code{.text.hot} for most frequently executed functions and
7057 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7058 the linker so object file format must support named sections and linker must
7059 place them in a reasonable way.
7061 Also profile feedback must be available in to make this option effective.  See
7062 @option{-fprofile-arcs} for details.
7064 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7066 @item -fstrict-aliasing
7067 @opindex fstrict-aliasing
7068 Allow the compiler to assume the strictest aliasing rules applicable to
7069 the language being compiled.  For C (and C++), this activates
7070 optimizations based on the type of expressions.  In particular, an
7071 object of one type is assumed never to reside at the same address as an
7072 object of a different type, unless the types are almost the same.  For
7073 example, an @code{unsigned int} can alias an @code{int}, but not a
7074 @code{void*} or a @code{double}.  A character type may alias any other
7075 type.
7077 @anchor{Type-punning}Pay special attention to code like this:
7078 @smallexample
7079 union a_union @{
7080   int i;
7081   double d;
7084 int f() @{
7085   union a_union t;
7086   t.d = 3.0;
7087   return t.i;
7089 @end smallexample
7090 The practice of reading from a different union member than the one most
7091 recently written to (called ``type-punning'') is common.  Even with
7092 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7093 is accessed through the union type.  So, the code above will work as
7094 expected.  @xref{Structures unions enumerations and bit-fields
7095 implementation}.  However, this code might not:
7096 @smallexample
7097 int f() @{
7098   union a_union t;
7099   int* ip;
7100   t.d = 3.0;
7101   ip = &t.i;
7102   return *ip;
7104 @end smallexample
7106 Similarly, access by taking the address, casting the resulting pointer
7107 and dereferencing the result has undefined behavior, even if the cast
7108 uses a union type, e.g.:
7109 @smallexample
7110 int f() @{
7111   double d = 3.0;
7112   return ((union a_union *) &d)->i;
7114 @end smallexample
7116 The @option{-fstrict-aliasing} option is enabled at levels
7117 @option{-O2}, @option{-O3}, @option{-Os}.
7119 @item -fstrict-overflow
7120 @opindex fstrict-overflow
7121 Allow the compiler to assume strict signed overflow rules, depending
7122 on the language being compiled.  For C (and C++) this means that
7123 overflow when doing arithmetic with signed numbers is undefined, which
7124 means that the compiler may assume that it will not happen.  This
7125 permits various optimizations.  For example, the compiler will assume
7126 that an expression like @code{i + 10 > i} will always be true for
7127 signed @code{i}.  This assumption is only valid if signed overflow is
7128 undefined, as the expression is false if @code{i + 10} overflows when
7129 using twos complement arithmetic.  When this option is in effect any
7130 attempt to determine whether an operation on signed numbers will
7131 overflow must be written carefully to not actually involve overflow.
7133 This option also allows the compiler to assume strict pointer
7134 semantics: given a pointer to an object, if adding an offset to that
7135 pointer does not produce a pointer to the same object, the addition is
7136 undefined.  This permits the compiler to conclude that @code{p + u >
7137 p} is always true for a pointer @code{p} and unsigned integer
7138 @code{u}.  This assumption is only valid because pointer wraparound is
7139 undefined, as the expression is false if @code{p + u} overflows using
7140 twos complement arithmetic.
7142 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7143 that integer signed overflow is fully defined: it wraps.  When
7144 @option{-fwrapv} is used, there is no difference between
7145 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7146 integers.  With @option{-fwrapv} certain types of overflow are
7147 permitted.  For example, if the compiler gets an overflow when doing
7148 arithmetic on constants, the overflowed value can still be used with
7149 @option{-fwrapv}, but not otherwise.
7151 The @option{-fstrict-overflow} option is enabled at levels
7152 @option{-O2}, @option{-O3}, @option{-Os}.
7154 @item -falign-functions
7155 @itemx -falign-functions=@var{n}
7156 @opindex falign-functions
7157 Align the start of functions to the next power-of-two greater than
7158 @var{n}, skipping up to @var{n} bytes.  For instance,
7159 @option{-falign-functions=32} aligns functions to the next 32-byte
7160 boundary, but @option{-falign-functions=24} would align to the next
7161 32-byte boundary only if this can be done by skipping 23 bytes or less.
7163 @option{-fno-align-functions} and @option{-falign-functions=1} are
7164 equivalent and mean that functions will not be aligned.
7166 Some assemblers only support this flag when @var{n} is a power of two;
7167 in that case, it is rounded up.
7169 If @var{n} is not specified or is zero, use a machine-dependent default.
7171 Enabled at levels @option{-O2}, @option{-O3}.
7173 @item -falign-labels
7174 @itemx -falign-labels=@var{n}
7175 @opindex falign-labels
7176 Align all branch targets to a power-of-two boundary, skipping up to
7177 @var{n} bytes like @option{-falign-functions}.  This option can easily
7178 make code slower, because it must insert dummy operations for when the
7179 branch target is reached in the usual flow of the code.
7181 @option{-fno-align-labels} and @option{-falign-labels=1} are
7182 equivalent and mean that labels will not be aligned.
7184 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7185 are greater than this value, then their values are used instead.
7187 If @var{n} is not specified or is zero, use a machine-dependent default
7188 which is very likely to be @samp{1}, meaning no alignment.
7190 Enabled at levels @option{-O2}, @option{-O3}.
7192 @item -falign-loops
7193 @itemx -falign-loops=@var{n}
7194 @opindex falign-loops
7195 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7196 like @option{-falign-functions}.  The hope is that the loop will be
7197 executed many times, which will make up for any execution of the dummy
7198 operations.
7200 @option{-fno-align-loops} and @option{-falign-loops=1} are
7201 equivalent and mean that loops will not be aligned.
7203 If @var{n} is not specified or is zero, use a machine-dependent default.
7205 Enabled at levels @option{-O2}, @option{-O3}.
7207 @item -falign-jumps
7208 @itemx -falign-jumps=@var{n}
7209 @opindex falign-jumps
7210 Align branch targets to a power-of-two boundary, for branch targets
7211 where the targets can only be reached by jumping, skipping up to @var{n}
7212 bytes like @option{-falign-functions}.  In this case, no dummy operations
7213 need be executed.
7215 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7216 equivalent and mean that loops will not be aligned.
7218 If @var{n} is not specified or is zero, use a machine-dependent default.
7220 Enabled at levels @option{-O2}, @option{-O3}.
7222 @item -funit-at-a-time
7223 @opindex funit-at-a-time
7224 This option is left for compatibility reasons. @option{-funit-at-a-time}
7225 has no effect, while @option{-fno-unit-at-a-time} implies
7226 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7228 Enabled by default.
7230 @item -fno-toplevel-reorder
7231 @opindex fno-toplevel-reorder
7232 Do not reorder top-level functions, variables, and @code{asm}
7233 statements.  Output them in the same order that they appear in the
7234 input file.  When this option is used, unreferenced static variables
7235 will not be removed.  This option is intended to support existing code
7236 which relies on a particular ordering.  For new code, it is better to
7237 use attributes.
7239 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7240 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7241 targets.
7243 @item -fweb
7244 @opindex fweb
7245 Constructs webs as commonly used for register allocation purposes and assign
7246 each web individual pseudo register.  This allows the register allocation pass
7247 to operate on pseudos directly, but also strengthens several other optimization
7248 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7249 however, make debugging impossible, since variables will no longer stay in a
7250 ``home register''.
7252 Enabled by default with @option{-funroll-loops}.
7254 @item -fwhole-program
7255 @opindex fwhole-program
7256 Assume that the current compilation unit represents the whole program being
7257 compiled.  All public functions and variables with the exception of @code{main}
7258 and those merged by attribute @code{externally_visible} become static functions
7259 and in effect are optimized more aggressively by interprocedural optimizers.
7260 While this option is equivalent to proper use of the @code{static} keyword for
7261 programs consisting of a single file, in combination with option
7262 @option{-combine}, @option{-flto} or @option{-fwhopr} this flag can be used to
7263 compile many smaller scale programs since the functions and variables become
7264 local for the whole combined compilation unit, not for the single source file
7265 itself.
7267 This option implies @option{-fwhole-file} for Fortran programs.
7269 @item -flto
7270 @opindex flto
7271 This option runs the standard link-time optimizer.  When invoked
7272 with source code, it generates GIMPLE (one of GCC's internal
7273 representations) and writes it to special ELF sections in the object
7274 file.  When the object files are linked together, all the function
7275 bodies are read from these ELF sections and instantiated as if they
7276 had been part of the same translation unit.
7278 To use the link-timer optimizer, @option{-flto} needs to be specified at
7279 compile time and during the final link.  For example,
7281 @smallexample
7282 gcc -c -O2 -flto foo.c
7283 gcc -c -O2 -flto bar.c
7284 gcc -o myprog -flto -O2 foo.o bar.o
7285 @end smallexample
7287 The first two invocations to GCC will save a bytecode representation
7288 of GIMPLE into special ELF sections inside @file{foo.o} and
7289 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7290 @file{foo.o} and @file{bar.o}, merge the two files into a single
7291 internal image, and compile the result as usual.  Since both
7292 @file{foo.o} and @file{bar.o} are merged into a single image, this
7293 causes all the inter-procedural analyses and optimizations in GCC to
7294 work across the two files as if they were a single one.  This means,
7295 for example, that the inliner will be able to inline functions in
7296 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7298 Another (simpler) way to enable link-time optimization is,
7300 @smallexample
7301 gcc -o myprog -flto -O2 foo.c bar.c
7302 @end smallexample
7304 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7305 merge them together into a single GIMPLE representation and optimize
7306 them as usual to produce @file{myprog}.
7308 The only important thing to keep in mind is that to enable link-time
7309 optimizations the @option{-flto} flag needs to be passed to both the
7310 compile and the link commands.
7312 Note that when a file is compiled with @option{-flto}, the generated
7313 object file will be larger than a regular object file because it will
7314 contain GIMPLE bytecodes and the usual final code.  This means that
7315 object files with LTO information can be linked as a normal object
7316 file.  So, in the previous example, if the final link is done with
7318 @smallexample
7319 gcc -o myprog foo.o bar.o
7320 @end smallexample
7322 The only difference will be that no inter-procedural optimizations
7323 will be applied to produce @file{myprog}.  The two object files
7324 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7325 linker.
7327 Additionally, the optimization flags used to compile individual files
7328 are not necessarily related to those used at link-time.  For instance,
7330 @smallexample
7331 gcc -c -O0 -flto foo.c
7332 gcc -c -O0 -flto bar.c
7333 gcc -o myprog -flto -O3 foo.o bar.o
7334 @end smallexample
7336 This will produce individual object files with unoptimized assembler
7337 code, but the resulting binary @file{myprog} will be optimized at
7338 @option{-O3}.  Now, if the final binary is generated without
7339 @option{-flto}, then @file{myprog} will not be optimized.
7341 When producing the final binary with @option{-flto}, GCC will only
7342 apply link-time optimizations to those files that contain bytecode.
7343 Therefore, you can mix and match object files and libraries with
7344 GIMPLE bytecodes and final object code.  GCC will automatically select
7345 which files to optimize in LTO mode and which files to link without
7346 further processing.
7348 There are some code generation flags that GCC will preserve when
7349 generating bytecodes, as they need to be used during the final link
7350 stage.  Currently, the following options are saved into the GIMPLE
7351 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7352 @option{-m} target flags.
7354 At link time, these options are read-in and reapplied.  Note that the
7355 current implementation makes no attempt at recognizing conflicting
7356 values for these options.  If two or more files have a conflicting
7357 value (e.g., one file is compiled with @option{-fPIC} and another
7358 isn't), the compiler will simply use the last value read from the
7359 bytecode files.  It is recommended, then, that all the files
7360 participating in the same link be compiled with the same options.
7362 Another feature of LTO is that it is possible to apply interprocedural
7363 optimizations on files written in different languages.  This requires
7364 some support in the language front end.  Currently, the C, C++ and
7365 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7366 something like this should work
7368 @smallexample
7369 gcc -c -flto foo.c
7370 g++ -c -flto bar.cc
7371 gfortran -c -flto baz.f90
7372 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7373 @end smallexample
7375 Notice that the final link is done with @command{g++} to get the C++
7376 runtime libraries and @option{-lgfortran} is added to get the Fortran
7377 runtime libraries.  In general, when mixing languages in LTO mode, you
7378 should use the same link command used when mixing languages in a
7379 regular (non-LTO) compilation.  This means that if your build process
7380 was mixing languages before, all you need to add is @option{-flto} to
7381 all the compile and link commands.
7383 If LTO encounters objects with C linkage declared with incompatible
7384 types in separate translation units to be linked together (undefined
7385 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
7386 issued.  The behavior is still undefined at runtime.
7388 If object files containing GIMPLE bytecode are stored in a library
7389 archive, say @file{libfoo.a}, it is possible to extract and use them
7390 in an LTO link if you are using @command{gold} as the linker (which,
7391 in turn requires GCC to be configured with @option{--enable-gold}).
7392 To enable this feature, use the flag @option{-fuse-linker-plugin} at
7393 link-time:
7395 @smallexample
7396 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7397 @end smallexample
7399 With the linker plugin enabled, @command{gold} will extract the needed
7400 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7401 to make them part of the aggregated GIMPLE image to be optimized.
7403 If you are not using @command{gold} and/or do not specify
7404 @option{-fuse-linker-plugin} then the objects inside @file{libfoo.a}
7405 will be extracted and linked as usual, but they will not participate
7406 in the LTO optimization process.
7408 Link time optimizations do not require the presence of the whole
7409 program to operate.  If the program does not require any symbols to
7410 be exported, it is possible to combine @option{-flto} and
7411 @option{-fwhopr} with @option{-fwhole-program} to allow the
7412 interprocedural optimizers to use more aggressive assumptions which
7413 may lead to improved optimization opportunities.
7415 Regarding portability: the current implementation of LTO makes no
7416 attempt at generating bytecode that can be ported between different
7417 types of hosts.  The bytecode files are versioned and there is a
7418 strict version check, so bytecode files generated in one version of
7419 GCC will not work with an older/newer version of GCC.
7421 Link time optimization does not play well with generating debugging
7422 information.  Combining @option{-flto} or @option{-fwhopr} with
7423 @option{-g} is experimental.
7425 This option is disabled by default.
7427 @item -fwhopr
7428 @opindex fwhopr
7429 This option is identical in functionality to @option{-flto} but it
7430 differs in how the final link stage is executed.  Instead of loading
7431 all the function bodies in memory, the callgraph is analyzed and
7432 optimization decisions are made (whole program analysis or WPA). Once
7433 optimization decisions are made, the callgraph is partitioned and the
7434 different sections are compiled separately (local transformations or
7435 LTRANS)@.  This process allows optimizations on very large programs
7436 that otherwise would not fit in memory.  This option enables
7437 @option{-fwpa} and @option{-fltrans} automatically.
7439 Disabled by default.
7441 This option is experimental.
7443 @item -fwpa
7444 @opindex fwpa
7445 This is an internal option used by GCC when compiling with
7446 @option{-fwhopr}.  You should never need to use it.
7448 This option runs the link-time optimizer in the whole-program-analysis
7449 (WPA) mode, which reads in summary information from all inputs and
7450 performs a whole-program analysis based on summary information only.
7451 It generates object files for subsequent runs of the link-time
7452 optimizer where individual object files are optimized using both
7453 summary information from the WPA mode and the actual function bodies.
7454 It then drives the LTRANS phase.
7456 Disabled by default.
7458 @item -fltrans
7459 @opindex fltrans
7460 This is an internal option used by GCC when compiling with
7461 @option{-fwhopr}.  You should never need to use it.
7463 This option runs the link-time optimizer in the local-transformation (LTRANS)
7464 mode, which reads in output from a previous run of the LTO in WPA mode.
7465 In the LTRANS mode, LTO optimizes an object and produces the final assembly.
7467 Disabled by default.
7469 @item -fltrans-output-list=@var{file}
7470 @opindex fltrans-output-list
7471 This is an internal option used by GCC when compiling with
7472 @option{-fwhopr}.  You should never need to use it.
7474 This option specifies a file to which the names of LTRANS output files are
7475 written.  This option is only meaningful in conjunction with @option{-fwpa}.
7477 Disabled by default.
7479 @item -flto-compression-level=@var{n}
7480 This option specifies the level of compression used for intermediate
7481 language written to LTO object files, and is only meaningful in
7482 conjunction with LTO mode (@option{-fwhopr}, @option{-flto}).  Valid
7483 values are 0 (no compression) to 9 (maximum compression).  Values
7484 outside this range are clamped to either 0 or 9.  If the option is not
7485 given, a default balanced compression setting is used.
7487 @item -flto-report
7488 Prints a report with internal details on the workings of the link-time
7489 optimizer.  The contents of this report vary from version to version,
7490 it is meant to be useful to GCC developers when processing object
7491 files in LTO mode (via @option{-fwhopr} or @option{-flto}).
7493 Disabled by default.
7495 @item -fuse-linker-plugin
7496 Enables the extraction of objects with GIMPLE bytecode information
7497 from library archives.  This option relies on features available only
7498 in @command{gold}, so to use this you must configure GCC with
7499 @option{--enable-gold}.  See @option{-flto} for a description on the
7500 effect of this flag and how to use it.
7502 Disabled by default.
7504 @item -fcprop-registers
7505 @opindex fcprop-registers
7506 After register allocation and post-register allocation instruction splitting,
7507 we perform a copy-propagation pass to try to reduce scheduling dependencies
7508 and occasionally eliminate the copy.
7510 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7512 @item -fprofile-correction
7513 @opindex fprofile-correction
7514 Profiles collected using an instrumented binary for multi-threaded programs may
7515 be inconsistent due to missed counter updates. When this option is specified,
7516 GCC will use heuristics to correct or smooth out such inconsistencies. By
7517 default, GCC will emit an error message when an inconsistent profile is detected.
7519 @item -fprofile-dir=@var{path}
7520 @opindex fprofile-dir
7522 Set the directory to search the profile data files in to @var{path}.
7523 This option affects only the profile data generated by
7524 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7525 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7526 and its related options.
7527 By default, GCC will use the current directory as @var{path}
7528 thus the profile data file will appear in the same directory as the object file.
7530 @item -fprofile-generate
7531 @itemx -fprofile-generate=@var{path}
7532 @opindex fprofile-generate
7534 Enable options usually used for instrumenting application to produce
7535 profile useful for later recompilation with profile feedback based
7536 optimization.  You must use @option{-fprofile-generate} both when
7537 compiling and when linking your program.
7539 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7541 If @var{path} is specified, GCC will look at the @var{path} to find
7542 the profile feedback data files. See @option{-fprofile-dir}.
7544 @item -fprofile-use
7545 @itemx -fprofile-use=@var{path}
7546 @opindex fprofile-use
7547 Enable profile feedback directed optimizations, and optimizations
7548 generally profitable only with profile feedback available.
7550 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7551 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7553 By default, GCC emits an error message if the feedback profiles do not
7554 match the source code.  This error can be turned into a warning by using
7555 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7556 code.
7558 If @var{path} is specified, GCC will look at the @var{path} to find
7559 the profile feedback data files. See @option{-fprofile-dir}.
7560 @end table
7562 The following options control compiler behavior regarding floating
7563 point arithmetic.  These options trade off between speed and
7564 correctness.  All must be specifically enabled.
7566 @table @gcctabopt
7567 @item -ffloat-store
7568 @opindex ffloat-store
7569 Do not store floating point variables in registers, and inhibit other
7570 options that might change whether a floating point value is taken from a
7571 register or memory.
7573 @cindex floating point precision
7574 This option prevents undesirable excess precision on machines such as
7575 the 68000 where the floating registers (of the 68881) keep more
7576 precision than a @code{double} is supposed to have.  Similarly for the
7577 x86 architecture.  For most programs, the excess precision does only
7578 good, but a few programs rely on the precise definition of IEEE floating
7579 point.  Use @option{-ffloat-store} for such programs, after modifying
7580 them to store all pertinent intermediate computations into variables.
7582 @item -fexcess-precision=@var{style}
7583 @opindex fexcess-precision
7584 This option allows further control over excess precision on machines
7585 where floating-point registers have more precision than the IEEE
7586 @code{float} and @code{double} types and the processor does not
7587 support operations rounding to those types.  By default,
7588 @option{-fexcess-precision=fast} is in effect; this means that
7589 operations are carried out in the precision of the registers and that
7590 it is unpredictable when rounding to the types specified in the source
7591 code takes place.  When compiling C, if
7592 @option{-fexcess-precision=standard} is specified then excess
7593 precision will follow the rules specified in ISO C99; in particular,
7594 both casts and assignments cause values to be rounded to their
7595 semantic types (whereas @option{-ffloat-store} only affects
7596 assignments).  This option is enabled by default for C if a strict
7597 conformance option such as @option{-std=c99} is used.
7599 @opindex mfpmath
7600 @option{-fexcess-precision=standard} is not implemented for languages
7601 other than C, and has no effect if
7602 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7603 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7604 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7605 semantics apply without excess precision, and in the latter, rounding
7606 is unpredictable.
7608 @item -ffast-math
7609 @opindex ffast-math
7610 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7611 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7612 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7614 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7616 This option is not turned on by any @option{-O} option since
7617 it can result in incorrect output for programs which depend on
7618 an exact implementation of IEEE or ISO rules/specifications for
7619 math functions. It may, however, yield faster code for programs
7620 that do not require the guarantees of these specifications.
7622 @item -fno-math-errno
7623 @opindex fno-math-errno
7624 Do not set ERRNO after calling math functions that are executed
7625 with a single instruction, e.g., sqrt.  A program that relies on
7626 IEEE exceptions for math error handling may want to use this flag
7627 for speed while maintaining IEEE arithmetic compatibility.
7629 This option is not turned on by any @option{-O} option since
7630 it can result in incorrect output for programs which depend on
7631 an exact implementation of IEEE or ISO rules/specifications for
7632 math functions. It may, however, yield faster code for programs
7633 that do not require the guarantees of these specifications.
7635 The default is @option{-fmath-errno}.
7637 On Darwin systems, the math library never sets @code{errno}.  There is
7638 therefore no reason for the compiler to consider the possibility that
7639 it might, and @option{-fno-math-errno} is the default.
7641 @item -funsafe-math-optimizations
7642 @opindex funsafe-math-optimizations
7644 Allow optimizations for floating-point arithmetic that (a) assume
7645 that arguments and results are valid and (b) may violate IEEE or
7646 ANSI standards.  When used at link-time, it may include libraries
7647 or startup files that change the default FPU control word or other
7648 similar optimizations.
7650 This option is not turned on by any @option{-O} option since
7651 it can result in incorrect output for programs which depend on
7652 an exact implementation of IEEE or ISO rules/specifications for
7653 math functions. It may, however, yield faster code for programs
7654 that do not require the guarantees of these specifications.
7655 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7656 @option{-fassociative-math} and @option{-freciprocal-math}.
7658 The default is @option{-fno-unsafe-math-optimizations}.
7660 @item -fassociative-math
7661 @opindex fassociative-math
7663 Allow re-association of operands in series of floating-point operations.
7664 This violates the ISO C and C++ language standard by possibly changing
7665 computation result.  NOTE: re-ordering may change the sign of zero as
7666 well as ignore NaNs and inhibit or create underflow or overflow (and
7667 thus cannot be used on a code which relies on rounding behavior like
7668 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7669 and thus may not be used when ordered comparisons are required.
7670 This option requires that both @option{-fno-signed-zeros} and
7671 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7672 much sense with @option{-frounding-math}. For Fortran the option
7673 is automatically enabled when both @option{-fno-signed-zeros} and
7674 @option{-fno-trapping-math} are in effect.
7676 The default is @option{-fno-associative-math}.
7678 @item -freciprocal-math
7679 @opindex freciprocal-math
7681 Allow the reciprocal of a value to be used instead of dividing by
7682 the value if this enables optimizations.  For example @code{x / y}
7683 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7684 is subject to common subexpression elimination.  Note that this loses
7685 precision and increases the number of flops operating on the value.
7687 The default is @option{-fno-reciprocal-math}.
7689 @item -ffinite-math-only
7690 @opindex ffinite-math-only
7691 Allow optimizations for floating-point arithmetic that assume
7692 that arguments and results are not NaNs or +-Infs.
7694 This option is not turned on by any @option{-O} option since
7695 it can result in incorrect output for programs which depend on
7696 an exact implementation of IEEE or ISO rules/specifications for
7697 math functions. It may, however, yield faster code for programs
7698 that do not require the guarantees of these specifications.
7700 The default is @option{-fno-finite-math-only}.
7702 @item -fno-signed-zeros
7703 @opindex fno-signed-zeros
7704 Allow optimizations for floating point arithmetic that ignore the
7705 signedness of zero.  IEEE arithmetic specifies the behavior of
7706 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7707 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7708 This option implies that the sign of a zero result isn't significant.
7710 The default is @option{-fsigned-zeros}.
7712 @item -fno-trapping-math
7713 @opindex fno-trapping-math
7714 Compile code assuming that floating-point operations cannot generate
7715 user-visible traps.  These traps include division by zero, overflow,
7716 underflow, inexact result and invalid operation.  This option requires
7717 that @option{-fno-signaling-nans} be in effect.  Setting this option may
7718 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7720 This option should never be turned on by any @option{-O} option since
7721 it can result in incorrect output for programs which depend on
7722 an exact implementation of IEEE or ISO rules/specifications for
7723 math functions.
7725 The default is @option{-ftrapping-math}.
7727 @item -frounding-math
7728 @opindex frounding-math
7729 Disable transformations and optimizations that assume default floating
7730 point rounding behavior.  This is round-to-zero for all floating point
7731 to integer conversions, and round-to-nearest for all other arithmetic
7732 truncations.  This option should be specified for programs that change
7733 the FP rounding mode dynamically, or that may be executed with a
7734 non-default rounding mode.  This option disables constant folding of
7735 floating point expressions at compile-time (which may be affected by
7736 rounding mode) and arithmetic transformations that are unsafe in the
7737 presence of sign-dependent rounding modes.
7739 The default is @option{-fno-rounding-math}.
7741 This option is experimental and does not currently guarantee to
7742 disable all GCC optimizations that are affected by rounding mode.
7743 Future versions of GCC may provide finer control of this setting
7744 using C99's @code{FENV_ACCESS} pragma.  This command line option
7745 will be used to specify the default state for @code{FENV_ACCESS}.
7747 @item -fsignaling-nans
7748 @opindex fsignaling-nans
7749 Compile code assuming that IEEE signaling NaNs may generate user-visible
7750 traps during floating-point operations.  Setting this option disables
7751 optimizations that may change the number of exceptions visible with
7752 signaling NaNs.  This option implies @option{-ftrapping-math}.
7754 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7755 be defined.
7757 The default is @option{-fno-signaling-nans}.
7759 This option is experimental and does not currently guarantee to
7760 disable all GCC optimizations that affect signaling NaN behavior.
7762 @item -fsingle-precision-constant
7763 @opindex fsingle-precision-constant
7764 Treat floating point constant as single precision constant instead of
7765 implicitly converting it to double precision constant.
7767 @item -fcx-limited-range
7768 @opindex fcx-limited-range
7769 When enabled, this option states that a range reduction step is not
7770 needed when performing complex division.  Also, there is no checking
7771 whether the result of a complex multiplication or division is @code{NaN
7772 + I*NaN}, with an attempt to rescue the situation in that case.  The
7773 default is @option{-fno-cx-limited-range}, but is enabled by
7774 @option{-ffast-math}.
7776 This option controls the default setting of the ISO C99
7777 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
7778 all languages.
7780 @item -fcx-fortran-rules
7781 @opindex fcx-fortran-rules
7782 Complex multiplication and division follow Fortran rules.  Range
7783 reduction is done as part of complex division, but there is no checking
7784 whether the result of a complex multiplication or division is @code{NaN
7785 + I*NaN}, with an attempt to rescue the situation in that case.
7787 The default is @option{-fno-cx-fortran-rules}.
7789 @end table
7791 The following options control optimizations that may improve
7792 performance, but are not enabled by any @option{-O} options.  This
7793 section includes experimental options that may produce broken code.
7795 @table @gcctabopt
7796 @item -fbranch-probabilities
7797 @opindex fbranch-probabilities
7798 After running a program compiled with @option{-fprofile-arcs}
7799 (@pxref{Debugging Options,, Options for Debugging Your Program or
7800 @command{gcc}}), you can compile it a second time using
7801 @option{-fbranch-probabilities}, to improve optimizations based on
7802 the number of times each branch was taken.  When the program
7803 compiled with @option{-fprofile-arcs} exits it saves arc execution
7804 counts to a file called @file{@var{sourcename}.gcda} for each source
7805 file.  The information in this data file is very dependent on the
7806 structure of the generated code, so you must use the same source code
7807 and the same optimization options for both compilations.
7809 With @option{-fbranch-probabilities}, GCC puts a
7810 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7811 These can be used to improve optimization.  Currently, they are only
7812 used in one place: in @file{reorg.c}, instead of guessing which path a
7813 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
7814 exactly determine which path is taken more often.
7816 @item -fprofile-values
7817 @opindex fprofile-values
7818 If combined with @option{-fprofile-arcs}, it adds code so that some
7819 data about values of expressions in the program is gathered.
7821 With @option{-fbranch-probabilities}, it reads back the data gathered
7822 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
7823 notes to instructions for their later usage in optimizations.
7825 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
7827 @item -fvpt
7828 @opindex fvpt
7829 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7830 a code to gather information about values of expressions.
7832 With @option{-fbranch-probabilities}, it reads back the data gathered
7833 and actually performs the optimizations based on them.
7834 Currently the optimizations include specialization of division operation
7835 using the knowledge about the value of the denominator.
7837 @item -frename-registers
7838 @opindex frename-registers
7839 Attempt to avoid false dependencies in scheduled code by making use
7840 of registers left over after register allocation.  This optimization
7841 will most benefit processors with lots of registers.  Depending on the
7842 debug information format adopted by the target, however, it can
7843 make debugging impossible, since variables will no longer stay in
7844 a ``home register''.
7846 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
7848 @item -ftracer
7849 @opindex ftracer
7850 Perform tail duplication to enlarge superblock size.  This transformation
7851 simplifies the control flow of the function allowing other optimizations to do
7852 better job.
7854 Enabled with @option{-fprofile-use}.
7856 @item -funroll-loops
7857 @opindex funroll-loops
7858 Unroll loops whose number of iterations can be determined at compile time or
7859 upon entry to the loop.  @option{-funroll-loops} implies
7860 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
7861 It also turns on complete loop peeling (i.e.@: complete removal of loops with
7862 small constant number of iterations).  This option makes code larger, and may
7863 or may not make it run faster.
7865 Enabled with @option{-fprofile-use}.
7867 @item -funroll-all-loops
7868 @opindex funroll-all-loops
7869 Unroll all loops, even if their number of iterations is uncertain when
7870 the loop is entered.  This usually makes programs run more slowly.
7871 @option{-funroll-all-loops} implies the same options as
7872 @option{-funroll-loops}.
7874 @item -fpeel-loops
7875 @opindex fpeel-loops
7876 Peels the loops for that there is enough information that they do not
7877 roll much (from profile feedback).  It also turns on complete loop peeling
7878 (i.e.@: complete removal of loops with small constant number of iterations).
7880 Enabled with @option{-fprofile-use}.
7882 @item -fmove-loop-invariants
7883 @opindex fmove-loop-invariants
7884 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
7885 at level @option{-O1}
7887 @item -funswitch-loops
7888 @opindex funswitch-loops
7889 Move branches with loop invariant conditions out of the loop, with duplicates
7890 of the loop on both branches (modified according to result of the condition).
7892 @item -ffunction-sections
7893 @itemx -fdata-sections
7894 @opindex ffunction-sections
7895 @opindex fdata-sections
7896 Place each function or data item into its own section in the output
7897 file if the target supports arbitrary sections.  The name of the
7898 function or the name of the data item determines the section's name
7899 in the output file.
7901 Use these options on systems where the linker can perform optimizations
7902 to improve locality of reference in the instruction space.  Most systems
7903 using the ELF object format and SPARC processors running Solaris 2 have
7904 linkers with such optimizations.  AIX may have these optimizations in
7905 the future.
7907 Only use these options when there are significant benefits from doing
7908 so.  When you specify these options, the assembler and linker will
7909 create larger object and executable files and will also be slower.
7910 You will not be able to use @code{gprof} on all systems if you
7911 specify this option and you may have problems with debugging if
7912 you specify both this option and @option{-g}.
7914 @item -fbranch-target-load-optimize
7915 @opindex fbranch-target-load-optimize
7916 Perform branch target register load optimization before prologue / epilogue
7917 threading.
7918 The use of target registers can typically be exposed only during reload,
7919 thus hoisting loads out of loops and doing inter-block scheduling needs
7920 a separate optimization pass.
7922 @item -fbranch-target-load-optimize2
7923 @opindex fbranch-target-load-optimize2
7924 Perform branch target register load optimization after prologue / epilogue
7925 threading.
7927 @item -fbtr-bb-exclusive
7928 @opindex fbtr-bb-exclusive
7929 When performing branch target register load optimization, don't reuse
7930 branch target registers in within any basic block.
7932 @item -fstack-protector
7933 @opindex fstack-protector
7934 Emit extra code to check for buffer overflows, such as stack smashing
7935 attacks.  This is done by adding a guard variable to functions with
7936 vulnerable objects.  This includes functions that call alloca, and
7937 functions with buffers larger than 8 bytes.  The guards are initialized
7938 when a function is entered and then checked when the function exits.
7939 If a guard check fails, an error message is printed and the program exits.
7941 @item -fstack-protector-all
7942 @opindex fstack-protector-all
7943 Like @option{-fstack-protector} except that all functions are protected.
7945 @item -fsection-anchors
7946 @opindex fsection-anchors
7947 Try to reduce the number of symbolic address calculations by using
7948 shared ``anchor'' symbols to address nearby objects.  This transformation
7949 can help to reduce the number of GOT entries and GOT accesses on some
7950 targets.
7952 For example, the implementation of the following function @code{foo}:
7954 @smallexample
7955 static int a, b, c;
7956 int foo (void) @{ return a + b + c; @}
7957 @end smallexample
7959 would usually calculate the addresses of all three variables, but if you
7960 compile it with @option{-fsection-anchors}, it will access the variables
7961 from a common anchor point instead.  The effect is similar to the
7962 following pseudocode (which isn't valid C):
7964 @smallexample
7965 int foo (void)
7967   register int *xr = &x;
7968   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
7970 @end smallexample
7972 Not all targets support this option.
7974 @item --param @var{name}=@var{value}
7975 @opindex param
7976 In some places, GCC uses various constants to control the amount of
7977 optimization that is done.  For example, GCC will not inline functions
7978 that contain more that a certain number of instructions.  You can
7979 control some of these constants on the command-line using the
7980 @option{--param} option.
7982 The names of specific parameters, and the meaning of the values, are
7983 tied to the internals of the compiler, and are subject to change
7984 without notice in future releases.
7986 In each case, the @var{value} is an integer.  The allowable choices for
7987 @var{name} are given in the following table:
7989 @table @gcctabopt
7990 @item struct-reorg-cold-struct-ratio
7991 The threshold ratio (as a percentage) between a structure frequency
7992 and the frequency of the hottest structure in the program.  This parameter
7993 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
7994 We say that if the ratio of a structure frequency, calculated by profiling,
7995 to the hottest structure frequency in the program is less than this
7996 parameter, then structure reorganization is not applied to this structure.
7997 The default is 10.
7999 @item predictable-branch-outcome
8000 When branch is predicted to be taken with probability lower than this threshold
8001 (in percent), then it is considered well predictable. The default is 10.
8003 @item max-crossjump-edges
8004 The maximum number of incoming edges to consider for crossjumping.
8005 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8006 the number of edges incoming to each block.  Increasing values mean
8007 more aggressive optimization, making the compile time increase with
8008 probably small improvement in executable size.
8010 @item min-crossjump-insns
8011 The minimum number of instructions which must be matched at the end
8012 of two blocks before crossjumping will be performed on them.  This
8013 value is ignored in the case where all instructions in the block being
8014 crossjumped from are matched.  The default value is 5.
8016 @item max-grow-copy-bb-insns
8017 The maximum code size expansion factor when copying basic blocks
8018 instead of jumping.  The expansion is relative to a jump instruction.
8019 The default value is 8.
8021 @item max-goto-duplication-insns
8022 The maximum number of instructions to duplicate to a block that jumps
8023 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8024 passes, GCC factors computed gotos early in the compilation process,
8025 and unfactors them as late as possible.  Only computed jumps at the
8026 end of a basic blocks with no more than max-goto-duplication-insns are
8027 unfactored.  The default value is 8.
8029 @item max-delay-slot-insn-search
8030 The maximum number of instructions to consider when looking for an
8031 instruction to fill a delay slot.  If more than this arbitrary number of
8032 instructions is searched, the time savings from filling the delay slot
8033 will be minimal so stop searching.  Increasing values mean more
8034 aggressive optimization, making the compile time increase with probably
8035 small improvement in executable run time.
8037 @item max-delay-slot-live-search
8038 When trying to fill delay slots, the maximum number of instructions to
8039 consider when searching for a block with valid live register
8040 information.  Increasing this arbitrarily chosen value means more
8041 aggressive optimization, increasing the compile time.  This parameter
8042 should be removed when the delay slot code is rewritten to maintain the
8043 control-flow graph.
8045 @item max-gcse-memory
8046 The approximate maximum amount of memory that will be allocated in
8047 order to perform the global common subexpression elimination
8048 optimization.  If more memory than specified is required, the
8049 optimization will not be done.
8051 @item max-pending-list-length
8052 The maximum number of pending dependencies scheduling will allow
8053 before flushing the current state and starting over.  Large functions
8054 with few branches or calls can create excessively large lists which
8055 needlessly consume memory and resources.
8057 @item max-inline-insns-single
8058 Several parameters control the tree inliner used in gcc.
8059 This number sets the maximum number of instructions (counted in GCC's
8060 internal representation) in a single function that the tree inliner
8061 will consider for inlining.  This only affects functions declared
8062 inline and methods implemented in a class declaration (C++).
8063 The default value is 300.
8065 @item max-inline-insns-auto
8066 When you use @option{-finline-functions} (included in @option{-O3}),
8067 a lot of functions that would otherwise not be considered for inlining
8068 by the compiler will be investigated.  To those functions, a different
8069 (more restrictive) limit compared to functions declared inline can
8070 be applied.
8071 The default value is 50.
8073 @item large-function-insns
8074 The limit specifying really large functions.  For functions larger than this
8075 limit after inlining, inlining is constrained by
8076 @option{--param large-function-growth}.  This parameter is useful primarily
8077 to avoid extreme compilation time caused by non-linear algorithms used by the
8078 backend.
8079 The default value is 2700.
8081 @item large-function-growth
8082 Specifies maximal growth of large function caused by inlining in percents.
8083 The default value is 100 which limits large function growth to 2.0 times
8084 the original size.
8086 @item large-unit-insns
8087 The limit specifying large translation unit.  Growth caused by inlining of
8088 units larger than this limit is limited by @option{--param inline-unit-growth}.
8089 For small units this might be too tight (consider unit consisting of function A
8090 that is inline and B that just calls A three time.  If B is small relative to
8091 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8092 large units consisting of small inlineable functions however the overall unit
8093 growth limit is needed to avoid exponential explosion of code size.  Thus for
8094 smaller units, the size is increased to @option{--param large-unit-insns}
8095 before applying @option{--param inline-unit-growth}.  The default is 10000
8097 @item inline-unit-growth
8098 Specifies maximal overall growth of the compilation unit caused by inlining.
8099 The default value is 30 which limits unit growth to 1.3 times the original
8100 size.
8102 @item ipcp-unit-growth
8103 Specifies maximal overall growth of the compilation unit caused by
8104 interprocedural constant propagation.  The default value is 10 which limits
8105 unit growth to 1.1 times the original size.
8107 @item large-stack-frame
8108 The limit specifying large stack frames.  While inlining the algorithm is trying
8109 to not grow past this limit too much.  Default value is 256 bytes.
8111 @item large-stack-frame-growth
8112 Specifies maximal growth of large stack frames caused by inlining in percents.
8113 The default value is 1000 which limits large stack frame growth to 11 times
8114 the original size.
8116 @item max-inline-insns-recursive
8117 @itemx max-inline-insns-recursive-auto
8118 Specifies maximum number of instructions out-of-line copy of self recursive inline
8119 function can grow into by performing recursive inlining.
8121 For functions declared inline @option{--param max-inline-insns-recursive} is
8122 taken into account.  For function not declared inline, recursive inlining
8123 happens only when @option{-finline-functions} (included in @option{-O3}) is
8124 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8125 default value is 450.
8127 @item max-inline-recursive-depth
8128 @itemx max-inline-recursive-depth-auto
8129 Specifies maximum recursion depth used by the recursive inlining.
8131 For functions declared inline @option{--param max-inline-recursive-depth} is
8132 taken into account.  For function not declared inline, recursive inlining
8133 happens only when @option{-finline-functions} (included in @option{-O3}) is
8134 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8135 default value is 8.
8137 @item min-inline-recursive-probability
8138 Recursive inlining is profitable only for function having deep recursion
8139 in average and can hurt for function having little recursion depth by
8140 increasing the prologue size or complexity of function body to other
8141 optimizers.
8143 When profile feedback is available (see @option{-fprofile-generate}) the actual
8144 recursion depth can be guessed from probability that function will recurse via
8145 given call expression.  This parameter limits inlining only to call expression
8146 whose probability exceeds given threshold (in percents).  The default value is
8149 @item early-inlining-insns
8150 Specify growth that early inliner can make.  In effect it increases amount of
8151 inlining for code having large abstraction penalty.  The default value is 8.
8153 @item max-early-inliner-iterations
8154 @itemx max-early-inliner-iterations
8155 Limit of iterations of early inliner.  This basically bounds number of nested
8156 indirect calls early inliner can resolve.  Deeper chains are still handled by
8157 late inlining.
8159 @item min-vect-loop-bound
8160 The minimum number of iterations under which a loop will not get vectorized
8161 when @option{-ftree-vectorize} is used.  The number of iterations after
8162 vectorization needs to be greater than the value specified by this option
8163 to allow vectorization.  The default value is 0.
8165 @item max-unrolled-insns
8166 The maximum number of instructions that a loop should have if that loop
8167 is unrolled, and if the loop is unrolled, it determines how many times
8168 the loop code is unrolled.
8170 @item max-average-unrolled-insns
8171 The maximum number of instructions biased by probabilities of their execution
8172 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8173 it determines how many times the loop code is unrolled.
8175 @item max-unroll-times
8176 The maximum number of unrollings of a single loop.
8178 @item max-peeled-insns
8179 The maximum number of instructions that a loop should have if that loop
8180 is peeled, and if the loop is peeled, it determines how many times
8181 the loop code is peeled.
8183 @item max-peel-times
8184 The maximum number of peelings of a single loop.
8186 @item max-completely-peeled-insns
8187 The maximum number of insns of a completely peeled loop.
8189 @item max-completely-peel-times
8190 The maximum number of iterations of a loop to be suitable for complete peeling.
8192 @item max-completely-peel-loop-nest-depth
8193 The maximum depth of a loop nest suitable for complete peeling.
8195 @item max-unswitch-insns
8196 The maximum number of insns of an unswitched loop.
8198 @item max-unswitch-level
8199 The maximum number of branches unswitched in a single loop.
8201 @item lim-expensive
8202 The minimum cost of an expensive expression in the loop invariant motion.
8204 @item iv-consider-all-candidates-bound
8205 Bound on number of candidates for induction variables below that
8206 all candidates are considered for each use in induction variable
8207 optimizations.  Only the most relevant candidates are considered
8208 if there are more candidates, to avoid quadratic time complexity.
8210 @item iv-max-considered-uses
8211 The induction variable optimizations give up on loops that contain more
8212 induction variable uses.
8214 @item iv-always-prune-cand-set-bound
8215 If number of candidates in the set is smaller than this value,
8216 we always try to remove unnecessary ivs from the set during its
8217 optimization when a new iv is added to the set.
8219 @item scev-max-expr-size
8220 Bound on size of expressions used in the scalar evolutions analyzer.
8221 Large expressions slow the analyzer.
8223 @item omega-max-vars
8224 The maximum number of variables in an Omega constraint system.
8225 The default value is 128.
8227 @item omega-max-geqs
8228 The maximum number of inequalities in an Omega constraint system.
8229 The default value is 256.
8231 @item omega-max-eqs
8232 The maximum number of equalities in an Omega constraint system.
8233 The default value is 128.
8235 @item omega-max-wild-cards
8236 The maximum number of wildcard variables that the Omega solver will
8237 be able to insert.  The default value is 18.
8239 @item omega-hash-table-size
8240 The size of the hash table in the Omega solver.  The default value is
8241 550.
8243 @item omega-max-keys
8244 The maximal number of keys used by the Omega solver.  The default
8245 value is 500.
8247 @item omega-eliminate-redundant-constraints
8248 When set to 1, use expensive methods to eliminate all redundant
8249 constraints.  The default value is 0.
8251 @item vect-max-version-for-alignment-checks
8252 The maximum number of runtime checks that can be performed when
8253 doing loop versioning for alignment in the vectorizer.  See option
8254 ftree-vect-loop-version for more information.
8256 @item vect-max-version-for-alias-checks
8257 The maximum number of runtime checks that can be performed when
8258 doing loop versioning for alias in the vectorizer.  See option
8259 ftree-vect-loop-version for more information.
8261 @item max-iterations-to-track
8263 The maximum number of iterations of a loop the brute force algorithm
8264 for analysis of # of iterations of the loop tries to evaluate.
8266 @item hot-bb-count-fraction
8267 Select fraction of the maximal count of repetitions of basic block in program
8268 given basic block needs to have to be considered hot.
8270 @item hot-bb-frequency-fraction
8271 Select fraction of the maximal frequency of executions of basic block in
8272 function given basic block needs to have to be considered hot
8274 @item max-predicted-iterations
8275 The maximum number of loop iterations we predict statically.  This is useful
8276 in cases where function contain single loop with known bound and other loop
8277 with unknown.  We predict the known number of iterations correctly, while
8278 the unknown number of iterations average to roughly 10.  This means that the
8279 loop without bounds would appear artificially cold relative to the other one.
8281 @item align-threshold
8283 Select fraction of the maximal frequency of executions of basic block in
8284 function given basic block will get aligned.
8286 @item align-loop-iterations
8288 A loop expected to iterate at lest the selected number of iterations will get
8289 aligned.
8291 @item tracer-dynamic-coverage
8292 @itemx tracer-dynamic-coverage-feedback
8294 This value is used to limit superblock formation once the given percentage of
8295 executed instructions is covered.  This limits unnecessary code size
8296 expansion.
8298 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8299 feedback is available.  The real profiles (as opposed to statically estimated
8300 ones) are much less balanced allowing the threshold to be larger value.
8302 @item tracer-max-code-growth
8303 Stop tail duplication once code growth has reached given percentage.  This is
8304 rather hokey argument, as most of the duplicates will be eliminated later in
8305 cross jumping, so it may be set to much higher values than is the desired code
8306 growth.
8308 @item tracer-min-branch-ratio
8310 Stop reverse growth when the reverse probability of best edge is less than this
8311 threshold (in percent).
8313 @item tracer-min-branch-ratio
8314 @itemx tracer-min-branch-ratio-feedback
8316 Stop forward growth if the best edge do have probability lower than this
8317 threshold.
8319 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8320 compilation for profile feedback and one for compilation without.  The value
8321 for compilation with profile feedback needs to be more conservative (higher) in
8322 order to make tracer effective.
8324 @item max-cse-path-length
8326 Maximum number of basic blocks on path that cse considers.  The default is 10.
8328 @item max-cse-insns
8329 The maximum instructions CSE process before flushing. The default is 1000.
8331 @item ggc-min-expand
8333 GCC uses a garbage collector to manage its own memory allocation.  This
8334 parameter specifies the minimum percentage by which the garbage
8335 collector's heap should be allowed to expand between collections.
8336 Tuning this may improve compilation speed; it has no effect on code
8337 generation.
8339 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8340 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8341 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8342 GCC is not able to calculate RAM on a particular platform, the lower
8343 bound of 30% is used.  Setting this parameter and
8344 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8345 every opportunity.  This is extremely slow, but can be useful for
8346 debugging.
8348 @item ggc-min-heapsize
8350 Minimum size of the garbage collector's heap before it begins bothering
8351 to collect garbage.  The first collection occurs after the heap expands
8352 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8353 tuning this may improve compilation speed, and has no effect on code
8354 generation.
8356 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8357 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8358 with a lower bound of 4096 (four megabytes) and an upper bound of
8359 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8360 particular platform, the lower bound is used.  Setting this parameter
8361 very large effectively disables garbage collection.  Setting this
8362 parameter and @option{ggc-min-expand} to zero causes a full collection
8363 to occur at every opportunity.
8365 @item max-reload-search-insns
8366 The maximum number of instruction reload should look backward for equivalent
8367 register.  Increasing values mean more aggressive optimization, making the
8368 compile time increase with probably slightly better performance.  The default
8369 value is 100.
8371 @item max-cselib-memory-locations
8372 The maximum number of memory locations cselib should take into account.
8373 Increasing values mean more aggressive optimization, making the compile time
8374 increase with probably slightly better performance.  The default value is 500.
8376 @item reorder-blocks-duplicate
8377 @itemx reorder-blocks-duplicate-feedback
8379 Used by basic block reordering pass to decide whether to use unconditional
8380 branch or duplicate the code on its destination.  Code is duplicated when its
8381 estimated size is smaller than this value multiplied by the estimated size of
8382 unconditional jump in the hot spots of the program.
8384 The @option{reorder-block-duplicate-feedback} is used only when profile
8385 feedback is available and may be set to higher values than
8386 @option{reorder-block-duplicate} since information about the hot spots is more
8387 accurate.
8389 @item max-sched-ready-insns
8390 The maximum number of instructions ready to be issued the scheduler should
8391 consider at any given time during the first scheduling pass.  Increasing
8392 values mean more thorough searches, making the compilation time increase
8393 with probably little benefit.  The default value is 100.
8395 @item max-sched-region-blocks
8396 The maximum number of blocks in a region to be considered for
8397 interblock scheduling.  The default value is 10.
8399 @item max-pipeline-region-blocks
8400 The maximum number of blocks in a region to be considered for
8401 pipelining in the selective scheduler.  The default value is 15.
8403 @item max-sched-region-insns
8404 The maximum number of insns in a region to be considered for
8405 interblock scheduling.  The default value is 100.
8407 @item max-pipeline-region-insns
8408 The maximum number of insns in a region to be considered for
8409 pipelining in the selective scheduler.  The default value is 200.
8411 @item min-spec-prob
8412 The minimum probability (in percents) of reaching a source block
8413 for interblock speculative scheduling.  The default value is 40.
8415 @item max-sched-extend-regions-iters
8416 The maximum number of iterations through CFG to extend regions.
8417 0 - disable region extension,
8418 N - do at most N iterations.
8419 The default value is 0.
8421 @item max-sched-insn-conflict-delay
8422 The maximum conflict delay for an insn to be considered for speculative motion.
8423 The default value is 3.
8425 @item sched-spec-prob-cutoff
8426 The minimal probability of speculation success (in percents), so that
8427 speculative insn will be scheduled.
8428 The default value is 40.
8430 @item sched-mem-true-dep-cost
8431 Minimal distance (in CPU cycles) between store and load targeting same
8432 memory locations.  The default value is 1.
8434 @item selsched-max-lookahead
8435 The maximum size of the lookahead window of selective scheduling.  It is a
8436 depth of search for available instructions.
8437 The default value is 50.
8439 @item selsched-max-sched-times
8440 The maximum number of times that an instruction will be scheduled during
8441 selective scheduling.  This is the limit on the number of iterations
8442 through which the instruction may be pipelined.  The default value is 2.
8444 @item selsched-max-insns-to-rename
8445 The maximum number of best instructions in the ready list that are considered
8446 for renaming in the selective scheduler.  The default value is 2.
8448 @item max-last-value-rtl
8449 The maximum size measured as number of RTLs that can be recorded in an expression
8450 in combiner for a pseudo register as last known value of that register.  The default
8451 is 10000.
8453 @item integer-share-limit
8454 Small integer constants can use a shared data structure, reducing the
8455 compiler's memory usage and increasing its speed.  This sets the maximum
8456 value of a shared integer constant.  The default value is 256.
8458 @item min-virtual-mappings
8459 Specifies the minimum number of virtual mappings in the incremental
8460 SSA updater that should be registered to trigger the virtual mappings
8461 heuristic defined by virtual-mappings-ratio.  The default value is
8462 100.
8464 @item virtual-mappings-ratio
8465 If the number of virtual mappings is virtual-mappings-ratio bigger
8466 than the number of virtual symbols to be updated, then the incremental
8467 SSA updater switches to a full update for those symbols.  The default
8468 ratio is 3.
8470 @item ssp-buffer-size
8471 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8472 protection when @option{-fstack-protection} is used.
8474 @item max-jump-thread-duplication-stmts
8475 Maximum number of statements allowed in a block that needs to be
8476 duplicated when threading jumps.
8478 @item max-fields-for-field-sensitive
8479 Maximum number of fields in a structure we will treat in
8480 a field sensitive manner during pointer analysis.  The default is zero
8481 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8483 @item prefetch-latency
8484 Estimate on average number of instructions that are executed before
8485 prefetch finishes.  The distance we prefetch ahead is proportional
8486 to this constant.  Increasing this number may also lead to less
8487 streams being prefetched (see @option{simultaneous-prefetches}).
8489 @item simultaneous-prefetches
8490 Maximum number of prefetches that can run at the same time.
8492 @item l1-cache-line-size
8493 The size of cache line in L1 cache, in bytes.
8495 @item l1-cache-size
8496 The size of L1 cache, in kilobytes.
8498 @item l2-cache-size
8499 The size of L2 cache, in kilobytes.
8501 @item min-insn-to-prefetch-ratio
8502 The minimum ratio between the number of instructions and the
8503 number of prefetches to enable prefetching in a loop with an
8504 unknown trip count.
8506 @item prefetch-min-insn-to-mem-ratio
8507 The minimum ratio between the number of instructions and the
8508 number of memory references to enable prefetching in a loop.
8510 @item use-canonical-types
8511 Whether the compiler should use the ``canonical'' type system.  By
8512 default, this should always be 1, which uses a more efficient internal
8513 mechanism for comparing types in C++ and Objective-C++.  However, if
8514 bugs in the canonical type system are causing compilation failures,
8515 set this value to 0 to disable canonical types.
8517 @item switch-conversion-max-branch-ratio
8518 Switch initialization conversion will refuse to create arrays that are
8519 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8520 branches in the switch.
8522 @item max-partial-antic-length
8523 Maximum length of the partial antic set computed during the tree
8524 partial redundancy elimination optimization (@option{-ftree-pre}) when
8525 optimizing at @option{-O3} and above.  For some sorts of source code
8526 the enhanced partial redundancy elimination optimization can run away,
8527 consuming all of the memory available on the host machine.  This
8528 parameter sets a limit on the length of the sets that are computed,
8529 which prevents the runaway behavior.  Setting a value of 0 for
8530 this parameter will allow an unlimited set length.
8532 @item sccvn-max-scc-size
8533 Maximum size of a strongly connected component (SCC) during SCCVN
8534 processing.  If this limit is hit, SCCVN processing for the whole
8535 function will not be done and optimizations depending on it will
8536 be disabled.  The default maximum SCC size is 10000.
8538 @item ira-max-loops-num
8539 IRA uses a regional register allocation by default.  If a function
8540 contains loops more than number given by the parameter, only at most
8541 given number of the most frequently executed loops will form regions
8542 for the regional register allocation.  The default value of the
8543 parameter is 100.
8545 @item ira-max-conflict-table-size
8546 Although IRA uses a sophisticated algorithm of compression conflict
8547 table, the table can be still big for huge functions.  If the conflict
8548 table for a function could be more than size in MB given by the
8549 parameter, the conflict table is not built and faster, simpler, and
8550 lower quality register allocation algorithm will be used.  The
8551 algorithm do not use pseudo-register conflicts.  The default value of
8552 the parameter is 2000.
8554 @item ira-loop-reserved-regs
8555 IRA can be used to evaluate more accurate register pressure in loops
8556 for decision to move loop invariants (see @option{-O3}).  The number
8557 of available registers reserved for some other purposes is described
8558 by this parameter.  The default value of the parameter is 2 which is
8559 minimal number of registers needed for execution of typical
8560 instruction.  This value is the best found from numerous experiments.
8562 @item loop-invariant-max-bbs-in-loop
8563 Loop invariant motion can be very expensive, both in compile time and
8564 in amount of needed compile time memory, with very large loops.  Loops
8565 with more basic blocks than this parameter won't have loop invariant
8566 motion optimization performed on them.  The default value of the
8567 parameter is 1000 for -O1 and 10000 for -O2 and above.
8569 @item max-vartrack-size
8570 Sets a maximum number of hash table slots to use during variable
8571 tracking dataflow analysis of any function.  If this limit is exceeded
8572 with variable tracking at assignments enabled, analysis for that
8573 function is retried without it, after removing all debug insns from
8574 the function.  If the limit is exceeded even without debug insns, var
8575 tracking analysis is completely disabled for the function.  Setting
8576 the parameter to zero makes it unlimited.
8578 @item min-nondebug-insn-uid
8579 Use uids starting at this parameter for nondebug insns.  The range below
8580 the parameter is reserved exclusively for debug insns created by
8581 @option{-fvar-tracking-assignments}, but debug insns may get
8582 (non-overlapping) uids above it if the reserved range is exhausted.
8584 @item ipa-sra-ptr-growth-factor
8585 IPA-SRA will replace a pointer to an aggregate with one or more new
8586 parameters only when their cumulative size is less or equal to
8587 @option{ipa-sra-ptr-growth-factor} times the size of the original
8588 pointer parameter.
8590 @item graphite-max-nb-scop-params
8591 To avoid exponential effects in the Graphite loop transforms, the
8592 number of parameters in a Static Control Part (SCoP) is bounded.  The
8593 default value is 10 parameters.  A variable whose value is unknown at
8594 compile time and defined outside a SCoP is a parameter of the SCoP.
8596 @item graphite-max-bbs-per-function
8597 To avoid exponential effects in the detection of SCoPs, the size of
8598 the functions analyzed by Graphite is bounded.  The default value is
8599 100 basic blocks.
8601 @item loop-block-tile-size
8602 Loop blocking or strip mining transforms, enabled with
8603 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
8604 loop in the loop nest by a given number of iterations.  The strip
8605 length can be changed using the @option{loop-block-tile-size}
8606 parameter.  The default value is 51 iterations.
8608 @end table
8609 @end table
8611 @node Preprocessor Options
8612 @section Options Controlling the Preprocessor
8613 @cindex preprocessor options
8614 @cindex options, preprocessor
8616 These options control the C preprocessor, which is run on each C source
8617 file before actual compilation.
8619 If you use the @option{-E} option, nothing is done except preprocessing.
8620 Some of these options make sense only together with @option{-E} because
8621 they cause the preprocessor output to be unsuitable for actual
8622 compilation.
8624 @table @gcctabopt
8625 @item -Wp,@var{option}
8626 @opindex Wp
8627 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8628 and pass @var{option} directly through to the preprocessor.  If
8629 @var{option} contains commas, it is split into multiple options at the
8630 commas.  However, many options are modified, translated or interpreted
8631 by the compiler driver before being passed to the preprocessor, and
8632 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8633 interface is undocumented and subject to change, so whenever possible
8634 you should avoid using @option{-Wp} and let the driver handle the
8635 options instead.
8637 @item -Xpreprocessor @var{option}
8638 @opindex Xpreprocessor
8639 Pass @var{option} as an option to the preprocessor.  You can use this to
8640 supply system-specific preprocessor options which GCC does not know how to
8641 recognize.
8643 If you want to pass an option that takes an argument, you must use
8644 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8645 @end table
8647 @include cppopts.texi
8649 @node Assembler Options
8650 @section Passing Options to the Assembler
8652 @c prevent bad page break with this line
8653 You can pass options to the assembler.
8655 @table @gcctabopt
8656 @item -Wa,@var{option}
8657 @opindex Wa
8658 Pass @var{option} as an option to the assembler.  If @var{option}
8659 contains commas, it is split into multiple options at the commas.
8661 @item -Xassembler @var{option}
8662 @opindex Xassembler
8663 Pass @var{option} as an option to the assembler.  You can use this to
8664 supply system-specific assembler options which GCC does not know how to
8665 recognize.
8667 If you want to pass an option that takes an argument, you must use
8668 @option{-Xassembler} twice, once for the option and once for the argument.
8670 @end table
8672 @node Link Options
8673 @section Options for Linking
8674 @cindex link options
8675 @cindex options, linking
8677 These options come into play when the compiler links object files into
8678 an executable output file.  They are meaningless if the compiler is
8679 not doing a link step.
8681 @table @gcctabopt
8682 @cindex file names
8683 @item @var{object-file-name}
8684 A file name that does not end in a special recognized suffix is
8685 considered to name an object file or library.  (Object files are
8686 distinguished from libraries by the linker according to the file
8687 contents.)  If linking is done, these object files are used as input
8688 to the linker.
8690 @item -c
8691 @itemx -S
8692 @itemx -E
8693 @opindex c
8694 @opindex S
8695 @opindex E
8696 If any of these options is used, then the linker is not run, and
8697 object file names should not be used as arguments.  @xref{Overall
8698 Options}.
8700 @cindex Libraries
8701 @item -l@var{library}
8702 @itemx -l @var{library}
8703 @opindex l
8704 Search the library named @var{library} when linking.  (The second
8705 alternative with the library as a separate argument is only for
8706 POSIX compliance and is not recommended.)
8708 It makes a difference where in the command you write this option; the
8709 linker searches and processes libraries and object files in the order they
8710 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8711 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8712 to functions in @samp{z}, those functions may not be loaded.
8714 The linker searches a standard list of directories for the library,
8715 which is actually a file named @file{lib@var{library}.a}.  The linker
8716 then uses this file as if it had been specified precisely by name.
8718 The directories searched include several standard system directories
8719 plus any that you specify with @option{-L}.
8721 Normally the files found this way are library files---archive files
8722 whose members are object files.  The linker handles an archive file by
8723 scanning through it for members which define symbols that have so far
8724 been referenced but not defined.  But if the file that is found is an
8725 ordinary object file, it is linked in the usual fashion.  The only
8726 difference between using an @option{-l} option and specifying a file name
8727 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8728 and searches several directories.
8730 @item -lobjc
8731 @opindex lobjc
8732 You need this special case of the @option{-l} option in order to
8733 link an Objective-C or Objective-C++ program.
8735 @item -nostartfiles
8736 @opindex nostartfiles
8737 Do not use the standard system startup files when linking.
8738 The standard system libraries are used normally, unless @option{-nostdlib}
8739 or @option{-nodefaultlibs} is used.
8741 @item -nodefaultlibs
8742 @opindex nodefaultlibs
8743 Do not use the standard system libraries when linking.
8744 Only the libraries you specify will be passed to the linker, options
8745 specifying linkage of the system libraries, such as @code{-static-libgcc}
8746 or @code{-shared-libgcc}, will be ignored.
8747 The standard startup files are used normally, unless @option{-nostartfiles}
8748 is used.  The compiler may generate calls to @code{memcmp},
8749 @code{memset}, @code{memcpy} and @code{memmove}.
8750 These entries are usually resolved by entries in
8751 libc.  These entry points should be supplied through some other
8752 mechanism when this option is specified.
8754 @item -nostdlib
8755 @opindex nostdlib
8756 Do not use the standard system startup files or libraries when linking.
8757 No startup files and only the libraries you specify will be passed to
8758 the linker, options specifying linkage of the system libraries, such as
8759 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8760 The compiler may generate calls to @code{memcmp}, @code{memset},
8761 @code{memcpy} and @code{memmove}.
8762 These entries are usually resolved by entries in
8763 libc.  These entry points should be supplied through some other
8764 mechanism when this option is specified.
8766 @cindex @option{-lgcc}, use with @option{-nostdlib}
8767 @cindex @option{-nostdlib} and unresolved references
8768 @cindex unresolved references and @option{-nostdlib}
8769 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8770 @cindex @option{-nodefaultlibs} and unresolved references
8771 @cindex unresolved references and @option{-nodefaultlibs}
8772 One of the standard libraries bypassed by @option{-nostdlib} and
8773 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8774 that GCC uses to overcome shortcomings of particular machines, or special
8775 needs for some languages.
8776 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8777 Collection (GCC) Internals},
8778 for more discussion of @file{libgcc.a}.)
8779 In most cases, you need @file{libgcc.a} even when you want to avoid
8780 other standard libraries.  In other words, when you specify @option{-nostdlib}
8781 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8782 This ensures that you have no unresolved references to internal GCC
8783 library subroutines.  (For example, @samp{__main}, used to ensure C++
8784 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8785 GNU Compiler Collection (GCC) Internals}.)
8787 @item -pie
8788 @opindex pie
8789 Produce a position independent executable on targets which support it.
8790 For predictable results, you must also specify the same set of options
8791 that were used to generate code (@option{-fpie}, @option{-fPIE},
8792 or model suboptions) when you specify this option.
8794 @item -rdynamic
8795 @opindex rdynamic
8796 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8797 that support it. This instructs the linker to add all symbols, not
8798 only used ones, to the dynamic symbol table. This option is needed
8799 for some uses of @code{dlopen} or to allow obtaining backtraces
8800 from within a program.
8802 @item -s
8803 @opindex s
8804 Remove all symbol table and relocation information from the executable.
8806 @item -static
8807 @opindex static
8808 On systems that support dynamic linking, this prevents linking with the shared
8809 libraries.  On other systems, this option has no effect.
8811 @item -shared
8812 @opindex shared
8813 Produce a shared object which can then be linked with other objects to
8814 form an executable.  Not all systems support this option.  For predictable
8815 results, you must also specify the same set of options that were used to
8816 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
8817 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
8818 needs to build supplementary stub code for constructors to work.  On
8819 multi-libbed systems, @samp{gcc -shared} must select the correct support
8820 libraries to link against.  Failing to supply the correct flags may lead
8821 to subtle defects.  Supplying them in cases where they are not necessary
8822 is innocuous.}
8824 @item -shared-libgcc
8825 @itemx -static-libgcc
8826 @opindex shared-libgcc
8827 @opindex static-libgcc
8828 On systems that provide @file{libgcc} as a shared library, these options
8829 force the use of either the shared or static version respectively.
8830 If no shared version of @file{libgcc} was built when the compiler was
8831 configured, these options have no effect.
8833 There are several situations in which an application should use the
8834 shared @file{libgcc} instead of the static version.  The most common
8835 of these is when the application wishes to throw and catch exceptions
8836 across different shared libraries.  In that case, each of the libraries
8837 as well as the application itself should use the shared @file{libgcc}.
8839 Therefore, the G++ and GCJ drivers automatically add
8840 @option{-shared-libgcc} whenever you build a shared library or a main
8841 executable, because C++ and Java programs typically use exceptions, so
8842 this is the right thing to do.
8844 If, instead, you use the GCC driver to create shared libraries, you may
8845 find that they will not always be linked with the shared @file{libgcc}.
8846 If GCC finds, at its configuration time, that you have a non-GNU linker
8847 or a GNU linker that does not support option @option{--eh-frame-hdr},
8848 it will link the shared version of @file{libgcc} into shared libraries
8849 by default.  Otherwise, it will take advantage of the linker and optimize
8850 away the linking with the shared version of @file{libgcc}, linking with
8851 the static version of libgcc by default.  This allows exceptions to
8852 propagate through such shared libraries, without incurring relocation
8853 costs at library load time.
8855 However, if a library or main executable is supposed to throw or catch
8856 exceptions, you must link it using the G++ or GCJ driver, as appropriate
8857 for the languages used in the program, or using the option
8858 @option{-shared-libgcc}, such that it is linked with the shared
8859 @file{libgcc}.
8861 @item -static-libstdc++
8862 When the @command{g++} program is used to link a C++ program, it will
8863 normally automatically link against @option{libstdc++}.  If
8864 @file{libstdc++} is available as a shared library, and the
8865 @option{-static} option is not used, then this will link against the
8866 shared version of @file{libstdc++}.  That is normally fine.  However, it
8867 is sometimes useful to freeze the version of @file{libstdc++} used by
8868 the program without going all the way to a fully static link.  The
8869 @option{-static-libstdc++} option directs the @command{g++} driver to
8870 link @file{libstdc++} statically, without necessarily linking other
8871 libraries statically.
8873 @item -symbolic
8874 @opindex symbolic
8875 Bind references to global symbols when building a shared object.  Warn
8876 about any unresolved references (unless overridden by the link editor
8877 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
8878 this option.
8880 @item -T @var{script}
8881 @opindex T
8882 @cindex linker script
8883 Use @var{script} as the linker script.  This option is supported by most
8884 systems using the GNU linker.  On some targets, such as bare-board
8885 targets without an operating system, the @option{-T} option may be required
8886 when linking to avoid references to undefined symbols.
8888 @item -Xlinker @var{option}
8889 @opindex Xlinker
8890 Pass @var{option} as an option to the linker.  You can use this to
8891 supply system-specific linker options which GCC does not know how to
8892 recognize.
8894 If you want to pass an option that takes a separate argument, you must use
8895 @option{-Xlinker} twice, once for the option and once for the argument.
8896 For example, to pass @option{-assert definitions}, you must write
8897 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
8898 @option{-Xlinker "-assert definitions"}, because this passes the entire
8899 string as a single argument, which is not what the linker expects.
8901 When using the GNU linker, it is usually more convenient to pass
8902 arguments to linker options using the @option{@var{option}=@var{value}}
8903 syntax than as separate arguments.  For example, you can specify
8904 @samp{-Xlinker -Map=output.map} rather than
8905 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
8906 this syntax for command-line options.
8908 @item -Wl,@var{option}
8909 @opindex Wl
8910 Pass @var{option} as an option to the linker.  If @var{option} contains
8911 commas, it is split into multiple options at the commas.  You can use this
8912 syntax to pass an argument to the option.
8913 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
8914 linker.  When using the GNU linker, you can also get the same effect with
8915 @samp{-Wl,-Map=output.map}.
8917 @item -u @var{symbol}
8918 @opindex u
8919 Pretend the symbol @var{symbol} is undefined, to force linking of
8920 library modules to define it.  You can use @option{-u} multiple times with
8921 different symbols to force loading of additional library modules.
8922 @end table
8924 @node Directory Options
8925 @section Options for Directory Search
8926 @cindex directory options
8927 @cindex options, directory search
8928 @cindex search path
8930 These options specify directories to search for header files, for
8931 libraries and for parts of the compiler:
8933 @table @gcctabopt
8934 @item -I@var{dir}
8935 @opindex I
8936 Add the directory @var{dir} to the head of the list of directories to be
8937 searched for header files.  This can be used to override a system header
8938 file, substituting your own version, since these directories are
8939 searched before the system header file directories.  However, you should
8940 not use this option to add directories that contain vendor-supplied
8941 system header files (use @option{-isystem} for that).  If you use more than
8942 one @option{-I} option, the directories are scanned in left-to-right
8943 order; the standard system directories come after.
8945 If a standard system include directory, or a directory specified with
8946 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
8947 option will be ignored.  The directory will still be searched but as a
8948 system directory at its normal position in the system include chain.
8949 This is to ensure that GCC's procedure to fix buggy system headers and
8950 the ordering for the include_next directive are not inadvertently changed.
8951 If you really need to change the search order for system directories,
8952 use the @option{-nostdinc} and/or @option{-isystem} options.
8954 @item -iplugindir=@var{dir}
8955 Set the directory to search for plugins which are passed
8956 by @option{-fplugin=@var{name}} instead of
8957 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
8958 to be used by the user, but only passed by the driver.
8960 @item -iquote@var{dir}
8961 @opindex iquote
8962 Add the directory @var{dir} to the head of the list of directories to
8963 be searched for header files only for the case of @samp{#include
8964 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
8965 otherwise just like @option{-I}.
8967 @item -L@var{dir}
8968 @opindex L
8969 Add directory @var{dir} to the list of directories to be searched
8970 for @option{-l}.
8972 @item -B@var{prefix}
8973 @opindex B
8974 This option specifies where to find the executables, libraries,
8975 include files, and data files of the compiler itself.
8977 The compiler driver program runs one or more of the subprograms
8978 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
8979 @var{prefix} as a prefix for each program it tries to run, both with and
8980 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
8982 For each subprogram to be run, the compiler driver first tries the
8983 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
8984 was not specified, the driver tries two standard prefixes, which are
8985 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
8986 those results in a file name that is found, the unmodified program
8987 name is searched for using the directories specified in your
8988 @env{PATH} environment variable.
8990 The compiler will check to see if the path provided by the @option{-B}
8991 refers to a directory, and if necessary it will add a directory
8992 separator character at the end of the path.
8994 @option{-B} prefixes that effectively specify directory names also apply
8995 to libraries in the linker, because the compiler translates these
8996 options into @option{-L} options for the linker.  They also apply to
8997 includes files in the preprocessor, because the compiler translates these
8998 options into @option{-isystem} options for the preprocessor.  In this case,
8999 the compiler appends @samp{include} to the prefix.
9001 The run-time support file @file{libgcc.a} can also be searched for using
9002 the @option{-B} prefix, if needed.  If it is not found there, the two
9003 standard prefixes above are tried, and that is all.  The file is left
9004 out of the link if it is not found by those means.
9006 Another way to specify a prefix much like the @option{-B} prefix is to use
9007 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9008 Variables}.
9010 As a special kludge, if the path provided by @option{-B} is
9011 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9012 9, then it will be replaced by @file{[dir/]include}.  This is to help
9013 with boot-strapping the compiler.
9015 @item -specs=@var{file}
9016 @opindex specs
9017 Process @var{file} after the compiler reads in the standard @file{specs}
9018 file, in order to override the defaults that the @file{gcc} driver
9019 program uses when determining what switches to pass to @file{cc1},
9020 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
9021 @option{-specs=@var{file}} can be specified on the command line, and they
9022 are processed in order, from left to right.
9024 @item --sysroot=@var{dir}
9025 @opindex sysroot
9026 Use @var{dir} as the logical root directory for headers and libraries.
9027 For example, if the compiler would normally search for headers in
9028 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
9029 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9031 If you use both this option and the @option{-isysroot} option, then
9032 the @option{--sysroot} option will apply to libraries, but the
9033 @option{-isysroot} option will apply to header files.
9035 The GNU linker (beginning with version 2.16) has the necessary support
9036 for this option.  If your linker does not support this option, the
9037 header file aspect of @option{--sysroot} will still work, but the
9038 library aspect will not.
9040 @item -I-
9041 @opindex I-
9042 This option has been deprecated.  Please use @option{-iquote} instead for
9043 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9044 Any directories you specify with @option{-I} options before the @option{-I-}
9045 option are searched only for the case of @samp{#include "@var{file}"};
9046 they are not searched for @samp{#include <@var{file}>}.
9048 If additional directories are specified with @option{-I} options after
9049 the @option{-I-}, these directories are searched for all @samp{#include}
9050 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9051 this way.)
9053 In addition, the @option{-I-} option inhibits the use of the current
9054 directory (where the current input file came from) as the first search
9055 directory for @samp{#include "@var{file}"}.  There is no way to
9056 override this effect of @option{-I-}.  With @option{-I.} you can specify
9057 searching the directory which was current when the compiler was
9058 invoked.  That is not exactly the same as what the preprocessor does
9059 by default, but it is often satisfactory.
9061 @option{-I-} does not inhibit the use of the standard system directories
9062 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9063 independent.
9064 @end table
9066 @c man end
9068 @node Spec Files
9069 @section Specifying subprocesses and the switches to pass to them
9070 @cindex Spec Files
9072 @command{gcc} is a driver program.  It performs its job by invoking a
9073 sequence of other programs to do the work of compiling, assembling and
9074 linking.  GCC interprets its command-line parameters and uses these to
9075 deduce which programs it should invoke, and which command-line options
9076 it ought to place on their command lines.  This behavior is controlled
9077 by @dfn{spec strings}.  In most cases there is one spec string for each
9078 program that GCC can invoke, but a few programs have multiple spec
9079 strings to control their behavior.  The spec strings built into GCC can
9080 be overridden by using the @option{-specs=} command-line switch to specify
9081 a spec file.
9083 @dfn{Spec files} are plaintext files that are used to construct spec
9084 strings.  They consist of a sequence of directives separated by blank
9085 lines.  The type of directive is determined by the first non-whitespace
9086 character on the line and it can be one of the following:
9088 @table @code
9089 @item %@var{command}
9090 Issues a @var{command} to the spec file processor.  The commands that can
9091 appear here are:
9093 @table @code
9094 @item %include <@var{file}>
9095 @cindex %include
9096 Search for @var{file} and insert its text at the current point in the
9097 specs file.
9099 @item %include_noerr <@var{file}>
9100 @cindex %include_noerr
9101 Just like @samp{%include}, but do not generate an error message if the include
9102 file cannot be found.
9104 @item %rename @var{old_name} @var{new_name}
9105 @cindex %rename
9106 Rename the spec string @var{old_name} to @var{new_name}.
9108 @end table
9110 @item *[@var{spec_name}]:
9111 This tells the compiler to create, override or delete the named spec
9112 string.  All lines after this directive up to the next directive or
9113 blank line are considered to be the text for the spec string.  If this
9114 results in an empty string then the spec will be deleted.  (Or, if the
9115 spec did not exist, then nothing will happened.)  Otherwise, if the spec
9116 does not currently exist a new spec will be created.  If the spec does
9117 exist then its contents will be overridden by the text of this
9118 directive, unless the first character of that text is the @samp{+}
9119 character, in which case the text will be appended to the spec.
9121 @item [@var{suffix}]:
9122 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9123 and up to the next directive or blank line are considered to make up the
9124 spec string for the indicated suffix.  When the compiler encounters an
9125 input file with the named suffix, it will processes the spec string in
9126 order to work out how to compile that file.  For example:
9128 @smallexample
9129 .ZZ:
9130 z-compile -input %i
9131 @end smallexample
9133 This says that any input file whose name ends in @samp{.ZZ} should be
9134 passed to the program @samp{z-compile}, which should be invoked with the
9135 command-line switch @option{-input} and with the result of performing the
9136 @samp{%i} substitution.  (See below.)
9138 As an alternative to providing a spec string, the text that follows a
9139 suffix directive can be one of the following:
9141 @table @code
9142 @item @@@var{language}
9143 This says that the suffix is an alias for a known @var{language}.  This is
9144 similar to using the @option{-x} command-line switch to GCC to specify a
9145 language explicitly.  For example:
9147 @smallexample
9148 .ZZ:
9149 @@c++
9150 @end smallexample
9152 Says that .ZZ files are, in fact, C++ source files.
9154 @item #@var{name}
9155 This causes an error messages saying:
9157 @smallexample
9158 @var{name} compiler not installed on this system.
9159 @end smallexample
9160 @end table
9162 GCC already has an extensive list of suffixes built into it.
9163 This directive will add an entry to the end of the list of suffixes, but
9164 since the list is searched from the end backwards, it is effectively
9165 possible to override earlier entries using this technique.
9167 @end table
9169 GCC has the following spec strings built into it.  Spec files can
9170 override these strings or create their own.  Note that individual
9171 targets can also add their own spec strings to this list.
9173 @smallexample
9174 asm          Options to pass to the assembler
9175 asm_final    Options to pass to the assembler post-processor
9176 cpp          Options to pass to the C preprocessor
9177 cc1          Options to pass to the C compiler
9178 cc1plus      Options to pass to the C++ compiler
9179 endfile      Object files to include at the end of the link
9180 link         Options to pass to the linker
9181 lib          Libraries to include on the command line to the linker
9182 libgcc       Decides which GCC support library to pass to the linker
9183 linker       Sets the name of the linker
9184 predefines   Defines to be passed to the C preprocessor
9185 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9186              by default
9187 startfile    Object files to include at the start of the link
9188 @end smallexample
9190 Here is a small example of a spec file:
9192 @smallexample
9193 %rename lib                 old_lib
9195 *lib:
9196 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9197 @end smallexample
9199 This example renames the spec called @samp{lib} to @samp{old_lib} and
9200 then overrides the previous definition of @samp{lib} with a new one.
9201 The new definition adds in some extra command-line options before
9202 including the text of the old definition.
9204 @dfn{Spec strings} are a list of command-line options to be passed to their
9205 corresponding program.  In addition, the spec strings can contain
9206 @samp{%}-prefixed sequences to substitute variable text or to
9207 conditionally insert text into the command line.  Using these constructs
9208 it is possible to generate quite complex command lines.
9210 Here is a table of all defined @samp{%}-sequences for spec
9211 strings.  Note that spaces are not generated automatically around the
9212 results of expanding these sequences.  Therefore you can concatenate them
9213 together or combine them with constant text in a single argument.
9215 @table @code
9216 @item %%
9217 Substitute one @samp{%} into the program name or argument.
9219 @item %i
9220 Substitute the name of the input file being processed.
9222 @item %b
9223 Substitute the basename of the input file being processed.
9224 This is the substring up to (and not including) the last period
9225 and not including the directory.
9227 @item %B
9228 This is the same as @samp{%b}, but include the file suffix (text after
9229 the last period).
9231 @item %d
9232 Marks the argument containing or following the @samp{%d} as a
9233 temporary file name, so that that file will be deleted if GCC exits
9234 successfully.  Unlike @samp{%g}, this contributes no text to the
9235 argument.
9237 @item %g@var{suffix}
9238 Substitute a file name that has suffix @var{suffix} and is chosen
9239 once per compilation, and mark the argument in the same way as
9240 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9241 name is now chosen in a way that is hard to predict even when previously
9242 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9243 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9244 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9245 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9246 was simply substituted with a file name chosen once per compilation,
9247 without regard to any appended suffix (which was therefore treated
9248 just like ordinary text), making such attacks more likely to succeed.
9250 @item %u@var{suffix}
9251 Like @samp{%g}, but generates a new temporary file name even if
9252 @samp{%u@var{suffix}} was already seen.
9254 @item %U@var{suffix}
9255 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9256 new one if there is no such last file name.  In the absence of any
9257 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9258 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9259 would involve the generation of two distinct file names, one
9260 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9261 simply substituted with a file name chosen for the previous @samp{%u},
9262 without regard to any appended suffix.
9264 @item %j@var{suffix}
9265 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9266 writable, and if save-temps is off; otherwise, substitute the name
9267 of a temporary file, just like @samp{%u}.  This temporary file is not
9268 meant for communication between processes, but rather as a junk
9269 disposal mechanism.
9271 @item %|@var{suffix}
9272 @itemx %m@var{suffix}
9273 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9274 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9275 all.  These are the two most common ways to instruct a program that it
9276 should read from standard input or write to standard output.  If you
9277 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9278 construct: see for example @file{f/lang-specs.h}.
9280 @item %.@var{SUFFIX}
9281 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9282 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9283 terminated by the next space or %.
9285 @item %w
9286 Marks the argument containing or following the @samp{%w} as the
9287 designated output file of this compilation.  This puts the argument
9288 into the sequence of arguments that @samp{%o} will substitute later.
9290 @item %o
9291 Substitutes the names of all the output files, with spaces
9292 automatically placed around them.  You should write spaces
9293 around the @samp{%o} as well or the results are undefined.
9294 @samp{%o} is for use in the specs for running the linker.
9295 Input files whose names have no recognized suffix are not compiled
9296 at all, but they are included among the output files, so they will
9297 be linked.
9299 @item %O
9300 Substitutes the suffix for object files.  Note that this is
9301 handled specially when it immediately follows @samp{%g, %u, or %U},
9302 because of the need for those to form complete file names.  The
9303 handling is such that @samp{%O} is treated exactly as if it had already
9304 been substituted, except that @samp{%g, %u, and %U} do not currently
9305 support additional @var{suffix} characters following @samp{%O} as they would
9306 following, for example, @samp{.o}.
9308 @item %p
9309 Substitutes the standard macro predefinitions for the
9310 current target machine.  Use this when running @code{cpp}.
9312 @item %P
9313 Like @samp{%p}, but puts @samp{__} before and after the name of each
9314 predefined macro, except for macros that start with @samp{__} or with
9315 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9318 @item %I
9319 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9320 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9321 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9322 and @option{-imultilib} as necessary.
9324 @item %s
9325 Current argument is the name of a library or startup file of some sort.
9326 Search for that file in a standard list of directories and substitute
9327 the full name found.  The current working directory is included in the
9328 list of directories scanned.
9330 @item %T
9331 Current argument is the name of a linker script.  Search for that file
9332 in the current list of directories to scan for libraries. If the file
9333 is located insert a @option{--script} option into the command line
9334 followed by the full path name found.  If the file is not found then
9335 generate an error message.  Note: the current working directory is not
9336 searched.
9338 @item %e@var{str}
9339 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9340 Use this when inconsistent options are detected.
9342 @item %(@var{name})
9343 Substitute the contents of spec string @var{name} at this point.
9345 @item %[@var{name}]
9346 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9348 @item %x@{@var{option}@}
9349 Accumulate an option for @samp{%X}.
9351 @item %X
9352 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9353 spec string.
9355 @item %Y
9356 Output the accumulated assembler options specified by @option{-Wa}.
9358 @item %Z
9359 Output the accumulated preprocessor options specified by @option{-Wp}.
9361 @item %a
9362 Process the @code{asm} spec.  This is used to compute the
9363 switches to be passed to the assembler.
9365 @item %A
9366 Process the @code{asm_final} spec.  This is a spec string for
9367 passing switches to an assembler post-processor, if such a program is
9368 needed.
9370 @item %l
9371 Process the @code{link} spec.  This is the spec for computing the
9372 command line passed to the linker.  Typically it will make use of the
9373 @samp{%L %G %S %D and %E} sequences.
9375 @item %D
9376 Dump out a @option{-L} option for each directory that GCC believes might
9377 contain startup files.  If the target supports multilibs then the
9378 current multilib directory will be prepended to each of these paths.
9380 @item %L
9381 Process the @code{lib} spec.  This is a spec string for deciding which
9382 libraries should be included on the command line to the linker.
9384 @item %G
9385 Process the @code{libgcc} spec.  This is a spec string for deciding
9386 which GCC support library should be included on the command line to the linker.
9388 @item %S
9389 Process the @code{startfile} spec.  This is a spec for deciding which
9390 object files should be the first ones passed to the linker.  Typically
9391 this might be a file named @file{crt0.o}.
9393 @item %E
9394 Process the @code{endfile} spec.  This is a spec string that specifies
9395 the last object files that will be passed to the linker.
9397 @item %C
9398 Process the @code{cpp} spec.  This is used to construct the arguments
9399 to be passed to the C preprocessor.
9401 @item %1
9402 Process the @code{cc1} spec.  This is used to construct the options to be
9403 passed to the actual C compiler (@samp{cc1}).
9405 @item %2
9406 Process the @code{cc1plus} spec.  This is used to construct the options to be
9407 passed to the actual C++ compiler (@samp{cc1plus}).
9409 @item %*
9410 Substitute the variable part of a matched option.  See below.
9411 Note that each comma in the substituted string is replaced by
9412 a single space.
9414 @item %<@code{S}
9415 Remove all occurrences of @code{-S} from the command line.  Note---this
9416 command is position dependent.  @samp{%} commands in the spec string
9417 before this one will see @code{-S}, @samp{%} commands in the spec string
9418 after this one will not.
9420 @item %:@var{function}(@var{args})
9421 Call the named function @var{function}, passing it @var{args}.
9422 @var{args} is first processed as a nested spec string, then split
9423 into an argument vector in the usual fashion.  The function returns
9424 a string which is processed as if it had appeared literally as part
9425 of the current spec.
9427 The following built-in spec functions are provided:
9429 @table @code
9430 @item @code{getenv}
9431 The @code{getenv} spec function takes two arguments: an environment
9432 variable name and a string.  If the environment variable is not
9433 defined, a fatal error is issued.  Otherwise, the return value is the
9434 value of the environment variable concatenated with the string.  For
9435 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9437 @smallexample
9438 %:getenv(TOPDIR /include)
9439 @end smallexample
9441 expands to @file{/path/to/top/include}.
9443 @item @code{if-exists}
9444 The @code{if-exists} spec function takes one argument, an absolute
9445 pathname to a file.  If the file exists, @code{if-exists} returns the
9446 pathname.  Here is a small example of its usage:
9448 @smallexample
9449 *startfile:
9450 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9451 @end smallexample
9453 @item @code{if-exists-else}
9454 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9455 spec function, except that it takes two arguments.  The first argument is
9456 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9457 returns the pathname.  If it does not exist, it returns the second argument.
9458 This way, @code{if-exists-else} can be used to select one file or another,
9459 based on the existence of the first.  Here is a small example of its usage:
9461 @smallexample
9462 *startfile:
9463 crt0%O%s %:if-exists(crti%O%s) \
9464 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9465 @end smallexample
9467 @item @code{replace-outfile}
9468 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9469 first argument in the outfiles array and replaces it with the second argument.  Here
9470 is a small example of its usage:
9472 @smallexample
9473 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9474 @end smallexample
9476 @item @code{print-asm-header}
9477 The @code{print-asm-header} function takes no arguments and simply
9478 prints a banner like:
9480 @smallexample
9481 Assembler options
9482 =================
9484 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9485 @end smallexample
9487 It is used to separate compiler options from assembler options
9488 in the @option{--target-help} output.
9489 @end table
9491 @item %@{@code{S}@}
9492 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9493 If that switch was not specified, this substitutes nothing.  Note that
9494 the leading dash is omitted when specifying this option, and it is
9495 automatically inserted if the substitution is performed.  Thus the spec
9496 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9497 and would output the command line option @option{-foo}.
9499 @item %W@{@code{S}@}
9500 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9501 deleted on failure.
9503 @item %@{@code{S}*@}
9504 Substitutes all the switches specified to GCC whose names start
9505 with @code{-S}, but which also take an argument.  This is used for
9506 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9507 GCC considers @option{-o foo} as being
9508 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9509 text, including the space.  Thus two arguments would be generated.
9511 @item %@{@code{S}*&@code{T}*@}
9512 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9513 (the order of @code{S} and @code{T} in the spec is not significant).
9514 There can be any number of ampersand-separated variables; for each the
9515 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9517 @item %@{@code{S}:@code{X}@}
9518 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9520 @item %@{!@code{S}:@code{X}@}
9521 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9523 @item %@{@code{S}*:@code{X}@}
9524 Substitutes @code{X} if one or more switches whose names start with
9525 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9526 once, no matter how many such switches appeared.  However, if @code{%*}
9527 appears somewhere in @code{X}, then @code{X} will be substituted once
9528 for each matching switch, with the @code{%*} replaced by the part of
9529 that switch that matched the @code{*}.
9531 @item %@{.@code{S}:@code{X}@}
9532 Substitutes @code{X}, if processing a file with suffix @code{S}.
9534 @item %@{!.@code{S}:@code{X}@}
9535 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9537 @item %@{,@code{S}:@code{X}@}
9538 Substitutes @code{X}, if processing a file for language @code{S}.
9540 @item %@{!,@code{S}:@code{X}@}
9541 Substitutes @code{X}, if not processing a file for language @code{S}.
9543 @item %@{@code{S}|@code{P}:@code{X}@}
9544 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9545 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9546 @code{*} sequences as well, although they have a stronger binding than
9547 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9548 alternatives must be starred, and only the first matching alternative
9549 is substituted.
9551 For example, a spec string like this:
9553 @smallexample
9554 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9555 @end smallexample
9557 will output the following command-line options from the following input
9558 command-line options:
9560 @smallexample
9561 fred.c        -foo -baz
9562 jim.d         -bar -boggle
9563 -d fred.c     -foo -baz -boggle
9564 -d jim.d      -bar -baz -boggle
9565 @end smallexample
9567 @item %@{S:X; T:Y; :D@}
9569 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9570 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9571 be as many clauses as you need.  This may be combined with @code{.},
9572 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9575 @end table
9577 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9578 construct may contain other nested @samp{%} constructs or spaces, or
9579 even newlines.  They are processed as usual, as described above.
9580 Trailing white space in @code{X} is ignored.  White space may also
9581 appear anywhere on the left side of the colon in these constructs,
9582 except between @code{.} or @code{*} and the corresponding word.
9584 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9585 handled specifically in these constructs.  If another value of
9586 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9587 @option{-W} switch is found later in the command line, the earlier
9588 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9589 just one letter, which passes all matching options.
9591 The character @samp{|} at the beginning of the predicate text is used to
9592 indicate that a command should be piped to the following command, but
9593 only if @option{-pipe} is specified.
9595 It is built into GCC which switches take arguments and which do not.
9596 (You might think it would be useful to generalize this to allow each
9597 compiler's spec to say which switches take arguments.  But this cannot
9598 be done in a consistent fashion.  GCC cannot even decide which input
9599 files have been specified without knowing which switches take arguments,
9600 and it must know which input files to compile in order to tell which
9601 compilers to run).
9603 GCC also knows implicitly that arguments starting in @option{-l} are to be
9604 treated as compiler output files, and passed to the linker in their
9605 proper position among the other output files.
9607 @c man begin OPTIONS
9609 @node Target Options
9610 @section Specifying Target Machine and Compiler Version
9611 @cindex target options
9612 @cindex cross compiling
9613 @cindex specifying machine version
9614 @cindex specifying compiler version and target machine
9615 @cindex compiler version, specifying
9616 @cindex target machine, specifying
9618 The usual way to run GCC is to run the executable called @file{gcc}, or
9619 @file{<machine>-gcc} when cross-compiling, or
9620 @file{<machine>-gcc-<version>} to run a version other than the one that
9621 was installed last.
9623 @node Submodel Options
9624 @section Hardware Models and Configurations
9625 @cindex submodel options
9626 @cindex specifying hardware config
9627 @cindex hardware models and configurations, specifying
9628 @cindex machine dependent options
9630 Each target machine types can have its own
9631 special options, starting with @samp{-m}, to choose among various
9632 hardware models or configurations---for example, 68010 vs 68020,
9633 floating coprocessor or none.  A single installed version of the
9634 compiler can compile for any model or configuration, according to the
9635 options specified.
9637 Some configurations of the compiler also support additional special
9638 options, usually for compatibility with other compilers on the same
9639 platform.
9641 @c This list is ordered alphanumerically by subsection name.
9642 @c It should be the same order and spelling as these options are listed
9643 @c in Machine Dependent Options
9645 @menu
9646 * ARC Options::
9647 * ARM Options::
9648 * AVR Options::
9649 * Blackfin Options::
9650 * CRIS Options::
9651 * CRX Options::
9652 * Darwin Options::
9653 * DEC Alpha Options::
9654 * DEC Alpha/VMS Options::
9655 * FR30 Options::
9656 * FRV Options::
9657 * GNU/Linux Options::
9658 * H8/300 Options::
9659 * HPPA Options::
9660 * i386 and x86-64 Options::
9661 * i386 and x86-64 Windows Options::
9662 * IA-64 Options::
9663 * IA-64/VMS Options::
9664 * LM32 Options::
9665 * M32C Options::
9666 * M32R/D Options::
9667 * M680x0 Options::
9668 * M68hc1x Options::
9669 * MCore Options::
9670 * MeP Options::
9671 * MIPS Options::
9672 * MMIX Options::
9673 * MN10300 Options::
9674 * PDP-11 Options::
9675 * picoChip Options::
9676 * PowerPC Options::
9677 * RS/6000 and PowerPC Options::
9678 * RX Options::
9679 * S/390 and zSeries Options::
9680 * Score Options::
9681 * SH Options::
9682 * SPARC Options::
9683 * SPU Options::
9684 * System V Options::
9685 * V850 Options::
9686 * VAX Options::
9687 * VxWorks Options::
9688 * x86-64 Options::
9689 * Xstormy16 Options::
9690 * Xtensa Options::
9691 * zSeries Options::
9692 @end menu
9694 @node ARC Options
9695 @subsection ARC Options
9696 @cindex ARC Options
9698 These options are defined for ARC implementations:
9700 @table @gcctabopt
9701 @item -EL
9702 @opindex EL
9703 Compile code for little endian mode.  This is the default.
9705 @item -EB
9706 @opindex EB
9707 Compile code for big endian mode.
9709 @item -mmangle-cpu
9710 @opindex mmangle-cpu
9711 Prepend the name of the cpu to all public symbol names.
9712 In multiple-processor systems, there are many ARC variants with different
9713 instruction and register set characteristics.  This flag prevents code
9714 compiled for one cpu to be linked with code compiled for another.
9715 No facility exists for handling variants that are ``almost identical''.
9716 This is an all or nothing option.
9718 @item -mcpu=@var{cpu}
9719 @opindex mcpu
9720 Compile code for ARC variant @var{cpu}.
9721 Which variants are supported depend on the configuration.
9722 All variants support @option{-mcpu=base}, this is the default.
9724 @item -mtext=@var{text-section}
9725 @itemx -mdata=@var{data-section}
9726 @itemx -mrodata=@var{readonly-data-section}
9727 @opindex mtext
9728 @opindex mdata
9729 @opindex mrodata
9730 Put functions, data, and readonly data in @var{text-section},
9731 @var{data-section}, and @var{readonly-data-section} respectively
9732 by default.  This can be overridden with the @code{section} attribute.
9733 @xref{Variable Attributes}.
9735 @item -mfix-cortex-m3-ldrd
9736 @opindex mfix-cortex-m3-ldrd
9737 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
9738 with overlapping destination and base registers are used.  This option avoids
9739 generating these instructions.  This option is enabled by default when
9740 @option{-mcpu=cortex-m3} is specified.
9742 @end table
9744 @node ARM Options
9745 @subsection ARM Options
9746 @cindex ARM options
9748 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9749 architectures:
9751 @table @gcctabopt
9752 @item -mabi=@var{name}
9753 @opindex mabi
9754 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9755 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9757 @item -mapcs-frame
9758 @opindex mapcs-frame
9759 Generate a stack frame that is compliant with the ARM Procedure Call
9760 Standard for all functions, even if this is not strictly necessary for
9761 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9762 with this option will cause the stack frames not to be generated for
9763 leaf functions.  The default is @option{-mno-apcs-frame}.
9765 @item -mapcs
9766 @opindex mapcs
9767 This is a synonym for @option{-mapcs-frame}.
9769 @ignore
9770 @c not currently implemented
9771 @item -mapcs-stack-check
9772 @opindex mapcs-stack-check
9773 Generate code to check the amount of stack space available upon entry to
9774 every function (that actually uses some stack space).  If there is
9775 insufficient space available then either the function
9776 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9777 called, depending upon the amount of stack space required.  The run time
9778 system is required to provide these functions.  The default is
9779 @option{-mno-apcs-stack-check}, since this produces smaller code.
9781 @c not currently implemented
9782 @item -mapcs-float
9783 @opindex mapcs-float
9784 Pass floating point arguments using the float point registers.  This is
9785 one of the variants of the APCS@.  This option is recommended if the
9786 target hardware has a floating point unit or if a lot of floating point
9787 arithmetic is going to be performed by the code.  The default is
9788 @option{-mno-apcs-float}, since integer only code is slightly increased in
9789 size if @option{-mapcs-float} is used.
9791 @c not currently implemented
9792 @item -mapcs-reentrant
9793 @opindex mapcs-reentrant
9794 Generate reentrant, position independent code.  The default is
9795 @option{-mno-apcs-reentrant}.
9796 @end ignore
9798 @item -mthumb-interwork
9799 @opindex mthumb-interwork
9800 Generate code which supports calling between the ARM and Thumb
9801 instruction sets.  Without this option the two instruction sets cannot
9802 be reliably used inside one program.  The default is
9803 @option{-mno-thumb-interwork}, since slightly larger code is generated
9804 when @option{-mthumb-interwork} is specified.
9806 @item -mno-sched-prolog
9807 @opindex mno-sched-prolog
9808 Prevent the reordering of instructions in the function prolog, or the
9809 merging of those instruction with the instructions in the function's
9810 body.  This means that all functions will start with a recognizable set
9811 of instructions (or in fact one of a choice from a small set of
9812 different function prologues), and this information can be used to
9813 locate the start if functions inside an executable piece of code.  The
9814 default is @option{-msched-prolog}.
9816 @item -mfloat-abi=@var{name}
9817 @opindex mfloat-abi
9818 Specifies which floating-point ABI to use.  Permissible values
9819 are: @samp{soft}, @samp{softfp} and @samp{hard}.
9821 Specifying @samp{soft} causes GCC to generate output containing
9822 library calls for floating-point operations.
9823 @samp{softfp} allows the generation of code using hardware floating-point
9824 instructions, but still uses the soft-float calling conventions.
9825 @samp{hard} allows generation of floating-point instructions
9826 and uses FPU-specific calling conventions.
9828 The default depends on the specific target configuration.  Note that
9829 the hard-float and soft-float ABIs are not link-compatible; you must
9830 compile your entire program with the same ABI, and link with a
9831 compatible set of libraries.
9833 @item -mhard-float
9834 @opindex mhard-float
9835 Equivalent to @option{-mfloat-abi=hard}.
9837 @item -msoft-float
9838 @opindex msoft-float
9839 Equivalent to @option{-mfloat-abi=soft}.
9841 @item -mlittle-endian
9842 @opindex mlittle-endian
9843 Generate code for a processor running in little-endian mode.  This is
9844 the default for all standard configurations.
9846 @item -mbig-endian
9847 @opindex mbig-endian
9848 Generate code for a processor running in big-endian mode; the default is
9849 to compile code for a little-endian processor.
9851 @item -mwords-little-endian
9852 @opindex mwords-little-endian
9853 This option only applies when generating code for big-endian processors.
9854 Generate code for a little-endian word order but a big-endian byte
9855 order.  That is, a byte order of the form @samp{32107654}.  Note: this
9856 option should only be used if you require compatibility with code for
9857 big-endian ARM processors generated by versions of the compiler prior to
9858 2.8.
9860 @item -mcpu=@var{name}
9861 @opindex mcpu
9862 This specifies the name of the target ARM processor.  GCC uses this name
9863 to determine what kind of instructions it can emit when generating
9864 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
9865 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
9866 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
9867 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
9868 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
9869 @samp{arm720},
9870 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
9871 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
9872 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
9873 @samp{strongarm1110},
9874 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
9875 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
9876 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
9877 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
9878 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
9879 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
9880 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
9881 @samp{cortex-a5}, @samp{cortex-a8}, @samp{cortex-a9},
9882 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
9883 @samp{cortex-m1},
9884 @samp{cortex-m0},
9885 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9887 @item -mtune=@var{name}
9888 @opindex mtune
9889 This option is very similar to the @option{-mcpu=} option, except that
9890 instead of specifying the actual target processor type, and hence
9891 restricting which instructions can be used, it specifies that GCC should
9892 tune the performance of the code as if the target were of the type
9893 specified in this option, but still choosing the instructions that it
9894 will generate based on the cpu specified by a @option{-mcpu=} option.
9895 For some ARM implementations better performance can be obtained by using
9896 this option.
9898 @item -march=@var{name}
9899 @opindex march
9900 This specifies the name of the target ARM architecture.  GCC uses this
9901 name to determine what kind of instructions it can emit when generating
9902 assembly code.  This option can be used in conjunction with or instead
9903 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
9904 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
9905 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
9906 @samp{armv6}, @samp{armv6j},
9907 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
9908 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
9909 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9911 @item -mfpu=@var{name}
9912 @itemx -mfpe=@var{number}
9913 @itemx -mfp=@var{number}
9914 @opindex mfpu
9915 @opindex mfpe
9916 @opindex mfp
9917 This specifies what floating point hardware (or hardware emulation) is
9918 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
9919 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
9920 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
9921 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
9922 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
9923 @option{-mfp} and @option{-mfpe} are synonyms for
9924 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
9925 of GCC@.
9927 If @option{-msoft-float} is specified this specifies the format of
9928 floating point values.
9930 @item -mfp16-format=@var{name}
9931 @opindex mfp16-format
9932 Specify the format of the @code{__fp16} half-precision floating-point type.
9933 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
9934 the default is @samp{none}, in which case the @code{__fp16} type is not
9935 defined.  @xref{Half-Precision}, for more information.
9937 @item -mstructure-size-boundary=@var{n}
9938 @opindex mstructure-size-boundary
9939 The size of all structures and unions will be rounded up to a multiple
9940 of the number of bits set by this option.  Permissible values are 8, 32
9941 and 64.  The default value varies for different toolchains.  For the COFF
9942 targeted toolchain the default value is 8.  A value of 64 is only allowed
9943 if the underlying ABI supports it.
9945 Specifying the larger number can produce faster, more efficient code, but
9946 can also increase the size of the program.  Different values are potentially
9947 incompatible.  Code compiled with one value cannot necessarily expect to
9948 work with code or libraries compiled with another value, if they exchange
9949 information using structures or unions.
9951 @item -mabort-on-noreturn
9952 @opindex mabort-on-noreturn
9953 Generate a call to the function @code{abort} at the end of a
9954 @code{noreturn} function.  It will be executed if the function tries to
9955 return.
9957 @item -mlong-calls
9958 @itemx -mno-long-calls
9959 @opindex mlong-calls
9960 @opindex mno-long-calls
9961 Tells the compiler to perform function calls by first loading the
9962 address of the function into a register and then performing a subroutine
9963 call on this register.  This switch is needed if the target function
9964 will lie outside of the 64 megabyte addressing range of the offset based
9965 version of subroutine call instruction.
9967 Even if this switch is enabled, not all function calls will be turned
9968 into long calls.  The heuristic is that static functions, functions
9969 which have the @samp{short-call} attribute, functions that are inside
9970 the scope of a @samp{#pragma no_long_calls} directive and functions whose
9971 definitions have already been compiled within the current compilation
9972 unit, will not be turned into long calls.  The exception to this rule is
9973 that weak function definitions, functions with the @samp{long-call}
9974 attribute or the @samp{section} attribute, and functions that are within
9975 the scope of a @samp{#pragma long_calls} directive, will always be
9976 turned into long calls.
9978 This feature is not enabled by default.  Specifying
9979 @option{-mno-long-calls} will restore the default behavior, as will
9980 placing the function calls within the scope of a @samp{#pragma
9981 long_calls_off} directive.  Note these switches have no effect on how
9982 the compiler generates code to handle function calls via function
9983 pointers.
9985 @item -msingle-pic-base
9986 @opindex msingle-pic-base
9987 Treat the register used for PIC addressing as read-only, rather than
9988 loading it in the prologue for each function.  The run-time system is
9989 responsible for initializing this register with an appropriate value
9990 before execution begins.
9992 @item -mpic-register=@var{reg}
9993 @opindex mpic-register
9994 Specify the register to be used for PIC addressing.  The default is R10
9995 unless stack-checking is enabled, when R9 is used.
9997 @item -mcirrus-fix-invalid-insns
9998 @opindex mcirrus-fix-invalid-insns
9999 @opindex mno-cirrus-fix-invalid-insns
10000 Insert NOPs into the instruction stream to in order to work around
10001 problems with invalid Maverick instruction combinations.  This option
10002 is only valid if the @option{-mcpu=ep9312} option has been used to
10003 enable generation of instructions for the Cirrus Maverick floating
10004 point co-processor.  This option is not enabled by default, since the
10005 problem is only present in older Maverick implementations.  The default
10006 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10007 switch.
10009 @item -mpoke-function-name
10010 @opindex mpoke-function-name
10011 Write the name of each function into the text section, directly
10012 preceding the function prologue.  The generated code is similar to this:
10014 @smallexample
10015      t0
10016          .ascii "arm_poke_function_name", 0
10017          .align
10018      t1
10019          .word 0xff000000 + (t1 - t0)
10020      arm_poke_function_name
10021          mov     ip, sp
10022          stmfd   sp!, @{fp, ip, lr, pc@}
10023          sub     fp, ip, #4
10024 @end smallexample
10026 When performing a stack backtrace, code can inspect the value of
10027 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
10028 location @code{pc - 12} and the top 8 bits are set, then we know that
10029 there is a function name embedded immediately preceding this location
10030 and has length @code{((pc[-3]) & 0xff000000)}.
10032 @item -mthumb
10033 @opindex mthumb
10034 Generate code for the Thumb instruction set.  The default is to
10035 use the 32-bit ARM instruction set.
10036 This option automatically enables either 16-bit Thumb-1 or
10037 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
10038 and @option{-march=@var{name}} options.  This option is not passed to the
10039 assembler. If you want to force assembler files to be interpreted as Thumb code,
10040 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
10041 option directly to the assembler by prefixing it with @option{-Wa}.
10043 @item -mtpcs-frame
10044 @opindex mtpcs-frame
10045 Generate a stack frame that is compliant with the Thumb Procedure Call
10046 Standard for all non-leaf functions.  (A leaf function is one that does
10047 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
10049 @item -mtpcs-leaf-frame
10050 @opindex mtpcs-leaf-frame
10051 Generate a stack frame that is compliant with the Thumb Procedure Call
10052 Standard for all leaf functions.  (A leaf function is one that does
10053 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
10055 @item -mcallee-super-interworking
10056 @opindex mcallee-super-interworking
10057 Gives all externally visible functions in the file being compiled an ARM
10058 instruction set header which switches to Thumb mode before executing the
10059 rest of the function.  This allows these functions to be called from
10060 non-interworking code.  This option is not valid in AAPCS configurations
10061 because interworking is enabled by default.
10063 @item -mcaller-super-interworking
10064 @opindex mcaller-super-interworking
10065 Allows calls via function pointers (including virtual functions) to
10066 execute correctly regardless of whether the target code has been
10067 compiled for interworking or not.  There is a small overhead in the cost
10068 of executing a function pointer if this option is enabled.  This option
10069 is not valid in AAPCS configurations because interworking is enabled
10070 by default.
10072 @item -mtp=@var{name}
10073 @opindex mtp
10074 Specify the access model for the thread local storage pointer.  The valid
10075 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
10076 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
10077 (supported in the arm6k architecture), and @option{auto}, which uses the
10078 best available method for the selected processor.  The default setting is
10079 @option{auto}.
10081 @item -mword-relocations
10082 @opindex mword-relocations
10083 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
10084 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
10085 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
10086 is specified.
10088 @end table
10090 @node AVR Options
10091 @subsection AVR Options
10092 @cindex AVR Options
10094 These options are defined for AVR implementations:
10096 @table @gcctabopt
10097 @item -mmcu=@var{mcu}
10098 @opindex mmcu
10099 Specify ATMEL AVR instruction set or MCU type.
10101 Instruction set avr1 is for the minimal AVR core, not supported by the C
10102 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10103 attiny11, attiny12, attiny15, attiny28).
10105 Instruction set avr2 (default) is for the classic AVR core with up to
10106 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10107 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10108 at90c8534, at90s8535).
10110 Instruction set avr3 is for the classic AVR core with up to 128K program
10111 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10113 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10114 memory space (MCU types: atmega8, atmega83, atmega85).
10116 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10117 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10118 atmega64, atmega128, at43usb355, at94k).
10120 @item -mno-interrupts
10121 @opindex mno-interrupts
10122 Generated code is not compatible with hardware interrupts.
10123 Code size will be smaller.
10125 @item -mcall-prologues
10126 @opindex mcall-prologues
10127 Functions prologues/epilogues expanded as call to appropriate
10128 subroutines.  Code size will be smaller.
10130 @item -mtiny-stack
10131 @opindex mtiny-stack
10132 Change only the low 8 bits of the stack pointer.
10134 @item -mint8
10135 @opindex mint8
10136 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10137 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10138 and long long will be 4 bytes.  Please note that this option does not
10139 comply to the C standards, but it will provide you with smaller code
10140 size.
10141 @end table
10143 @node Blackfin Options
10144 @subsection Blackfin Options
10145 @cindex Blackfin Options
10147 @table @gcctabopt
10148 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10149 @opindex mcpu=
10150 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
10151 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10152 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10153 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10154 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10155 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10156 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10157 @samp{bf561}.
10158 The optional @var{sirevision} specifies the silicon revision of the target
10159 Blackfin processor.  Any workarounds available for the targeted silicon revision
10160 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
10161 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10162 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
10163 hexadecimal digits representing the major and minor numbers in the silicon
10164 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10165 is not defined.  If @var{sirevision} is @samp{any}, the
10166 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10167 If this optional @var{sirevision} is not used, GCC assumes the latest known
10168 silicon revision of the targeted Blackfin processor.
10170 Support for @samp{bf561} is incomplete.  For @samp{bf561},
10171 Only the processor macro is defined.
10172 Without this option, @samp{bf532} is used as the processor by default.
10173 The corresponding predefined processor macros for @var{cpu} is to
10174 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10175 provided by libgloss to be linked in if @option{-msim} is not given.
10177 @item -msim
10178 @opindex msim
10179 Specifies that the program will be run on the simulator.  This causes
10180 the simulator BSP provided by libgloss to be linked in.  This option
10181 has effect only for @samp{bfin-elf} toolchain.
10182 Certain other options, such as @option{-mid-shared-library} and
10183 @option{-mfdpic}, imply @option{-msim}.
10185 @item -momit-leaf-frame-pointer
10186 @opindex momit-leaf-frame-pointer
10187 Don't keep the frame pointer in a register for leaf functions.  This
10188 avoids the instructions to save, set up and restore frame pointers and
10189 makes an extra register available in leaf functions.  The option
10190 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10191 which might make debugging harder.
10193 @item -mspecld-anomaly
10194 @opindex mspecld-anomaly
10195 When enabled, the compiler will ensure that the generated code does not
10196 contain speculative loads after jump instructions. If this option is used,
10197 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10199 @item -mno-specld-anomaly
10200 @opindex mno-specld-anomaly
10201 Don't generate extra code to prevent speculative loads from occurring.
10203 @item -mcsync-anomaly
10204 @opindex mcsync-anomaly
10205 When enabled, the compiler will ensure that the generated code does not
10206 contain CSYNC or SSYNC instructions too soon after conditional branches.
10207 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10209 @item -mno-csync-anomaly
10210 @opindex mno-csync-anomaly
10211 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10212 occurring too soon after a conditional branch.
10214 @item -mlow-64k
10215 @opindex mlow-64k
10216 When enabled, the compiler is free to take advantage of the knowledge that
10217 the entire program fits into the low 64k of memory.
10219 @item -mno-low-64k
10220 @opindex mno-low-64k
10221 Assume that the program is arbitrarily large.  This is the default.
10223 @item -mstack-check-l1
10224 @opindex mstack-check-l1
10225 Do stack checking using information placed into L1 scratchpad memory by the
10226 uClinux kernel.
10228 @item -mid-shared-library
10229 @opindex mid-shared-library
10230 Generate code that supports shared libraries via the library ID method.
10231 This allows for execute in place and shared libraries in an environment
10232 without virtual memory management.  This option implies @option{-fPIC}.
10233 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10235 @item -mno-id-shared-library
10236 @opindex mno-id-shared-library
10237 Generate code that doesn't assume ID based shared libraries are being used.
10238 This is the default.
10240 @item -mleaf-id-shared-library
10241 @opindex mleaf-id-shared-library
10242 Generate code that supports shared libraries via the library ID method,
10243 but assumes that this library or executable won't link against any other
10244 ID shared libraries.  That allows the compiler to use faster code for jumps
10245 and calls.
10247 @item -mno-leaf-id-shared-library
10248 @opindex mno-leaf-id-shared-library
10249 Do not assume that the code being compiled won't link against any ID shared
10250 libraries.  Slower code will be generated for jump and call insns.
10252 @item -mshared-library-id=n
10253 @opindex mshared-library-id
10254 Specified the identification number of the ID based shared library being
10255 compiled.  Specifying a value of 0 will generate more compact code, specifying
10256 other values will force the allocation of that number to the current
10257 library but is no more space or time efficient than omitting this option.
10259 @item -msep-data
10260 @opindex msep-data
10261 Generate code that allows the data segment to be located in a different
10262 area of memory from the text segment.  This allows for execute in place in
10263 an environment without virtual memory management by eliminating relocations
10264 against the text section.
10266 @item -mno-sep-data
10267 @opindex mno-sep-data
10268 Generate code that assumes that the data segment follows the text segment.
10269 This is the default.
10271 @item -mlong-calls
10272 @itemx -mno-long-calls
10273 @opindex mlong-calls
10274 @opindex mno-long-calls
10275 Tells the compiler to perform function calls by first loading the
10276 address of the function into a register and then performing a subroutine
10277 call on this register.  This switch is needed if the target function
10278 will lie outside of the 24 bit addressing range of the offset based
10279 version of subroutine call instruction.
10281 This feature is not enabled by default.  Specifying
10282 @option{-mno-long-calls} will restore the default behavior.  Note these
10283 switches have no effect on how the compiler generates code to handle
10284 function calls via function pointers.
10286 @item -mfast-fp
10287 @opindex mfast-fp
10288 Link with the fast floating-point library. This library relaxes some of
10289 the IEEE floating-point standard's rules for checking inputs against
10290 Not-a-Number (NAN), in the interest of performance.
10292 @item -minline-plt
10293 @opindex minline-plt
10294 Enable inlining of PLT entries in function calls to functions that are
10295 not known to bind locally.  It has no effect without @option{-mfdpic}.
10297 @item -mmulticore
10298 @opindex mmulticore
10299 Build standalone application for multicore Blackfin processor. Proper
10300 start files and link scripts will be used to support multicore.
10301 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10302 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10303 @option{-mcorea} or @option{-mcoreb}. If it's used without
10304 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10305 programming model is used. In this model, the main function of Core B
10306 should be named as coreb_main. If it's used with @option{-mcorea} or
10307 @option{-mcoreb}, one application per core programming model is used.
10308 If this option is not used, single core application programming
10309 model is used.
10311 @item -mcorea
10312 @opindex mcorea
10313 Build standalone application for Core A of BF561 when using
10314 one application per core programming model. Proper start files
10315 and link scripts will be used to support Core A. This option
10316 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10318 @item -mcoreb
10319 @opindex mcoreb
10320 Build standalone application for Core B of BF561 when using
10321 one application per core programming model. Proper start files
10322 and link scripts will be used to support Core B. This option
10323 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10324 should be used instead of main. It must be used with
10325 @option{-mmulticore}.
10327 @item -msdram
10328 @opindex msdram
10329 Build standalone application for SDRAM. Proper start files and
10330 link scripts will be used to put the application into SDRAM.
10331 Loader should initialize SDRAM before loading the application
10332 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10334 @item -micplb
10335 @opindex micplb
10336 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
10337 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
10338 are enabled; for standalone applications the default is off.
10339 @end table
10341 @node CRIS Options
10342 @subsection CRIS Options
10343 @cindex CRIS Options
10345 These options are defined specifically for the CRIS ports.
10347 @table @gcctabopt
10348 @item -march=@var{architecture-type}
10349 @itemx -mcpu=@var{architecture-type}
10350 @opindex march
10351 @opindex mcpu
10352 Generate code for the specified architecture.  The choices for
10353 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10354 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10355 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10356 @samp{v10}.
10358 @item -mtune=@var{architecture-type}
10359 @opindex mtune
10360 Tune to @var{architecture-type} everything applicable about the generated
10361 code, except for the ABI and the set of available instructions.  The
10362 choices for @var{architecture-type} are the same as for
10363 @option{-march=@var{architecture-type}}.
10365 @item -mmax-stack-frame=@var{n}
10366 @opindex mmax-stack-frame
10367 Warn when the stack frame of a function exceeds @var{n} bytes.
10369 @item -metrax4
10370 @itemx -metrax100
10371 @opindex metrax4
10372 @opindex metrax100
10373 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10374 @option{-march=v3} and @option{-march=v8} respectively.
10376 @item -mmul-bug-workaround
10377 @itemx -mno-mul-bug-workaround
10378 @opindex mmul-bug-workaround
10379 @opindex mno-mul-bug-workaround
10380 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10381 models where it applies.  This option is active by default.
10383 @item -mpdebug
10384 @opindex mpdebug
10385 Enable CRIS-specific verbose debug-related information in the assembly
10386 code.  This option also has the effect to turn off the @samp{#NO_APP}
10387 formatted-code indicator to the assembler at the beginning of the
10388 assembly file.
10390 @item -mcc-init
10391 @opindex mcc-init
10392 Do not use condition-code results from previous instruction; always emit
10393 compare and test instructions before use of condition codes.
10395 @item -mno-side-effects
10396 @opindex mno-side-effects
10397 Do not emit instructions with side-effects in addressing modes other than
10398 post-increment.
10400 @item -mstack-align
10401 @itemx -mno-stack-align
10402 @itemx -mdata-align
10403 @itemx -mno-data-align
10404 @itemx -mconst-align
10405 @itemx -mno-const-align
10406 @opindex mstack-align
10407 @opindex mno-stack-align
10408 @opindex mdata-align
10409 @opindex mno-data-align
10410 @opindex mconst-align
10411 @opindex mno-const-align
10412 These options (no-options) arranges (eliminate arrangements) for the
10413 stack-frame, individual data and constants to be aligned for the maximum
10414 single data access size for the chosen CPU model.  The default is to
10415 arrange for 32-bit alignment.  ABI details such as structure layout are
10416 not affected by these options.
10418 @item -m32-bit
10419 @itemx -m16-bit
10420 @itemx -m8-bit
10421 @opindex m32-bit
10422 @opindex m16-bit
10423 @opindex m8-bit
10424 Similar to the stack- data- and const-align options above, these options
10425 arrange for stack-frame, writable data and constants to all be 32-bit,
10426 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10428 @item -mno-prologue-epilogue
10429 @itemx -mprologue-epilogue
10430 @opindex mno-prologue-epilogue
10431 @opindex mprologue-epilogue
10432 With @option{-mno-prologue-epilogue}, the normal function prologue and
10433 epilogue that sets up the stack-frame are omitted and no return
10434 instructions or return sequences are generated in the code.  Use this
10435 option only together with visual inspection of the compiled code: no
10436 warnings or errors are generated when call-saved registers must be saved,
10437 or storage for local variable needs to be allocated.
10439 @item -mno-gotplt
10440 @itemx -mgotplt
10441 @opindex mno-gotplt
10442 @opindex mgotplt
10443 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10444 instruction sequences that load addresses for functions from the PLT part
10445 of the GOT rather than (traditional on other architectures) calls to the
10446 PLT@.  The default is @option{-mgotplt}.
10448 @item -melf
10449 @opindex melf
10450 Legacy no-op option only recognized with the cris-axis-elf and
10451 cris-axis-linux-gnu targets.
10453 @item -mlinux
10454 @opindex mlinux
10455 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10457 @item -sim
10458 @opindex sim
10459 This option, recognized for the cris-axis-elf arranges
10460 to link with input-output functions from a simulator library.  Code,
10461 initialized data and zero-initialized data are allocated consecutively.
10463 @item -sim2
10464 @opindex sim2
10465 Like @option{-sim}, but pass linker options to locate initialized data at
10466 0x40000000 and zero-initialized data at 0x80000000.
10467 @end table
10469 @node CRX Options
10470 @subsection CRX Options
10471 @cindex CRX Options
10473 These options are defined specifically for the CRX ports.
10475 @table @gcctabopt
10477 @item -mmac
10478 @opindex mmac
10479 Enable the use of multiply-accumulate instructions. Disabled by default.
10481 @item -mpush-args
10482 @opindex mpush-args
10483 Push instructions will be used to pass outgoing arguments when functions
10484 are called. Enabled by default.
10485 @end table
10487 @node Darwin Options
10488 @subsection Darwin Options
10489 @cindex Darwin options
10491 These options are defined for all architectures running the Darwin operating
10492 system.
10494 FSF GCC on Darwin does not create ``fat'' object files; it will create
10495 an object file for the single architecture that it was built to
10496 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10497 @option{-arch} options are used; it does so by running the compiler or
10498 linker multiple times and joining the results together with
10499 @file{lipo}.
10501 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10502 @samp{i686}) is determined by the flags that specify the ISA
10503 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10504 @option{-force_cpusubtype_ALL} option can be used to override this.
10506 The Darwin tools vary in their behavior when presented with an ISA
10507 mismatch.  The assembler, @file{as}, will only permit instructions to
10508 be used that are valid for the subtype of the file it is generating,
10509 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10510 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10511 and print an error if asked to create a shared library with a less
10512 restrictive subtype than its input files (for instance, trying to put
10513 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10514 for executables, @file{ld}, will quietly give the executable the most
10515 restrictive subtype of any of its input files.
10517 @table @gcctabopt
10518 @item -F@var{dir}
10519 @opindex F
10520 Add the framework directory @var{dir} to the head of the list of
10521 directories to be searched for header files.  These directories are
10522 interleaved with those specified by @option{-I} options and are
10523 scanned in a left-to-right order.
10525 A framework directory is a directory with frameworks in it.  A
10526 framework is a directory with a @samp{"Headers"} and/or
10527 @samp{"PrivateHeaders"} directory contained directly in it that ends
10528 in @samp{".framework"}.  The name of a framework is the name of this
10529 directory excluding the @samp{".framework"}.  Headers associated with
10530 the framework are found in one of those two directories, with
10531 @samp{"Headers"} being searched first.  A subframework is a framework
10532 directory that is in a framework's @samp{"Frameworks"} directory.
10533 Includes of subframework headers can only appear in a header of a
10534 framework that contains the subframework, or in a sibling subframework
10535 header.  Two subframeworks are siblings if they occur in the same
10536 framework.  A subframework should not have the same name as a
10537 framework, a warning will be issued if this is violated.  Currently a
10538 subframework cannot have subframeworks, in the future, the mechanism
10539 may be extended to support this.  The standard frameworks can be found
10540 in @samp{"/System/Library/Frameworks"} and
10541 @samp{"/Library/Frameworks"}.  An example include looks like
10542 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10543 the name of the framework and header.h is found in the
10544 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10546 @item -iframework@var{dir}
10547 @opindex iframework
10548 Like @option{-F} except the directory is a treated as a system
10549 directory.  The main difference between this @option{-iframework} and
10550 @option{-F} is that with @option{-iframework} the compiler does not
10551 warn about constructs contained within header files found via
10552 @var{dir}.  This option is valid only for the C family of languages.
10554 @item -gused
10555 @opindex gused
10556 Emit debugging information for symbols that are used.  For STABS
10557 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10558 This is by default ON@.
10560 @item -gfull
10561 @opindex gfull
10562 Emit debugging information for all symbols and types.
10564 @item -mmacosx-version-min=@var{version}
10565 The earliest version of MacOS X that this executable will run on
10566 is @var{version}.  Typical values of @var{version} include @code{10.1},
10567 @code{10.2}, and @code{10.3.9}.
10569 If the compiler was built to use the system's headers by default,
10570 then the default for this option is the system version on which the
10571 compiler is running, otherwise the default is to make choices which
10572 are compatible with as many systems and code bases as possible.
10574 @item -mkernel
10575 @opindex mkernel
10576 Enable kernel development mode.  The @option{-mkernel} option sets
10577 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10578 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10579 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10580 applicable.  This mode also sets @option{-mno-altivec},
10581 @option{-msoft-float}, @option{-fno-builtin} and
10582 @option{-mlong-branch} for PowerPC targets.
10584 @item -mone-byte-bool
10585 @opindex mone-byte-bool
10586 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10587 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10588 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10589 option has no effect on x86.
10591 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10592 to generate code that is not binary compatible with code generated
10593 without that switch.  Using this switch may require recompiling all
10594 other modules in a program, including system libraries.  Use this
10595 switch to conform to a non-default data model.
10597 @item -mfix-and-continue
10598 @itemx -ffix-and-continue
10599 @itemx -findirect-data
10600 @opindex mfix-and-continue
10601 @opindex ffix-and-continue
10602 @opindex findirect-data
10603 Generate code suitable for fast turn around development.  Needed to
10604 enable gdb to dynamically load @code{.o} files into already running
10605 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10606 are provided for backwards compatibility.
10608 @item -all_load
10609 @opindex all_load
10610 Loads all members of static archive libraries.
10611 See man ld(1) for more information.
10613 @item -arch_errors_fatal
10614 @opindex arch_errors_fatal
10615 Cause the errors having to do with files that have the wrong architecture
10616 to be fatal.
10618 @item -bind_at_load
10619 @opindex bind_at_load
10620 Causes the output file to be marked such that the dynamic linker will
10621 bind all undefined references when the file is loaded or launched.
10623 @item -bundle
10624 @opindex bundle
10625 Produce a Mach-o bundle format file.
10626 See man ld(1) for more information.
10628 @item -bundle_loader @var{executable}
10629 @opindex bundle_loader
10630 This option specifies the @var{executable} that will be loading the build
10631 output file being linked.  See man ld(1) for more information.
10633 @item -dynamiclib
10634 @opindex dynamiclib
10635 When passed this option, GCC will produce a dynamic library instead of
10636 an executable when linking, using the Darwin @file{libtool} command.
10638 @item -force_cpusubtype_ALL
10639 @opindex force_cpusubtype_ALL
10640 This causes GCC's output file to have the @var{ALL} subtype, instead of
10641 one controlled by the @option{-mcpu} or @option{-march} option.
10643 @item -allowable_client  @var{client_name}
10644 @itemx -client_name
10645 @itemx -compatibility_version
10646 @itemx -current_version
10647 @itemx -dead_strip
10648 @itemx -dependency-file
10649 @itemx -dylib_file
10650 @itemx -dylinker_install_name
10651 @itemx -dynamic
10652 @itemx -exported_symbols_list
10653 @itemx -filelist
10654 @itemx -flat_namespace
10655 @itemx -force_flat_namespace
10656 @itemx -headerpad_max_install_names
10657 @itemx -image_base
10658 @itemx -init
10659 @itemx -install_name
10660 @itemx -keep_private_externs
10661 @itemx -multi_module
10662 @itemx -multiply_defined
10663 @itemx -multiply_defined_unused
10664 @itemx -noall_load
10665 @itemx -no_dead_strip_inits_and_terms
10666 @itemx -nofixprebinding
10667 @itemx -nomultidefs
10668 @itemx -noprebind
10669 @itemx -noseglinkedit
10670 @itemx -pagezero_size
10671 @itemx -prebind
10672 @itemx -prebind_all_twolevel_modules
10673 @itemx -private_bundle
10674 @itemx -read_only_relocs
10675 @itemx -sectalign
10676 @itemx -sectobjectsymbols
10677 @itemx -whyload
10678 @itemx -seg1addr
10679 @itemx -sectcreate
10680 @itemx -sectobjectsymbols
10681 @itemx -sectorder
10682 @itemx -segaddr
10683 @itemx -segs_read_only_addr
10684 @itemx -segs_read_write_addr
10685 @itemx -seg_addr_table
10686 @itemx -seg_addr_table_filename
10687 @itemx -seglinkedit
10688 @itemx -segprot
10689 @itemx -segs_read_only_addr
10690 @itemx -segs_read_write_addr
10691 @itemx -single_module
10692 @itemx -static
10693 @itemx -sub_library
10694 @itemx -sub_umbrella
10695 @itemx -twolevel_namespace
10696 @itemx -umbrella
10697 @itemx -undefined
10698 @itemx -unexported_symbols_list
10699 @itemx -weak_reference_mismatches
10700 @itemx -whatsloaded
10701 @opindex allowable_client
10702 @opindex client_name
10703 @opindex compatibility_version
10704 @opindex current_version
10705 @opindex dead_strip
10706 @opindex dependency-file
10707 @opindex dylib_file
10708 @opindex dylinker_install_name
10709 @opindex dynamic
10710 @opindex exported_symbols_list
10711 @opindex filelist
10712 @opindex flat_namespace
10713 @opindex force_flat_namespace
10714 @opindex headerpad_max_install_names
10715 @opindex image_base
10716 @opindex init
10717 @opindex install_name
10718 @opindex keep_private_externs
10719 @opindex multi_module
10720 @opindex multiply_defined
10721 @opindex multiply_defined_unused
10722 @opindex noall_load
10723 @opindex no_dead_strip_inits_and_terms
10724 @opindex nofixprebinding
10725 @opindex nomultidefs
10726 @opindex noprebind
10727 @opindex noseglinkedit
10728 @opindex pagezero_size
10729 @opindex prebind
10730 @opindex prebind_all_twolevel_modules
10731 @opindex private_bundle
10732 @opindex read_only_relocs
10733 @opindex sectalign
10734 @opindex sectobjectsymbols
10735 @opindex whyload
10736 @opindex seg1addr
10737 @opindex sectcreate
10738 @opindex sectobjectsymbols
10739 @opindex sectorder
10740 @opindex segaddr
10741 @opindex segs_read_only_addr
10742 @opindex segs_read_write_addr
10743 @opindex seg_addr_table
10744 @opindex seg_addr_table_filename
10745 @opindex seglinkedit
10746 @opindex segprot
10747 @opindex segs_read_only_addr
10748 @opindex segs_read_write_addr
10749 @opindex single_module
10750 @opindex static
10751 @opindex sub_library
10752 @opindex sub_umbrella
10753 @opindex twolevel_namespace
10754 @opindex umbrella
10755 @opindex undefined
10756 @opindex unexported_symbols_list
10757 @opindex weak_reference_mismatches
10758 @opindex whatsloaded
10759 These options are passed to the Darwin linker.  The Darwin linker man page
10760 describes them in detail.
10761 @end table
10763 @node DEC Alpha Options
10764 @subsection DEC Alpha Options
10766 These @samp{-m} options are defined for the DEC Alpha implementations:
10768 @table @gcctabopt
10769 @item -mno-soft-float
10770 @itemx -msoft-float
10771 @opindex mno-soft-float
10772 @opindex msoft-float
10773 Use (do not use) the hardware floating-point instructions for
10774 floating-point operations.  When @option{-msoft-float} is specified,
10775 functions in @file{libgcc.a} will be used to perform floating-point
10776 operations.  Unless they are replaced by routines that emulate the
10777 floating-point operations, or compiled in such a way as to call such
10778 emulations routines, these routines will issue floating-point
10779 operations.   If you are compiling for an Alpha without floating-point
10780 operations, you must ensure that the library is built so as not to call
10781 them.
10783 Note that Alpha implementations without floating-point operations are
10784 required to have floating-point registers.
10786 @item -mfp-reg
10787 @itemx -mno-fp-regs
10788 @opindex mfp-reg
10789 @opindex mno-fp-regs
10790 Generate code that uses (does not use) the floating-point register set.
10791 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
10792 register set is not used, floating point operands are passed in integer
10793 registers as if they were integers and floating-point results are passed
10794 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
10795 so any function with a floating-point argument or return value called by code
10796 compiled with @option{-mno-fp-regs} must also be compiled with that
10797 option.
10799 A typical use of this option is building a kernel that does not use,
10800 and hence need not save and restore, any floating-point registers.
10802 @item -mieee
10803 @opindex mieee
10804 The Alpha architecture implements floating-point hardware optimized for
10805 maximum performance.  It is mostly compliant with the IEEE floating
10806 point standard.  However, for full compliance, software assistance is
10807 required.  This option generates code fully IEEE compliant code
10808 @emph{except} that the @var{inexact-flag} is not maintained (see below).
10809 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
10810 defined during compilation.  The resulting code is less efficient but is
10811 able to correctly support denormalized numbers and exceptional IEEE
10812 values such as not-a-number and plus/minus infinity.  Other Alpha
10813 compilers call this option @option{-ieee_with_no_inexact}.
10815 @item -mieee-with-inexact
10816 @opindex mieee-with-inexact
10817 This is like @option{-mieee} except the generated code also maintains
10818 the IEEE @var{inexact-flag}.  Turning on this option causes the
10819 generated code to implement fully-compliant IEEE math.  In addition to
10820 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
10821 macro.  On some Alpha implementations the resulting code may execute
10822 significantly slower than the code generated by default.  Since there is
10823 very little code that depends on the @var{inexact-flag}, you should
10824 normally not specify this option.  Other Alpha compilers call this
10825 option @option{-ieee_with_inexact}.
10827 @item -mfp-trap-mode=@var{trap-mode}
10828 @opindex mfp-trap-mode
10829 This option controls what floating-point related traps are enabled.
10830 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
10831 The trap mode can be set to one of four values:
10833 @table @samp
10834 @item n
10835 This is the default (normal) setting.  The only traps that are enabled
10836 are the ones that cannot be disabled in software (e.g., division by zero
10837 trap).
10839 @item u
10840 In addition to the traps enabled by @samp{n}, underflow traps are enabled
10841 as well.
10843 @item su
10844 Like @samp{u}, but the instructions are marked to be safe for software
10845 completion (see Alpha architecture manual for details).
10847 @item sui
10848 Like @samp{su}, but inexact traps are enabled as well.
10849 @end table
10851 @item -mfp-rounding-mode=@var{rounding-mode}
10852 @opindex mfp-rounding-mode
10853 Selects the IEEE rounding mode.  Other Alpha compilers call this option
10854 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
10857 @table @samp
10858 @item n
10859 Normal IEEE rounding mode.  Floating point numbers are rounded towards
10860 the nearest machine number or towards the even machine number in case
10861 of a tie.
10863 @item m
10864 Round towards minus infinity.
10866 @item c
10867 Chopped rounding mode.  Floating point numbers are rounded towards zero.
10869 @item d
10870 Dynamic rounding mode.  A field in the floating point control register
10871 (@var{fpcr}, see Alpha architecture reference manual) controls the
10872 rounding mode in effect.  The C library initializes this register for
10873 rounding towards plus infinity.  Thus, unless your program modifies the
10874 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
10875 @end table
10877 @item -mtrap-precision=@var{trap-precision}
10878 @opindex mtrap-precision
10879 In the Alpha architecture, floating point traps are imprecise.  This
10880 means without software assistance it is impossible to recover from a
10881 floating trap and program execution normally needs to be terminated.
10882 GCC can generate code that can assist operating system trap handlers
10883 in determining the exact location that caused a floating point trap.
10884 Depending on the requirements of an application, different levels of
10885 precisions can be selected:
10887 @table @samp
10888 @item p
10889 Program precision.  This option is the default and means a trap handler
10890 can only identify which program caused a floating point exception.
10892 @item f
10893 Function precision.  The trap handler can determine the function that
10894 caused a floating point exception.
10896 @item i
10897 Instruction precision.  The trap handler can determine the exact
10898 instruction that caused a floating point exception.
10899 @end table
10901 Other Alpha compilers provide the equivalent options called
10902 @option{-scope_safe} and @option{-resumption_safe}.
10904 @item -mieee-conformant
10905 @opindex mieee-conformant
10906 This option marks the generated code as IEEE conformant.  You must not
10907 use this option unless you also specify @option{-mtrap-precision=i} and either
10908 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
10909 is to emit the line @samp{.eflag 48} in the function prologue of the
10910 generated assembly file.  Under DEC Unix, this has the effect that
10911 IEEE-conformant math library routines will be linked in.
10913 @item -mbuild-constants
10914 @opindex mbuild-constants
10915 Normally GCC examines a 32- or 64-bit integer constant to
10916 see if it can construct it from smaller constants in two or three
10917 instructions.  If it cannot, it will output the constant as a literal and
10918 generate code to load it from the data segment at runtime.
10920 Use this option to require GCC to construct @emph{all} integer constants
10921 using code, even if it takes more instructions (the maximum is six).
10923 You would typically use this option to build a shared library dynamic
10924 loader.  Itself a shared library, it must relocate itself in memory
10925 before it can find the variables and constants in its own data segment.
10927 @item -malpha-as
10928 @itemx -mgas
10929 @opindex malpha-as
10930 @opindex mgas
10931 Select whether to generate code to be assembled by the vendor-supplied
10932 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
10934 @item -mbwx
10935 @itemx -mno-bwx
10936 @itemx -mcix
10937 @itemx -mno-cix
10938 @itemx -mfix
10939 @itemx -mno-fix
10940 @itemx -mmax
10941 @itemx -mno-max
10942 @opindex mbwx
10943 @opindex mno-bwx
10944 @opindex mcix
10945 @opindex mno-cix
10946 @opindex mfix
10947 @opindex mno-fix
10948 @opindex mmax
10949 @opindex mno-max
10950 Indicate whether GCC should generate code to use the optional BWX,
10951 CIX, FIX and MAX instruction sets.  The default is to use the instruction
10952 sets supported by the CPU type specified via @option{-mcpu=} option or that
10953 of the CPU on which GCC was built if none was specified.
10955 @item -mfloat-vax
10956 @itemx -mfloat-ieee
10957 @opindex mfloat-vax
10958 @opindex mfloat-ieee
10959 Generate code that uses (does not use) VAX F and G floating point
10960 arithmetic instead of IEEE single and double precision.
10962 @item -mexplicit-relocs
10963 @itemx -mno-explicit-relocs
10964 @opindex mexplicit-relocs
10965 @opindex mno-explicit-relocs
10966 Older Alpha assemblers provided no way to generate symbol relocations
10967 except via assembler macros.  Use of these macros does not allow
10968 optimal instruction scheduling.  GNU binutils as of version 2.12
10969 supports a new syntax that allows the compiler to explicitly mark
10970 which relocations should apply to which instructions.  This option
10971 is mostly useful for debugging, as GCC detects the capabilities of
10972 the assembler when it is built and sets the default accordingly.
10974 @item -msmall-data
10975 @itemx -mlarge-data
10976 @opindex msmall-data
10977 @opindex mlarge-data
10978 When @option{-mexplicit-relocs} is in effect, static data is
10979 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
10980 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
10981 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
10982 16-bit relocations off of the @code{$gp} register.  This limits the
10983 size of the small data area to 64KB, but allows the variables to be
10984 directly accessed via a single instruction.
10986 The default is @option{-mlarge-data}.  With this option the data area
10987 is limited to just below 2GB@.  Programs that require more than 2GB of
10988 data must use @code{malloc} or @code{mmap} to allocate the data in the
10989 heap instead of in the program's data segment.
10991 When generating code for shared libraries, @option{-fpic} implies
10992 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
10994 @item -msmall-text
10995 @itemx -mlarge-text
10996 @opindex msmall-text
10997 @opindex mlarge-text
10998 When @option{-msmall-text} is used, the compiler assumes that the
10999 code of the entire program (or shared library) fits in 4MB, and is
11000 thus reachable with a branch instruction.  When @option{-msmall-data}
11001 is used, the compiler can assume that all local symbols share the
11002 same @code{$gp} value, and thus reduce the number of instructions
11003 required for a function call from 4 to 1.
11005 The default is @option{-mlarge-text}.
11007 @item -mcpu=@var{cpu_type}
11008 @opindex mcpu
11009 Set the instruction set and instruction scheduling parameters for
11010 machine type @var{cpu_type}.  You can specify either the @samp{EV}
11011 style name or the corresponding chip number.  GCC supports scheduling
11012 parameters for the EV4, EV5 and EV6 family of processors and will
11013 choose the default values for the instruction set from the processor
11014 you specify.  If you do not specify a processor type, GCC will default
11015 to the processor on which the compiler was built.
11017 Supported values for @var{cpu_type} are
11019 @table @samp
11020 @item ev4
11021 @itemx ev45
11022 @itemx 21064
11023 Schedules as an EV4 and has no instruction set extensions.
11025 @item ev5
11026 @itemx 21164
11027 Schedules as an EV5 and has no instruction set extensions.
11029 @item ev56
11030 @itemx 21164a
11031 Schedules as an EV5 and supports the BWX extension.
11033 @item pca56
11034 @itemx 21164pc
11035 @itemx 21164PC
11036 Schedules as an EV5 and supports the BWX and MAX extensions.
11038 @item ev6
11039 @itemx 21264
11040 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
11042 @item ev67
11043 @itemx 21264a
11044 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
11045 @end table
11047 Native Linux/GNU toolchains also support the value @samp{native},
11048 which selects the best architecture option for the host processor.
11049 @option{-mcpu=native} has no effect if GCC does not recognize
11050 the processor.
11052 @item -mtune=@var{cpu_type}
11053 @opindex mtune
11054 Set only the instruction scheduling parameters for machine type
11055 @var{cpu_type}.  The instruction set is not changed.
11057 Native Linux/GNU toolchains also support the value @samp{native},
11058 which selects the best architecture option for the host processor.
11059 @option{-mtune=native} has no effect if GCC does not recognize
11060 the processor.
11062 @item -mmemory-latency=@var{time}
11063 @opindex mmemory-latency
11064 Sets the latency the scheduler should assume for typical memory
11065 references as seen by the application.  This number is highly
11066 dependent on the memory access patterns used by the application
11067 and the size of the external cache on the machine.
11069 Valid options for @var{time} are
11071 @table @samp
11072 @item @var{number}
11073 A decimal number representing clock cycles.
11075 @item L1
11076 @itemx L2
11077 @itemx L3
11078 @itemx main
11079 The compiler contains estimates of the number of clock cycles for
11080 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
11081 (also called Dcache, Scache, and Bcache), as well as to main memory.
11082 Note that L3 is only valid for EV5.
11084 @end table
11085 @end table
11087 @node DEC Alpha/VMS Options
11088 @subsection DEC Alpha/VMS Options
11090 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
11092 @table @gcctabopt
11093 @item -mvms-return-codes
11094 @opindex mvms-return-codes
11095 Return VMS condition codes from main.  The default is to return POSIX
11096 style condition (e.g.@: error) codes.
11098 @item -mdebug-main=@var{prefix}
11099 @opindex mdebug-main=@var{prefix}
11100 Flag the first routine whose name starts with @var{prefix} as the main
11101 routine for the debugger.
11103 @item -mmalloc64
11104 @opindex mmalloc64
11105 Default to 64bit memory allocation routines.
11106 @end table
11108 @node FR30 Options
11109 @subsection FR30 Options
11110 @cindex FR30 Options
11112 These options are defined specifically for the FR30 port.
11114 @table @gcctabopt
11116 @item -msmall-model
11117 @opindex msmall-model
11118 Use the small address space model.  This can produce smaller code, but
11119 it does assume that all symbolic values and addresses will fit into a
11120 20-bit range.
11122 @item -mno-lsim
11123 @opindex mno-lsim
11124 Assume that run-time support has been provided and so there is no need
11125 to include the simulator library (@file{libsim.a}) on the linker
11126 command line.
11128 @end table
11130 @node FRV Options
11131 @subsection FRV Options
11132 @cindex FRV Options
11134 @table @gcctabopt
11135 @item -mgpr-32
11136 @opindex mgpr-32
11138 Only use the first 32 general purpose registers.
11140 @item -mgpr-64
11141 @opindex mgpr-64
11143 Use all 64 general purpose registers.
11145 @item -mfpr-32
11146 @opindex mfpr-32
11148 Use only the first 32 floating point registers.
11150 @item -mfpr-64
11151 @opindex mfpr-64
11153 Use all 64 floating point registers
11155 @item -mhard-float
11156 @opindex mhard-float
11158 Use hardware instructions for floating point operations.
11160 @item -msoft-float
11161 @opindex msoft-float
11163 Use library routines for floating point operations.
11165 @item -malloc-cc
11166 @opindex malloc-cc
11168 Dynamically allocate condition code registers.
11170 @item -mfixed-cc
11171 @opindex mfixed-cc
11173 Do not try to dynamically allocate condition code registers, only
11174 use @code{icc0} and @code{fcc0}.
11176 @item -mdword
11177 @opindex mdword
11179 Change ABI to use double word insns.
11181 @item -mno-dword
11182 @opindex mno-dword
11184 Do not use double word instructions.
11186 @item -mdouble
11187 @opindex mdouble
11189 Use floating point double instructions.
11191 @item -mno-double
11192 @opindex mno-double
11194 Do not use floating point double instructions.
11196 @item -mmedia
11197 @opindex mmedia
11199 Use media instructions.
11201 @item -mno-media
11202 @opindex mno-media
11204 Do not use media instructions.
11206 @item -mmuladd
11207 @opindex mmuladd
11209 Use multiply and add/subtract instructions.
11211 @item -mno-muladd
11212 @opindex mno-muladd
11214 Do not use multiply and add/subtract instructions.
11216 @item -mfdpic
11217 @opindex mfdpic
11219 Select the FDPIC ABI, that uses function descriptors to represent
11220 pointers to functions.  Without any PIC/PIE-related options, it
11221 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
11222 assumes GOT entries and small data are within a 12-bit range from the
11223 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11224 are computed with 32 bits.
11225 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11227 @item -minline-plt
11228 @opindex minline-plt
11230 Enable inlining of PLT entries in function calls to functions that are
11231 not known to bind locally.  It has no effect without @option{-mfdpic}.
11232 It's enabled by default if optimizing for speed and compiling for
11233 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11234 optimization option such as @option{-O3} or above is present in the
11235 command line.
11237 @item -mTLS
11238 @opindex mTLS
11240 Assume a large TLS segment when generating thread-local code.
11242 @item -mtls
11243 @opindex mtls
11245 Do not assume a large TLS segment when generating thread-local code.
11247 @item -mgprel-ro
11248 @opindex mgprel-ro
11250 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11251 that is known to be in read-only sections.  It's enabled by default,
11252 except for @option{-fpic} or @option{-fpie}: even though it may help
11253 make the global offset table smaller, it trades 1 instruction for 4.
11254 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11255 one of which may be shared by multiple symbols, and it avoids the need
11256 for a GOT entry for the referenced symbol, so it's more likely to be a
11257 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
11259 @item -multilib-library-pic
11260 @opindex multilib-library-pic
11262 Link with the (library, not FD) pic libraries.  It's implied by
11263 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11264 @option{-fpic} without @option{-mfdpic}.  You should never have to use
11265 it explicitly.
11267 @item -mlinked-fp
11268 @opindex mlinked-fp
11270 Follow the EABI requirement of always creating a frame pointer whenever
11271 a stack frame is allocated.  This option is enabled by default and can
11272 be disabled with @option{-mno-linked-fp}.
11274 @item -mlong-calls
11275 @opindex mlong-calls
11277 Use indirect addressing to call functions outside the current
11278 compilation unit.  This allows the functions to be placed anywhere
11279 within the 32-bit address space.
11281 @item -malign-labels
11282 @opindex malign-labels
11284 Try to align labels to an 8-byte boundary by inserting nops into the
11285 previous packet.  This option only has an effect when VLIW packing
11286 is enabled.  It doesn't create new packets; it merely adds nops to
11287 existing ones.
11289 @item -mlibrary-pic
11290 @opindex mlibrary-pic
11292 Generate position-independent EABI code.
11294 @item -macc-4
11295 @opindex macc-4
11297 Use only the first four media accumulator registers.
11299 @item -macc-8
11300 @opindex macc-8
11302 Use all eight media accumulator registers.
11304 @item -mpack
11305 @opindex mpack
11307 Pack VLIW instructions.
11309 @item -mno-pack
11310 @opindex mno-pack
11312 Do not pack VLIW instructions.
11314 @item -mno-eflags
11315 @opindex mno-eflags
11317 Do not mark ABI switches in e_flags.
11319 @item -mcond-move
11320 @opindex mcond-move
11322 Enable the use of conditional-move instructions (default).
11324 This switch is mainly for debugging the compiler and will likely be removed
11325 in a future version.
11327 @item -mno-cond-move
11328 @opindex mno-cond-move
11330 Disable the use of conditional-move instructions.
11332 This switch is mainly for debugging the compiler and will likely be removed
11333 in a future version.
11335 @item -mscc
11336 @opindex mscc
11338 Enable the use of conditional set instructions (default).
11340 This switch is mainly for debugging the compiler and will likely be removed
11341 in a future version.
11343 @item -mno-scc
11344 @opindex mno-scc
11346 Disable the use of conditional set instructions.
11348 This switch is mainly for debugging the compiler and will likely be removed
11349 in a future version.
11351 @item -mcond-exec
11352 @opindex mcond-exec
11354 Enable the use of conditional execution (default).
11356 This switch is mainly for debugging the compiler and will likely be removed
11357 in a future version.
11359 @item -mno-cond-exec
11360 @opindex mno-cond-exec
11362 Disable the use of conditional execution.
11364 This switch is mainly for debugging the compiler and will likely be removed
11365 in a future version.
11367 @item -mvliw-branch
11368 @opindex mvliw-branch
11370 Run a pass to pack branches into VLIW instructions (default).
11372 This switch is mainly for debugging the compiler and will likely be removed
11373 in a future version.
11375 @item -mno-vliw-branch
11376 @opindex mno-vliw-branch
11378 Do not run a pass to pack branches into VLIW instructions.
11380 This switch is mainly for debugging the compiler and will likely be removed
11381 in a future version.
11383 @item -mmulti-cond-exec
11384 @opindex mmulti-cond-exec
11386 Enable optimization of @code{&&} and @code{||} in conditional execution
11387 (default).
11389 This switch is mainly for debugging the compiler and will likely be removed
11390 in a future version.
11392 @item -mno-multi-cond-exec
11393 @opindex mno-multi-cond-exec
11395 Disable optimization of @code{&&} and @code{||} in conditional execution.
11397 This switch is mainly for debugging the compiler and will likely be removed
11398 in a future version.
11400 @item -mnested-cond-exec
11401 @opindex mnested-cond-exec
11403 Enable nested conditional execution optimizations (default).
11405 This switch is mainly for debugging the compiler and will likely be removed
11406 in a future version.
11408 @item -mno-nested-cond-exec
11409 @opindex mno-nested-cond-exec
11411 Disable nested conditional execution optimizations.
11413 This switch is mainly for debugging the compiler and will likely be removed
11414 in a future version.
11416 @item -moptimize-membar
11417 @opindex moptimize-membar
11419 This switch removes redundant @code{membar} instructions from the
11420 compiler generated code.  It is enabled by default.
11422 @item -mno-optimize-membar
11423 @opindex mno-optimize-membar
11425 This switch disables the automatic removal of redundant @code{membar}
11426 instructions from the generated code.
11428 @item -mtomcat-stats
11429 @opindex mtomcat-stats
11431 Cause gas to print out tomcat statistics.
11433 @item -mcpu=@var{cpu}
11434 @opindex mcpu
11436 Select the processor type for which to generate code.  Possible values are
11437 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11438 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11440 @end table
11442 @node GNU/Linux Options
11443 @subsection GNU/Linux Options
11445 These @samp{-m} options are defined for GNU/Linux targets:
11447 @table @gcctabopt
11448 @item -mglibc
11449 @opindex mglibc
11450 Use the GNU C library instead of uClibc.  This is the default except
11451 on @samp{*-*-linux-*uclibc*} targets.
11453 @item -muclibc
11454 @opindex muclibc
11455 Use uClibc instead of the GNU C library.  This is the default on
11456 @samp{*-*-linux-*uclibc*} targets.
11457 @end table
11459 @node H8/300 Options
11460 @subsection H8/300 Options
11462 These @samp{-m} options are defined for the H8/300 implementations:
11464 @table @gcctabopt
11465 @item -mrelax
11466 @opindex mrelax
11467 Shorten some address references at link time, when possible; uses the
11468 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11469 ld, Using ld}, for a fuller description.
11471 @item -mh
11472 @opindex mh
11473 Generate code for the H8/300H@.
11475 @item -ms
11476 @opindex ms
11477 Generate code for the H8S@.
11479 @item -mn
11480 @opindex mn
11481 Generate code for the H8S and H8/300H in the normal mode.  This switch
11482 must be used either with @option{-mh} or @option{-ms}.
11484 @item -ms2600
11485 @opindex ms2600
11486 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11488 @item -mint32
11489 @opindex mint32
11490 Make @code{int} data 32 bits by default.
11492 @item -malign-300
11493 @opindex malign-300
11494 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11495 The default for the H8/300H and H8S is to align longs and floats on 4
11496 byte boundaries.
11497 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11498 This option has no effect on the H8/300.
11499 @end table
11501 @node HPPA Options
11502 @subsection HPPA Options
11503 @cindex HPPA Options
11505 These @samp{-m} options are defined for the HPPA family of computers:
11507 @table @gcctabopt
11508 @item -march=@var{architecture-type}
11509 @opindex march
11510 Generate code for the specified architecture.  The choices for
11511 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11512 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11513 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11514 architecture option for your machine.  Code compiled for lower numbered
11515 architectures will run on higher numbered architectures, but not the
11516 other way around.
11518 @item -mpa-risc-1-0
11519 @itemx -mpa-risc-1-1
11520 @itemx -mpa-risc-2-0
11521 @opindex mpa-risc-1-0
11522 @opindex mpa-risc-1-1
11523 @opindex mpa-risc-2-0
11524 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11526 @item -mbig-switch
11527 @opindex mbig-switch
11528 Generate code suitable for big switch tables.  Use this option only if
11529 the assembler/linker complain about out of range branches within a switch
11530 table.
11532 @item -mjump-in-delay
11533 @opindex mjump-in-delay
11534 Fill delay slots of function calls with unconditional jump instructions
11535 by modifying the return pointer for the function call to be the target
11536 of the conditional jump.
11538 @item -mdisable-fpregs
11539 @opindex mdisable-fpregs
11540 Prevent floating point registers from being used in any manner.  This is
11541 necessary for compiling kernels which perform lazy context switching of
11542 floating point registers.  If you use this option and attempt to perform
11543 floating point operations, the compiler will abort.
11545 @item -mdisable-indexing
11546 @opindex mdisable-indexing
11547 Prevent the compiler from using indexing address modes.  This avoids some
11548 rather obscure problems when compiling MIG generated code under MACH@.
11550 @item -mno-space-regs
11551 @opindex mno-space-regs
11552 Generate code that assumes the target has no space registers.  This allows
11553 GCC to generate faster indirect calls and use unscaled index address modes.
11555 Such code is suitable for level 0 PA systems and kernels.
11557 @item -mfast-indirect-calls
11558 @opindex mfast-indirect-calls
11559 Generate code that assumes calls never cross space boundaries.  This
11560 allows GCC to emit code which performs faster indirect calls.
11562 This option will not work in the presence of shared libraries or nested
11563 functions.
11565 @item -mfixed-range=@var{register-range}
11566 @opindex mfixed-range
11567 Generate code treating the given register range as fixed registers.
11568 A fixed register is one that the register allocator can not use.  This is
11569 useful when compiling kernel code.  A register range is specified as
11570 two registers separated by a dash.  Multiple register ranges can be
11571 specified separated by a comma.
11573 @item -mlong-load-store
11574 @opindex mlong-load-store
11575 Generate 3-instruction load and store sequences as sometimes required by
11576 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11577 the HP compilers.
11579 @item -mportable-runtime
11580 @opindex mportable-runtime
11581 Use the portable calling conventions proposed by HP for ELF systems.
11583 @item -mgas
11584 @opindex mgas
11585 Enable the use of assembler directives only GAS understands.
11587 @item -mschedule=@var{cpu-type}
11588 @opindex mschedule
11589 Schedule code according to the constraints for the machine type
11590 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11591 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11592 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11593 proper scheduling option for your machine.  The default scheduling is
11594 @samp{8000}.
11596 @item -mlinker-opt
11597 @opindex mlinker-opt
11598 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11599 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11600 linkers in which they give bogus error messages when linking some programs.
11602 @item -msoft-float
11603 @opindex msoft-float
11604 Generate output containing library calls for floating point.
11605 @strong{Warning:} the requisite libraries are not available for all HPPA
11606 targets.  Normally the facilities of the machine's usual C compiler are
11607 used, but this cannot be done directly in cross-compilation.  You must make
11608 your own arrangements to provide suitable library functions for
11609 cross-compilation.
11611 @option{-msoft-float} changes the calling convention in the output file;
11612 therefore, it is only useful if you compile @emph{all} of a program with
11613 this option.  In particular, you need to compile @file{libgcc.a}, the
11614 library that comes with GCC, with @option{-msoft-float} in order for
11615 this to work.
11617 @item -msio
11618 @opindex msio
11619 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11620 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11621 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11622 options are available under HP-UX and HI-UX@.
11624 @item -mgnu-ld
11625 @opindex mgnu-ld
11626 Use GNU ld specific options.  This passes @option{-shared} to ld when
11627 building a shared library.  It is the default when GCC is configured,
11628 explicitly or implicitly, with the GNU linker.  This option does not
11629 have any affect on which ld is called, it only changes what parameters
11630 are passed to that ld.  The ld that is called is determined by the
11631 @option{--with-ld} configure option, GCC's program search path, and
11632 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11633 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11634 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11636 @item -mhp-ld
11637 @opindex mhp-ld
11638 Use HP ld specific options.  This passes @option{-b} to ld when building
11639 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11640 links.  It is the default when GCC is configured, explicitly or
11641 implicitly, with the HP linker.  This option does not have any affect on
11642 which ld is called, it only changes what parameters are passed to that
11643 ld.  The ld that is called is determined by the @option{--with-ld}
11644 configure option, GCC's program search path, and finally by the user's
11645 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11646 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11647 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11649 @item -mlong-calls
11650 @opindex mno-long-calls
11651 Generate code that uses long call sequences.  This ensures that a call
11652 is always able to reach linker generated stubs.  The default is to generate
11653 long calls only when the distance from the call site to the beginning
11654 of the function or translation unit, as the case may be, exceeds a
11655 predefined limit set by the branch type being used.  The limits for
11656 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11657 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11658 240,000 bytes.
11660 Distances are measured from the beginning of functions when using the
11661 @option{-ffunction-sections} option, or when using the @option{-mgas}
11662 and @option{-mno-portable-runtime} options together under HP-UX with
11663 the SOM linker.
11665 It is normally not desirable to use this option as it will degrade
11666 performance.  However, it may be useful in large applications,
11667 particularly when partial linking is used to build the application.
11669 The types of long calls used depends on the capabilities of the
11670 assembler and linker, and the type of code being generated.  The
11671 impact on systems that support long absolute calls, and long pic
11672 symbol-difference or pc-relative calls should be relatively small.
11673 However, an indirect call is used on 32-bit ELF systems in pic code
11674 and it is quite long.
11676 @item -munix=@var{unix-std}
11677 @opindex march
11678 Generate compiler predefines and select a startfile for the specified
11679 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11680 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11681 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11682 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11683 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11684 and later.
11686 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11687 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11688 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11689 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11690 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11691 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11693 It is @emph{important} to note that this option changes the interfaces
11694 for various library routines.  It also affects the operational behavior
11695 of the C library.  Thus, @emph{extreme} care is needed in using this
11696 option.
11698 Library code that is intended to operate with more than one UNIX
11699 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11700 as appropriate.  Most GNU software doesn't provide this capability.
11702 @item -nolibdld
11703 @opindex nolibdld
11704 Suppress the generation of link options to search libdld.sl when the
11705 @option{-static} option is specified on HP-UX 10 and later.
11707 @item -static
11708 @opindex static
11709 The HP-UX implementation of setlocale in libc has a dependency on
11710 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11711 when the @option{-static} option is specified, special link options
11712 are needed to resolve this dependency.
11714 On HP-UX 10 and later, the GCC driver adds the necessary options to
11715 link with libdld.sl when the @option{-static} option is specified.
11716 This causes the resulting binary to be dynamic.  On the 64-bit port,
11717 the linkers generate dynamic binaries by default in any case.  The
11718 @option{-nolibdld} option can be used to prevent the GCC driver from
11719 adding these link options.
11721 @item -threads
11722 @opindex threads
11723 Add support for multithreading with the @dfn{dce thread} library
11724 under HP-UX@.  This option sets flags for both the preprocessor and
11725 linker.
11726 @end table
11728 @node i386 and x86-64 Options
11729 @subsection Intel 386 and AMD x86-64 Options
11730 @cindex i386 Options
11731 @cindex x86-64 Options
11732 @cindex Intel 386 Options
11733 @cindex AMD x86-64 Options
11735 These @samp{-m} options are defined for the i386 and x86-64 family of
11736 computers:
11738 @table @gcctabopt
11739 @item -mtune=@var{cpu-type}
11740 @opindex mtune
11741 Tune to @var{cpu-type} everything applicable about the generated code, except
11742 for the ABI and the set of available instructions.  The choices for
11743 @var{cpu-type} are:
11744 @table @emph
11745 @item generic
11746 Produce code optimized for the most common IA32/AMD64/EM64T processors.
11747 If you know the CPU on which your code will run, then you should use
11748 the corresponding @option{-mtune} option instead of
11749 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
11750 of your application will have, then you should use this option.
11752 As new processors are deployed in the marketplace, the behavior of this
11753 option will change.  Therefore, if you upgrade to a newer version of
11754 GCC, the code generated option will change to reflect the processors
11755 that were most common when that version of GCC was released.
11757 There is no @option{-march=generic} option because @option{-march}
11758 indicates the instruction set the compiler can use, and there is no
11759 generic instruction set applicable to all processors.  In contrast,
11760 @option{-mtune} indicates the processor (or, in this case, collection of
11761 processors) for which the code is optimized.
11762 @item native
11763 This selects the CPU to tune for at compilation time by determining
11764 the processor type of the compiling machine.  Using @option{-mtune=native}
11765 will produce code optimized for the local machine under the constraints
11766 of the selected instruction set.  Using @option{-march=native} will
11767 enable all instruction subsets supported by the local machine (hence
11768 the result might not run on different machines).
11769 @item i386
11770 Original Intel's i386 CPU@.
11771 @item i486
11772 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
11773 @item i586, pentium
11774 Intel Pentium CPU with no MMX support.
11775 @item pentium-mmx
11776 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
11777 @item pentiumpro
11778 Intel PentiumPro CPU@.
11779 @item i686
11780 Same as @code{generic}, but when used as @code{march} option, PentiumPro
11781 instruction set will be used, so the code will run on all i686 family chips.
11782 @item pentium2
11783 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
11784 @item pentium3, pentium3m
11785 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
11786 support.
11787 @item pentium-m
11788 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
11789 support.  Used by Centrino notebooks.
11790 @item pentium4, pentium4m
11791 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
11792 @item prescott
11793 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
11794 set support.
11795 @item nocona
11796 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
11797 SSE2 and SSE3 instruction set support.
11798 @item core2
11799 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11800 instruction set support.
11801 @item atom
11802 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11803 instruction set support.
11804 @item k6
11805 AMD K6 CPU with MMX instruction set support.
11806 @item k6-2, k6-3
11807 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
11808 @item athlon, athlon-tbird
11809 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
11810 support.
11811 @item athlon-4, athlon-xp, athlon-mp
11812 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
11813 instruction set support.
11814 @item k8, opteron, athlon64, athlon-fx
11815 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
11816 MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit instruction set extensions.)
11817 @item k8-sse3, opteron-sse3, athlon64-sse3
11818 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
11819 @item amdfam10, barcelona
11820 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
11821 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
11822 instruction set extensions.)
11823 @item winchip-c6
11824 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
11825 set support.
11826 @item winchip2
11827 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
11828 instruction set support.
11829 @item c3
11830 Via C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
11831 implemented for this chip.)
11832 @item c3-2
11833 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
11834 implemented for this chip.)
11835 @item geode
11836 Embedded AMD CPU with MMX and 3DNow!@: instruction set support.
11837 @end table
11839 While picking a specific @var{cpu-type} will schedule things appropriately
11840 for that particular chip, the compiler will not generate any code that
11841 does not run on the i386 without the @option{-march=@var{cpu-type}} option
11842 being used.
11844 @item -march=@var{cpu-type}
11845 @opindex march
11846 Generate instructions for the machine type @var{cpu-type}.  The choices
11847 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
11848 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
11850 @item -mcpu=@var{cpu-type}
11851 @opindex mcpu
11852 A deprecated synonym for @option{-mtune}.
11854 @item -mfpmath=@var{unit}
11855 @opindex mfpmath
11856 Generate floating point arithmetics for selected unit @var{unit}.  The choices
11857 for @var{unit} are:
11859 @table @samp
11860 @item 387
11861 Use the standard 387 floating point coprocessor present majority of chips and
11862 emulated otherwise.  Code compiled with this option will run almost everywhere.
11863 The temporary results are computed in 80bit precision instead of precision
11864 specified by the type resulting in slightly different results compared to most
11865 of other chips.  See @option{-ffloat-store} for more detailed description.
11867 This is the default choice for i386 compiler.
11869 @item sse
11870 Use scalar floating point instructions present in the SSE instruction set.
11871 This instruction set is supported by Pentium3 and newer chips, in the AMD line
11872 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
11873 instruction set supports only single precision arithmetics, thus the double and
11874 extended precision arithmetics is still done using 387.  Later version, present
11875 only in Pentium4 and the future AMD x86-64 chips supports double precision
11876 arithmetics too.
11878 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
11879 or @option{-msse2} switches to enable SSE extensions and make this option
11880 effective.  For the x86-64 compiler, these extensions are enabled by default.
11882 The resulting code should be considerably faster in the majority of cases and avoid
11883 the numerical instability problems of 387 code, but may break some existing
11884 code that expects temporaries to be 80bit.
11886 This is the default choice for the x86-64 compiler.
11888 @item sse,387
11889 @itemx sse+387
11890 @itemx both
11891 Attempt to utilize both instruction sets at once.  This effectively double the
11892 amount of available registers and on chips with separate execution units for
11893 387 and SSE the execution resources too.  Use this option with care, as it is
11894 still experimental, because the GCC register allocator does not model separate
11895 functional units well resulting in instable performance.
11896 @end table
11898 @item -masm=@var{dialect}
11899 @opindex masm=@var{dialect}
11900 Output asm instructions using selected @var{dialect}.  Supported
11901 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
11902 not support @samp{intel}.
11904 @item -mieee-fp
11905 @itemx -mno-ieee-fp
11906 @opindex mieee-fp
11907 @opindex mno-ieee-fp
11908 Control whether or not the compiler uses IEEE floating point
11909 comparisons.  These handle correctly the case where the result of a
11910 comparison is unordered.
11912 @item -msoft-float
11913 @opindex msoft-float
11914 Generate output containing library calls for floating point.
11915 @strong{Warning:} the requisite libraries are not part of GCC@.
11916 Normally the facilities of the machine's usual C compiler are used, but
11917 this can't be done directly in cross-compilation.  You must make your
11918 own arrangements to provide suitable library functions for
11919 cross-compilation.
11921 On machines where a function returns floating point results in the 80387
11922 register stack, some floating point opcodes may be emitted even if
11923 @option{-msoft-float} is used.
11925 @item -mno-fp-ret-in-387
11926 @opindex mno-fp-ret-in-387
11927 Do not use the FPU registers for return values of functions.
11929 The usual calling convention has functions return values of types
11930 @code{float} and @code{double} in an FPU register, even if there
11931 is no FPU@.  The idea is that the operating system should emulate
11932 an FPU@.
11934 The option @option{-mno-fp-ret-in-387} causes such values to be returned
11935 in ordinary CPU registers instead.
11937 @item -mno-fancy-math-387
11938 @opindex mno-fancy-math-387
11939 Some 387 emulators do not support the @code{sin}, @code{cos} and
11940 @code{sqrt} instructions for the 387.  Specify this option to avoid
11941 generating those instructions.  This option is the default on FreeBSD,
11942 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
11943 indicates that the target cpu will always have an FPU and so the
11944 instruction will not need emulation.  As of revision 2.6.1, these
11945 instructions are not generated unless you also use the
11946 @option{-funsafe-math-optimizations} switch.
11948 @item -malign-double
11949 @itemx -mno-align-double
11950 @opindex malign-double
11951 @opindex mno-align-double
11952 Control whether GCC aligns @code{double}, @code{long double}, and
11953 @code{long long} variables on a two word boundary or a one word
11954 boundary.  Aligning @code{double} variables on a two word boundary will
11955 produce code that runs somewhat faster on a @samp{Pentium} at the
11956 expense of more memory.
11958 On x86-64, @option{-malign-double} is enabled by default.
11960 @strong{Warning:} if you use the @option{-malign-double} switch,
11961 structures containing the above types will be aligned differently than
11962 the published application binary interface specifications for the 386
11963 and will not be binary compatible with structures in code compiled
11964 without that switch.
11966 @item -m96bit-long-double
11967 @itemx -m128bit-long-double
11968 @opindex m96bit-long-double
11969 @opindex m128bit-long-double
11970 These switches control the size of @code{long double} type.  The i386
11971 application binary interface specifies the size to be 96 bits,
11972 so @option{-m96bit-long-double} is the default in 32 bit mode.
11974 Modern architectures (Pentium and newer) would prefer @code{long double}
11975 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
11976 conforming to the ABI, this would not be possible.  So specifying a
11977 @option{-m128bit-long-double} will align @code{long double}
11978 to a 16 byte boundary by padding the @code{long double} with an additional
11979 32 bit zero.
11981 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
11982 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
11984 Notice that neither of these options enable any extra precision over the x87
11985 standard of 80 bits for a @code{long double}.
11987 @strong{Warning:} if you override the default value for your target ABI, the
11988 structures and arrays containing @code{long double} variables will change
11989 their size as well as function calling convention for function taking
11990 @code{long double} will be modified.  Hence they will not be binary
11991 compatible with arrays or structures in code compiled without that switch.
11993 @item -mlarge-data-threshold=@var{number}
11994 @opindex mlarge-data-threshold=@var{number}
11995 When @option{-mcmodel=medium} is specified, the data greater than
11996 @var{threshold} are placed in large data section.  This value must be the
11997 same across all object linked into the binary and defaults to 65535.
11999 @item -mrtd
12000 @opindex mrtd
12001 Use a different function-calling convention, in which functions that
12002 take a fixed number of arguments return with the @code{ret} @var{num}
12003 instruction, which pops their arguments while returning.  This saves one
12004 instruction in the caller since there is no need to pop the arguments
12005 there.
12007 You can specify that an individual function is called with this calling
12008 sequence with the function attribute @samp{stdcall}.  You can also
12009 override the @option{-mrtd} option by using the function attribute
12010 @samp{cdecl}.  @xref{Function Attributes}.
12012 @strong{Warning:} this calling convention is incompatible with the one
12013 normally used on Unix, so you cannot use it if you need to call
12014 libraries compiled with the Unix compiler.
12016 Also, you must provide function prototypes for all functions that
12017 take variable numbers of arguments (including @code{printf});
12018 otherwise incorrect code will be generated for calls to those
12019 functions.
12021 In addition, seriously incorrect code will result if you call a
12022 function with too many arguments.  (Normally, extra arguments are
12023 harmlessly ignored.)
12025 @item -mregparm=@var{num}
12026 @opindex mregparm
12027 Control how many registers are used to pass integer arguments.  By
12028 default, no registers are used to pass arguments, and at most 3
12029 registers can be used.  You can control this behavior for a specific
12030 function by using the function attribute @samp{regparm}.
12031 @xref{Function Attributes}.
12033 @strong{Warning:} if you use this switch, and
12034 @var{num} is nonzero, then you must build all modules with the same
12035 value, including any libraries.  This includes the system libraries and
12036 startup modules.
12038 @item -msseregparm
12039 @opindex msseregparm
12040 Use SSE register passing conventions for float and double arguments
12041 and return values.  You can control this behavior for a specific
12042 function by using the function attribute @samp{sseregparm}.
12043 @xref{Function Attributes}.
12045 @strong{Warning:} if you use this switch then you must build all
12046 modules with the same value, including any libraries.  This includes
12047 the system libraries and startup modules.
12049 @item -mpc32
12050 @itemx -mpc64
12051 @itemx -mpc80
12052 @opindex mpc32
12053 @opindex mpc64
12054 @opindex mpc80
12056 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
12057 is specified, the significands of results of floating-point operations are
12058 rounded to 24 bits (single precision); @option{-mpc64} rounds the
12059 significands of results of floating-point operations to 53 bits (double
12060 precision) and @option{-mpc80} rounds the significands of results of
12061 floating-point operations to 64 bits (extended double precision), which is
12062 the default.  When this option is used, floating-point operations in higher
12063 precisions are not available to the programmer without setting the FPU
12064 control word explicitly.
12066 Setting the rounding of floating-point operations to less than the default
12067 80 bits can speed some programs by 2% or more.  Note that some mathematical
12068 libraries assume that extended precision (80 bit) floating-point operations
12069 are enabled by default; routines in such libraries could suffer significant
12070 loss of accuracy, typically through so-called "catastrophic cancellation",
12071 when this option is used to set the precision to less than extended precision.
12073 @item -mstackrealign
12074 @opindex mstackrealign
12075 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
12076 option will generate an alternate prologue and epilogue that realigns the
12077 runtime stack if necessary.  This supports mixing legacy codes that keep
12078 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
12079 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
12080 applicable to individual functions.
12082 @item -mpreferred-stack-boundary=@var{num}
12083 @opindex mpreferred-stack-boundary
12084 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
12085 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
12086 the default is 4 (16 bytes or 128 bits).
12088 @item -mincoming-stack-boundary=@var{num}
12089 @opindex mincoming-stack-boundary
12090 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
12091 boundary.  If @option{-mincoming-stack-boundary} is not specified,
12092 the one specified by @option{-mpreferred-stack-boundary} will be used.
12094 On Pentium and PentiumPro, @code{double} and @code{long double} values
12095 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
12096 suffer significant run time performance penalties.  On Pentium III, the
12097 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
12098 properly if it is not 16 byte aligned.
12100 To ensure proper alignment of this values on the stack, the stack boundary
12101 must be as aligned as that required by any value stored on the stack.
12102 Further, every function must be generated such that it keeps the stack
12103 aligned.  Thus calling a function compiled with a higher preferred
12104 stack boundary from a function compiled with a lower preferred stack
12105 boundary will most likely misalign the stack.  It is recommended that
12106 libraries that use callbacks always use the default setting.
12108 This extra alignment does consume extra stack space, and generally
12109 increases code size.  Code that is sensitive to stack space usage, such
12110 as embedded systems and operating system kernels, may want to reduce the
12111 preferred alignment to @option{-mpreferred-stack-boundary=2}.
12113 @item -mmmx
12114 @itemx -mno-mmx
12115 @itemx -msse
12116 @itemx -mno-sse
12117 @itemx -msse2
12118 @itemx -mno-sse2
12119 @itemx -msse3
12120 @itemx -mno-sse3
12121 @itemx -mssse3
12122 @itemx -mno-ssse3
12123 @itemx -msse4.1
12124 @itemx -mno-sse4.1
12125 @itemx -msse4.2
12126 @itemx -mno-sse4.2
12127 @itemx -msse4
12128 @itemx -mno-sse4
12129 @itemx -mavx
12130 @itemx -mno-avx
12131 @itemx -maes
12132 @itemx -mno-aes
12133 @itemx -mpclmul
12134 @itemx -mno-pclmul
12135 @itemx -msse4a
12136 @itemx -mno-sse4a
12137 @itemx -mfma4
12138 @itemx -mno-fma4
12139 @itemx -mxop
12140 @itemx -mno-xop
12141 @itemx -mlwp
12142 @itemx -mno-lwp
12143 @itemx -m3dnow
12144 @itemx -mno-3dnow
12145 @itemx -mpopcnt
12146 @itemx -mno-popcnt
12147 @itemx -mabm
12148 @itemx -mno-abm
12149 @opindex mmmx
12150 @opindex mno-mmx
12151 @opindex msse
12152 @opindex mno-sse
12153 @opindex m3dnow
12154 @opindex mno-3dnow
12155 These switches enable or disable the use of instructions in the MMX,
12156 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, FMA4, XOP,
12157 LWP, ABM or 3DNow!@: extended instruction sets.
12158 These extensions are also available as built-in functions: see
12159 @ref{X86 Built-in Functions}, for details of the functions enabled and
12160 disabled by these switches.
12162 To have SSE/SSE2 instructions generated automatically from floating-point
12163 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12165 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12166 generates new AVX instructions or AVX equivalence for all SSEx instructions
12167 when needed.
12169 These options will enable GCC to use these extended instructions in
12170 generated code, even without @option{-mfpmath=sse}.  Applications which
12171 perform runtime CPU detection must compile separate files for each
12172 supported architecture, using the appropriate flags.  In particular,
12173 the file containing the CPU detection code should be compiled without
12174 these options.
12176 @item -mfused-madd
12177 @itemx -mno-fused-madd
12178 @opindex mfused-madd
12179 @opindex mno-fused-madd
12180 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12181 instructions.  The default is to use these instructions.
12183 @item -mcld
12184 @opindex mcld
12185 This option instructs GCC to emit a @code{cld} instruction in the prologue
12186 of functions that use string instructions.  String instructions depend on
12187 the DF flag to select between autoincrement or autodecrement mode.  While the
12188 ABI specifies the DF flag to be cleared on function entry, some operating
12189 systems violate this specification by not clearing the DF flag in their
12190 exception dispatchers.  The exception handler can be invoked with the DF flag
12191 set which leads to wrong direction mode, when string instructions are used.
12192 This option can be enabled by default on 32-bit x86 targets by configuring
12193 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
12194 instructions can be suppressed with the @option{-mno-cld} compiler option
12195 in this case.
12197 @item -mcx16
12198 @opindex mcx16
12199 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12200 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12201 data types.  This is useful for high resolution counters that could be updated
12202 by multiple processors (or cores).  This instruction is generated as part of
12203 atomic built-in functions: see @ref{Atomic Builtins} for details.
12205 @item -msahf
12206 @opindex msahf
12207 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12208 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12209 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
12210 SAHF are load and store instructions, respectively, for certain status flags.
12211 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12212 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12214 @item -mmovbe
12215 @opindex mmovbe
12216 This option will enable GCC to use movbe instruction to implement
12217 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12219 @item -mcrc32
12220 @opindex mcrc32
12221 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12222 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12223 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12225 @item -mrecip
12226 @opindex mrecip
12227 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12228 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12229 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12230 variants) for single precision floating point arguments.  These instructions
12231 are generated only when @option{-funsafe-math-optimizations} is enabled
12232 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12233 Note that while the throughput of the sequence is higher than the throughput
12234 of the non-reciprocal instruction, the precision of the sequence can be
12235 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12237 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12238 already with @option{-ffast-math} (or the above option combination), and
12239 doesn't need @option{-mrecip}.
12241 @item -mveclibabi=@var{type}
12242 @opindex mveclibabi
12243 Specifies the ABI type to use for vectorizing intrinsics using an
12244 external library.  Supported types are @code{svml} for the Intel short
12245 vector math library and @code{acml} for the AMD math core library style
12246 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
12247 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12248 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12249 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12250 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12251 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12252 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12253 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12254 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12255 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12256 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12257 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12258 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12259 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12260 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12261 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12262 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12263 compatible library will have to be specified at link time.
12265 @item -mabi=@var{name}
12266 @opindex mabi
12267 Generate code for the specified calling convention.  Permissible values
12268 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12269 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
12270 ABI when targeting Windows.  On all other systems, the default is the
12271 SYSV ABI.  You can control this behavior for a specific function by
12272 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12273 @xref{Function Attributes}.
12275 @item -mpush-args
12276 @itemx -mno-push-args
12277 @opindex mpush-args
12278 @opindex mno-push-args
12279 Use PUSH operations to store outgoing parameters.  This method is shorter
12280 and usually equally fast as method using SUB/MOV operations and is enabled
12281 by default.  In some cases disabling it may improve performance because of
12282 improved scheduling and reduced dependencies.
12284 @item -maccumulate-outgoing-args
12285 @opindex maccumulate-outgoing-args
12286 If enabled, the maximum amount of space required for outgoing arguments will be
12287 computed in the function prologue.  This is faster on most modern CPUs
12288 because of reduced dependencies, improved scheduling and reduced stack usage
12289 when preferred stack boundary is not equal to 2.  The drawback is a notable
12290 increase in code size.  This switch implies @option{-mno-push-args}.
12292 @item -mthreads
12293 @opindex mthreads
12294 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
12295 on thread-safe exception handling must compile and link all code with the
12296 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
12297 @option{-D_MT}; when linking, it links in a special thread helper library
12298 @option{-lmingwthrd} which cleans up per thread exception handling data.
12300 @item -mno-align-stringops
12301 @opindex mno-align-stringops
12302 Do not align destination of inlined string operations.  This switch reduces
12303 code size and improves performance in case the destination is already aligned,
12304 but GCC doesn't know about it.
12306 @item -minline-all-stringops
12307 @opindex minline-all-stringops
12308 By default GCC inlines string operations only when destination is known to be
12309 aligned at least to 4 byte boundary.  This enables more inlining, increase code
12310 size, but may improve performance of code that depends on fast memcpy, strlen
12311 and memset for short lengths.
12313 @item -minline-stringops-dynamically
12314 @opindex minline-stringops-dynamically
12315 For string operation of unknown size, inline runtime checks so for small
12316 blocks inline code is used, while for large blocks library call is used.
12318 @item -mstringop-strategy=@var{alg}
12319 @opindex mstringop-strategy=@var{alg}
12320 Overwrite internal decision heuristic about particular algorithm to inline
12321 string operation with.  The allowed values are @code{rep_byte},
12322 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12323 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12324 expanding inline loop, @code{libcall} for always expanding library call.
12326 @item -momit-leaf-frame-pointer
12327 @opindex momit-leaf-frame-pointer
12328 Don't keep the frame pointer in a register for leaf functions.  This
12329 avoids the instructions to save, set up and restore frame pointers and
12330 makes an extra register available in leaf functions.  The option
12331 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12332 which might make debugging harder.
12334 @item -mtls-direct-seg-refs
12335 @itemx -mno-tls-direct-seg-refs
12336 @opindex mtls-direct-seg-refs
12337 Controls whether TLS variables may be accessed with offsets from the
12338 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12339 or whether the thread base pointer must be added.  Whether or not this
12340 is legal depends on the operating system, and whether it maps the
12341 segment to cover the entire TLS area.
12343 For systems that use GNU libc, the default is on.
12345 @item -msse2avx
12346 @itemx -mno-sse2avx
12347 @opindex msse2avx
12348 Specify that the assembler should encode SSE instructions with VEX
12349 prefix.  The option @option{-mavx} turns this on by default.
12350 @end table
12352 These @samp{-m} switches are supported in addition to the above
12353 on AMD x86-64 processors in 64-bit environments.
12355 @table @gcctabopt
12356 @item -m32
12357 @itemx -m64
12358 @opindex m32
12359 @opindex m64
12360 Generate code for a 32-bit or 64-bit environment.
12361 The 32-bit environment sets int, long and pointer to 32 bits and
12362 generates code that runs on any i386 system.
12363 The 64-bit environment sets int to 32 bits and long and pointer
12364 to 64 bits and generates code for AMD's x86-64 architecture. For
12365 darwin only the -m64 option turns off the @option{-fno-pic} and
12366 @option{-mdynamic-no-pic} options.
12368 @item -mno-red-zone
12369 @opindex mno-red-zone
12370 Do not use a so called red zone for x86-64 code.  The red zone is mandated
12371 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12372 stack pointer that will not be modified by signal or interrupt handlers
12373 and therefore can be used for temporary data without adjusting the stack
12374 pointer.  The flag @option{-mno-red-zone} disables this red zone.
12376 @item -mcmodel=small
12377 @opindex mcmodel=small
12378 Generate code for the small code model: the program and its symbols must
12379 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
12380 Programs can be statically or dynamically linked.  This is the default
12381 code model.
12383 @item -mcmodel=kernel
12384 @opindex mcmodel=kernel
12385 Generate code for the kernel code model.  The kernel runs in the
12386 negative 2 GB of the address space.
12387 This model has to be used for Linux kernel code.
12389 @item -mcmodel=medium
12390 @opindex mcmodel=medium
12391 Generate code for the medium model: The program is linked in the lower 2
12392 GB of the address space.  Small symbols are also placed there.  Symbols
12393 with sizes larger than @option{-mlarge-data-threshold} are put into
12394 large data or bss sections and can be located above 2GB.  Programs can
12395 be statically or dynamically linked.
12397 @item -mcmodel=large
12398 @opindex mcmodel=large
12399 Generate code for the large model: This model makes no assumptions
12400 about addresses and sizes of sections.
12401 @end table
12403 @node IA-64 Options
12404 @subsection IA-64 Options
12405 @cindex IA-64 Options
12407 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12409 @table @gcctabopt
12410 @item -mbig-endian
12411 @opindex mbig-endian
12412 Generate code for a big endian target.  This is the default for HP-UX@.
12414 @item -mlittle-endian
12415 @opindex mlittle-endian
12416 Generate code for a little endian target.  This is the default for AIX5
12417 and GNU/Linux.
12419 @item -mgnu-as
12420 @itemx -mno-gnu-as
12421 @opindex mgnu-as
12422 @opindex mno-gnu-as
12423 Generate (or don't) code for the GNU assembler.  This is the default.
12424 @c Also, this is the default if the configure option @option{--with-gnu-as}
12425 @c is used.
12427 @item -mgnu-ld
12428 @itemx -mno-gnu-ld
12429 @opindex mgnu-ld
12430 @opindex mno-gnu-ld
12431 Generate (or don't) code for the GNU linker.  This is the default.
12432 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12433 @c is used.
12435 @item -mno-pic
12436 @opindex mno-pic
12437 Generate code that does not use a global pointer register.  The result
12438 is not position independent code, and violates the IA-64 ABI@.
12440 @item -mvolatile-asm-stop
12441 @itemx -mno-volatile-asm-stop
12442 @opindex mvolatile-asm-stop
12443 @opindex mno-volatile-asm-stop
12444 Generate (or don't) a stop bit immediately before and after volatile asm
12445 statements.
12447 @item -mregister-names
12448 @itemx -mno-register-names
12449 @opindex mregister-names
12450 @opindex mno-register-names
12451 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12452 the stacked registers.  This may make assembler output more readable.
12454 @item -mno-sdata
12455 @itemx -msdata
12456 @opindex mno-sdata
12457 @opindex msdata
12458 Disable (or enable) optimizations that use the small data section.  This may
12459 be useful for working around optimizer bugs.
12461 @item -mconstant-gp
12462 @opindex mconstant-gp
12463 Generate code that uses a single constant global pointer value.  This is
12464 useful when compiling kernel code.
12466 @item -mauto-pic
12467 @opindex mauto-pic
12468 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
12469 This is useful when compiling firmware code.
12471 @item -minline-float-divide-min-latency
12472 @opindex minline-float-divide-min-latency
12473 Generate code for inline divides of floating point values
12474 using the minimum latency algorithm.
12476 @item -minline-float-divide-max-throughput
12477 @opindex minline-float-divide-max-throughput
12478 Generate code for inline divides of floating point values
12479 using the maximum throughput algorithm.
12481 @item -mno-inline-float-divide
12482 @opindex mno-inline-float-divide
12483 Do not generate inline code for divides of floating point values.
12485 @item -minline-int-divide-min-latency
12486 @opindex minline-int-divide-min-latency
12487 Generate code for inline divides of integer values
12488 using the minimum latency algorithm.
12490 @item -minline-int-divide-max-throughput
12491 @opindex minline-int-divide-max-throughput
12492 Generate code for inline divides of integer values
12493 using the maximum throughput algorithm.
12495 @item -mno-inline-int-divide
12496 @opindex mno-inline-int-divide
12497 Do not generate inline code for divides of integer values.
12499 @item -minline-sqrt-min-latency
12500 @opindex minline-sqrt-min-latency
12501 Generate code for inline square roots
12502 using the minimum latency algorithm.
12504 @item -minline-sqrt-max-throughput
12505 @opindex minline-sqrt-max-throughput
12506 Generate code for inline square roots
12507 using the maximum throughput algorithm.
12509 @item -mno-inline-sqrt
12510 @opindex mno-inline-sqrt
12511 Do not generate inline code for sqrt.
12513 @item -mfused-madd
12514 @itemx -mno-fused-madd
12515 @opindex mfused-madd
12516 @opindex mno-fused-madd
12517 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12518 instructions.  The default is to use these instructions.
12520 @item -mno-dwarf2-asm
12521 @itemx -mdwarf2-asm
12522 @opindex mno-dwarf2-asm
12523 @opindex mdwarf2-asm
12524 Don't (or do) generate assembler code for the DWARF2 line number debugging
12525 info.  This may be useful when not using the GNU assembler.
12527 @item -mearly-stop-bits
12528 @itemx -mno-early-stop-bits
12529 @opindex mearly-stop-bits
12530 @opindex mno-early-stop-bits
12531 Allow stop bits to be placed earlier than immediately preceding the
12532 instruction that triggered the stop bit.  This can improve instruction
12533 scheduling, but does not always do so.
12535 @item -mfixed-range=@var{register-range}
12536 @opindex mfixed-range
12537 Generate code treating the given register range as fixed registers.
12538 A fixed register is one that the register allocator can not use.  This is
12539 useful when compiling kernel code.  A register range is specified as
12540 two registers separated by a dash.  Multiple register ranges can be
12541 specified separated by a comma.
12543 @item -mtls-size=@var{tls-size}
12544 @opindex mtls-size
12545 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12548 @item -mtune=@var{cpu-type}
12549 @opindex mtune
12550 Tune the instruction scheduling for a particular CPU, Valid values are
12551 itanium, itanium1, merced, itanium2, and mckinley.
12553 @item -milp32
12554 @itemx -mlp64
12555 @opindex milp32
12556 @opindex mlp64
12557 Generate code for a 32-bit or 64-bit environment.
12558 The 32-bit environment sets int, long and pointer to 32 bits.
12559 The 64-bit environment sets int to 32 bits and long and pointer
12560 to 64 bits.  These are HP-UX specific flags.
12562 @item -mno-sched-br-data-spec
12563 @itemx -msched-br-data-spec
12564 @opindex mno-sched-br-data-spec
12565 @opindex msched-br-data-spec
12566 (Dis/En)able data speculative scheduling before reload.
12567 This will result in generation of the ld.a instructions and
12568 the corresponding check instructions (ld.c / chk.a).
12569 The default is 'disable'.
12571 @item -msched-ar-data-spec
12572 @itemx -mno-sched-ar-data-spec
12573 @opindex msched-ar-data-spec
12574 @opindex mno-sched-ar-data-spec
12575 (En/Dis)able data speculative scheduling after reload.
12576 This will result in generation of the ld.a instructions and
12577 the corresponding check instructions (ld.c / chk.a).
12578 The default is 'enable'.
12580 @item -mno-sched-control-spec
12581 @itemx -msched-control-spec
12582 @opindex mno-sched-control-spec
12583 @opindex msched-control-spec
12584 (Dis/En)able control speculative scheduling.  This feature is
12585 available only during region scheduling (i.e.@: before reload).
12586 This will result in generation of the ld.s instructions and
12587 the corresponding check instructions chk.s .
12588 The default is 'disable'.
12590 @item -msched-br-in-data-spec
12591 @itemx -mno-sched-br-in-data-spec
12592 @opindex msched-br-in-data-spec
12593 @opindex mno-sched-br-in-data-spec
12594 (En/Dis)able speculative scheduling of the instructions that
12595 are dependent on the data speculative loads before reload.
12596 This is effective only with @option{-msched-br-data-spec} enabled.
12597 The default is 'enable'.
12599 @item -msched-ar-in-data-spec
12600 @itemx -mno-sched-ar-in-data-spec
12601 @opindex msched-ar-in-data-spec
12602 @opindex mno-sched-ar-in-data-spec
12603 (En/Dis)able speculative scheduling of the instructions that
12604 are dependent on the data speculative loads after reload.
12605 This is effective only with @option{-msched-ar-data-spec} enabled.
12606 The default is 'enable'.
12608 @item -msched-in-control-spec
12609 @itemx -mno-sched-in-control-spec
12610 @opindex msched-in-control-spec
12611 @opindex mno-sched-in-control-spec
12612 (En/Dis)able speculative scheduling of the instructions that
12613 are dependent on the control speculative loads.
12614 This is effective only with @option{-msched-control-spec} enabled.
12615 The default is 'enable'.
12617 @item -mno-sched-prefer-non-data-spec-insns
12618 @itemx -msched-prefer-non-data-spec-insns
12619 @opindex mno-sched-prefer-non-data-spec-insns
12620 @opindex msched-prefer-non-data-spec-insns
12621 If enabled, data speculative instructions will be chosen for schedule
12622 only if there are no other choices at the moment.  This will make
12623 the use of the data speculation much more conservative.
12624 The default is 'disable'.
12626 @item -mno-sched-prefer-non-control-spec-insns
12627 @itemx -msched-prefer-non-control-spec-insns
12628 @opindex mno-sched-prefer-non-control-spec-insns
12629 @opindex msched-prefer-non-control-spec-insns
12630 If enabled, control speculative instructions will be chosen for schedule
12631 only if there are no other choices at the moment.  This will make
12632 the use of the control speculation much more conservative.
12633 The default is 'disable'.
12635 @item -mno-sched-count-spec-in-critical-path
12636 @itemx -msched-count-spec-in-critical-path
12637 @opindex mno-sched-count-spec-in-critical-path
12638 @opindex msched-count-spec-in-critical-path
12639 If enabled, speculative dependencies will be considered during
12640 computation of the instructions priorities.  This will make the use of the
12641 speculation a bit more conservative.
12642 The default is 'disable'.
12644 @item -msched-spec-ldc
12645 @opindex msched-spec-ldc
12646 Use a simple data speculation check.  This option is on by default.
12648 @item -msched-control-spec-ldc
12649 @opindex msched-spec-ldc
12650 Use a simple check for control speculation.  This option is on by default.
12652 @item -msched-stop-bits-after-every-cycle
12653 @opindex msched-stop-bits-after-every-cycle
12654 Place a stop bit after every cycle when scheduling.  This option is on
12655 by default.
12657 @item -msched-fp-mem-deps-zero-cost
12658 @opindex msched-fp-mem-deps-zero-cost
12659 Assume that floating-point stores and loads are not likely to cause a conflict
12660 when placed into the same instruction group.  This option is disabled by
12661 default.
12663 @item -msel-sched-dont-check-control-spec
12664 @opindex msel-sched-dont-check-control-spec
12665 Generate checks for control speculation in selective scheduling.
12666 This flag is disabled by default.
12668 @item -msched-max-memory-insns=@var{max-insns}
12669 @opindex msched-max-memory-insns
12670 Limit on the number of memory insns per instruction group, giving lower
12671 priority to subsequent memory insns attempting to schedule in the same
12672 instruction group. Frequently useful to prevent cache bank conflicts.
12673 The default value is 1.
12675 @item -msched-max-memory-insns-hard-limit
12676 @opindex msched-max-memory-insns-hard-limit
12677 Disallow more than `msched-max-memory-insns' in instruction group.
12678 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12679 when limit is reached but may still schedule memory operations.
12681 @end table
12683 @node IA-64/VMS Options
12684 @subsection IA-64/VMS Options
12686 These @samp{-m} options are defined for the IA-64/VMS implementations:
12688 @table @gcctabopt
12689 @item -mvms-return-codes
12690 @opindex mvms-return-codes
12691 Return VMS condition codes from main. The default is to return POSIX
12692 style condition (e.g.@ error) codes.
12694 @item -mdebug-main=@var{prefix}
12695 @opindex mdebug-main=@var{prefix}
12696 Flag the first routine whose name starts with @var{prefix} as the main
12697 routine for the debugger.
12699 @item -mmalloc64
12700 @opindex mmalloc64
12701 Default to 64bit memory allocation routines.
12702 @end table
12704 @node LM32 Options
12705 @subsection LM32 Options
12706 @cindex LM32 options
12708 These @option{-m} options are defined for the Lattice Mico32 architecture:
12710 @table @gcctabopt
12711 @item -mbarrel-shift-enabled
12712 @opindex mbarrel-shift-enabled
12713 Enable barrel-shift instructions.
12715 @item -mdivide-enabled
12716 @opindex mdivide-enabled
12717 Enable divide and modulus instructions.
12719 @item -mmultiply-enabled
12720 @opindex multiply-enabled
12721 Enable multiply instructions.
12723 @item -msign-extend-enabled
12724 @opindex msign-extend-enabled
12725 Enable sign extend instructions.
12727 @item -muser-enabled
12728 @opindex muser-enabled
12729 Enable user-defined instructions.
12731 @end table
12733 @node M32C Options
12734 @subsection M32C Options
12735 @cindex M32C options
12737 @table @gcctabopt
12738 @item -mcpu=@var{name}
12739 @opindex mcpu=
12740 Select the CPU for which code is generated.  @var{name} may be one of
12741 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
12742 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
12743 the M32C/80 series.
12745 @item -msim
12746 @opindex msim
12747 Specifies that the program will be run on the simulator.  This causes
12748 an alternate runtime library to be linked in which supports, for
12749 example, file I/O@.  You must not use this option when generating
12750 programs that will run on real hardware; you must provide your own
12751 runtime library for whatever I/O functions are needed.
12753 @item -memregs=@var{number}
12754 @opindex memregs=
12755 Specifies the number of memory-based pseudo-registers GCC will use
12756 during code generation.  These pseudo-registers will be used like real
12757 registers, so there is a tradeoff between GCC's ability to fit the
12758 code into available registers, and the performance penalty of using
12759 memory instead of registers.  Note that all modules in a program must
12760 be compiled with the same value for this option.  Because of that, you
12761 must not use this option with the default runtime libraries gcc
12762 builds.
12764 @end table
12766 @node M32R/D Options
12767 @subsection M32R/D Options
12768 @cindex M32R/D options
12770 These @option{-m} options are defined for Renesas M32R/D architectures:
12772 @table @gcctabopt
12773 @item -m32r2
12774 @opindex m32r2
12775 Generate code for the M32R/2@.
12777 @item -m32rx
12778 @opindex m32rx
12779 Generate code for the M32R/X@.
12781 @item -m32r
12782 @opindex m32r
12783 Generate code for the M32R@.  This is the default.
12785 @item -mmodel=small
12786 @opindex mmodel=small
12787 Assume all objects live in the lower 16MB of memory (so that their addresses
12788 can be loaded with the @code{ld24} instruction), and assume all subroutines
12789 are reachable with the @code{bl} instruction.
12790 This is the default.
12792 The addressability of a particular object can be set with the
12793 @code{model} attribute.
12795 @item -mmodel=medium
12796 @opindex mmodel=medium
12797 Assume objects may be anywhere in the 32-bit address space (the compiler
12798 will generate @code{seth/add3} instructions to load their addresses), and
12799 assume all subroutines are reachable with the @code{bl} instruction.
12801 @item -mmodel=large
12802 @opindex mmodel=large
12803 Assume objects may be anywhere in the 32-bit address space (the compiler
12804 will generate @code{seth/add3} instructions to load their addresses), and
12805 assume subroutines may not be reachable with the @code{bl} instruction
12806 (the compiler will generate the much slower @code{seth/add3/jl}
12807 instruction sequence).
12809 @item -msdata=none
12810 @opindex msdata=none
12811 Disable use of the small data area.  Variables will be put into
12812 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
12813 @code{section} attribute has been specified).
12814 This is the default.
12816 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
12817 Objects may be explicitly put in the small data area with the
12818 @code{section} attribute using one of these sections.
12820 @item -msdata=sdata
12821 @opindex msdata=sdata
12822 Put small global and static data in the small data area, but do not
12823 generate special code to reference them.
12825 @item -msdata=use
12826 @opindex msdata=use
12827 Put small global and static data in the small data area, and generate
12828 special instructions to reference them.
12830 @item -G @var{num}
12831 @opindex G
12832 @cindex smaller data references
12833 Put global and static objects less than or equal to @var{num} bytes
12834 into the small data or bss sections instead of the normal data or bss
12835 sections.  The default value of @var{num} is 8.
12836 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
12837 for this option to have any effect.
12839 All modules should be compiled with the same @option{-G @var{num}} value.
12840 Compiling with different values of @var{num} may or may not work; if it
12841 doesn't the linker will give an error message---incorrect code will not be
12842 generated.
12844 @item -mdebug
12845 @opindex mdebug
12846 Makes the M32R specific code in the compiler display some statistics
12847 that might help in debugging programs.
12849 @item -malign-loops
12850 @opindex malign-loops
12851 Align all loops to a 32-byte boundary.
12853 @item -mno-align-loops
12854 @opindex mno-align-loops
12855 Do not enforce a 32-byte alignment for loops.  This is the default.
12857 @item -missue-rate=@var{number}
12858 @opindex missue-rate=@var{number}
12859 Issue @var{number} instructions per cycle.  @var{number} can only be 1
12860 or 2.
12862 @item -mbranch-cost=@var{number}
12863 @opindex mbranch-cost=@var{number}
12864 @var{number} can only be 1 or 2.  If it is 1 then branches will be
12865 preferred over conditional code, if it is 2, then the opposite will
12866 apply.
12868 @item -mflush-trap=@var{number}
12869 @opindex mflush-trap=@var{number}
12870 Specifies the trap number to use to flush the cache.  The default is
12871 12.  Valid numbers are between 0 and 15 inclusive.
12873 @item -mno-flush-trap
12874 @opindex mno-flush-trap
12875 Specifies that the cache cannot be flushed by using a trap.
12877 @item -mflush-func=@var{name}
12878 @opindex mflush-func=@var{name}
12879 Specifies the name of the operating system function to call to flush
12880 the cache.  The default is @emph{_flush_cache}, but a function call
12881 will only be used if a trap is not available.
12883 @item -mno-flush-func
12884 @opindex mno-flush-func
12885 Indicates that there is no OS function for flushing the cache.
12887 @end table
12889 @node M680x0 Options
12890 @subsection M680x0 Options
12891 @cindex M680x0 options
12893 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
12894 The default settings depend on which architecture was selected when
12895 the compiler was configured; the defaults for the most common choices
12896 are given below.
12898 @table @gcctabopt
12899 @item -march=@var{arch}
12900 @opindex march
12901 Generate code for a specific M680x0 or ColdFire instruction set
12902 architecture.  Permissible values of @var{arch} for M680x0
12903 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
12904 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
12905 architectures are selected according to Freescale's ISA classification
12906 and the permissible values are: @samp{isaa}, @samp{isaaplus},
12907 @samp{isab} and @samp{isac}.
12909 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
12910 code for a ColdFire target.  The @var{arch} in this macro is one of the
12911 @option{-march} arguments given above.
12913 When used together, @option{-march} and @option{-mtune} select code
12914 that runs on a family of similar processors but that is optimized
12915 for a particular microarchitecture.
12917 @item -mcpu=@var{cpu}
12918 @opindex mcpu
12919 Generate code for a specific M680x0 or ColdFire processor.
12920 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
12921 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
12922 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
12923 below, which also classifies the CPUs into families:
12925 @multitable @columnfractions 0.20 0.80
12926 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
12927 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
12928 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
12929 @item @samp{5206e} @tab @samp{5206e}
12930 @item @samp{5208} @tab @samp{5207} @samp{5208}
12931 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
12932 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
12933 @item @samp{5216} @tab @samp{5214} @samp{5216}
12934 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
12935 @item @samp{5225} @tab @samp{5224} @samp{5225}
12936 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
12937 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
12938 @item @samp{5249} @tab @samp{5249}
12939 @item @samp{5250} @tab @samp{5250}
12940 @item @samp{5271} @tab @samp{5270} @samp{5271}
12941 @item @samp{5272} @tab @samp{5272}
12942 @item @samp{5275} @tab @samp{5274} @samp{5275}
12943 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
12944 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
12945 @item @samp{5307} @tab @samp{5307}
12946 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
12947 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
12948 @item @samp{5407} @tab @samp{5407}
12949 @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}
12950 @end multitable
12952 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
12953 @var{arch} is compatible with @var{cpu}.  Other combinations of
12954 @option{-mcpu} and @option{-march} are rejected.
12956 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
12957 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
12958 where the value of @var{family} is given by the table above.
12960 @item -mtune=@var{tune}
12961 @opindex mtune
12962 Tune the code for a particular microarchitecture, within the
12963 constraints set by @option{-march} and @option{-mcpu}.
12964 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
12965 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
12966 and @samp{cpu32}.  The ColdFire microarchitectures
12967 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
12969 You can also use @option{-mtune=68020-40} for code that needs
12970 to run relatively well on 68020, 68030 and 68040 targets.
12971 @option{-mtune=68020-60} is similar but includes 68060 targets
12972 as well.  These two options select the same tuning decisions as
12973 @option{-m68020-40} and @option{-m68020-60} respectively.
12975 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
12976 when tuning for 680x0 architecture @var{arch}.  It also defines
12977 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
12978 option is used.  If gcc is tuning for a range of architectures,
12979 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
12980 it defines the macros for every architecture in the range.
12982 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
12983 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
12984 of the arguments given above.
12986 @item -m68000
12987 @itemx -mc68000
12988 @opindex m68000
12989 @opindex mc68000
12990 Generate output for a 68000.  This is the default
12991 when the compiler is configured for 68000-based systems.
12992 It is equivalent to @option{-march=68000}.
12994 Use this option for microcontrollers with a 68000 or EC000 core,
12995 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
12997 @item -m68010
12998 @opindex m68010
12999 Generate output for a 68010.  This is the default
13000 when the compiler is configured for 68010-based systems.
13001 It is equivalent to @option{-march=68010}.
13003 @item -m68020
13004 @itemx -mc68020
13005 @opindex m68020
13006 @opindex mc68020
13007 Generate output for a 68020.  This is the default
13008 when the compiler is configured for 68020-based systems.
13009 It is equivalent to @option{-march=68020}.
13011 @item -m68030
13012 @opindex m68030
13013 Generate output for a 68030.  This is the default when the compiler is
13014 configured for 68030-based systems.  It is equivalent to
13015 @option{-march=68030}.
13017 @item -m68040
13018 @opindex m68040
13019 Generate output for a 68040.  This is the default when the compiler is
13020 configured for 68040-based systems.  It is equivalent to
13021 @option{-march=68040}.
13023 This option inhibits the use of 68881/68882 instructions that have to be
13024 emulated by software on the 68040.  Use this option if your 68040 does not
13025 have code to emulate those instructions.
13027 @item -m68060
13028 @opindex m68060
13029 Generate output for a 68060.  This is the default when the compiler is
13030 configured for 68060-based systems.  It is equivalent to
13031 @option{-march=68060}.
13033 This option inhibits the use of 68020 and 68881/68882 instructions that
13034 have to be emulated by software on the 68060.  Use this option if your 68060
13035 does not have code to emulate those instructions.
13037 @item -mcpu32
13038 @opindex mcpu32
13039 Generate output for a CPU32.  This is the default
13040 when the compiler is configured for CPU32-based systems.
13041 It is equivalent to @option{-march=cpu32}.
13043 Use this option for microcontrollers with a
13044 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
13045 68336, 68340, 68341, 68349 and 68360.
13047 @item -m5200
13048 @opindex m5200
13049 Generate output for a 520X ColdFire CPU@.  This is the default
13050 when the compiler is configured for 520X-based systems.
13051 It is equivalent to @option{-mcpu=5206}, and is now deprecated
13052 in favor of that option.
13054 Use this option for microcontroller with a 5200 core, including
13055 the MCF5202, MCF5203, MCF5204 and MCF5206.
13057 @item -m5206e
13058 @opindex m5206e
13059 Generate output for a 5206e ColdFire CPU@.  The option is now
13060 deprecated in favor of the equivalent @option{-mcpu=5206e}.
13062 @item -m528x
13063 @opindex m528x
13064 Generate output for a member of the ColdFire 528X family.
13065 The option is now deprecated in favor of the equivalent
13066 @option{-mcpu=528x}.
13068 @item -m5307
13069 @opindex m5307
13070 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
13071 in favor of the equivalent @option{-mcpu=5307}.
13073 @item -m5407
13074 @opindex m5407
13075 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
13076 in favor of the equivalent @option{-mcpu=5407}.
13078 @item -mcfv4e
13079 @opindex mcfv4e
13080 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
13081 This includes use of hardware floating point instructions.
13082 The option is equivalent to @option{-mcpu=547x}, and is now
13083 deprecated in favor of that option.
13085 @item -m68020-40
13086 @opindex m68020-40
13087 Generate output for a 68040, without using any of the new instructions.
13088 This results in code which can run relatively efficiently on either a
13089 68020/68881 or a 68030 or a 68040.  The generated code does use the
13090 68881 instructions that are emulated on the 68040.
13092 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
13094 @item -m68020-60
13095 @opindex m68020-60
13096 Generate output for a 68060, without using any of the new instructions.
13097 This results in code which can run relatively efficiently on either a
13098 68020/68881 or a 68030 or a 68040.  The generated code does use the
13099 68881 instructions that are emulated on the 68060.
13101 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
13103 @item -mhard-float
13104 @itemx -m68881
13105 @opindex mhard-float
13106 @opindex m68881
13107 Generate floating-point instructions.  This is the default for 68020
13108 and above, and for ColdFire devices that have an FPU@.  It defines the
13109 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
13110 on ColdFire targets.
13112 @item -msoft-float
13113 @opindex msoft-float
13114 Do not generate floating-point instructions; use library calls instead.
13115 This is the default for 68000, 68010, and 68832 targets.  It is also
13116 the default for ColdFire devices that have no FPU.
13118 @item -mdiv
13119 @itemx -mno-div
13120 @opindex mdiv
13121 @opindex mno-div
13122 Generate (do not generate) ColdFire hardware divide and remainder
13123 instructions.  If @option{-march} is used without @option{-mcpu},
13124 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
13125 architectures.  Otherwise, the default is taken from the target CPU
13126 (either the default CPU, or the one specified by @option{-mcpu}).  For
13127 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
13128 @option{-mcpu=5206e}.
13130 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
13132 @item -mshort
13133 @opindex mshort
13134 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13135 Additionally, parameters passed on the stack are also aligned to a
13136 16-bit boundary even on targets whose API mandates promotion to 32-bit.
13138 @item -mno-short
13139 @opindex mno-short
13140 Do not consider type @code{int} to be 16 bits wide.  This is the default.
13142 @item -mnobitfield
13143 @itemx -mno-bitfield
13144 @opindex mnobitfield
13145 @opindex mno-bitfield
13146 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
13147 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
13149 @item -mbitfield
13150 @opindex mbitfield
13151 Do use the bit-field instructions.  The @option{-m68020} option implies
13152 @option{-mbitfield}.  This is the default if you use a configuration
13153 designed for a 68020.
13155 @item -mrtd
13156 @opindex mrtd
13157 Use a different function-calling convention, in which functions
13158 that take a fixed number of arguments return with the @code{rtd}
13159 instruction, which pops their arguments while returning.  This
13160 saves one instruction in the caller since there is no need to pop
13161 the arguments there.
13163 This calling convention is incompatible with the one normally
13164 used on Unix, so you cannot use it if you need to call libraries
13165 compiled with the Unix compiler.
13167 Also, you must provide function prototypes for all functions that
13168 take variable numbers of arguments (including @code{printf});
13169 otherwise incorrect code will be generated for calls to those
13170 functions.
13172 In addition, seriously incorrect code will result if you call a
13173 function with too many arguments.  (Normally, extra arguments are
13174 harmlessly ignored.)
13176 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13177 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13179 @item -mno-rtd
13180 @opindex mno-rtd
13181 Do not use the calling conventions selected by @option{-mrtd}.
13182 This is the default.
13184 @item -malign-int
13185 @itemx -mno-align-int
13186 @opindex malign-int
13187 @opindex mno-align-int
13188 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13189 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13190 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13191 Aligning variables on 32-bit boundaries produces code that runs somewhat
13192 faster on processors with 32-bit busses at the expense of more memory.
13194 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13195 align structures containing the above types  differently than
13196 most published application binary interface specifications for the m68k.
13198 @item -mpcrel
13199 @opindex mpcrel
13200 Use the pc-relative addressing mode of the 68000 directly, instead of
13201 using a global offset table.  At present, this option implies @option{-fpic},
13202 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
13203 not presently supported with @option{-mpcrel}, though this could be supported for
13204 68020 and higher processors.
13206 @item -mno-strict-align
13207 @itemx -mstrict-align
13208 @opindex mno-strict-align
13209 @opindex mstrict-align
13210 Do not (do) assume that unaligned memory references will be handled by
13211 the system.
13213 @item -msep-data
13214 Generate code that allows the data segment to be located in a different
13215 area of memory from the text segment.  This allows for execute in place in
13216 an environment without virtual memory management.  This option implies
13217 @option{-fPIC}.
13219 @item -mno-sep-data
13220 Generate code that assumes that the data segment follows the text segment.
13221 This is the default.
13223 @item -mid-shared-library
13224 Generate code that supports shared libraries via the library ID method.
13225 This allows for execute in place and shared libraries in an environment
13226 without virtual memory management.  This option implies @option{-fPIC}.
13228 @item -mno-id-shared-library
13229 Generate code that doesn't assume ID based shared libraries are being used.
13230 This is the default.
13232 @item -mshared-library-id=n
13233 Specified the identification number of the ID based shared library being
13234 compiled.  Specifying a value of 0 will generate more compact code, specifying
13235 other values will force the allocation of that number to the current
13236 library but is no more space or time efficient than omitting this option.
13238 @item -mxgot
13239 @itemx -mno-xgot
13240 @opindex mxgot
13241 @opindex mno-xgot
13242 When generating position-independent code for ColdFire, generate code
13243 that works if the GOT has more than 8192 entries.  This code is
13244 larger and slower than code generated without this option.  On M680x0
13245 processors, this option is not needed; @option{-fPIC} suffices.
13247 GCC normally uses a single instruction to load values from the GOT@.
13248 While this is relatively efficient, it only works if the GOT
13249 is smaller than about 64k.  Anything larger causes the linker
13250 to report an error such as:
13252 @cindex relocation truncated to fit (ColdFire)
13253 @smallexample
13254 relocation truncated to fit: R_68K_GOT16O foobar
13255 @end smallexample
13257 If this happens, you should recompile your code with @option{-mxgot}.
13258 It should then work with very large GOTs.  However, code generated with
13259 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13260 the value of a global symbol.
13262 Note that some linkers, including newer versions of the GNU linker,
13263 can create multiple GOTs and sort GOT entries.  If you have such a linker,
13264 you should only need to use @option{-mxgot} when compiling a single
13265 object file that accesses more than 8192 GOT entries.  Very few do.
13267 These options have no effect unless GCC is generating
13268 position-independent code.
13270 @end table
13272 @node M68hc1x Options
13273 @subsection M68hc1x Options
13274 @cindex M68hc1x options
13276 These are the @samp{-m} options defined for the 68hc11 and 68hc12
13277 microcontrollers.  The default values for these options depends on
13278 which style of microcontroller was selected when the compiler was configured;
13279 the defaults for the most common choices are given below.
13281 @table @gcctabopt
13282 @item -m6811
13283 @itemx -m68hc11
13284 @opindex m6811
13285 @opindex m68hc11
13286 Generate output for a 68HC11.  This is the default
13287 when the compiler is configured for 68HC11-based systems.
13289 @item -m6812
13290 @itemx -m68hc12
13291 @opindex m6812
13292 @opindex m68hc12
13293 Generate output for a 68HC12.  This is the default
13294 when the compiler is configured for 68HC12-based systems.
13296 @item -m68S12
13297 @itemx -m68hcs12
13298 @opindex m68S12
13299 @opindex m68hcs12
13300 Generate output for a 68HCS12.
13302 @item -mauto-incdec
13303 @opindex mauto-incdec
13304 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
13305 addressing modes.
13307 @item -minmax
13308 @itemx -mnominmax
13309 @opindex minmax
13310 @opindex mnominmax
13311 Enable the use of 68HC12 min and max instructions.
13313 @item -mlong-calls
13314 @itemx -mno-long-calls
13315 @opindex mlong-calls
13316 @opindex mno-long-calls
13317 Treat all calls as being far away (near).  If calls are assumed to be
13318 far away, the compiler will use the @code{call} instruction to
13319 call a function and the @code{rtc} instruction for returning.
13321 @item -mshort
13322 @opindex mshort
13323 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13325 @item -msoft-reg-count=@var{count}
13326 @opindex msoft-reg-count
13327 Specify the number of pseudo-soft registers which are used for the
13328 code generation.  The maximum number is 32.  Using more pseudo-soft
13329 register may or may not result in better code depending on the program.
13330 The default is 4 for 68HC11 and 2 for 68HC12.
13332 @end table
13334 @node MCore Options
13335 @subsection MCore Options
13336 @cindex MCore options
13338 These are the @samp{-m} options defined for the Motorola M*Core
13339 processors.
13341 @table @gcctabopt
13343 @item -mhardlit
13344 @itemx -mno-hardlit
13345 @opindex mhardlit
13346 @opindex mno-hardlit
13347 Inline constants into the code stream if it can be done in two
13348 instructions or less.
13350 @item -mdiv
13351 @itemx -mno-div
13352 @opindex mdiv
13353 @opindex mno-div
13354 Use the divide instruction.  (Enabled by default).
13356 @item -mrelax-immediate
13357 @itemx -mno-relax-immediate
13358 @opindex mrelax-immediate
13359 @opindex mno-relax-immediate
13360 Allow arbitrary sized immediates in bit operations.
13362 @item -mwide-bitfields
13363 @itemx -mno-wide-bitfields
13364 @opindex mwide-bitfields
13365 @opindex mno-wide-bitfields
13366 Always treat bit-fields as int-sized.
13368 @item -m4byte-functions
13369 @itemx -mno-4byte-functions
13370 @opindex m4byte-functions
13371 @opindex mno-4byte-functions
13372 Force all functions to be aligned to a four byte boundary.
13374 @item -mcallgraph-data
13375 @itemx -mno-callgraph-data
13376 @opindex mcallgraph-data
13377 @opindex mno-callgraph-data
13378 Emit callgraph information.
13380 @item -mslow-bytes
13381 @itemx -mno-slow-bytes
13382 @opindex mslow-bytes
13383 @opindex mno-slow-bytes
13384 Prefer word access when reading byte quantities.
13386 @item -mlittle-endian
13387 @itemx -mbig-endian
13388 @opindex mlittle-endian
13389 @opindex mbig-endian
13390 Generate code for a little endian target.
13392 @item -m210
13393 @itemx -m340
13394 @opindex m210
13395 @opindex m340
13396 Generate code for the 210 processor.
13398 @item -mno-lsim
13399 @opindex mno-lsim
13400 Assume that run-time support has been provided and so omit the
13401 simulator library (@file{libsim.a)} from the linker command line.
13403 @item -mstack-increment=@var{size}
13404 @opindex mstack-increment
13405 Set the maximum amount for a single stack increment operation.  Large
13406 values can increase the speed of programs which contain functions
13407 that need a large amount of stack space, but they can also trigger a
13408 segmentation fault if the stack is extended too much.  The default
13409 value is 0x1000.
13411 @end table
13413 @node MeP Options
13414 @subsection MeP Options
13415 @cindex MeP options
13417 @table @gcctabopt
13419 @item -mabsdiff
13420 @opindex mabsdiff
13421 Enables the @code{abs} instruction, which is the absolute difference
13422 between two registers.
13424 @item -mall-opts
13425 @opindex mall-opts
13426 Enables all the optional instructions - average, multiply, divide, bit
13427 operations, leading zero, absolute difference, min/max, clip, and
13428 saturation.
13431 @item -maverage
13432 @opindex maverage
13433 Enables the @code{ave} instruction, which computes the average of two
13434 registers.
13436 @item -mbased=@var{n}
13437 @opindex mbased=
13438 Variables of size @var{n} bytes or smaller will be placed in the
13439 @code{.based} section by default.  Based variables use the @code{$tp}
13440 register as a base register, and there is a 128 byte limit to the
13441 @code{.based} section.
13443 @item -mbitops
13444 @opindex mbitops
13445 Enables the bit operation instructions - bit test (@code{btstm}), set
13446 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13447 test-and-set (@code{tas}).
13449 @item -mc=@var{name}
13450 @opindex mc=
13451 Selects which section constant data will be placed in.  @var{name} may
13452 be @code{tiny}, @code{near}, or @code{far}.
13454 @item -mclip
13455 @opindex mclip
13456 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13457 useful unless you also provide @code{-mminmax}.
13459 @item -mconfig=@var{name}
13460 @opindex mconfig=
13461 Selects one of the build-in core configurations.  Each MeP chip has
13462 one or more modules in it; each module has a core CPU and a variety of
13463 coprocessors, optional instructions, and peripherals.  The
13464 @code{MeP-Integrator} tool, not part of GCC, provides these
13465 configurations through this option; using this option is the same as
13466 using all the corresponding command line options.  The default
13467 configuration is @code{default}.
13469 @item -mcop
13470 @opindex mcop
13471 Enables the coprocessor instructions.  By default, this is a 32-bit
13472 coprocessor.  Note that the coprocessor is normally enabled via the
13473 @code{-mconfig=} option.
13475 @item -mcop32
13476 @opindex mcop32
13477 Enables the 32-bit coprocessor's instructions.
13479 @item -mcop64
13480 @opindex mcop64
13481 Enables the 64-bit coprocessor's instructions.
13483 @item -mivc2
13484 @opindex mivc2
13485 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13487 @item -mdc
13488 @opindex mdc
13489 Causes constant variables to be placed in the @code{.near} section.
13491 @item -mdiv
13492 @opindex mdiv
13493 Enables the @code{div} and @code{divu} instructions.
13495 @item -meb
13496 @opindex meb
13497 Generate big-endian code.
13499 @item -mel
13500 @opindex mel
13501 Generate little-endian code.
13503 @item -mio-volatile
13504 @opindex mio-volatile
13505 Tells the compiler that any variable marked with the @code{io}
13506 attribute is to be considered volatile.
13508 @item -ml
13509 @opindex ml
13510 Causes variables to be assigned to the @code{.far} section by default.
13512 @item -mleadz
13513 @opindex mleadz
13514 Enables the @code{leadz} (leading zero) instruction.
13516 @item -mm
13517 @opindex mm
13518 Causes variables to be assigned to the @code{.near} section by default.
13520 @item -mminmax
13521 @opindex mminmax
13522 Enables the @code{min} and @code{max} instructions.
13524 @item -mmult
13525 @opindex mmult
13526 Enables the multiplication and multiply-accumulate instructions.
13528 @item -mno-opts
13529 @opindex mno-opts
13530 Disables all the optional instructions enabled by @code{-mall-opts}.
13532 @item -mrepeat
13533 @opindex mrepeat
13534 Enables the @code{repeat} and @code{erepeat} instructions, used for
13535 low-overhead looping.
13537 @item -ms
13538 @opindex ms
13539 Causes all variables to default to the @code{.tiny} section.  Note
13540 that there is a 65536 byte limit to this section.  Accesses to these
13541 variables use the @code{%gp} base register.
13543 @item -msatur
13544 @opindex msatur
13545 Enables the saturation instructions.  Note that the compiler does not
13546 currently generate these itself, but this option is included for
13547 compatibility with other tools, like @code{as}.
13549 @item -msdram
13550 @opindex msdram
13551 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13553 @item -msim
13554 @opindex msim
13555 Link the simulator runtime libraries.
13557 @item -msimnovec
13558 @opindex msimnovec
13559 Link the simulator runtime libraries, excluding built-in support
13560 for reset and exception vectors and tables.
13562 @item -mtf
13563 @opindex mtf
13564 Causes all functions to default to the @code{.far} section.  Without
13565 this option, functions default to the @code{.near} section.
13567 @item -mtiny=@var{n}
13568 @opindex mtiny=
13569 Variables that are @var{n} bytes or smaller will be allocated to the
13570 @code{.tiny} section.  These variables use the @code{$gp} base
13571 register.  The default for this option is 4, but note that there's a
13572 65536 byte limit to the @code{.tiny} section.
13574 @end table
13576 @node MIPS Options
13577 @subsection MIPS Options
13578 @cindex MIPS options
13580 @table @gcctabopt
13582 @item -EB
13583 @opindex EB
13584 Generate big-endian code.
13586 @item -EL
13587 @opindex EL
13588 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13589 configurations.
13591 @item -march=@var{arch}
13592 @opindex march
13593 Generate code that will run on @var{arch}, which can be the name of a
13594 generic MIPS ISA, or the name of a particular processor.
13595 The ISA names are:
13596 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13597 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13598 The processor names are:
13599 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13600 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13601 @samp{5kc}, @samp{5kf},
13602 @samp{20kc},
13603 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13604 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13605 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13606 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13607 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
13608 @samp{loongson2e}, @samp{loongson2f},
13609 @samp{m4k},
13610 @samp{octeon},
13611 @samp{orion},
13612 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
13613 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
13614 @samp{rm7000}, @samp{rm9000},
13615 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
13616 @samp{sb1},
13617 @samp{sr71000},
13618 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
13619 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
13620 and @samp{xlr}.
13621 The special value @samp{from-abi} selects the
13622 most compatible architecture for the selected ABI (that is,
13623 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
13625 Native Linux/GNU toolchains also support the value @samp{native},
13626 which selects the best architecture option for the host processor.
13627 @option{-march=native} has no effect if GCC does not recognize
13628 the processor.
13630 In processor names, a final @samp{000} can be abbreviated as @samp{k}
13631 (for example, @samp{-march=r2k}).  Prefixes are optional, and
13632 @samp{vr} may be written @samp{r}.
13634 Names of the form @samp{@var{n}f2_1} refer to processors with
13635 FPUs clocked at half the rate of the core, names of the form
13636 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
13637 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
13638 processors with FPUs clocked a ratio of 3:2 with respect to the core.
13639 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
13640 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
13641 accepted as synonyms for @samp{@var{n}f1_1}.
13643 GCC defines two macros based on the value of this option.  The first
13644 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
13645 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
13646 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
13647 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
13648 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
13650 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
13651 above.  In other words, it will have the full prefix and will not
13652 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
13653 the macro names the resolved architecture (either @samp{"mips1"} or
13654 @samp{"mips3"}).  It names the default architecture when no
13655 @option{-march} option is given.
13657 @item -mtune=@var{arch}
13658 @opindex mtune
13659 Optimize for @var{arch}.  Among other things, this option controls
13660 the way instructions are scheduled, and the perceived cost of arithmetic
13661 operations.  The list of @var{arch} values is the same as for
13662 @option{-march}.
13664 When this option is not used, GCC will optimize for the processor
13665 specified by @option{-march}.  By using @option{-march} and
13666 @option{-mtune} together, it is possible to generate code that will
13667 run on a family of processors, but optimize the code for one
13668 particular member of that family.
13670 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
13671 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
13672 @samp{-march} ones described above.
13674 @item -mips1
13675 @opindex mips1
13676 Equivalent to @samp{-march=mips1}.
13678 @item -mips2
13679 @opindex mips2
13680 Equivalent to @samp{-march=mips2}.
13682 @item -mips3
13683 @opindex mips3
13684 Equivalent to @samp{-march=mips3}.
13686 @item -mips4
13687 @opindex mips4
13688 Equivalent to @samp{-march=mips4}.
13690 @item -mips32
13691 @opindex mips32
13692 Equivalent to @samp{-march=mips32}.
13694 @item -mips32r2
13695 @opindex mips32r2
13696 Equivalent to @samp{-march=mips32r2}.
13698 @item -mips64
13699 @opindex mips64
13700 Equivalent to @samp{-march=mips64}.
13702 @item -mips64r2
13703 @opindex mips64r2
13704 Equivalent to @samp{-march=mips64r2}.
13706 @item -mips16
13707 @itemx -mno-mips16
13708 @opindex mips16
13709 @opindex mno-mips16
13710 Generate (do not generate) MIPS16 code.  If GCC is targetting a
13711 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
13713 MIPS16 code generation can also be controlled on a per-function basis
13714 by means of @code{mips16} and @code{nomips16} attributes.
13715 @xref{Function Attributes}, for more information.
13717 @item -mflip-mips16
13718 @opindex mflip-mips16
13719 Generate MIPS16 code on alternating functions.  This option is provided
13720 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
13721 not intended for ordinary use in compiling user code.
13723 @item -minterlink-mips16
13724 @itemx -mno-interlink-mips16
13725 @opindex minterlink-mips16
13726 @opindex mno-interlink-mips16
13727 Require (do not require) that non-MIPS16 code be link-compatible with
13728 MIPS16 code.
13730 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
13731 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
13732 therefore disables direct jumps unless GCC knows that the target of the
13733 jump is not MIPS16.
13735 @item -mabi=32
13736 @itemx -mabi=o64
13737 @itemx -mabi=n32
13738 @itemx -mabi=64
13739 @itemx -mabi=eabi
13740 @opindex mabi=32
13741 @opindex mabi=o64
13742 @opindex mabi=n32
13743 @opindex mabi=64
13744 @opindex mabi=eabi
13745 Generate code for the given ABI@.
13747 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
13748 generates 64-bit code when you select a 64-bit architecture, but you
13749 can use @option{-mgp32} to get 32-bit code instead.
13751 For information about the O64 ABI, see
13752 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
13754 GCC supports a variant of the o32 ABI in which floating-point registers
13755 are 64 rather than 32 bits wide.  You can select this combination with
13756 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
13757 and @samp{mfhc1} instructions and is therefore only supported for
13758 MIPS32R2 processors.
13760 The register assignments for arguments and return values remain the
13761 same, but each scalar value is passed in a single 64-bit register
13762 rather than a pair of 32-bit registers.  For example, scalar
13763 floating-point values are returned in @samp{$f0} only, not a
13764 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
13765 remains the same, but all 64 bits are saved.
13767 @item -mabicalls
13768 @itemx -mno-abicalls
13769 @opindex mabicalls
13770 @opindex mno-abicalls
13771 Generate (do not generate) code that is suitable for SVR4-style
13772 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
13773 systems.
13775 @item -mshared
13776 @itemx -mno-shared
13777 Generate (do not generate) code that is fully position-independent,
13778 and that can therefore be linked into shared libraries.  This option
13779 only affects @option{-mabicalls}.
13781 All @option{-mabicalls} code has traditionally been position-independent,
13782 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
13783 as an extension, the GNU toolchain allows executables to use absolute
13784 accesses for locally-binding symbols.  It can also use shorter GP
13785 initialization sequences and generate direct calls to locally-defined
13786 functions.  This mode is selected by @option{-mno-shared}.
13788 @option{-mno-shared} depends on binutils 2.16 or higher and generates
13789 objects that can only be linked by the GNU linker.  However, the option
13790 does not affect the ABI of the final executable; it only affects the ABI
13791 of relocatable objects.  Using @option{-mno-shared} will generally make
13792 executables both smaller and quicker.
13794 @option{-mshared} is the default.
13796 @item -mplt
13797 @itemx -mno-plt
13798 @opindex mplt
13799 @opindex mno-plt
13800 Assume (do not assume) that the static and dynamic linkers
13801 support PLTs and copy relocations.  This option only affects
13802 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
13803 has no effect without @samp{-msym32}.
13805 You can make @option{-mplt} the default by configuring
13806 GCC with @option{--with-mips-plt}.  The default is
13807 @option{-mno-plt} otherwise.
13809 @item -mxgot
13810 @itemx -mno-xgot
13811 @opindex mxgot
13812 @opindex mno-xgot
13813 Lift (do not lift) the usual restrictions on the size of the global
13814 offset table.
13816 GCC normally uses a single instruction to load values from the GOT@.
13817 While this is relatively efficient, it will only work if the GOT
13818 is smaller than about 64k.  Anything larger will cause the linker
13819 to report an error such as:
13821 @cindex relocation truncated to fit (MIPS)
13822 @smallexample
13823 relocation truncated to fit: R_MIPS_GOT16 foobar
13824 @end smallexample
13826 If this happens, you should recompile your code with @option{-mxgot}.
13827 It should then work with very large GOTs, although it will also be
13828 less efficient, since it will take three instructions to fetch the
13829 value of a global symbol.
13831 Note that some linkers can create multiple GOTs.  If you have such a
13832 linker, you should only need to use @option{-mxgot} when a single object
13833 file accesses more than 64k's worth of GOT entries.  Very few do.
13835 These options have no effect unless GCC is generating position
13836 independent code.
13838 @item -mgp32
13839 @opindex mgp32
13840 Assume that general-purpose registers are 32 bits wide.
13842 @item -mgp64
13843 @opindex mgp64
13844 Assume that general-purpose registers are 64 bits wide.
13846 @item -mfp32
13847 @opindex mfp32
13848 Assume that floating-point registers are 32 bits wide.
13850 @item -mfp64
13851 @opindex mfp64
13852 Assume that floating-point registers are 64 bits wide.
13854 @item -mhard-float
13855 @opindex mhard-float
13856 Use floating-point coprocessor instructions.
13858 @item -msoft-float
13859 @opindex msoft-float
13860 Do not use floating-point coprocessor instructions.  Implement
13861 floating-point calculations using library calls instead.
13863 @item -msingle-float
13864 @opindex msingle-float
13865 Assume that the floating-point coprocessor only supports single-precision
13866 operations.
13868 @item -mdouble-float
13869 @opindex mdouble-float
13870 Assume that the floating-point coprocessor supports double-precision
13871 operations.  This is the default.
13873 @item -mllsc
13874 @itemx -mno-llsc
13875 @opindex mllsc
13876 @opindex mno-llsc
13877 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
13878 implement atomic memory built-in functions.  When neither option is
13879 specified, GCC will use the instructions if the target architecture
13880 supports them.
13882 @option{-mllsc} is useful if the runtime environment can emulate the
13883 instructions and @option{-mno-llsc} can be useful when compiling for
13884 nonstandard ISAs.  You can make either option the default by
13885 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
13886 respectively.  @option{--with-llsc} is the default for some
13887 configurations; see the installation documentation for details.
13889 @item -mdsp
13890 @itemx -mno-dsp
13891 @opindex mdsp
13892 @opindex mno-dsp
13893 Use (do not use) revision 1 of the MIPS DSP ASE@.
13894 @xref{MIPS DSP Built-in Functions}.  This option defines the
13895 preprocessor macro @samp{__mips_dsp}.  It also defines
13896 @samp{__mips_dsp_rev} to 1.
13898 @item -mdspr2
13899 @itemx -mno-dspr2
13900 @opindex mdspr2
13901 @opindex mno-dspr2
13902 Use (do not use) revision 2 of the MIPS DSP ASE@.
13903 @xref{MIPS DSP Built-in Functions}.  This option defines the
13904 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
13905 It also defines @samp{__mips_dsp_rev} to 2.
13907 @item -msmartmips
13908 @itemx -mno-smartmips
13909 @opindex msmartmips
13910 @opindex mno-smartmips
13911 Use (do not use) the MIPS SmartMIPS ASE.
13913 @item -mpaired-single
13914 @itemx -mno-paired-single
13915 @opindex mpaired-single
13916 @opindex mno-paired-single
13917 Use (do not use) paired-single floating-point instructions.
13918 @xref{MIPS Paired-Single Support}.  This option requires
13919 hardware floating-point support to be enabled.
13921 @item -mdmx
13922 @itemx -mno-mdmx
13923 @opindex mdmx
13924 @opindex mno-mdmx
13925 Use (do not use) MIPS Digital Media Extension instructions.
13926 This option can only be used when generating 64-bit code and requires
13927 hardware floating-point support to be enabled.
13929 @item -mips3d
13930 @itemx -mno-mips3d
13931 @opindex mips3d
13932 @opindex mno-mips3d
13933 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
13934 The option @option{-mips3d} implies @option{-mpaired-single}.
13936 @item -mmt
13937 @itemx -mno-mt
13938 @opindex mmt
13939 @opindex mno-mt
13940 Use (do not use) MT Multithreading instructions.
13942 @item -mlong64
13943 @opindex mlong64
13944 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
13945 an explanation of the default and the way that the pointer size is
13946 determined.
13948 @item -mlong32
13949 @opindex mlong32
13950 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
13952 The default size of @code{int}s, @code{long}s and pointers depends on
13953 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
13954 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
13955 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
13956 or the same size as integer registers, whichever is smaller.
13958 @item -msym32
13959 @itemx -mno-sym32
13960 @opindex msym32
13961 @opindex mno-sym32
13962 Assume (do not assume) that all symbols have 32-bit values, regardless
13963 of the selected ABI@.  This option is useful in combination with
13964 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
13965 to generate shorter and faster references to symbolic addresses.
13967 @item -G @var{num}
13968 @opindex G
13969 Put definitions of externally-visible data in a small data section
13970 if that data is no bigger than @var{num} bytes.  GCC can then access
13971 the data more efficiently; see @option{-mgpopt} for details.
13973 The default @option{-G} option depends on the configuration.
13975 @item -mlocal-sdata
13976 @itemx -mno-local-sdata
13977 @opindex mlocal-sdata
13978 @opindex mno-local-sdata
13979 Extend (do not extend) the @option{-G} behavior to local data too,
13980 such as to static variables in C@.  @option{-mlocal-sdata} is the
13981 default for all configurations.
13983 If the linker complains that an application is using too much small data,
13984 you might want to try rebuilding the less performance-critical parts with
13985 @option{-mno-local-sdata}.  You might also want to build large
13986 libraries with @option{-mno-local-sdata}, so that the libraries leave
13987 more room for the main program.
13989 @item -mextern-sdata
13990 @itemx -mno-extern-sdata
13991 @opindex mextern-sdata
13992 @opindex mno-extern-sdata
13993 Assume (do not assume) that externally-defined data will be in
13994 a small data section if that data is within the @option{-G} limit.
13995 @option{-mextern-sdata} is the default for all configurations.
13997 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
13998 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
13999 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
14000 is placed in a small data section.  If @var{Var} is defined by another
14001 module, you must either compile that module with a high-enough
14002 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
14003 definition.  If @var{Var} is common, you must link the application
14004 with a high-enough @option{-G} setting.
14006 The easiest way of satisfying these restrictions is to compile
14007 and link every module with the same @option{-G} option.  However,
14008 you may wish to build a library that supports several different
14009 small data limits.  You can do this by compiling the library with
14010 the highest supported @option{-G} setting and additionally using
14011 @option{-mno-extern-sdata} to stop the library from making assumptions
14012 about externally-defined data.
14014 @item -mgpopt
14015 @itemx -mno-gpopt
14016 @opindex mgpopt
14017 @opindex mno-gpopt
14018 Use (do not use) GP-relative accesses for symbols that are known to be
14019 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
14020 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
14021 configurations.
14023 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
14024 might not hold the value of @code{_gp}.  For example, if the code is
14025 part of a library that might be used in a boot monitor, programs that
14026 call boot monitor routines will pass an unknown value in @code{$gp}.
14027 (In such situations, the boot monitor itself would usually be compiled
14028 with @option{-G0}.)
14030 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
14031 @option{-mno-extern-sdata}.
14033 @item -membedded-data
14034 @itemx -mno-embedded-data
14035 @opindex membedded-data
14036 @opindex mno-embedded-data
14037 Allocate variables to the read-only data section first if possible, then
14038 next in the small data section if possible, otherwise in data.  This gives
14039 slightly slower code than the default, but reduces the amount of RAM required
14040 when executing, and thus may be preferred for some embedded systems.
14042 @item -muninit-const-in-rodata
14043 @itemx -mno-uninit-const-in-rodata
14044 @opindex muninit-const-in-rodata
14045 @opindex mno-uninit-const-in-rodata
14046 Put uninitialized @code{const} variables in the read-only data section.
14047 This option is only meaningful in conjunction with @option{-membedded-data}.
14049 @item -mcode-readable=@var{setting}
14050 @opindex mcode-readable
14051 Specify whether GCC may generate code that reads from executable sections.
14052 There are three possible settings:
14054 @table @gcctabopt
14055 @item -mcode-readable=yes
14056 Instructions may freely access executable sections.  This is the
14057 default setting.
14059 @item -mcode-readable=pcrel
14060 MIPS16 PC-relative load instructions can access executable sections,
14061 but other instructions must not do so.  This option is useful on 4KSc
14062 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
14063 It is also useful on processors that can be configured to have a dual
14064 instruction/data SRAM interface and that, like the M4K, automatically
14065 redirect PC-relative loads to the instruction RAM.
14067 @item -mcode-readable=no
14068 Instructions must not access executable sections.  This option can be
14069 useful on targets that are configured to have a dual instruction/data
14070 SRAM interface but that (unlike the M4K) do not automatically redirect
14071 PC-relative loads to the instruction RAM.
14072 @end table
14074 @item -msplit-addresses
14075 @itemx -mno-split-addresses
14076 @opindex msplit-addresses
14077 @opindex mno-split-addresses
14078 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
14079 relocation operators.  This option has been superseded by
14080 @option{-mexplicit-relocs} but is retained for backwards compatibility.
14082 @item -mexplicit-relocs
14083 @itemx -mno-explicit-relocs
14084 @opindex mexplicit-relocs
14085 @opindex mno-explicit-relocs
14086 Use (do not use) assembler relocation operators when dealing with symbolic
14087 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
14088 is to use assembler macros instead.
14090 @option{-mexplicit-relocs} is the default if GCC was configured
14091 to use an assembler that supports relocation operators.
14093 @item -mcheck-zero-division
14094 @itemx -mno-check-zero-division
14095 @opindex mcheck-zero-division
14096 @opindex mno-check-zero-division
14097 Trap (do not trap) on integer division by zero.
14099 The default is @option{-mcheck-zero-division}.
14101 @item -mdivide-traps
14102 @itemx -mdivide-breaks
14103 @opindex mdivide-traps
14104 @opindex mdivide-breaks
14105 MIPS systems check for division by zero by generating either a
14106 conditional trap or a break instruction.  Using traps results in
14107 smaller code, but is only supported on MIPS II and later.  Also, some
14108 versions of the Linux kernel have a bug that prevents trap from
14109 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
14110 allow conditional traps on architectures that support them and
14111 @option{-mdivide-breaks} to force the use of breaks.
14113 The default is usually @option{-mdivide-traps}, but this can be
14114 overridden at configure time using @option{--with-divide=breaks}.
14115 Divide-by-zero checks can be completely disabled using
14116 @option{-mno-check-zero-division}.
14118 @item -mmemcpy
14119 @itemx -mno-memcpy
14120 @opindex mmemcpy
14121 @opindex mno-memcpy
14122 Force (do not force) the use of @code{memcpy()} for non-trivial block
14123 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
14124 most constant-sized copies.
14126 @item -mlong-calls
14127 @itemx -mno-long-calls
14128 @opindex mlong-calls
14129 @opindex mno-long-calls
14130 Disable (do not disable) use of the @code{jal} instruction.  Calling
14131 functions using @code{jal} is more efficient but requires the caller
14132 and callee to be in the same 256 megabyte segment.
14134 This option has no effect on abicalls code.  The default is
14135 @option{-mno-long-calls}.
14137 @item -mmad
14138 @itemx -mno-mad
14139 @opindex mmad
14140 @opindex mno-mad
14141 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
14142 instructions, as provided by the R4650 ISA@.
14144 @item -mfused-madd
14145 @itemx -mno-fused-madd
14146 @opindex mfused-madd
14147 @opindex mno-fused-madd
14148 Enable (disable) use of the floating point multiply-accumulate
14149 instructions, when they are available.  The default is
14150 @option{-mfused-madd}.
14152 When multiply-accumulate instructions are used, the intermediate
14153 product is calculated to infinite precision and is not subject to
14154 the FCSR Flush to Zero bit.  This may be undesirable in some
14155 circumstances.
14157 @item -nocpp
14158 @opindex nocpp
14159 Tell the MIPS assembler to not run its preprocessor over user
14160 assembler files (with a @samp{.s} suffix) when assembling them.
14162 @item -mfix-r4000
14163 @itemx -mno-fix-r4000
14164 @opindex mfix-r4000
14165 @opindex mno-fix-r4000
14166 Work around certain R4000 CPU errata:
14167 @itemize @minus
14168 @item
14169 A double-word or a variable shift may give an incorrect result if executed
14170 immediately after starting an integer division.
14171 @item
14172 A double-word or a variable shift may give an incorrect result if executed
14173 while an integer multiplication is in progress.
14174 @item
14175 An integer division may give an incorrect result if started in a delay slot
14176 of a taken branch or a jump.
14177 @end itemize
14179 @item -mfix-r4400
14180 @itemx -mno-fix-r4400
14181 @opindex mfix-r4400
14182 @opindex mno-fix-r4400
14183 Work around certain R4400 CPU errata:
14184 @itemize @minus
14185 @item
14186 A double-word or a variable shift may give an incorrect result if executed
14187 immediately after starting an integer division.
14188 @end itemize
14190 @item -mfix-r10000
14191 @itemx -mno-fix-r10000
14192 @opindex mfix-r10000
14193 @opindex mno-fix-r10000
14194 Work around certain R10000 errata:
14195 @itemize @minus
14196 @item
14197 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14198 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
14199 @end itemize
14201 This option can only be used if the target architecture supports
14202 branch-likely instructions.  @option{-mfix-r10000} is the default when
14203 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14204 otherwise.
14206 @item -mfix-vr4120
14207 @itemx -mno-fix-vr4120
14208 @opindex mfix-vr4120
14209 Work around certain VR4120 errata:
14210 @itemize @minus
14211 @item
14212 @code{dmultu} does not always produce the correct result.
14213 @item
14214 @code{div} and @code{ddiv} do not always produce the correct result if one
14215 of the operands is negative.
14216 @end itemize
14217 The workarounds for the division errata rely on special functions in
14218 @file{libgcc.a}.  At present, these functions are only provided by
14219 the @code{mips64vr*-elf} configurations.
14221 Other VR4120 errata require a nop to be inserted between certain pairs of
14222 instructions.  These errata are handled by the assembler, not by GCC itself.
14224 @item -mfix-vr4130
14225 @opindex mfix-vr4130
14226 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
14227 workarounds are implemented by the assembler rather than by GCC,
14228 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14229 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14230 instructions are available instead.
14232 @item -mfix-sb1
14233 @itemx -mno-fix-sb1
14234 @opindex mfix-sb1
14235 Work around certain SB-1 CPU core errata.
14236 (This flag currently works around the SB-1 revision 2
14237 ``F1'' and ``F2'' floating point errata.)
14239 @item -mr10k-cache-barrier=@var{setting}
14240 @opindex mr10k-cache-barrier
14241 Specify whether GCC should insert cache barriers to avoid the
14242 side-effects of speculation on R10K processors.
14244 In common with many processors, the R10K tries to predict the outcome
14245 of a conditional branch and speculatively executes instructions from
14246 the ``taken'' branch.  It later aborts these instructions if the
14247 predicted outcome was wrong.  However, on the R10K, even aborted
14248 instructions can have side effects.
14250 This problem only affects kernel stores and, depending on the system,
14251 kernel loads.  As an example, a speculatively-executed store may load
14252 the target memory into cache and mark the cache line as dirty, even if
14253 the store itself is later aborted.  If a DMA operation writes to the
14254 same area of memory before the ``dirty'' line is flushed, the cached
14255 data will overwrite the DMA-ed data.  See the R10K processor manual
14256 for a full description, including other potential problems.
14258 One workaround is to insert cache barrier instructions before every memory
14259 access that might be speculatively executed and that might have side
14260 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
14261 controls GCC's implementation of this workaround.  It assumes that
14262 aborted accesses to any byte in the following regions will not have
14263 side effects:
14265 @enumerate
14266 @item
14267 the memory occupied by the current function's stack frame;
14269 @item
14270 the memory occupied by an incoming stack argument;
14272 @item
14273 the memory occupied by an object with a link-time-constant address.
14274 @end enumerate
14276 It is the kernel's responsibility to ensure that speculative
14277 accesses to these regions are indeed safe.
14279 If the input program contains a function declaration such as:
14281 @smallexample
14282 void foo (void);
14283 @end smallexample
14285 then the implementation of @code{foo} must allow @code{j foo} and
14286 @code{jal foo} to be executed speculatively.  GCC honors this
14287 restriction for functions it compiles itself.  It expects non-GCC
14288 functions (such as hand-written assembly code) to do the same.
14290 The option has three forms:
14292 @table @gcctabopt
14293 @item -mr10k-cache-barrier=load-store
14294 Insert a cache barrier before a load or store that might be
14295 speculatively executed and that might have side effects even
14296 if aborted.
14298 @item -mr10k-cache-barrier=store
14299 Insert a cache barrier before a store that might be speculatively
14300 executed and that might have side effects even if aborted.
14302 @item -mr10k-cache-barrier=none
14303 Disable the insertion of cache barriers.  This is the default setting.
14304 @end table
14306 @item -mflush-func=@var{func}
14307 @itemx -mno-flush-func
14308 @opindex mflush-func
14309 Specifies the function to call to flush the I and D caches, or to not
14310 call any such function.  If called, the function must take the same
14311 arguments as the common @code{_flush_func()}, that is, the address of the
14312 memory range for which the cache is being flushed, the size of the
14313 memory range, and the number 3 (to flush both caches).  The default
14314 depends on the target GCC was configured for, but commonly is either
14315 @samp{_flush_func} or @samp{__cpu_flush}.
14317 @item mbranch-cost=@var{num}
14318 @opindex mbranch-cost
14319 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14320 This cost is only a heuristic and is not guaranteed to produce
14321 consistent results across releases.  A zero cost redundantly selects
14322 the default, which is based on the @option{-mtune} setting.
14324 @item -mbranch-likely
14325 @itemx -mno-branch-likely
14326 @opindex mbranch-likely
14327 @opindex mno-branch-likely
14328 Enable or disable use of Branch Likely instructions, regardless of the
14329 default for the selected architecture.  By default, Branch Likely
14330 instructions may be generated if they are supported by the selected
14331 architecture.  An exception is for the MIPS32 and MIPS64 architectures
14332 and processors which implement those architectures; for those, Branch
14333 Likely instructions will not be generated by default because the MIPS32
14334 and MIPS64 architectures specifically deprecate their use.
14336 @item -mfp-exceptions
14337 @itemx -mno-fp-exceptions
14338 @opindex mfp-exceptions
14339 Specifies whether FP exceptions are enabled.  This affects how we schedule
14340 FP instructions for some processors.  The default is that FP exceptions are
14341 enabled.
14343 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14344 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
14345 FP pipe.
14347 @item -mvr4130-align
14348 @itemx -mno-vr4130-align
14349 @opindex mvr4130-align
14350 The VR4130 pipeline is two-way superscalar, but can only issue two
14351 instructions together if the first one is 8-byte aligned.  When this
14352 option is enabled, GCC will align pairs of instructions that it
14353 thinks should execute in parallel.
14355 This option only has an effect when optimizing for the VR4130.
14356 It normally makes code faster, but at the expense of making it bigger.
14357 It is enabled by default at optimization level @option{-O3}.
14359 @item -msynci
14360 @itemx -mno-synci
14361 @opindex msynci
14362 Enable (disable) generation of @code{synci} instructions on
14363 architectures that support it.  The @code{synci} instructions (if
14364 enabled) will be generated when @code{__builtin___clear_cache()} is
14365 compiled.
14367 This option defaults to @code{-mno-synci}, but the default can be
14368 overridden by configuring with @code{--with-synci}.
14370 When compiling code for single processor systems, it is generally safe
14371 to use @code{synci}.  However, on many multi-core (SMP) systems, it
14372 will not invalidate the instruction caches on all cores and may lead
14373 to undefined behavior.
14375 @item -mrelax-pic-calls
14376 @itemx -mno-relax-pic-calls
14377 @opindex mrelax-pic-calls
14378 Try to turn PIC calls that are normally dispatched via register
14379 @code{$25} into direct calls.  This is only possible if the linker can
14380 resolve the destination at link-time and if the destination is within
14381 range for a direct call.
14383 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14384 an assembler and a linker that supports the @code{.reloc} assembly
14385 directive and @code{-mexplicit-relocs} is in effect.  With
14386 @code{-mno-explicit-relocs}, this optimization can be performed by the
14387 assembler and the linker alone without help from the compiler.
14389 @item -mmcount-ra-address
14390 @itemx -mno-mcount-ra-address
14391 @opindex mmcount-ra-address
14392 @opindex mno-mcount-ra-address
14393 Emit (do not emit) code that allows @code{_mcount} to modify the
14394 calling function's return address.  When enabled, this option extends
14395 the usual @code{_mcount} interface with a new @var{ra-address}
14396 parameter, which has type @code{intptr_t *} and is passed in register
14397 @code{$12}.  @code{_mcount} can then modify the return address by
14398 doing both of the following:
14399 @itemize
14400 @item
14401 Returning the new address in register @code{$31}.
14402 @item
14403 Storing the new address in @code{*@var{ra-address}},
14404 if @var{ra-address} is nonnull.
14405 @end itemize
14407 The default is @option{-mno-mcount-ra-address}.
14409 @end table
14411 @node MMIX Options
14412 @subsection MMIX Options
14413 @cindex MMIX Options
14415 These options are defined for the MMIX:
14417 @table @gcctabopt
14418 @item -mlibfuncs
14419 @itemx -mno-libfuncs
14420 @opindex mlibfuncs
14421 @opindex mno-libfuncs
14422 Specify that intrinsic library functions are being compiled, passing all
14423 values in registers, no matter the size.
14425 @item -mepsilon
14426 @itemx -mno-epsilon
14427 @opindex mepsilon
14428 @opindex mno-epsilon
14429 Generate floating-point comparison instructions that compare with respect
14430 to the @code{rE} epsilon register.
14432 @item -mabi=mmixware
14433 @itemx -mabi=gnu
14434 @opindex mabi=mmixware
14435 @opindex mabi=gnu
14436 Generate code that passes function parameters and return values that (in
14437 the called function) are seen as registers @code{$0} and up, as opposed to
14438 the GNU ABI which uses global registers @code{$231} and up.
14440 @item -mzero-extend
14441 @itemx -mno-zero-extend
14442 @opindex mzero-extend
14443 @opindex mno-zero-extend
14444 When reading data from memory in sizes shorter than 64 bits, use (do not
14445 use) zero-extending load instructions by default, rather than
14446 sign-extending ones.
14448 @item -mknuthdiv
14449 @itemx -mno-knuthdiv
14450 @opindex mknuthdiv
14451 @opindex mno-knuthdiv
14452 Make the result of a division yielding a remainder have the same sign as
14453 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
14454 remainder follows the sign of the dividend.  Both methods are
14455 arithmetically valid, the latter being almost exclusively used.
14457 @item -mtoplevel-symbols
14458 @itemx -mno-toplevel-symbols
14459 @opindex mtoplevel-symbols
14460 @opindex mno-toplevel-symbols
14461 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
14462 code can be used with the @code{PREFIX} assembly directive.
14464 @item -melf
14465 @opindex melf
14466 Generate an executable in the ELF format, rather than the default
14467 @samp{mmo} format used by the @command{mmix} simulator.
14469 @item -mbranch-predict
14470 @itemx -mno-branch-predict
14471 @opindex mbranch-predict
14472 @opindex mno-branch-predict
14473 Use (do not use) the probable-branch instructions, when static branch
14474 prediction indicates a probable branch.
14476 @item -mbase-addresses
14477 @itemx -mno-base-addresses
14478 @opindex mbase-addresses
14479 @opindex mno-base-addresses
14480 Generate (do not generate) code that uses @emph{base addresses}.  Using a
14481 base address automatically generates a request (handled by the assembler
14482 and the linker) for a constant to be set up in a global register.  The
14483 register is used for one or more base address requests within the range 0
14484 to 255 from the value held in the register.  The generally leads to short
14485 and fast code, but the number of different data items that can be
14486 addressed is limited.  This means that a program that uses lots of static
14487 data may require @option{-mno-base-addresses}.
14489 @item -msingle-exit
14490 @itemx -mno-single-exit
14491 @opindex msingle-exit
14492 @opindex mno-single-exit
14493 Force (do not force) generated code to have a single exit point in each
14494 function.
14495 @end table
14497 @node MN10300 Options
14498 @subsection MN10300 Options
14499 @cindex MN10300 options
14501 These @option{-m} options are defined for Matsushita MN10300 architectures:
14503 @table @gcctabopt
14504 @item -mmult-bug
14505 @opindex mmult-bug
14506 Generate code to avoid bugs in the multiply instructions for the MN10300
14507 processors.  This is the default.
14509 @item -mno-mult-bug
14510 @opindex mno-mult-bug
14511 Do not generate code to avoid bugs in the multiply instructions for the
14512 MN10300 processors.
14514 @item -mam33
14515 @opindex mam33
14516 Generate code which uses features specific to the AM33 processor.
14518 @item -mno-am33
14519 @opindex mno-am33
14520 Do not generate code which uses features specific to the AM33 processor.  This
14521 is the default.
14523 @item -mreturn-pointer-on-d0
14524 @opindex mreturn-pointer-on-d0
14525 When generating a function which returns a pointer, return the pointer
14526 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
14527 only in a0, and attempts to call such functions without a prototype
14528 would result in errors.  Note that this option is on by default; use
14529 @option{-mno-return-pointer-on-d0} to disable it.
14531 @item -mno-crt0
14532 @opindex mno-crt0
14533 Do not link in the C run-time initialization object file.
14535 @item -mrelax
14536 @opindex mrelax
14537 Indicate to the linker that it should perform a relaxation optimization pass
14538 to shorten branches, calls and absolute memory addresses.  This option only
14539 has an effect when used on the command line for the final link step.
14541 This option makes symbolic debugging impossible.
14542 @end table
14544 @node PDP-11 Options
14545 @subsection PDP-11 Options
14546 @cindex PDP-11 Options
14548 These options are defined for the PDP-11:
14550 @table @gcctabopt
14551 @item -mfpu
14552 @opindex mfpu
14553 Use hardware FPP floating point.  This is the default.  (FIS floating
14554 point on the PDP-11/40 is not supported.)
14556 @item -msoft-float
14557 @opindex msoft-float
14558 Do not use hardware floating point.
14560 @item -mac0
14561 @opindex mac0
14562 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
14564 @item -mno-ac0
14565 @opindex mno-ac0
14566 Return floating-point results in memory.  This is the default.
14568 @item -m40
14569 @opindex m40
14570 Generate code for a PDP-11/40.
14572 @item -m45
14573 @opindex m45
14574 Generate code for a PDP-11/45.  This is the default.
14576 @item -m10
14577 @opindex m10
14578 Generate code for a PDP-11/10.
14580 @item -mbcopy-builtin
14581 @opindex mbcopy-builtin
14582 Use inline @code{movmemhi} patterns for copying memory.  This is the
14583 default.
14585 @item -mbcopy
14586 @opindex mbcopy
14587 Do not use inline @code{movmemhi} patterns for copying memory.
14589 @item -mint16
14590 @itemx -mno-int32
14591 @opindex mint16
14592 @opindex mno-int32
14593 Use 16-bit @code{int}.  This is the default.
14595 @item -mint32
14596 @itemx -mno-int16
14597 @opindex mint32
14598 @opindex mno-int16
14599 Use 32-bit @code{int}.
14601 @item -mfloat64
14602 @itemx -mno-float32
14603 @opindex mfloat64
14604 @opindex mno-float32
14605 Use 64-bit @code{float}.  This is the default.
14607 @item -mfloat32
14608 @itemx -mno-float64
14609 @opindex mfloat32
14610 @opindex mno-float64
14611 Use 32-bit @code{float}.
14613 @item -mabshi
14614 @opindex mabshi
14615 Use @code{abshi2} pattern.  This is the default.
14617 @item -mno-abshi
14618 @opindex mno-abshi
14619 Do not use @code{abshi2} pattern.
14621 @item -mbranch-expensive
14622 @opindex mbranch-expensive
14623 Pretend that branches are expensive.  This is for experimenting with
14624 code generation only.
14626 @item -mbranch-cheap
14627 @opindex mbranch-cheap
14628 Do not pretend that branches are expensive.  This is the default.
14630 @item -msplit
14631 @opindex msplit
14632 Generate code for a system with split I&D@.
14634 @item -mno-split
14635 @opindex mno-split
14636 Generate code for a system without split I&D@.  This is the default.
14638 @item -munix-asm
14639 @opindex munix-asm
14640 Use Unix assembler syntax.  This is the default when configured for
14641 @samp{pdp11-*-bsd}.
14643 @item -mdec-asm
14644 @opindex mdec-asm
14645 Use DEC assembler syntax.  This is the default when configured for any
14646 PDP-11 target other than @samp{pdp11-*-bsd}.
14647 @end table
14649 @node picoChip Options
14650 @subsection picoChip Options
14651 @cindex picoChip options
14653 These @samp{-m} options are defined for picoChip implementations:
14655 @table @gcctabopt
14657 @item -mae=@var{ae_type}
14658 @opindex mcpu
14659 Set the instruction set, register set, and instruction scheduling
14660 parameters for array element type @var{ae_type}.  Supported values
14661 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
14663 @option{-mae=ANY} selects a completely generic AE type.  Code
14664 generated with this option will run on any of the other AE types.  The
14665 code will not be as efficient as it would be if compiled for a specific
14666 AE type, and some types of operation (e.g., multiplication) will not
14667 work properly on all types of AE.
14669 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
14670 for compiled code, and is the default.
14672 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
14673 option may suffer from poor performance of byte (char) manipulation,
14674 since the DSP AE does not provide hardware support for byte load/stores.
14676 @item -msymbol-as-address
14677 Enable the compiler to directly use a symbol name as an address in a
14678 load/store instruction, without first loading it into a
14679 register.  Typically, the use of this option will generate larger
14680 programs, which run faster than when the option isn't used.  However, the
14681 results vary from program to program, so it is left as a user option,
14682 rather than being permanently enabled.
14684 @item -mno-inefficient-warnings
14685 Disables warnings about the generation of inefficient code.  These
14686 warnings can be generated, for example, when compiling code which
14687 performs byte-level memory operations on the MAC AE type.  The MAC AE has
14688 no hardware support for byte-level memory operations, so all byte
14689 load/stores must be synthesized from word load/store operations.  This is
14690 inefficient and a warning will be generated indicating to the programmer
14691 that they should rewrite the code to avoid byte operations, or to target
14692 an AE type which has the necessary hardware support.  This option enables
14693 the warning to be turned off.
14695 @end table
14697 @node PowerPC Options
14698 @subsection PowerPC Options
14699 @cindex PowerPC options
14701 These are listed under @xref{RS/6000 and PowerPC Options}.
14703 @node RS/6000 and PowerPC Options
14704 @subsection IBM RS/6000 and PowerPC Options
14705 @cindex RS/6000 and PowerPC Options
14706 @cindex IBM RS/6000 and PowerPC Options
14708 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
14709 @table @gcctabopt
14710 @item -mpower
14711 @itemx -mno-power
14712 @itemx -mpower2
14713 @itemx -mno-power2
14714 @itemx -mpowerpc
14715 @itemx -mno-powerpc
14716 @itemx -mpowerpc-gpopt
14717 @itemx -mno-powerpc-gpopt
14718 @itemx -mpowerpc-gfxopt
14719 @itemx -mno-powerpc-gfxopt
14720 @itemx -mpowerpc64
14721 @itemx -mno-powerpc64
14722 @itemx -mmfcrf
14723 @itemx -mno-mfcrf
14724 @itemx -mpopcntb
14725 @itemx -mno-popcntb
14726 @itemx -mpopcntd
14727 @itemx -mno-popcntd
14728 @itemx -mfprnd
14729 @itemx -mno-fprnd
14730 @itemx -mcmpb
14731 @itemx -mno-cmpb
14732 @itemx -mmfpgpr
14733 @itemx -mno-mfpgpr
14734 @itemx -mhard-dfp
14735 @itemx -mno-hard-dfp
14736 @opindex mpower
14737 @opindex mno-power
14738 @opindex mpower2
14739 @opindex mno-power2
14740 @opindex mpowerpc
14741 @opindex mno-powerpc
14742 @opindex mpowerpc-gpopt
14743 @opindex mno-powerpc-gpopt
14744 @opindex mpowerpc-gfxopt
14745 @opindex mno-powerpc-gfxopt
14746 @opindex mpowerpc64
14747 @opindex mno-powerpc64
14748 @opindex mmfcrf
14749 @opindex mno-mfcrf
14750 @opindex mpopcntb
14751 @opindex mno-popcntb
14752 @opindex mpopcntd
14753 @opindex mno-popcntd
14754 @opindex mfprnd
14755 @opindex mno-fprnd
14756 @opindex mcmpb
14757 @opindex mno-cmpb
14758 @opindex mmfpgpr
14759 @opindex mno-mfpgpr
14760 @opindex mhard-dfp
14761 @opindex mno-hard-dfp
14762 GCC supports two related instruction set architectures for the
14763 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
14764 instructions supported by the @samp{rios} chip set used in the original
14765 RS/6000 systems and the @dfn{PowerPC} instruction set is the
14766 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
14767 the IBM 4xx, 6xx, and follow-on microprocessors.
14769 Neither architecture is a subset of the other.  However there is a
14770 large common subset of instructions supported by both.  An MQ
14771 register is included in processors supporting the POWER architecture.
14773 You use these options to specify which instructions are available on the
14774 processor you are using.  The default value of these options is
14775 determined when configuring GCC@.  Specifying the
14776 @option{-mcpu=@var{cpu_type}} overrides the specification of these
14777 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
14778 rather than the options listed above.
14780 The @option{-mpower} option allows GCC to generate instructions that
14781 are found only in the POWER architecture and to use the MQ register.
14782 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
14783 to generate instructions that are present in the POWER2 architecture but
14784 not the original POWER architecture.
14786 The @option{-mpowerpc} option allows GCC to generate instructions that
14787 are found only in the 32-bit subset of the PowerPC architecture.
14788 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
14789 GCC to use the optional PowerPC architecture instructions in the
14790 General Purpose group, including floating-point square root.  Specifying
14791 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
14792 use the optional PowerPC architecture instructions in the Graphics
14793 group, including floating-point select.
14795 The @option{-mmfcrf} option allows GCC to generate the move from
14796 condition register field instruction implemented on the POWER4
14797 processor and other processors that support the PowerPC V2.01
14798 architecture.
14799 The @option{-mpopcntb} option allows GCC to generate the popcount and
14800 double precision FP reciprocal estimate instruction implemented on the
14801 POWER5 processor and other processors that support the PowerPC V2.02
14802 architecture.
14803 The @option{-mpopcntd} option allows GCC to generate the popcount
14804 instruction implemented on the POWER7 processor and other processors
14805 that support the PowerPC V2.06 architecture.
14806 The @option{-mfprnd} option allows GCC to generate the FP round to
14807 integer instructions implemented on the POWER5+ processor and other
14808 processors that support the PowerPC V2.03 architecture.
14809 The @option{-mcmpb} option allows GCC to generate the compare bytes
14810 instruction implemented on the POWER6 processor and other processors
14811 that support the PowerPC V2.05 architecture.
14812 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
14813 general purpose register instructions implemented on the POWER6X
14814 processor and other processors that support the extended PowerPC V2.05
14815 architecture.
14816 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
14817 point instructions implemented on some POWER processors.
14819 The @option{-mpowerpc64} option allows GCC to generate the additional
14820 64-bit instructions that are found in the full PowerPC64 architecture
14821 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
14822 @option{-mno-powerpc64}.
14824 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
14825 will use only the instructions in the common subset of both
14826 architectures plus some special AIX common-mode calls, and will not use
14827 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
14828 permits GCC to use any instruction from either architecture and to
14829 allow use of the MQ register; specify this for the Motorola MPC601.
14831 @item -mnew-mnemonics
14832 @itemx -mold-mnemonics
14833 @opindex mnew-mnemonics
14834 @opindex mold-mnemonics
14835 Select which mnemonics to use in the generated assembler code.  With
14836 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
14837 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
14838 assembler mnemonics defined for the POWER architecture.  Instructions
14839 defined in only one architecture have only one mnemonic; GCC uses that
14840 mnemonic irrespective of which of these options is specified.
14842 GCC defaults to the mnemonics appropriate for the architecture in
14843 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
14844 value of these option.  Unless you are building a cross-compiler, you
14845 should normally not specify either @option{-mnew-mnemonics} or
14846 @option{-mold-mnemonics}, but should instead accept the default.
14848 @item -mcpu=@var{cpu_type}
14849 @opindex mcpu
14850 Set architecture type, register usage, choice of mnemonics, and
14851 instruction scheduling parameters for machine type @var{cpu_type}.
14852 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
14853 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
14854 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
14855 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
14856 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
14857 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
14858 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
14859 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
14860 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
14861 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
14862 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
14864 @option{-mcpu=common} selects a completely generic processor.  Code
14865 generated under this option will run on any POWER or PowerPC processor.
14866 GCC will use only the instructions in the common subset of both
14867 architectures, and will not use the MQ register.  GCC assumes a generic
14868 processor model for scheduling purposes.
14870 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
14871 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
14872 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
14873 types, with an appropriate, generic processor model assumed for
14874 scheduling purposes.
14876 The other options specify a specific processor.  Code generated under
14877 those options will run best on that processor, and may not run at all on
14878 others.
14880 The @option{-mcpu} options automatically enable or disable the
14881 following options:
14883 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
14884 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
14885 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
14886 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
14888 The particular options set for any particular CPU will vary between
14889 compiler versions, depending on what setting seems to produce optimal
14890 code for that CPU; it doesn't necessarily reflect the actual hardware's
14891 capabilities.  If you wish to set an individual option to a particular
14892 value, you may specify it after the @option{-mcpu} option, like
14893 @samp{-mcpu=970 -mno-altivec}.
14895 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
14896 not enabled or disabled by the @option{-mcpu} option at present because
14897 AIX does not have full support for these options.  You may still
14898 enable or disable them individually if you're sure it'll work in your
14899 environment.
14901 @item -mtune=@var{cpu_type}
14902 @opindex mtune
14903 Set the instruction scheduling parameters for machine type
14904 @var{cpu_type}, but do not set the architecture type, register usage, or
14905 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
14906 values for @var{cpu_type} are used for @option{-mtune} as for
14907 @option{-mcpu}.  If both are specified, the code generated will use the
14908 architecture, registers, and mnemonics set by @option{-mcpu}, but the
14909 scheduling parameters set by @option{-mtune}.
14911 @item -mswdiv
14912 @itemx -mno-swdiv
14913 @opindex mswdiv
14914 @opindex mno-swdiv
14915 Generate code to compute division as reciprocal estimate and iterative
14916 refinement, creating opportunities for increased throughput.  This
14917 feature requires: optional PowerPC Graphics instruction set for single
14918 precision and FRE instruction for double precision, assuming divides
14919 cannot generate user-visible traps, and the domain values not include
14920 Infinities, denormals or zero denominator.
14922 @item -maltivec
14923 @itemx -mno-altivec
14924 @opindex maltivec
14925 @opindex mno-altivec
14926 Generate code that uses (does not use) AltiVec instructions, and also
14927 enable the use of built-in functions that allow more direct access to
14928 the AltiVec instruction set.  You may also need to set
14929 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
14930 enhancements.
14932 @item -mvrsave
14933 @itemx -mno-vrsave
14934 @opindex mvrsave
14935 @opindex mno-vrsave
14936 Generate VRSAVE instructions when generating AltiVec code.
14938 @item -mgen-cell-microcode
14939 @opindex mgen-cell-microcode
14940 Generate Cell microcode instructions
14942 @item -mwarn-cell-microcode
14943 @opindex mwarn-cell-microcode
14944 Warning when a Cell microcode instruction is going to emitted.  An example
14945 of a Cell microcode instruction is a variable shift.
14947 @item -msecure-plt
14948 @opindex msecure-plt
14949 Generate code that allows ld and ld.so to build executables and shared
14950 libraries with non-exec .plt and .got sections.  This is a PowerPC
14951 32-bit SYSV ABI option.
14953 @item -mbss-plt
14954 @opindex mbss-plt
14955 Generate code that uses a BSS .plt section that ld.so fills in, and
14956 requires .plt and .got sections that are both writable and executable.
14957 This is a PowerPC 32-bit SYSV ABI option.
14959 @item -misel
14960 @itemx -mno-isel
14961 @opindex misel
14962 @opindex mno-isel
14963 This switch enables or disables the generation of ISEL instructions.
14965 @item -misel=@var{yes/no}
14966 This switch has been deprecated.  Use @option{-misel} and
14967 @option{-mno-isel} instead.
14969 @item -mspe
14970 @itemx -mno-spe
14971 @opindex mspe
14972 @opindex mno-spe
14973 This switch enables or disables the generation of SPE simd
14974 instructions.
14976 @item -mpaired
14977 @itemx -mno-paired
14978 @opindex mpaired
14979 @opindex mno-paired
14980 This switch enables or disables the generation of PAIRED simd
14981 instructions.
14983 @item -mspe=@var{yes/no}
14984 This option has been deprecated.  Use @option{-mspe} and
14985 @option{-mno-spe} instead.
14987 @item -mvsx
14988 @itemx -mno-vsx
14989 @opindex mvsx
14990 @opindex mno-vsx
14991 Generate code that uses (does not use) vector/scalar (VSX)
14992 instructions, and also enable the use of built-in functions that allow
14993 more direct access to the VSX instruction set.
14995 @item -mfloat-gprs=@var{yes/single/double/no}
14996 @itemx -mfloat-gprs
14997 @opindex mfloat-gprs
14998 This switch enables or disables the generation of floating point
14999 operations on the general purpose registers for architectures that
15000 support it.
15002 The argument @var{yes} or @var{single} enables the use of
15003 single-precision floating point operations.
15005 The argument @var{double} enables the use of single and
15006 double-precision floating point operations.
15008 The argument @var{no} disables floating point operations on the
15009 general purpose registers.
15011 This option is currently only available on the MPC854x.
15013 @item -m32
15014 @itemx -m64
15015 @opindex m32
15016 @opindex m64
15017 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
15018 targets (including GNU/Linux).  The 32-bit environment sets int, long
15019 and pointer to 32 bits and generates code that runs on any PowerPC
15020 variant.  The 64-bit environment sets int to 32 bits and long and
15021 pointer to 64 bits, and generates code for PowerPC64, as for
15022 @option{-mpowerpc64}.
15024 @item -mfull-toc
15025 @itemx -mno-fp-in-toc
15026 @itemx -mno-sum-in-toc
15027 @itemx -mminimal-toc
15028 @opindex mfull-toc
15029 @opindex mno-fp-in-toc
15030 @opindex mno-sum-in-toc
15031 @opindex mminimal-toc
15032 Modify generation of the TOC (Table Of Contents), which is created for
15033 every executable file.  The @option{-mfull-toc} option is selected by
15034 default.  In that case, GCC will allocate at least one TOC entry for
15035 each unique non-automatic variable reference in your program.  GCC
15036 will also place floating-point constants in the TOC@.  However, only
15037 16,384 entries are available in the TOC@.
15039 If you receive a linker error message that saying you have overflowed
15040 the available TOC space, you can reduce the amount of TOC space used
15041 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
15042 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
15043 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
15044 generate code to calculate the sum of an address and a constant at
15045 run-time instead of putting that sum into the TOC@.  You may specify one
15046 or both of these options.  Each causes GCC to produce very slightly
15047 slower and larger code at the expense of conserving TOC space.
15049 If you still run out of space in the TOC even when you specify both of
15050 these options, specify @option{-mminimal-toc} instead.  This option causes
15051 GCC to make only one TOC entry for every file.  When you specify this
15052 option, GCC will produce code that is slower and larger but which
15053 uses extremely little TOC space.  You may wish to use this option
15054 only on files that contain less frequently executed code.
15056 @item -maix64
15057 @itemx -maix32
15058 @opindex maix64
15059 @opindex maix32
15060 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
15061 @code{long} type, and the infrastructure needed to support them.
15062 Specifying @option{-maix64} implies @option{-mpowerpc64} and
15063 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
15064 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
15066 @item -mxl-compat
15067 @itemx -mno-xl-compat
15068 @opindex mxl-compat
15069 @opindex mno-xl-compat
15070 Produce code that conforms more closely to IBM XL compiler semantics
15071 when using AIX-compatible ABI@.  Pass floating-point arguments to
15072 prototyped functions beyond the register save area (RSA) on the stack
15073 in addition to argument FPRs.  Do not assume that most significant
15074 double in 128-bit long double value is properly rounded when comparing
15075 values and converting to double.  Use XL symbol names for long double
15076 support routines.
15078 The AIX calling convention was extended but not initially documented to
15079 handle an obscure K&R C case of calling a function that takes the
15080 address of its arguments with fewer arguments than declared.  IBM XL
15081 compilers access floating point arguments which do not fit in the
15082 RSA from the stack when a subroutine is compiled without
15083 optimization.  Because always storing floating-point arguments on the
15084 stack is inefficient and rarely needed, this option is not enabled by
15085 default and only is necessary when calling subroutines compiled by IBM
15086 XL compilers without optimization.
15088 @item -mpe
15089 @opindex mpe
15090 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
15091 application written to use message passing with special startup code to
15092 enable the application to run.  The system must have PE installed in the
15093 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
15094 must be overridden with the @option{-specs=} option to specify the
15095 appropriate directory location.  The Parallel Environment does not
15096 support threads, so the @option{-mpe} option and the @option{-pthread}
15097 option are incompatible.
15099 @item -malign-natural
15100 @itemx -malign-power
15101 @opindex malign-natural
15102 @opindex malign-power
15103 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
15104 @option{-malign-natural} overrides the ABI-defined alignment of larger
15105 types, such as floating-point doubles, on their natural size-based boundary.
15106 The option @option{-malign-power} instructs GCC to follow the ABI-specified
15107 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
15109 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
15110 is not supported.
15112 @item -msoft-float
15113 @itemx -mhard-float
15114 @opindex msoft-float
15115 @opindex mhard-float
15116 Generate code that does not use (uses) the floating-point register set.
15117 Software floating point emulation is provided if you use the
15118 @option{-msoft-float} option, and pass the option to GCC when linking.
15120 @item -msingle-float
15121 @itemx -mdouble-float
15122 @opindex msingle-float
15123 @opindex mdouble-float
15124 Generate code for single or double-precision floating point operations.
15125 @option{-mdouble-float} implies @option{-msingle-float}.
15127 @item -msimple-fpu
15128 @opindex msimple-fpu
15129 Do not generate sqrt and div instructions for hardware floating point unit.
15131 @item -mfpu
15132 @opindex mfpu
15133 Specify type of floating point unit.  Valid values are @var{sp_lite}
15134 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
15135 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
15136 and @var{dp_full} (equivalent to -mdouble-float).
15138 @item -mxilinx-fpu
15139 @opindex mxilinx-fpu
15140 Perform optimizations for floating point unit on Xilinx PPC 405/440.
15142 @item -mmultiple
15143 @itemx -mno-multiple
15144 @opindex mmultiple
15145 @opindex mno-multiple
15146 Generate code that uses (does not use) the load multiple word
15147 instructions and the store multiple word instructions.  These
15148 instructions are generated by default on POWER systems, and not
15149 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
15150 endian PowerPC systems, since those instructions do not work when the
15151 processor is in little endian mode.  The exceptions are PPC740 and
15152 PPC750 which permit the instructions usage in little endian mode.
15154 @item -mstring
15155 @itemx -mno-string
15156 @opindex mstring
15157 @opindex mno-string
15158 Generate code that uses (does not use) the load string instructions
15159 and the store string word instructions to save multiple registers and
15160 do small block moves.  These instructions are generated by default on
15161 POWER systems, and not generated on PowerPC systems.  Do not use
15162 @option{-mstring} on little endian PowerPC systems, since those
15163 instructions do not work when the processor is in little endian mode.
15164 The exceptions are PPC740 and PPC750 which permit the instructions
15165 usage in little endian mode.
15167 @item -mupdate
15168 @itemx -mno-update
15169 @opindex mupdate
15170 @opindex mno-update
15171 Generate code that uses (does not use) the load or store instructions
15172 that update the base register to the address of the calculated memory
15173 location.  These instructions are generated by default.  If you use
15174 @option{-mno-update}, there is a small window between the time that the
15175 stack pointer is updated and the address of the previous frame is
15176 stored, which means code that walks the stack frame across interrupts or
15177 signals may get corrupted data.
15179 @item -mavoid-indexed-addresses
15180 @itemx -mno-avoid-indexed-addresses
15181 @opindex mavoid-indexed-addresses
15182 @opindex mno-avoid-indexed-addresses
15183 Generate code that tries to avoid (not avoid) the use of indexed load
15184 or store instructions. These instructions can incur a performance
15185 penalty on Power6 processors in certain situations, such as when
15186 stepping through large arrays that cross a 16M boundary.  This option
15187 is enabled by default when targetting Power6 and disabled otherwise.
15189 @item -mfused-madd
15190 @itemx -mno-fused-madd
15191 @opindex mfused-madd
15192 @opindex mno-fused-madd
15193 Generate code that uses (does not use) the floating point multiply and
15194 accumulate instructions.  These instructions are generated by default if
15195 hardware floating is used.
15197 @item -mmulhw
15198 @itemx -mno-mulhw
15199 @opindex mmulhw
15200 @opindex mno-mulhw
15201 Generate code that uses (does not use) the half-word multiply and
15202 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15203 These instructions are generated by default when targetting those
15204 processors.
15206 @item -mdlmzb
15207 @itemx -mno-dlmzb
15208 @opindex mdlmzb
15209 @opindex mno-dlmzb
15210 Generate code that uses (does not use) the string-search @samp{dlmzb}
15211 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
15212 generated by default when targetting those processors.
15214 @item -mno-bit-align
15215 @itemx -mbit-align
15216 @opindex mno-bit-align
15217 @opindex mbit-align
15218 On System V.4 and embedded PowerPC systems do not (do) force structures
15219 and unions that contain bit-fields to be aligned to the base type of the
15220 bit-field.
15222 For example, by default a structure containing nothing but 8
15223 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15224 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
15225 the structure would be aligned to a 1 byte boundary and be one byte in
15226 size.
15228 @item -mno-strict-align
15229 @itemx -mstrict-align
15230 @opindex mno-strict-align
15231 @opindex mstrict-align
15232 On System V.4 and embedded PowerPC systems do not (do) assume that
15233 unaligned memory references will be handled by the system.
15235 @item -mrelocatable
15236 @itemx -mno-relocatable
15237 @opindex mrelocatable
15238 @opindex mno-relocatable
15239 On embedded PowerPC systems generate code that allows (does not allow)
15240 the program to be relocated to a different address at runtime.  If you
15241 use @option{-mrelocatable} on any module, all objects linked together must
15242 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
15244 @item -mrelocatable-lib
15245 @itemx -mno-relocatable-lib
15246 @opindex mrelocatable-lib
15247 @opindex mno-relocatable-lib
15248 On embedded PowerPC systems generate code that allows (does not allow)
15249 the program to be relocated to a different address at runtime.  Modules
15250 compiled with @option{-mrelocatable-lib} can be linked with either modules
15251 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
15252 with modules compiled with the @option{-mrelocatable} options.
15254 @item -mno-toc
15255 @itemx -mtoc
15256 @opindex mno-toc
15257 @opindex mtoc
15258 On System V.4 and embedded PowerPC systems do not (do) assume that
15259 register 2 contains a pointer to a global area pointing to the addresses
15260 used in the program.
15262 @item -mlittle
15263 @itemx -mlittle-endian
15264 @opindex mlittle
15265 @opindex mlittle-endian
15266 On System V.4 and embedded PowerPC systems compile code for the
15267 processor in little endian mode.  The @option{-mlittle-endian} option is
15268 the same as @option{-mlittle}.
15270 @item -mbig
15271 @itemx -mbig-endian
15272 @opindex mbig
15273 @opindex mbig-endian
15274 On System V.4 and embedded PowerPC systems compile code for the
15275 processor in big endian mode.  The @option{-mbig-endian} option is
15276 the same as @option{-mbig}.
15278 @item -mdynamic-no-pic
15279 @opindex mdynamic-no-pic
15280 On Darwin and Mac OS X systems, compile code so that it is not
15281 relocatable, but that its external references are relocatable.  The
15282 resulting code is suitable for applications, but not shared
15283 libraries.
15285 @item -mprioritize-restricted-insns=@var{priority}
15286 @opindex mprioritize-restricted-insns
15287 This option controls the priority that is assigned to
15288 dispatch-slot restricted instructions during the second scheduling
15289 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
15290 @var{no/highest/second-highest} priority to dispatch slot restricted
15291 instructions.
15293 @item -msched-costly-dep=@var{dependence_type}
15294 @opindex msched-costly-dep
15295 This option controls which dependences are considered costly
15296 by the target during instruction scheduling.  The argument
15297 @var{dependence_type} takes one of the following values:
15298 @var{no}: no dependence is costly,
15299 @var{all}: all dependences are costly,
15300 @var{true_store_to_load}: a true dependence from store to load is costly,
15301 @var{store_to_load}: any dependence from store to load is costly,
15302 @var{number}: any dependence which latency >= @var{number} is costly.
15304 @item -minsert-sched-nops=@var{scheme}
15305 @opindex minsert-sched-nops
15306 This option controls which nop insertion scheme will be used during
15307 the second scheduling pass.  The argument @var{scheme} takes one of the
15308 following values:
15309 @var{no}: Don't insert nops.
15310 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15311 according to the scheduler's grouping.
15312 @var{regroup_exact}: Insert nops to force costly dependent insns into
15313 separate groups.  Insert exactly as many nops as needed to force an insn
15314 to a new group, according to the estimated processor grouping.
15315 @var{number}: Insert nops to force costly dependent insns into
15316 separate groups.  Insert @var{number} nops to force an insn to a new group.
15318 @item -mcall-sysv
15319 @opindex mcall-sysv
15320 On System V.4 and embedded PowerPC systems compile code using calling
15321 conventions that adheres to the March 1995 draft of the System V
15322 Application Binary Interface, PowerPC processor supplement.  This is the
15323 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15325 @item -mcall-sysv-eabi
15326 @itemx -mcall-eabi
15327 @opindex mcall-sysv-eabi
15328 @opindex mcall-eabi
15329 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15331 @item -mcall-sysv-noeabi
15332 @opindex mcall-sysv-noeabi
15333 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15335 @item -mcall-aixdesc
15336 @opindex m
15337 On System V.4 and embedded PowerPC systems compile code for the AIX
15338 operating system.
15340 @item -mcall-linux
15341 @opindex mcall-linux
15342 On System V.4 and embedded PowerPC systems compile code for the
15343 Linux-based GNU system.
15345 @item -mcall-gnu
15346 @opindex mcall-gnu
15347 On System V.4 and embedded PowerPC systems compile code for the
15348 Hurd-based GNU system.
15350 @item -mcall-freebsd
15351 @opindex mcall-freebsd
15352 On System V.4 and embedded PowerPC systems compile code for the
15353 FreeBSD operating system.
15355 @item -mcall-netbsd
15356 @opindex mcall-netbsd
15357 On System V.4 and embedded PowerPC systems compile code for the
15358 NetBSD operating system.
15360 @item -mcall-openbsd
15361 @opindex mcall-netbsd
15362 On System V.4 and embedded PowerPC systems compile code for the
15363 OpenBSD operating system.
15365 @item -maix-struct-return
15366 @opindex maix-struct-return
15367 Return all structures in memory (as specified by the AIX ABI)@.
15369 @item -msvr4-struct-return
15370 @opindex msvr4-struct-return
15371 Return structures smaller than 8 bytes in registers (as specified by the
15372 SVR4 ABI)@.
15374 @item -mabi=@var{abi-type}
15375 @opindex mabi
15376 Extend the current ABI with a particular extension, or remove such extension.
15377 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
15378 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
15380 @item -mabi=spe
15381 @opindex mabi=spe
15382 Extend the current ABI with SPE ABI extensions.  This does not change
15383 the default ABI, instead it adds the SPE ABI extensions to the current
15384 ABI@.
15386 @item -mabi=no-spe
15387 @opindex mabi=no-spe
15388 Disable Booke SPE ABI extensions for the current ABI@.
15390 @item -mabi=ibmlongdouble
15391 @opindex mabi=ibmlongdouble
15392 Change the current ABI to use IBM extended precision long double.
15393 This is a PowerPC 32-bit SYSV ABI option.
15395 @item -mabi=ieeelongdouble
15396 @opindex mabi=ieeelongdouble
15397 Change the current ABI to use IEEE extended precision long double.
15398 This is a PowerPC 32-bit Linux ABI option.
15400 @item -mprototype
15401 @itemx -mno-prototype
15402 @opindex mprototype
15403 @opindex mno-prototype
15404 On System V.4 and embedded PowerPC systems assume that all calls to
15405 variable argument functions are properly prototyped.  Otherwise, the
15406 compiler must insert an instruction before every non prototyped call to
15407 set or clear bit 6 of the condition code register (@var{CR}) to
15408 indicate whether floating point values were passed in the floating point
15409 registers in case the function takes a variable arguments.  With
15410 @option{-mprototype}, only calls to prototyped variable argument functions
15411 will set or clear the bit.
15413 @item -msim
15414 @opindex msim
15415 On embedded PowerPC systems, assume that the startup module is called
15416 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
15417 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
15418 configurations.
15420 @item -mmvme
15421 @opindex mmvme
15422 On embedded PowerPC systems, assume that the startup module is called
15423 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
15424 @file{libc.a}.
15426 @item -mads
15427 @opindex mads
15428 On embedded PowerPC systems, assume that the startup module is called
15429 @file{crt0.o} and the standard C libraries are @file{libads.a} and
15430 @file{libc.a}.
15432 @item -myellowknife
15433 @opindex myellowknife
15434 On embedded PowerPC systems, assume that the startup module is called
15435 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
15436 @file{libc.a}.
15438 @item -mvxworks
15439 @opindex mvxworks
15440 On System V.4 and embedded PowerPC systems, specify that you are
15441 compiling for a VxWorks system.
15443 @item -memb
15444 @opindex memb
15445 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
15446 header to indicate that @samp{eabi} extended relocations are used.
15448 @item -meabi
15449 @itemx -mno-eabi
15450 @opindex meabi
15451 @opindex mno-eabi
15452 On System V.4 and embedded PowerPC systems do (do not) adhere to the
15453 Embedded Applications Binary Interface (eabi) which is a set of
15454 modifications to the System V.4 specifications.  Selecting @option{-meabi}
15455 means that the stack is aligned to an 8 byte boundary, a function
15456 @code{__eabi} is called to from @code{main} to set up the eabi
15457 environment, and the @option{-msdata} option can use both @code{r2} and
15458 @code{r13} to point to two separate small data areas.  Selecting
15459 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
15460 do not call an initialization function from @code{main}, and the
15461 @option{-msdata} option will only use @code{r13} to point to a single
15462 small data area.  The @option{-meabi} option is on by default if you
15463 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
15465 @item -msdata=eabi
15466 @opindex msdata=eabi
15467 On System V.4 and embedded PowerPC systems, put small initialized
15468 @code{const} global and static data in the @samp{.sdata2} section, which
15469 is pointed to by register @code{r2}.  Put small initialized
15470 non-@code{const} global and static data in the @samp{.sdata} section,
15471 which is pointed to by register @code{r13}.  Put small uninitialized
15472 global and static data in the @samp{.sbss} section, which is adjacent to
15473 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
15474 incompatible with the @option{-mrelocatable} option.  The
15475 @option{-msdata=eabi} option also sets the @option{-memb} option.
15477 @item -msdata=sysv
15478 @opindex msdata=sysv
15479 On System V.4 and embedded PowerPC systems, put small global and static
15480 data in the @samp{.sdata} section, which is pointed to by register
15481 @code{r13}.  Put small uninitialized global and static data in the
15482 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15483 The @option{-msdata=sysv} option is incompatible with the
15484 @option{-mrelocatable} option.
15486 @item -msdata=default
15487 @itemx -msdata
15488 @opindex msdata=default
15489 @opindex msdata
15490 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15491 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15492 same as @option{-msdata=sysv}.
15494 @item -msdata=data
15495 @opindex msdata=data
15496 On System V.4 and embedded PowerPC systems, put small global
15497 data in the @samp{.sdata} section.  Put small uninitialized global
15498 data in the @samp{.sbss} section.  Do not use register @code{r13}
15499 to address small data however.  This is the default behavior unless
15500 other @option{-msdata} options are used.
15502 @item -msdata=none
15503 @itemx -mno-sdata
15504 @opindex msdata=none
15505 @opindex mno-sdata
15506 On embedded PowerPC systems, put all initialized global and static data
15507 in the @samp{.data} section, and all uninitialized data in the
15508 @samp{.bss} section.
15510 @item -G @var{num}
15511 @opindex G
15512 @cindex smaller data references (PowerPC)
15513 @cindex .sdata/.sdata2 references (PowerPC)
15514 On embedded PowerPC systems, put global and static items less than or
15515 equal to @var{num} bytes into the small data or bss sections instead of
15516 the normal data or bss section.  By default, @var{num} is 8.  The
15517 @option{-G @var{num}} switch is also passed to the linker.
15518 All modules should be compiled with the same @option{-G @var{num}} value.
15520 @item -mregnames
15521 @itemx -mno-regnames
15522 @opindex mregnames
15523 @opindex mno-regnames
15524 On System V.4 and embedded PowerPC systems do (do not) emit register
15525 names in the assembly language output using symbolic forms.
15527 @item -mlongcall
15528 @itemx -mno-longcall
15529 @opindex mlongcall
15530 @opindex mno-longcall
15531 By default assume that all calls are far away so that a longer more
15532 expensive calling sequence is required.  This is required for calls
15533 further than 32 megabytes (33,554,432 bytes) from the current location.
15534 A short call will be generated if the compiler knows
15535 the call cannot be that far away.  This setting can be overridden by
15536 the @code{shortcall} function attribute, or by @code{#pragma
15537 longcall(0)}.
15539 Some linkers are capable of detecting out-of-range calls and generating
15540 glue code on the fly.  On these systems, long calls are unnecessary and
15541 generate slower code.  As of this writing, the AIX linker can do this,
15542 as can the GNU linker for PowerPC/64.  It is planned to add this feature
15543 to the GNU linker for 32-bit PowerPC systems as well.
15545 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
15546 callee, L42'', plus a ``branch island'' (glue code).  The two target
15547 addresses represent the callee and the ``branch island''.  The
15548 Darwin/PPC linker will prefer the first address and generate a ``bl
15549 callee'' if the PPC ``bl'' instruction will reach the callee directly;
15550 otherwise, the linker will generate ``bl L42'' to call the ``branch
15551 island''.  The ``branch island'' is appended to the body of the
15552 calling function; it computes the full 32-bit address of the callee
15553 and jumps to it.
15555 On Mach-O (Darwin) systems, this option directs the compiler emit to
15556 the glue for every direct call, and the Darwin linker decides whether
15557 to use or discard it.
15559 In the future, we may cause GCC to ignore all longcall specifications
15560 when the linker is known to generate glue.
15562 @item -mtls-markers
15563 @itemx -mno-tls-markers
15564 @opindex mtls-markers
15565 @opindex mno-tls-markers
15566 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
15567 specifying the function argument.  The relocation allows ld to
15568 reliably associate function call with argument setup instructions for
15569 TLS optimization, which in turn allows gcc to better schedule the
15570 sequence.
15572 @item -pthread
15573 @opindex pthread
15574 Adds support for multithreading with the @dfn{pthreads} library.
15575 This option sets flags for both the preprocessor and linker.
15577 @end table
15579 @node RX Options
15580 @subsection RX Options
15581 @cindex RX Options
15583 These command line options are defined for RX targets:
15585 @table @gcctabopt
15586 @item -m64bit-doubles
15587 @itemx -m32bit-doubles
15588 @opindex m64bit-doubles
15589 @opindex m32bit-doubles
15590 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
15591 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
15592 @option{-m32bit-doubles}.  @emph{Note} RX floating point hardware only
15593 works on 32-bit values, which is why the default is
15594 @option{-m32bit-doubles}.
15596 @item -fpu
15597 @itemx -nofpu
15598 @opindex fpu
15599 @opindex nofpu
15600 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
15601 floating point hardware.  The default is enabled for the @var{RX600}
15602 series and disabled for the @var{RX200} series.
15604 Floating point instructions will only be generated for 32-bit floating
15605 point values however, so if the @option{-m64bit-doubles} option is in
15606 use then the FPU hardware will not be used for doubles.
15608 @emph{Note} If the @option{-fpu} option is enabled then
15609 @option{-funsafe-math-optimizations} is also enabled automatically.
15610 This is because the RX FPU instructions are themselves unsafe.
15612 @item -mcpu=@var{name}
15613 @itemx -patch=@var{name}
15614 @opindex -mcpu
15615 @opindex -patch
15616 Selects the type of RX CPU to be targeted.  Currently three types are
15617 supported, the generic @var{RX600} and @var{RX200} series hardware and
15618 the specific @var{RX610} cpu.  The default is @var{RX600}.
15620 The only difference between @var{RX600} and @var{RX610} is that the
15621 @var{RX610} does not support the @code{MVTIPL} instruction.
15623 The @var{RX200} series does not have a hardware floating point unit
15624 and so @option{-nofpu} is enabled by default when this type is
15625 selected.
15627 @item -mbig-endian-data
15628 @itemx -mlittle-endian-data
15629 @opindex mbig-endian-data
15630 @opindex mlittle-endian-data
15631 Store data (but not code) in the big-endian format.  The default is
15632 @option{-mlittle-endian-data}, ie to store data in the little endian
15633 format.
15635 @item -msmall-data-limit=@var{N}
15636 @opindex msmall-data-limit
15637 Specifies the maximum size in bytes of global and static variables
15638 which can be placed into the small data area.  Using the small data
15639 area can lead to smaller and faster code, but the size of area is
15640 limited and it is up to the programmer to ensure that the area does
15641 not overflow.  Also when the small data area is used one of the RX's
15642 registers (@code{r13}) is reserved for use pointing to this area, so
15643 it is no longer available for use by the compiler.  This could result
15644 in slower and/or larger code if variables which once could have been
15645 held in @code{r13} are now pushed onto the stack.
15647 Note, common variables (variables which have not been initialised) and
15648 constants are not placed into the small data area as they are assigned
15649 to other sections in the output executable.
15651 The default value is zero, which disables this feature.  Note, this
15652 feature is not enabled by default with higher optimization levels
15653 (@option{-O2} etc) because of the potentially detrimental effects of
15654 reserving register @code{r13}.  It is up to the programmer to
15655 experiment and discover whether this feature is of benefit to their
15656 program.
15658 @item -msim
15659 @itemx -mno-sim
15660 @opindex msim
15661 @opindex mno-sim
15662 Use the simulator runtime.  The default is to use the libgloss board
15663 specific runtime.
15665 @item -mas100-syntax
15666 @itemx -mno-as100-syntax
15667 @opindex mas100-syntax
15668 @opindex mno-as100-syntax
15669 When generating assembler output use a syntax that is compatible with
15670 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
15671 assembler but it has some restrictions so generating it is not the
15672 default option.
15674 @item -mmax-constant-size=@var{N}
15675 @opindex mmax-constant-size
15676 Specifies the maximum size, in bytes, of a constant that can be used as
15677 an operand in a RX instruction.  Although the RX instruction set does
15678 allow constants of up to 4 bytes in length to be used in instructions,
15679 a longer value equates to a longer instruction.  Thus in some
15680 circumstances it can be beneficial to restrict the size of constants
15681 that are used in instructions.  Constants that are too big are instead
15682 placed into a constant pool and referenced via register indirection.
15684 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
15685 or 4 means that constants of any size are allowed.
15687 @item -mrelax
15688 @opindex mrelax
15689 Enable linker relaxation.  Linker relaxation is a process whereby the
15690 linker will attempt to reduce the size of a program by finding shorter
15691 versions of various instructions.  Disabled by default.
15693 @item -mint-register=@var{N}
15694 @opindex mint-register
15695 Specify the number of registers to reserve for fast interrupt handler
15696 functions.  The value @var{N} can be between 0 and 4.  A value of 1
15697 means that register @code{r13} will be reserved for the exclusive use
15698 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
15699 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
15700 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
15701 A value of 0, the default, does not reserve any registers.
15703 @item -msave-acc-in-interrupts
15704 @opindex msave-acc-in-interrupts
15705 Specifies that interrupt handler functions should preserve the
15706 accumulator register.  This is only necessary if normal code might use
15707 the accumulator register, for example because it performs 64-bit
15708 multiplications.  The default is to ignore the accumulator as this
15709 makes the interrupt handlers faster.
15711 @end table
15713 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
15714 has special significance to the RX port when used with the
15715 @code{interrupt} function attribute.  This attribute indicates a
15716 function intended to process fast interrupts.  GCC will will ensure
15717 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
15718 and/or @code{r13} and only provided that the normal use of the
15719 corresponding registers have been restricted via the
15720 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
15721 options.
15723 @node S/390 and zSeries Options
15724 @subsection S/390 and zSeries Options
15725 @cindex S/390 and zSeries Options
15727 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
15729 @table @gcctabopt
15730 @item -mhard-float
15731 @itemx -msoft-float
15732 @opindex mhard-float
15733 @opindex msoft-float
15734 Use (do not use) the hardware floating-point instructions and registers
15735 for floating-point operations.  When @option{-msoft-float} is specified,
15736 functions in @file{libgcc.a} will be used to perform floating-point
15737 operations.  When @option{-mhard-float} is specified, the compiler
15738 generates IEEE floating-point instructions.  This is the default.
15740 @item -mhard-dfp
15741 @itemx -mno-hard-dfp
15742 @opindex mhard-dfp
15743 @opindex mno-hard-dfp
15744 Use (do not use) the hardware decimal-floating-point instructions for
15745 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
15746 specified, functions in @file{libgcc.a} will be used to perform
15747 decimal-floating-point operations.  When @option{-mhard-dfp} is
15748 specified, the compiler generates decimal-floating-point hardware
15749 instructions.  This is the default for @option{-march=z9-ec} or higher.
15751 @item -mlong-double-64
15752 @itemx -mlong-double-128
15753 @opindex mlong-double-64
15754 @opindex mlong-double-128
15755 These switches control the size of @code{long double} type. A size
15756 of 64bit makes the @code{long double} type equivalent to the @code{double}
15757 type. This is the default.
15759 @item -mbackchain
15760 @itemx -mno-backchain
15761 @opindex mbackchain
15762 @opindex mno-backchain
15763 Store (do not store) the address of the caller's frame as backchain pointer
15764 into the callee's stack frame.
15765 A backchain may be needed to allow debugging using tools that do not understand
15766 DWARF-2 call frame information.
15767 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
15768 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
15769 the backchain is placed into the topmost word of the 96/160 byte register
15770 save area.
15772 In general, code compiled with @option{-mbackchain} is call-compatible with
15773 code compiled with @option{-mmo-backchain}; however, use of the backchain
15774 for debugging purposes usually requires that the whole binary is built with
15775 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
15776 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15777 to build a linux kernel use @option{-msoft-float}.
15779 The default is to not maintain the backchain.
15781 @item -mpacked-stack
15782 @itemx -mno-packed-stack
15783 @opindex mpacked-stack
15784 @opindex mno-packed-stack
15785 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
15786 specified, the compiler uses the all fields of the 96/160 byte register save
15787 area only for their default purpose; unused fields still take up stack space.
15788 When @option{-mpacked-stack} is specified, register save slots are densely
15789 packed at the top of the register save area; unused space is reused for other
15790 purposes, allowing for more efficient use of the available stack space.
15791 However, when @option{-mbackchain} is also in effect, the topmost word of
15792 the save area is always used to store the backchain, and the return address
15793 register is always saved two words below the backchain.
15795 As long as the stack frame backchain is not used, code generated with
15796 @option{-mpacked-stack} is call-compatible with code generated with
15797 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
15798 S/390 or zSeries generated code that uses the stack frame backchain at run
15799 time, not just for debugging purposes.  Such code is not call-compatible
15800 with code compiled with @option{-mpacked-stack}.  Also, note that the
15801 combination of @option{-mbackchain},
15802 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15803 to build a linux kernel use @option{-msoft-float}.
15805 The default is to not use the packed stack layout.
15807 @item -msmall-exec
15808 @itemx -mno-small-exec
15809 @opindex msmall-exec
15810 @opindex mno-small-exec
15811 Generate (or do not generate) code using the @code{bras} instruction
15812 to do subroutine calls.
15813 This only works reliably if the total executable size does not
15814 exceed 64k.  The default is to use the @code{basr} instruction instead,
15815 which does not have this limitation.
15817 @item -m64
15818 @itemx -m31
15819 @opindex m64
15820 @opindex m31
15821 When @option{-m31} is specified, generate code compliant to the
15822 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
15823 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
15824 particular to generate 64-bit instructions.  For the @samp{s390}
15825 targets, the default is @option{-m31}, while the @samp{s390x}
15826 targets default to @option{-m64}.
15828 @item -mzarch
15829 @itemx -mesa
15830 @opindex mzarch
15831 @opindex mesa
15832 When @option{-mzarch} is specified, generate code using the
15833 instructions available on z/Architecture.
15834 When @option{-mesa} is specified, generate code using the
15835 instructions available on ESA/390.  Note that @option{-mesa} is
15836 not possible with @option{-m64}.
15837 When generating code compliant to the GNU/Linux for S/390 ABI,
15838 the default is @option{-mesa}.  When generating code compliant
15839 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
15841 @item -mmvcle
15842 @itemx -mno-mvcle
15843 @opindex mmvcle
15844 @opindex mno-mvcle
15845 Generate (or do not generate) code using the @code{mvcle} instruction
15846 to perform block moves.  When @option{-mno-mvcle} is specified,
15847 use a @code{mvc} loop instead.  This is the default unless optimizing for
15848 size.
15850 @item -mdebug
15851 @itemx -mno-debug
15852 @opindex mdebug
15853 @opindex mno-debug
15854 Print (or do not print) additional debug information when compiling.
15855 The default is to not print debug information.
15857 @item -march=@var{cpu-type}
15858 @opindex march
15859 Generate code that will run on @var{cpu-type}, which is the name of a system
15860 representing a certain processor type.  Possible values for
15861 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
15862 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
15863 When generating code using the instructions available on z/Architecture,
15864 the default is @option{-march=z900}.  Otherwise, the default is
15865 @option{-march=g5}.
15867 @item -mtune=@var{cpu-type}
15868 @opindex mtune
15869 Tune to @var{cpu-type} everything applicable about the generated code,
15870 except for the ABI and the set of available instructions.
15871 The list of @var{cpu-type} values is the same as for @option{-march}.
15872 The default is the value used for @option{-march}.
15874 @item -mtpf-trace
15875 @itemx -mno-tpf-trace
15876 @opindex mtpf-trace
15877 @opindex mno-tpf-trace
15878 Generate code that adds (does not add) in TPF OS specific branches to trace
15879 routines in the operating system.  This option is off by default, even
15880 when compiling for the TPF OS@.
15882 @item -mfused-madd
15883 @itemx -mno-fused-madd
15884 @opindex mfused-madd
15885 @opindex mno-fused-madd
15886 Generate code that uses (does not use) the floating point multiply and
15887 accumulate instructions.  These instructions are generated by default if
15888 hardware floating point is used.
15890 @item -mwarn-framesize=@var{framesize}
15891 @opindex mwarn-framesize
15892 Emit a warning if the current function exceeds the given frame size.  Because
15893 this is a compile time check it doesn't need to be a real problem when the program
15894 runs.  It is intended to identify functions which most probably cause
15895 a stack overflow.  It is useful to be used in an environment with limited stack
15896 size e.g.@: the linux kernel.
15898 @item -mwarn-dynamicstack
15899 @opindex mwarn-dynamicstack
15900 Emit a warning if the function calls alloca or uses dynamically
15901 sized arrays.  This is generally a bad idea with a limited stack size.
15903 @item -mstack-guard=@var{stack-guard}
15904 @itemx -mstack-size=@var{stack-size}
15905 @opindex mstack-guard
15906 @opindex mstack-size
15907 If these options are provided the s390 back end emits additional instructions in
15908 the function prologue which trigger a trap if the stack size is @var{stack-guard}
15909 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
15910 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
15911 the frame size of the compiled function is chosen.
15912 These options are intended to be used to help debugging stack overflow problems.
15913 The additionally emitted code causes only little overhead and hence can also be
15914 used in production like systems without greater performance degradation.  The given
15915 values have to be exact powers of 2 and @var{stack-size} has to be greater than
15916 @var{stack-guard} without exceeding 64k.
15917 In order to be efficient the extra code makes the assumption that the stack starts
15918 at an address aligned to the value given by @var{stack-size}.
15919 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
15920 @end table
15922 @node Score Options
15923 @subsection Score Options
15924 @cindex Score Options
15926 These options are defined for Score implementations:
15928 @table @gcctabopt
15929 @item -meb
15930 @opindex meb
15931 Compile code for big endian mode.  This is the default.
15933 @item -mel
15934 @opindex mel
15935 Compile code for little endian mode.
15937 @item -mnhwloop
15938 @opindex mnhwloop
15939 Disable generate bcnz instruction.
15941 @item -muls
15942 @opindex muls
15943 Enable generate unaligned load and store instruction.
15945 @item -mmac
15946 @opindex mmac
15947 Enable the use of multiply-accumulate instructions. Disabled by default.
15949 @item -mscore5
15950 @opindex mscore5
15951 Specify the SCORE5 as the target architecture.
15953 @item -mscore5u
15954 @opindex mscore5u
15955 Specify the SCORE5U of the target architecture.
15957 @item -mscore7
15958 @opindex mscore7
15959 Specify the SCORE7 as the target architecture. This is the default.
15961 @item -mscore7d
15962 @opindex mscore7d
15963 Specify the SCORE7D as the target architecture.
15964 @end table
15966 @node SH Options
15967 @subsection SH Options
15969 These @samp{-m} options are defined for the SH implementations:
15971 @table @gcctabopt
15972 @item -m1
15973 @opindex m1
15974 Generate code for the SH1.
15976 @item -m2
15977 @opindex m2
15978 Generate code for the SH2.
15980 @item -m2e
15981 Generate code for the SH2e.
15983 @item -m2a-nofpu
15984 @opindex m2a-nofpu
15985 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
15986 that the floating-point unit is not used.
15988 @item -m2a-single-only
15989 @opindex m2a-single-only
15990 Generate code for the SH2a-FPU, in such a way that no double-precision
15991 floating point operations are used.
15993 @item -m2a-single
15994 @opindex m2a-single
15995 Generate code for the SH2a-FPU assuming the floating-point unit is in
15996 single-precision mode by default.
15998 @item -m2a
15999 @opindex m2a
16000 Generate code for the SH2a-FPU assuming the floating-point unit is in
16001 double-precision mode by default.
16003 @item -m3
16004 @opindex m3
16005 Generate code for the SH3.
16007 @item -m3e
16008 @opindex m3e
16009 Generate code for the SH3e.
16011 @item -m4-nofpu
16012 @opindex m4-nofpu
16013 Generate code for the SH4 without a floating-point unit.
16015 @item -m4-single-only
16016 @opindex m4-single-only
16017 Generate code for the SH4 with a floating-point unit that only
16018 supports single-precision arithmetic.
16020 @item -m4-single
16021 @opindex m4-single
16022 Generate code for the SH4 assuming the floating-point unit is in
16023 single-precision mode by default.
16025 @item -m4
16026 @opindex m4
16027 Generate code for the SH4.
16029 @item -m4a-nofpu
16030 @opindex m4a-nofpu
16031 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
16032 floating-point unit is not used.
16034 @item -m4a-single-only
16035 @opindex m4a-single-only
16036 Generate code for the SH4a, in such a way that no double-precision
16037 floating point operations are used.
16039 @item -m4a-single
16040 @opindex m4a-single
16041 Generate code for the SH4a assuming the floating-point unit is in
16042 single-precision mode by default.
16044 @item -m4a
16045 @opindex m4a
16046 Generate code for the SH4a.
16048 @item -m4al
16049 @opindex m4al
16050 Same as @option{-m4a-nofpu}, except that it implicitly passes
16051 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
16052 instructions at the moment.
16054 @item -mb
16055 @opindex mb
16056 Compile code for the processor in big endian mode.
16058 @item -ml
16059 @opindex ml
16060 Compile code for the processor in little endian mode.
16062 @item -mdalign
16063 @opindex mdalign
16064 Align doubles at 64-bit boundaries.  Note that this changes the calling
16065 conventions, and thus some functions from the standard C library will
16066 not work unless you recompile it first with @option{-mdalign}.
16068 @item -mrelax
16069 @opindex mrelax
16070 Shorten some address references at link time, when possible; uses the
16071 linker option @option{-relax}.
16073 @item -mbigtable
16074 @opindex mbigtable
16075 Use 32-bit offsets in @code{switch} tables.  The default is to use
16076 16-bit offsets.
16078 @item -mbitops
16079 @opindex mbitops
16080 Enable the use of bit manipulation instructions on SH2A.
16082 @item -mfmovd
16083 @opindex mfmovd
16084 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
16085 alignment constraints.
16087 @item -mhitachi
16088 @opindex mhitachi
16089 Comply with the calling conventions defined by Renesas.
16091 @item -mrenesas
16092 @opindex mhitachi
16093 Comply with the calling conventions defined by Renesas.
16095 @item -mno-renesas
16096 @opindex mhitachi
16097 Comply with the calling conventions defined for GCC before the Renesas
16098 conventions were available.  This option is the default for all
16099 targets of the SH toolchain except for @samp{sh-symbianelf}.
16101 @item -mnomacsave
16102 @opindex mnomacsave
16103 Mark the @code{MAC} register as call-clobbered, even if
16104 @option{-mhitachi} is given.
16106 @item -mieee
16107 @opindex mieee
16108 Increase IEEE-compliance of floating-point code.
16109 At the moment, this is equivalent to @option{-fno-finite-math-only}.
16110 When generating 16 bit SH opcodes, getting IEEE-conforming results for
16111 comparisons of NANs / infinities incurs extra overhead in every
16112 floating point comparison, therefore the default is set to
16113 @option{-ffinite-math-only}.
16115 @item -minline-ic_invalidate
16116 @opindex minline-ic_invalidate
16117 Inline code to invalidate instruction cache entries after setting up
16118 nested function trampolines.
16119 This option has no effect if -musermode is in effect and the selected
16120 code generation option (e.g. -m4) does not allow the use of the icbi
16121 instruction.
16122 If the selected code generation option does not allow the use of the icbi
16123 instruction, and -musermode is not in effect, the inlined code will
16124 manipulate the instruction cache address array directly with an associative
16125 write.  This not only requires privileged mode, but it will also
16126 fail if the cache line had been mapped via the TLB and has become unmapped.
16128 @item -misize
16129 @opindex misize
16130 Dump instruction size and location in the assembly code.
16132 @item -mpadstruct
16133 @opindex mpadstruct
16134 This option is deprecated.  It pads structures to multiple of 4 bytes,
16135 which is incompatible with the SH ABI@.
16137 @item -mspace
16138 @opindex mspace
16139 Optimize for space instead of speed.  Implied by @option{-Os}.
16141 @item -mprefergot
16142 @opindex mprefergot
16143 When generating position-independent code, emit function calls using
16144 the Global Offset Table instead of the Procedure Linkage Table.
16146 @item -musermode
16147 @opindex musermode
16148 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
16149 if the inlined code would not work in user mode.
16150 This is the default when the target is @code{sh-*-linux*}.
16152 @item -multcost=@var{number}
16153 @opindex multcost=@var{number}
16154 Set the cost to assume for a multiply insn.
16156 @item -mdiv=@var{strategy}
16157 @opindex mdiv=@var{strategy}
16158 Set the division strategy to use for SHmedia code.  @var{strategy} must be
16159 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
16160 inv:call2, inv:fp .
16161 "fp" performs the operation in floating point.  This has a very high latency,
16162 but needs only a few instructions, so it might be a good choice if
16163 your code has enough easily exploitable ILP to allow the compiler to
16164 schedule the floating point instructions together with other instructions.
16165 Division by zero causes a floating point exception.
16166 "inv" uses integer operations to calculate the inverse of the divisor,
16167 and then multiplies the dividend with the inverse.  This strategy allows
16168 cse and hoisting of the inverse calculation.  Division by zero calculates
16169 an unspecified result, but does not trap.
16170 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
16171 have been found, or if the entire operation has been hoisted to the same
16172 place, the last stages of the inverse calculation are intertwined with the
16173 final multiply to reduce the overall latency, at the expense of using a few
16174 more instructions, and thus offering fewer scheduling opportunities with
16175 other code.
16176 "call" calls a library function that usually implements the inv:minlat
16177 strategy.
16178 This gives high code density for m5-*media-nofpu compilations.
16179 "call2" uses a different entry point of the same library function, where it
16180 assumes that a pointer to a lookup table has already been set up, which
16181 exposes the pointer load to cse / code hoisting optimizations.
16182 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16183 code generation, but if the code stays unoptimized, revert to the "call",
16184 "call2", or "fp" strategies, respectively.  Note that the
16185 potentially-trapping side effect of division by zero is carried by a
16186 separate instruction, so it is possible that all the integer instructions
16187 are hoisted out, but the marker for the side effect stays where it is.
16188 A recombination to fp operations or a call is not possible in that case.
16189 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
16190 that the inverse calculation was nor separated from the multiply, they speed
16191 up division where the dividend fits into 20 bits (plus sign where applicable),
16192 by inserting a test to skip a number of operations in this case; this test
16193 slows down the case of larger dividends.  inv20u assumes the case of a such
16194 a small dividend to be unlikely, and inv20l assumes it to be likely.
16196 @item -maccumulate-outgoing-args
16197 @opindex maccumulate-outgoing-args
16198 Reserve space once for outgoing arguments in the function prologue rather 
16199 than around each call.  Generally beneficial for performance and size.  Also
16200 needed for unwinding to avoid changing the stack frame around conditional code.
16202 @item -mdivsi3_libfunc=@var{name}
16203 @opindex mdivsi3_libfunc=@var{name}
16204 Set the name of the library function used for 32 bit signed division to
16205 @var{name}.  This only affect the name used in the call and inv:call
16206 division strategies, and the compiler will still expect the same
16207 sets of input/output/clobbered registers as if this option was not present.
16209 @item -mfixed-range=@var{register-range}
16210 @opindex mfixed-range
16211 Generate code treating the given register range as fixed registers.
16212 A fixed register is one that the register allocator can not use.  This is
16213 useful when compiling kernel code.  A register range is specified as
16214 two registers separated by a dash.  Multiple register ranges can be
16215 specified separated by a comma.
16217 @item -madjust-unroll
16218 @opindex madjust-unroll
16219 Throttle unrolling to avoid thrashing target registers.
16220 This option only has an effect if the gcc code base supports the
16221 TARGET_ADJUST_UNROLL_MAX target hook.
16223 @item -mindexed-addressing
16224 @opindex mindexed-addressing
16225 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16226 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16227 semantics for the indexed addressing mode.  The architecture allows the
16228 implementation of processors with 64 bit MMU, which the OS could use to
16229 get 32 bit addressing, but since no current hardware implementation supports
16230 this or any other way to make the indexed addressing mode safe to use in
16231 the 32 bit ABI, the default is -mno-indexed-addressing.
16233 @item -mgettrcost=@var{number}
16234 @opindex mgettrcost=@var{number}
16235 Set the cost assumed for the gettr instruction to @var{number}.
16236 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16238 @item -mpt-fixed
16239 @opindex mpt-fixed
16240 Assume pt* instructions won't trap.  This will generally generate better
16241 scheduled code, but is unsafe on current hardware.  The current architecture
16242 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16243 This has the unintentional effect of making it unsafe to schedule ptabs /
16244 ptrel before a branch, or hoist it out of a loop.  For example,
16245 __do_global_ctors, a part of libgcc that runs constructors at program
16246 startup, calls functions in a list which is delimited by @minus{}1.  With the
16247 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16248 That means that all the constructors will be run a bit quicker, but when
16249 the loop comes to the end of the list, the program crashes because ptabs
16250 loads @minus{}1 into a target register.  Since this option is unsafe for any
16251 hardware implementing the current architecture specification, the default
16252 is -mno-pt-fixed.  Unless the user specifies a specific cost with
16253 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16254 this deters register allocation using target registers for storing
16255 ordinary integers.
16257 @item -minvalid-symbols
16258 @opindex minvalid-symbols
16259 Assume symbols might be invalid.  Ordinary function symbols generated by
16260 the compiler will always be valid to load with movi/shori/ptabs or
16261 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16262 to generate symbols that will cause ptabs / ptrel to trap.
16263 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16264 It will then prevent cross-basic-block cse, hoisting and most scheduling
16265 of symbol loads.  The default is @option{-mno-invalid-symbols}.
16266 @end table
16268 @node SPARC Options
16269 @subsection SPARC Options
16270 @cindex SPARC options
16272 These @samp{-m} options are supported on the SPARC:
16274 @table @gcctabopt
16275 @item -mno-app-regs
16276 @itemx -mapp-regs
16277 @opindex mno-app-regs
16278 @opindex mapp-regs
16279 Specify @option{-mapp-regs} to generate output using the global registers
16280 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
16281 is the default.
16283 To be fully SVR4 ABI compliant at the cost of some performance loss,
16284 specify @option{-mno-app-regs}.  You should compile libraries and system
16285 software with this option.
16287 @item -mfpu
16288 @itemx -mhard-float
16289 @opindex mfpu
16290 @opindex mhard-float
16291 Generate output containing floating point instructions.  This is the
16292 default.
16294 @item -mno-fpu
16295 @itemx -msoft-float
16296 @opindex mno-fpu
16297 @opindex msoft-float
16298 Generate output containing library calls for floating point.
16299 @strong{Warning:} the requisite libraries are not available for all SPARC
16300 targets.  Normally the facilities of the machine's usual C compiler are
16301 used, but this cannot be done directly in cross-compilation.  You must make
16302 your own arrangements to provide suitable library functions for
16303 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
16304 @samp{sparclite-*-*} do provide software floating point support.
16306 @option{-msoft-float} changes the calling convention in the output file;
16307 therefore, it is only useful if you compile @emph{all} of a program with
16308 this option.  In particular, you need to compile @file{libgcc.a}, the
16309 library that comes with GCC, with @option{-msoft-float} in order for
16310 this to work.
16312 @item -mhard-quad-float
16313 @opindex mhard-quad-float
16314 Generate output containing quad-word (long double) floating point
16315 instructions.
16317 @item -msoft-quad-float
16318 @opindex msoft-quad-float
16319 Generate output containing library calls for quad-word (long double)
16320 floating point instructions.  The functions called are those specified
16321 in the SPARC ABI@.  This is the default.
16323 As of this writing, there are no SPARC implementations that have hardware
16324 support for the quad-word floating point instructions.  They all invoke
16325 a trap handler for one of these instructions, and then the trap handler
16326 emulates the effect of the instruction.  Because of the trap handler overhead,
16327 this is much slower than calling the ABI library routines.  Thus the
16328 @option{-msoft-quad-float} option is the default.
16330 @item -mno-unaligned-doubles
16331 @itemx -munaligned-doubles
16332 @opindex mno-unaligned-doubles
16333 @opindex munaligned-doubles
16334 Assume that doubles have 8 byte alignment.  This is the default.
16336 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
16337 alignment only if they are contained in another type, or if they have an
16338 absolute address.  Otherwise, it assumes they have 4 byte alignment.
16339 Specifying this option avoids some rare compatibility problems with code
16340 generated by other compilers.  It is not the default because it results
16341 in a performance loss, especially for floating point code.
16343 @item -mno-faster-structs
16344 @itemx -mfaster-structs
16345 @opindex mno-faster-structs
16346 @opindex mfaster-structs
16347 With @option{-mfaster-structs}, the compiler assumes that structures
16348 should have 8 byte alignment.  This enables the use of pairs of
16349 @code{ldd} and @code{std} instructions for copies in structure
16350 assignment, in place of twice as many @code{ld} and @code{st} pairs.
16351 However, the use of this changed alignment directly violates the SPARC
16352 ABI@.  Thus, it's intended only for use on targets where the developer
16353 acknowledges that their resulting code will not be directly in line with
16354 the rules of the ABI@.
16356 @item -mimpure-text
16357 @opindex mimpure-text
16358 @option{-mimpure-text}, used in addition to @option{-shared}, tells
16359 the compiler to not pass @option{-z text} to the linker when linking a
16360 shared object.  Using this option, you can link position-dependent
16361 code into a shared object.
16363 @option{-mimpure-text} suppresses the ``relocations remain against
16364 allocatable but non-writable sections'' linker error message.
16365 However, the necessary relocations will trigger copy-on-write, and the
16366 shared object is not actually shared across processes.  Instead of
16367 using @option{-mimpure-text}, you should compile all source code with
16368 @option{-fpic} or @option{-fPIC}.
16370 This option is only available on SunOS and Solaris.
16372 @item -mcpu=@var{cpu_type}
16373 @opindex mcpu
16374 Set the instruction set, register set, and instruction scheduling parameters
16375 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
16376 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
16377 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
16378 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
16379 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
16381 Default instruction scheduling parameters are used for values that select
16382 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
16383 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
16385 Here is a list of each supported architecture and their supported
16386 implementations.
16388 @smallexample
16389     v7:             cypress
16390     v8:             supersparc, hypersparc
16391     sparclite:      f930, f934, sparclite86x
16392     sparclet:       tsc701
16393     v9:             ultrasparc, ultrasparc3, niagara, niagara2
16394 @end smallexample
16396 By default (unless configured otherwise), GCC generates code for the V7
16397 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
16398 additionally optimizes it for the Cypress CY7C602 chip, as used in the
16399 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
16400 SPARCStation 1, 2, IPX etc.
16402 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
16403 architecture.  The only difference from V7 code is that the compiler emits
16404 the integer multiply and integer divide instructions which exist in SPARC-V8
16405 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
16406 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
16407 2000 series.
16409 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
16410 the SPARC architecture.  This adds the integer multiply, integer divide step
16411 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
16412 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
16413 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
16414 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
16415 MB86934 chip, which is the more recent SPARClite with FPU@.
16417 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
16418 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
16419 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
16420 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
16421 optimizes it for the TEMIC SPARClet chip.
16423 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
16424 architecture.  This adds 64-bit integer and floating-point move instructions,
16425 3 additional floating-point condition code registers and conditional move
16426 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
16427 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
16428 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
16429 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
16430 @option{-mcpu=niagara}, the compiler additionally optimizes it for
16431 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
16432 additionally optimizes it for Sun UltraSPARC T2 chips.
16434 @item -mtune=@var{cpu_type}
16435 @opindex mtune
16436 Set the instruction scheduling parameters for machine type
16437 @var{cpu_type}, but do not set the instruction set or register set that the
16438 option @option{-mcpu=@var{cpu_type}} would.
16440 The same values for @option{-mcpu=@var{cpu_type}} can be used for
16441 @option{-mtune=@var{cpu_type}}, but the only useful values are those
16442 that select a particular cpu implementation.  Those are @samp{cypress},
16443 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
16444 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
16445 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
16447 @item -mv8plus
16448 @itemx -mno-v8plus
16449 @opindex mv8plus
16450 @opindex mno-v8plus
16451 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
16452 difference from the V8 ABI is that the global and out registers are
16453 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
16454 mode for all SPARC-V9 processors.
16456 @item -mvis
16457 @itemx -mno-vis
16458 @opindex mvis
16459 @opindex mno-vis
16460 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
16461 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
16462 @end table
16464 These @samp{-m} options are supported in addition to the above
16465 on SPARC-V9 processors in 64-bit environments:
16467 @table @gcctabopt
16468 @item -mlittle-endian
16469 @opindex mlittle-endian
16470 Generate code for a processor running in little-endian mode.  It is only
16471 available for a few configurations and most notably not on Solaris and Linux.
16473 @item -m32
16474 @itemx -m64
16475 @opindex m32
16476 @opindex m64
16477 Generate code for a 32-bit or 64-bit environment.
16478 The 32-bit environment sets int, long and pointer to 32 bits.
16479 The 64-bit environment sets int to 32 bits and long and pointer
16480 to 64 bits.
16482 @item -mcmodel=medlow
16483 @opindex mcmodel=medlow
16484 Generate code for the Medium/Low code model: 64-bit addresses, programs
16485 must be linked in the low 32 bits of memory.  Programs can be statically
16486 or dynamically linked.
16488 @item -mcmodel=medmid
16489 @opindex mcmodel=medmid
16490 Generate code for the Medium/Middle code model: 64-bit addresses, programs
16491 must be linked in the low 44 bits of memory, the text and data segments must
16492 be less than 2GB in size and the data segment must be located within 2GB of
16493 the text segment.
16495 @item -mcmodel=medany
16496 @opindex mcmodel=medany
16497 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
16498 may be linked anywhere in memory, the text and data segments must be less
16499 than 2GB in size and the data segment must be located within 2GB of the
16500 text segment.
16502 @item -mcmodel=embmedany
16503 @opindex mcmodel=embmedany
16504 Generate code for the Medium/Anywhere code model for embedded systems:
16505 64-bit addresses, the text and data segments must be less than 2GB in
16506 size, both starting anywhere in memory (determined at link time).  The
16507 global register %g4 points to the base of the data segment.  Programs
16508 are statically linked and PIC is not supported.
16510 @item -mstack-bias
16511 @itemx -mno-stack-bias
16512 @opindex mstack-bias
16513 @opindex mno-stack-bias
16514 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
16515 frame pointer if present, are offset by @minus{}2047 which must be added back
16516 when making stack frame references.  This is the default in 64-bit mode.
16517 Otherwise, assume no such offset is present.
16518 @end table
16520 These switches are supported in addition to the above on Solaris:
16522 @table @gcctabopt
16523 @item -threads
16524 @opindex threads
16525 Add support for multithreading using the Solaris threads library.  This
16526 option sets flags for both the preprocessor and linker.  This option does
16527 not affect the thread safety of object code produced by the compiler or
16528 that of libraries supplied with it.
16530 @item -pthreads
16531 @opindex pthreads
16532 Add support for multithreading using the POSIX threads library.  This
16533 option sets flags for both the preprocessor and linker.  This option does
16534 not affect the thread safety of object code produced  by the compiler or
16535 that of libraries supplied with it.
16537 @item -pthread
16538 @opindex pthread
16539 This is a synonym for @option{-pthreads}.
16540 @end table
16542 @node SPU Options
16543 @subsection SPU Options
16544 @cindex SPU options
16546 These @samp{-m} options are supported on the SPU:
16548 @table @gcctabopt
16549 @item -mwarn-reloc
16550 @itemx -merror-reloc
16551 @opindex mwarn-reloc
16552 @opindex merror-reloc
16554 The loader for SPU does not handle dynamic relocations.  By default, GCC
16555 will give an error when it generates code that requires a dynamic
16556 relocation.  @option{-mno-error-reloc} disables the error,
16557 @option{-mwarn-reloc} will generate a warning instead.
16559 @item -msafe-dma
16560 @itemx -munsafe-dma
16561 @opindex msafe-dma
16562 @opindex munsafe-dma
16564 Instructions which initiate or test completion of DMA must not be
16565 reordered with respect to loads and stores of the memory which is being
16566 accessed.  Users typically address this problem using the volatile
16567 keyword, but that can lead to inefficient code in places where the
16568 memory is known to not change.  Rather than mark the memory as volatile
16569 we treat the DMA instructions as potentially effecting all memory.  With
16570 @option{-munsafe-dma} users must use the volatile keyword to protect
16571 memory accesses.
16573 @item -mbranch-hints
16574 @opindex mbranch-hints
16576 By default, GCC will generate a branch hint instruction to avoid
16577 pipeline stalls for always taken or probably taken branches.  A hint
16578 will not be generated closer than 8 instructions away from its branch.
16579 There is little reason to disable them, except for debugging purposes,
16580 or to make an object a little bit smaller.
16582 @item -msmall-mem
16583 @itemx -mlarge-mem
16584 @opindex msmall-mem
16585 @opindex mlarge-mem
16587 By default, GCC generates code assuming that addresses are never larger
16588 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
16589 a full 32 bit address.
16591 @item -mstdmain
16592 @opindex mstdmain
16594 By default, GCC links against startup code that assumes the SPU-style
16595 main function interface (which has an unconventional parameter list).
16596 With @option{-mstdmain}, GCC will link your program against startup
16597 code that assumes a C99-style interface to @code{main}, including a
16598 local copy of @code{argv} strings.
16600 @item -mfixed-range=@var{register-range}
16601 @opindex mfixed-range
16602 Generate code treating the given register range as fixed registers.
16603 A fixed register is one that the register allocator can not use.  This is
16604 useful when compiling kernel code.  A register range is specified as
16605 two registers separated by a dash.  Multiple register ranges can be
16606 specified separated by a comma.
16608 @item -mea32
16609 @itemx -mea64
16610 @opindex mea32
16611 @opindex mea64
16612 Compile code assuming that pointers to the PPU address space accessed
16613 via the @code{__ea} named address space qualifier are either 32 or 64
16614 bits wide.  The default is 32 bits.  As this is an ABI changing option,
16615 all object code in an executable must be compiled with the same setting.
16617 @item -maddress-space-conversion
16618 @itemx -mno-address-space-conversion
16619 @opindex maddress-space-conversion
16620 @opindex mno-address-space-conversion
16621 Allow/disallow treating the @code{__ea} address space as superset
16622 of the generic address space.  This enables explicit type casts
16623 between @code{__ea} and generic pointer as well as implicit
16624 conversions of generic pointers to @code{__ea} pointers.  The
16625 default is to allow address space pointer conversions.
16627 @item -mcache-size=@var{cache-size}
16628 @opindex mcache-size
16629 This option controls the version of libgcc that the compiler links to an
16630 executable and selects a software-managed cache for accessing variables
16631 in the @code{__ea} address space with a particular cache size.  Possible
16632 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
16633 and @samp{128}.  The default cache size is 64KB.
16635 @item -matomic-updates
16636 @itemx -mno-atomic-updates
16637 @opindex matomic-updates
16638 @opindex mno-atomic-updates
16639 This option controls the version of libgcc that the compiler links to an
16640 executable and selects whether atomic updates to the software-managed
16641 cache of PPU-side variables are used.  If you use atomic updates, changes
16642 to a PPU variable from SPU code using the @code{__ea} named address space
16643 qualifier will not interfere with changes to other PPU variables residing
16644 in the same cache line from PPU code.  If you do not use atomic updates,
16645 such interference may occur; however, writing back cache lines will be
16646 more efficient.  The default behavior is to use atomic updates.
16648 @item -mdual-nops
16649 @itemx -mdual-nops=@var{n}
16650 @opindex mdual-nops
16651 By default, GCC will insert nops to increase dual issue when it expects
16652 it to increase performance.  @var{n} can be a value from 0 to 10.  A
16653 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
16654 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
16656 @item -mhint-max-nops=@var{n}
16657 @opindex mhint-max-nops
16658 Maximum number of nops to insert for a branch hint.  A branch hint must
16659 be at least 8 instructions away from the branch it is effecting.  GCC
16660 will insert up to @var{n} nops to enforce this, otherwise it will not
16661 generate the branch hint.
16663 @item -mhint-max-distance=@var{n}
16664 @opindex mhint-max-distance
16665 The encoding of the branch hint instruction limits the hint to be within
16666 256 instructions of the branch it is effecting.  By default, GCC makes
16667 sure it is within 125.
16669 @item -msafe-hints
16670 @opindex msafe-hints
16671 Work around a hardware bug which causes the SPU to stall indefinitely.
16672 By default, GCC will insert the @code{hbrp} instruction to make sure
16673 this stall won't happen.
16675 @end table
16677 @node System V Options
16678 @subsection Options for System V
16680 These additional options are available on System V Release 4 for
16681 compatibility with other compilers on those systems:
16683 @table @gcctabopt
16684 @item -G
16685 @opindex G
16686 Create a shared object.
16687 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
16689 @item -Qy
16690 @opindex Qy
16691 Identify the versions of each tool used by the compiler, in a
16692 @code{.ident} assembler directive in the output.
16694 @item -Qn
16695 @opindex Qn
16696 Refrain from adding @code{.ident} directives to the output file (this is
16697 the default).
16699 @item -YP,@var{dirs}
16700 @opindex YP
16701 Search the directories @var{dirs}, and no others, for libraries
16702 specified with @option{-l}.
16704 @item -Ym,@var{dir}
16705 @opindex Ym
16706 Look in the directory @var{dir} to find the M4 preprocessor.
16707 The assembler uses this option.
16708 @c This is supposed to go with a -Yd for predefined M4 macro files, but
16709 @c the generic assembler that comes with Solaris takes just -Ym.
16710 @end table
16712 @node V850 Options
16713 @subsection V850 Options
16714 @cindex V850 Options
16716 These @samp{-m} options are defined for V850 implementations:
16718 @table @gcctabopt
16719 @item -mlong-calls
16720 @itemx -mno-long-calls
16721 @opindex mlong-calls
16722 @opindex mno-long-calls
16723 Treat all calls as being far away (near).  If calls are assumed to be
16724 far away, the compiler will always load the functions address up into a
16725 register, and call indirect through the pointer.
16727 @item -mno-ep
16728 @itemx -mep
16729 @opindex mno-ep
16730 @opindex mep
16731 Do not optimize (do optimize) basic blocks that use the same index
16732 pointer 4 or more times to copy pointer into the @code{ep} register, and
16733 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
16734 option is on by default if you optimize.
16736 @item -mno-prolog-function
16737 @itemx -mprolog-function
16738 @opindex mno-prolog-function
16739 @opindex mprolog-function
16740 Do not use (do use) external functions to save and restore registers
16741 at the prologue and epilogue of a function.  The external functions
16742 are slower, but use less code space if more than one function saves
16743 the same number of registers.  The @option{-mprolog-function} option
16744 is on by default if you optimize.
16746 @item -mspace
16747 @opindex mspace
16748 Try to make the code as small as possible.  At present, this just turns
16749 on the @option{-mep} and @option{-mprolog-function} options.
16751 @item -mtda=@var{n}
16752 @opindex mtda
16753 Put static or global variables whose size is @var{n} bytes or less into
16754 the tiny data area that register @code{ep} points to.  The tiny data
16755 area can hold up to 256 bytes in total (128 bytes for byte references).
16757 @item -msda=@var{n}
16758 @opindex msda
16759 Put static or global variables whose size is @var{n} bytes or less into
16760 the small data area that register @code{gp} points to.  The small data
16761 area can hold up to 64 kilobytes.
16763 @item -mzda=@var{n}
16764 @opindex mzda
16765 Put static or global variables whose size is @var{n} bytes or less into
16766 the first 32 kilobytes of memory.
16768 @item -mv850
16769 @opindex mv850
16770 Specify that the target processor is the V850.
16772 @item -mbig-switch
16773 @opindex mbig-switch
16774 Generate code suitable for big switch tables.  Use this option only if
16775 the assembler/linker complain about out of range branches within a switch
16776 table.
16778 @item -mapp-regs
16779 @opindex mapp-regs
16780 This option will cause r2 and r5 to be used in the code generated by
16781 the compiler.  This setting is the default.
16783 @item -mno-app-regs
16784 @opindex mno-app-regs
16785 This option will cause r2 and r5 to be treated as fixed registers.
16787 @item -mv850e1
16788 @opindex mv850e1
16789 Specify that the target processor is the V850E1.  The preprocessor
16790 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
16791 this option is used.
16793 @item -mv850e
16794 @opindex mv850e
16795 Specify that the target processor is the V850E@.  The preprocessor
16796 constant @samp{__v850e__} will be defined if this option is used.
16798 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
16799 are defined then a default target processor will be chosen and the
16800 relevant @samp{__v850*__} preprocessor constant will be defined.
16802 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
16803 defined, regardless of which processor variant is the target.
16805 @item -mdisable-callt
16806 @opindex mdisable-callt
16807 This option will suppress generation of the CALLT instruction for the
16808 v850e and v850e1 flavors of the v850 architecture.  The default is
16809 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
16811 @end table
16813 @node VAX Options
16814 @subsection VAX Options
16815 @cindex VAX options
16817 These @samp{-m} options are defined for the VAX:
16819 @table @gcctabopt
16820 @item -munix
16821 @opindex munix
16822 Do not output certain jump instructions (@code{aobleq} and so on)
16823 that the Unix assembler for the VAX cannot handle across long
16824 ranges.
16826 @item -mgnu
16827 @opindex mgnu
16828 Do output those jump instructions, on the assumption that you
16829 will assemble with the GNU assembler.
16831 @item -mg
16832 @opindex mg
16833 Output code for g-format floating point numbers instead of d-format.
16834 @end table
16836 @node VxWorks Options
16837 @subsection VxWorks Options
16838 @cindex VxWorks Options
16840 The options in this section are defined for all VxWorks targets.
16841 Options specific to the target hardware are listed with the other
16842 options for that target.
16844 @table @gcctabopt
16845 @item -mrtp
16846 @opindex mrtp
16847 GCC can generate code for both VxWorks kernels and real time processes
16848 (RTPs).  This option switches from the former to the latter.  It also
16849 defines the preprocessor macro @code{__RTP__}.
16851 @item -non-static
16852 @opindex non-static
16853 Link an RTP executable against shared libraries rather than static
16854 libraries.  The options @option{-static} and @option{-shared} can
16855 also be used for RTPs (@pxref{Link Options}); @option{-static}
16856 is the default.
16858 @item -Bstatic
16859 @itemx -Bdynamic
16860 @opindex Bstatic
16861 @opindex Bdynamic
16862 These options are passed down to the linker.  They are defined for
16863 compatibility with Diab.
16865 @item -Xbind-lazy
16866 @opindex Xbind-lazy
16867 Enable lazy binding of function calls.  This option is equivalent to
16868 @option{-Wl,-z,now} and is defined for compatibility with Diab.
16870 @item -Xbind-now
16871 @opindex Xbind-now
16872 Disable lazy binding of function calls.  This option is the default and
16873 is defined for compatibility with Diab.
16874 @end table
16876 @node x86-64 Options
16877 @subsection x86-64 Options
16878 @cindex x86-64 options
16880 These are listed under @xref{i386 and x86-64 Options}.
16882 @node i386 and x86-64 Windows Options
16883 @subsection i386 and x86-64 Windows Options
16884 @cindex i386 and x86-64 Windows Options
16886 These additional options are available for Windows targets:
16888 @table @gcctabopt
16889 @item -mconsole
16890 @opindex mconsole
16891 This option is available for Cygwin and MinGW targets.  It
16892 specifies that a console application is to be generated, by
16893 instructing the linker to set the PE header subsystem type
16894 required for console applications.
16895 This is the default behavior for Cygwin and MinGW targets.
16897 @item -mcygwin
16898 @opindex mcygwin
16899 This option is available for Cygwin targets.  It specifies that
16900 the Cygwin internal interface is to be used for predefined
16901 preprocessor macros, C runtime libraries and related linker
16902 paths and options.  For Cygwin targets this is the default behavior.
16903 This option is deprecated and will be removed in a future release.
16905 @item -mno-cygwin
16906 @opindex mno-cygwin
16907 This option is available for Cygwin targets.  It specifies that
16908 the MinGW internal interface is to be used instead of Cygwin's, by
16909 setting MinGW-related predefined macros and linker paths and default
16910 library options.
16911 This option is deprecated and will be removed in a future release.
16913 @item -mdll
16914 @opindex mdll
16915 This option is available for Cygwin and MinGW targets.  It
16916 specifies that a DLL - a dynamic link library - is to be
16917 generated, enabling the selection of the required runtime
16918 startup object and entry point.
16920 @item -mnop-fun-dllimport
16921 @opindex mnop-fun-dllimport
16922 This option is available for Cygwin and MinGW targets.  It
16923 specifies that the dllimport attribute should be ignored.
16925 @item -mthread
16926 @opindex mthread
16927 This option is available for MinGW targets. It specifies
16928 that MinGW-specific thread support is to be used.
16930 @item -municode
16931 @opindex municode
16932 This option is available for mingw-w64 targets.  It specifies
16933 that the UNICODE macro is getting pre-defined and that the
16934 unicode capable runtime startup code is chosen.
16936 @item -mwin32
16937 @opindex mwin32
16938 This option is available for Cygwin and MinGW targets.  It
16939 specifies that the typical Windows pre-defined macros are to
16940 be set in the pre-processor, but does not influence the choice
16941 of runtime library/startup code.
16943 @item -mwindows
16944 @opindex mwindows
16945 This option is available for Cygwin and MinGW targets.  It
16946 specifies that a GUI application is to be generated by
16947 instructing the linker to set the PE header subsystem type
16948 appropriately.
16950 @item -fno-set-stack-executable
16951 @opindex fno-set-stack-executable
16952 This option is available for MinGW targets. It specifies that
16953 the executable flag for stack used by nested functions isn't
16954 set. This is necessary for binaries running in kernel mode of
16955 Windows, as there the user32 API, which is used to set executable
16956 privileges, isn't available.
16958 @item -mpe-aligned-commons
16959 @opindex mpe-aligned-commons
16960 This option is available for Cygwin and MinGW targets.  It
16961 specifies that the GNU extension to the PE file format that
16962 permits the correct alignment of COMMON variables should be
16963 used when generating code.  It will be enabled by default if
16964 GCC detects that the target assembler found during configuration
16965 supports the feature.
16966 @end table
16968 See also under @ref{i386 and x86-64 Options} for standard options.
16970 @node Xstormy16 Options
16971 @subsection Xstormy16 Options
16972 @cindex Xstormy16 Options
16974 These options are defined for Xstormy16:
16976 @table @gcctabopt
16977 @item -msim
16978 @opindex msim
16979 Choose startup files and linker script suitable for the simulator.
16980 @end table
16982 @node Xtensa Options
16983 @subsection Xtensa Options
16984 @cindex Xtensa Options
16986 These options are supported for Xtensa targets:
16988 @table @gcctabopt
16989 @item -mconst16
16990 @itemx -mno-const16
16991 @opindex mconst16
16992 @opindex mno-const16
16993 Enable or disable use of @code{CONST16} instructions for loading
16994 constant values.  The @code{CONST16} instruction is currently not a
16995 standard option from Tensilica.  When enabled, @code{CONST16}
16996 instructions are always used in place of the standard @code{L32R}
16997 instructions.  The use of @code{CONST16} is enabled by default only if
16998 the @code{L32R} instruction is not available.
17000 @item -mfused-madd
17001 @itemx -mno-fused-madd
17002 @opindex mfused-madd
17003 @opindex mno-fused-madd
17004 Enable or disable use of fused multiply/add and multiply/subtract
17005 instructions in the floating-point option.  This has no effect if the
17006 floating-point option is not also enabled.  Disabling fused multiply/add
17007 and multiply/subtract instructions forces the compiler to use separate
17008 instructions for the multiply and add/subtract operations.  This may be
17009 desirable in some cases where strict IEEE 754-compliant results are
17010 required: the fused multiply add/subtract instructions do not round the
17011 intermediate result, thereby producing results with @emph{more} bits of
17012 precision than specified by the IEEE standard.  Disabling fused multiply
17013 add/subtract instructions also ensures that the program output is not
17014 sensitive to the compiler's ability to combine multiply and add/subtract
17015 operations.
17017 @item -mserialize-volatile
17018 @itemx -mno-serialize-volatile
17019 @opindex mserialize-volatile
17020 @opindex mno-serialize-volatile
17021 When this option is enabled, GCC inserts @code{MEMW} instructions before
17022 @code{volatile} memory references to guarantee sequential consistency.
17023 The default is @option{-mserialize-volatile}.  Use
17024 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
17026 @item -mtext-section-literals
17027 @itemx -mno-text-section-literals
17028 @opindex mtext-section-literals
17029 @opindex mno-text-section-literals
17030 Control the treatment of literal pools.  The default is
17031 @option{-mno-text-section-literals}, which places literals in a separate
17032 section in the output file.  This allows the literal pool to be placed
17033 in a data RAM/ROM, and it also allows the linker to combine literal
17034 pools from separate object files to remove redundant literals and
17035 improve code size.  With @option{-mtext-section-literals}, the literals
17036 are interspersed in the text section in order to keep them as close as
17037 possible to their references.  This may be necessary for large assembly
17038 files.
17040 @item -mtarget-align
17041 @itemx -mno-target-align
17042 @opindex mtarget-align
17043 @opindex mno-target-align
17044 When this option is enabled, GCC instructs the assembler to
17045 automatically align instructions to reduce branch penalties at the
17046 expense of some code density.  The assembler attempts to widen density
17047 instructions to align branch targets and the instructions following call
17048 instructions.  If there are not enough preceding safe density
17049 instructions to align a target, no widening will be performed.  The
17050 default is @option{-mtarget-align}.  These options do not affect the
17051 treatment of auto-aligned instructions like @code{LOOP}, which the
17052 assembler will always align, either by widening density instructions or
17053 by inserting no-op instructions.
17055 @item -mlongcalls
17056 @itemx -mno-longcalls
17057 @opindex mlongcalls
17058 @opindex mno-longcalls
17059 When this option is enabled, GCC instructs the assembler to translate
17060 direct calls to indirect calls unless it can determine that the target
17061 of a direct call is in the range allowed by the call instruction.  This
17062 translation typically occurs for calls to functions in other source
17063 files.  Specifically, the assembler translates a direct @code{CALL}
17064 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
17065 The default is @option{-mno-longcalls}.  This option should be used in
17066 programs where the call target can potentially be out of range.  This
17067 option is implemented in the assembler, not the compiler, so the
17068 assembly code generated by GCC will still show direct call
17069 instructions---look at the disassembled object code to see the actual
17070 instructions.  Note that the assembler will use an indirect call for
17071 every cross-file call, not just those that really will be out of range.
17072 @end table
17074 @node zSeries Options
17075 @subsection zSeries Options
17076 @cindex zSeries options
17078 These are listed under @xref{S/390 and zSeries Options}.
17080 @node Code Gen Options
17081 @section Options for Code Generation Conventions
17082 @cindex code generation conventions
17083 @cindex options, code generation
17084 @cindex run-time options
17086 These machine-independent options control the interface conventions
17087 used in code generation.
17089 Most of them have both positive and negative forms; the negative form
17090 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
17091 one of the forms is listed---the one which is not the default.  You
17092 can figure out the other form by either removing @samp{no-} or adding
17095 @table @gcctabopt
17096 @item -fbounds-check
17097 @opindex fbounds-check
17098 For front-ends that support it, generate additional code to check that
17099 indices used to access arrays are within the declared range.  This is
17100 currently only supported by the Java and Fortran front-ends, where
17101 this option defaults to true and false respectively.
17103 @item -ftrapv
17104 @opindex ftrapv
17105 This option generates traps for signed overflow on addition, subtraction,
17106 multiplication operations.
17108 @item -fwrapv
17109 @opindex fwrapv
17110 This option instructs the compiler to assume that signed arithmetic
17111 overflow of addition, subtraction and multiplication wraps around
17112 using twos-complement representation.  This flag enables some optimizations
17113 and disables others.  This option is enabled by default for the Java
17114 front-end, as required by the Java language specification.
17116 @item -fexceptions
17117 @opindex fexceptions
17118 Enable exception handling.  Generates extra code needed to propagate
17119 exceptions.  For some targets, this implies GCC will generate frame
17120 unwind information for all functions, which can produce significant data
17121 size overhead, although it does not affect execution.  If you do not
17122 specify this option, GCC will enable it by default for languages like
17123 C++ which normally require exception handling, and disable it for
17124 languages like C that do not normally require it.  However, you may need
17125 to enable this option when compiling C code that needs to interoperate
17126 properly with exception handlers written in C++.  You may also wish to
17127 disable this option if you are compiling older C++ programs that don't
17128 use exception handling.
17130 @item -fnon-call-exceptions
17131 @opindex fnon-call-exceptions
17132 Generate code that allows trapping instructions to throw exceptions.
17133 Note that this requires platform-specific runtime support that does
17134 not exist everywhere.  Moreover, it only allows @emph{trapping}
17135 instructions to throw exceptions, i.e.@: memory references or floating
17136 point instructions.  It does not allow exceptions to be thrown from
17137 arbitrary signal handlers such as @code{SIGALRM}.
17139 @item -funwind-tables
17140 @opindex funwind-tables
17141 Similar to @option{-fexceptions}, except that it will just generate any needed
17142 static data, but will not affect the generated code in any other way.
17143 You will normally not enable this option; instead, a language processor
17144 that needs this handling would enable it on your behalf.
17146 @item -fasynchronous-unwind-tables
17147 @opindex fasynchronous-unwind-tables
17148 Generate unwind table in dwarf2 format, if supported by target machine.  The
17149 table is exact at each instruction boundary, so it can be used for stack
17150 unwinding from asynchronous events (such as debugger or garbage collector).
17152 @item -fpcc-struct-return
17153 @opindex fpcc-struct-return
17154 Return ``short'' @code{struct} and @code{union} values in memory like
17155 longer ones, rather than in registers.  This convention is less
17156 efficient, but it has the advantage of allowing intercallability between
17157 GCC-compiled files and files compiled with other compilers, particularly
17158 the Portable C Compiler (pcc).
17160 The precise convention for returning structures in memory depends
17161 on the target configuration macros.
17163 Short structures and unions are those whose size and alignment match
17164 that of some integer type.
17166 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
17167 switch is not binary compatible with code compiled with the
17168 @option{-freg-struct-return} switch.
17169 Use it to conform to a non-default application binary interface.
17171 @item -freg-struct-return
17172 @opindex freg-struct-return
17173 Return @code{struct} and @code{union} values in registers when possible.
17174 This is more efficient for small structures than
17175 @option{-fpcc-struct-return}.
17177 If you specify neither @option{-fpcc-struct-return} nor
17178 @option{-freg-struct-return}, GCC defaults to whichever convention is
17179 standard for the target.  If there is no standard convention, GCC
17180 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17181 the principal compiler.  In those cases, we can choose the standard, and
17182 we chose the more efficient register return alternative.
17184 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17185 switch is not binary compatible with code compiled with the
17186 @option{-fpcc-struct-return} switch.
17187 Use it to conform to a non-default application binary interface.
17189 @item -fshort-enums
17190 @opindex fshort-enums
17191 Allocate to an @code{enum} type only as many bytes as it needs for the
17192 declared range of possible values.  Specifically, the @code{enum} type
17193 will be equivalent to the smallest integer type which has enough room.
17195 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17196 code that is not binary compatible with code generated without that switch.
17197 Use it to conform to a non-default application binary interface.
17199 @item -fshort-double
17200 @opindex fshort-double
17201 Use the same size for @code{double} as for @code{float}.
17203 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17204 code that is not binary compatible with code generated without that switch.
17205 Use it to conform to a non-default application binary interface.
17207 @item -fshort-wchar
17208 @opindex fshort-wchar
17209 Override the underlying type for @samp{wchar_t} to be @samp{short
17210 unsigned int} instead of the default for the target.  This option is
17211 useful for building programs to run under WINE@.
17213 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17214 code that is not binary compatible with code generated without that switch.
17215 Use it to conform to a non-default application binary interface.
17217 @item -fno-common
17218 @opindex fno-common
17219 In C code, controls the placement of uninitialized global variables.
17220 Unix C compilers have traditionally permitted multiple definitions of
17221 such variables in different compilation units by placing the variables
17222 in a common block.
17223 This is the behavior specified by @option{-fcommon}, and is the default
17224 for GCC on most targets.
17225 On the other hand, this behavior is not required by ISO C, and on some
17226 targets may carry a speed or code size penalty on variable references.
17227 The @option{-fno-common} option specifies that the compiler should place
17228 uninitialized global variables in the data section of the object file,
17229 rather than generating them as common blocks.
17230 This has the effect that if the same variable is declared
17231 (without @code{extern}) in two different compilations,
17232 you will get a multiple-definition error when you link them.
17233 In this case, you must compile with @option{-fcommon} instead.
17234 Compiling with @option{-fno-common} is useful on targets for which
17235 it provides better performance, or if you wish to verify that the
17236 program will work on other systems which always treat uninitialized
17237 variable declarations this way.
17239 @item -fno-ident
17240 @opindex fno-ident
17241 Ignore the @samp{#ident} directive.
17243 @item -finhibit-size-directive
17244 @opindex finhibit-size-directive
17245 Don't output a @code{.size} assembler directive, or anything else that
17246 would cause trouble if the function is split in the middle, and the
17247 two halves are placed at locations far apart in memory.  This option is
17248 used when compiling @file{crtstuff.c}; you should not need to use it
17249 for anything else.
17251 @item -fverbose-asm
17252 @opindex fverbose-asm
17253 Put extra commentary information in the generated assembly code to
17254 make it more readable.  This option is generally only of use to those
17255 who actually need to read the generated assembly code (perhaps while
17256 debugging the compiler itself).
17258 @option{-fno-verbose-asm}, the default, causes the
17259 extra information to be omitted and is useful when comparing two assembler
17260 files.
17262 @item -frecord-gcc-switches
17263 @opindex frecord-gcc-switches
17264 This switch causes the command line that was used to invoke the
17265 compiler to be recorded into the object file that is being created.
17266 This switch is only implemented on some targets and the exact format
17267 of the recording is target and binary file format dependent, but it
17268 usually takes the form of a section containing ASCII text.  This
17269 switch is related to the @option{-fverbose-asm} switch, but that
17270 switch only records information in the assembler output file as
17271 comments, so it never reaches the object file.
17273 @item -fpic
17274 @opindex fpic
17275 @cindex global offset table
17276 @cindex PIC
17277 Generate position-independent code (PIC) suitable for use in a shared
17278 library, if supported for the target machine.  Such code accesses all
17279 constant addresses through a global offset table (GOT)@.  The dynamic
17280 loader resolves the GOT entries when the program starts (the dynamic
17281 loader is not part of GCC; it is part of the operating system).  If
17282 the GOT size for the linked executable exceeds a machine-specific
17283 maximum size, you get an error message from the linker indicating that
17284 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17285 instead.  (These maximums are 8k on the SPARC and 32k
17286 on the m68k and RS/6000.  The 386 has no such limit.)
17288 Position-independent code requires special support, and therefore works
17289 only on certain machines.  For the 386, GCC supports PIC for System V
17290 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
17291 position-independent.
17293 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17294 are defined to 1.
17296 @item -fPIC
17297 @opindex fPIC
17298 If supported for the target machine, emit position-independent code,
17299 suitable for dynamic linking and avoiding any limit on the size of the
17300 global offset table.  This option makes a difference on the m68k,
17301 PowerPC and SPARC@.
17303 Position-independent code requires special support, and therefore works
17304 only on certain machines.
17306 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17307 are defined to 2.
17309 @item -fpie
17310 @itemx -fPIE
17311 @opindex fpie
17312 @opindex fPIE
17313 These options are similar to @option{-fpic} and @option{-fPIC}, but
17314 generated position independent code can be only linked into executables.
17315 Usually these options are used when @option{-pie} GCC option will be
17316 used during linking.
17318 @option{-fpie} and @option{-fPIE} both define the macros
17319 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
17320 for @option{-fpie} and 2 for @option{-fPIE}.
17322 @item -fno-jump-tables
17323 @opindex fno-jump-tables
17324 Do not use jump tables for switch statements even where it would be
17325 more efficient than other code generation strategies.  This option is
17326 of use in conjunction with @option{-fpic} or @option{-fPIC} for
17327 building code which forms part of a dynamic linker and cannot
17328 reference the address of a jump table.  On some targets, jump tables
17329 do not require a GOT and this option is not needed.
17331 @item -ffixed-@var{reg}
17332 @opindex ffixed
17333 Treat the register named @var{reg} as a fixed register; generated code
17334 should never refer to it (except perhaps as a stack pointer, frame
17335 pointer or in some other fixed role).
17337 @var{reg} must be the name of a register.  The register names accepted
17338 are machine-specific and are defined in the @code{REGISTER_NAMES}
17339 macro in the machine description macro file.
17341 This flag does not have a negative form, because it specifies a
17342 three-way choice.
17344 @item -fcall-used-@var{reg}
17345 @opindex fcall-used
17346 Treat the register named @var{reg} as an allocable register that is
17347 clobbered by function calls.  It may be allocated for temporaries or
17348 variables that do not live across a call.  Functions compiled this way
17349 will not save and restore the register @var{reg}.
17351 It is an error to used this flag with the frame pointer or stack pointer.
17352 Use of this flag for other registers that have fixed pervasive roles in
17353 the machine's execution model will produce disastrous results.
17355 This flag does not have a negative form, because it specifies a
17356 three-way choice.
17358 @item -fcall-saved-@var{reg}
17359 @opindex fcall-saved
17360 Treat the register named @var{reg} as an allocable register saved by
17361 functions.  It may be allocated even for temporaries or variables that
17362 live across a call.  Functions compiled this way will save and restore
17363 the register @var{reg} if they use it.
17365 It is an error to used this flag with the frame pointer or stack pointer.
17366 Use of this flag for other registers that have fixed pervasive roles in
17367 the machine's execution model will produce disastrous results.
17369 A different sort of disaster will result from the use of this flag for
17370 a register in which function values may be returned.
17372 This flag does not have a negative form, because it specifies a
17373 three-way choice.
17375 @item -fpack-struct[=@var{n}]
17376 @opindex fpack-struct
17377 Without a value specified, pack all structure members together without
17378 holes.  When a value is specified (which must be a small power of two), pack
17379 structure members according to this value, representing the maximum
17380 alignment (that is, objects with default alignment requirements larger than
17381 this will be output potentially unaligned at the next fitting location.
17383 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
17384 code that is not binary compatible with code generated without that switch.
17385 Additionally, it makes the code suboptimal.
17386 Use it to conform to a non-default application binary interface.
17388 @item -finstrument-functions
17389 @opindex finstrument-functions
17390 Generate instrumentation calls for entry and exit to functions.  Just
17391 after function entry and just before function exit, the following
17392 profiling functions will be called with the address of the current
17393 function and its call site.  (On some platforms,
17394 @code{__builtin_return_address} does not work beyond the current
17395 function, so the call site information may not be available to the
17396 profiling functions otherwise.)
17398 @smallexample
17399 void __cyg_profile_func_enter (void *this_fn,
17400                                void *call_site);
17401 void __cyg_profile_func_exit  (void *this_fn,
17402                                void *call_site);
17403 @end smallexample
17405 The first argument is the address of the start of the current function,
17406 which may be looked up exactly in the symbol table.
17408 This instrumentation is also done for functions expanded inline in other
17409 functions.  The profiling calls will indicate where, conceptually, the
17410 inline function is entered and exited.  This means that addressable
17411 versions of such functions must be available.  If all your uses of a
17412 function are expanded inline, this may mean an additional expansion of
17413 code size.  If you use @samp{extern inline} in your C code, an
17414 addressable version of such functions must be provided.  (This is
17415 normally the case anyways, but if you get lucky and the optimizer always
17416 expands the functions inline, you might have gotten away without
17417 providing static copies.)
17419 A function may be given the attribute @code{no_instrument_function}, in
17420 which case this instrumentation will not be done.  This can be used, for
17421 example, for the profiling functions listed above, high-priority
17422 interrupt routines, and any functions from which the profiling functions
17423 cannot safely be called (perhaps signal handlers, if the profiling
17424 routines generate output or allocate memory).
17426 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
17427 @opindex finstrument-functions-exclude-file-list
17429 Set the list of functions that are excluded from instrumentation (see
17430 the description of @code{-finstrument-functions}).  If the file that
17431 contains a function definition matches with one of @var{file}, then
17432 that function is not instrumented.  The match is done on substrings:
17433 if the @var{file} parameter is a substring of the file name, it is
17434 considered to be a match.
17436 For example,
17437 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
17438 will exclude any inline function defined in files whose pathnames
17439 contain @code{/bits/stl} or @code{include/sys}.
17441 If, for some reason, you want to include letter @code{','} in one of
17442 @var{sym}, write @code{'\,'}. For example,
17443 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
17444 (note the single quote surrounding the option).
17446 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
17447 @opindex finstrument-functions-exclude-function-list
17449 This is similar to @code{-finstrument-functions-exclude-file-list},
17450 but this option sets the list of function names to be excluded from
17451 instrumentation.  The function name to be matched is its user-visible
17452 name, such as @code{vector<int> blah(const vector<int> &)}, not the
17453 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
17454 match is done on substrings: if the @var{sym} parameter is a substring
17455 of the function name, it is considered to be a match.  For C99 and C++
17456 extended identifiers, the function name must be given in UTF-8, not
17457 using universal character names.
17459 @item -fstack-check
17460 @opindex fstack-check
17461 Generate code to verify that you do not go beyond the boundary of the
17462 stack.  You should specify this flag if you are running in an
17463 environment with multiple threads, but only rarely need to specify it in
17464 a single-threaded environment since stack overflow is automatically
17465 detected on nearly all systems if there is only one stack.
17467 Note that this switch does not actually cause checking to be done; the
17468 operating system or the language runtime must do that.  The switch causes
17469 generation of code to ensure that they see the stack being extended.
17471 You can additionally specify a string parameter: @code{no} means no
17472 checking, @code{generic} means force the use of old-style checking,
17473 @code{specific} means use the best checking method and is equivalent
17474 to bare @option{-fstack-check}.
17476 Old-style checking is a generic mechanism that requires no specific
17477 target support in the compiler but comes with the following drawbacks:
17479 @enumerate
17480 @item
17481 Modified allocation strategy for large objects: they will always be
17482 allocated dynamically if their size exceeds a fixed threshold.
17484 @item
17485 Fixed limit on the size of the static frame of functions: when it is
17486 topped by a particular function, stack checking is not reliable and
17487 a warning is issued by the compiler.
17489 @item
17490 Inefficiency: because of both the modified allocation strategy and the
17491 generic implementation, the performances of the code are hampered.
17492 @end enumerate
17494 Note that old-style stack checking is also the fallback method for
17495 @code{specific} if no target support has been added in the compiler.
17497 @item -fstack-limit-register=@var{reg}
17498 @itemx -fstack-limit-symbol=@var{sym}
17499 @itemx -fno-stack-limit
17500 @opindex fstack-limit-register
17501 @opindex fstack-limit-symbol
17502 @opindex fno-stack-limit
17503 Generate code to ensure that the stack does not grow beyond a certain value,
17504 either the value of a register or the address of a symbol.  If the stack
17505 would grow beyond the value, a signal is raised.  For most targets,
17506 the signal is raised before the stack overruns the boundary, so
17507 it is possible to catch the signal without taking special precautions.
17509 For instance, if the stack starts at absolute address @samp{0x80000000}
17510 and grows downwards, you can use the flags
17511 @option{-fstack-limit-symbol=__stack_limit} and
17512 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
17513 of 128KB@.  Note that this may only work with the GNU linker.
17515 @item -fleading-underscore
17516 @opindex fleading-underscore
17517 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
17518 change the way C symbols are represented in the object file.  One use
17519 is to help link with legacy assembly code.
17521 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
17522 generate code that is not binary compatible with code generated without that
17523 switch.  Use it to conform to a non-default application binary interface.
17524 Not all targets provide complete support for this switch.
17526 @item -ftls-model=@var{model}
17527 @opindex ftls-model
17528 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
17529 The @var{model} argument should be one of @code{global-dynamic},
17530 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
17532 The default without @option{-fpic} is @code{initial-exec}; with
17533 @option{-fpic} the default is @code{global-dynamic}.
17535 @item -fvisibility=@var{default|internal|hidden|protected}
17536 @opindex fvisibility
17537 Set the default ELF image symbol visibility to the specified option---all
17538 symbols will be marked with this unless overridden within the code.
17539 Using this feature can very substantially improve linking and
17540 load times of shared object libraries, produce more optimized
17541 code, provide near-perfect API export and prevent symbol clashes.
17542 It is @strong{strongly} recommended that you use this in any shared objects
17543 you distribute.
17545 Despite the nomenclature, @code{default} always means public ie;
17546 available to be linked against from outside the shared object.
17547 @code{protected} and @code{internal} are pretty useless in real-world
17548 usage so the only other commonly used option will be @code{hidden}.
17549 The default if @option{-fvisibility} isn't specified is
17550 @code{default}, i.e., make every
17551 symbol public---this causes the same behavior as previous versions of
17552 GCC@.
17554 A good explanation of the benefits offered by ensuring ELF
17555 symbols have the correct visibility is given by ``How To Write
17556 Shared Libraries'' by Ulrich Drepper (which can be found at
17557 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
17558 solution made possible by this option to marking things hidden when
17559 the default is public is to make the default hidden and mark things
17560 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
17561 and @code{__attribute__ ((visibility("default")))} instead of
17562 @code{__declspec(dllexport)} you get almost identical semantics with
17563 identical syntax.  This is a great boon to those working with
17564 cross-platform projects.
17566 For those adding visibility support to existing code, you may find
17567 @samp{#pragma GCC visibility} of use.  This works by you enclosing
17568 the declarations you wish to set visibility for with (for example)
17569 @samp{#pragma GCC visibility push(hidden)} and
17570 @samp{#pragma GCC visibility pop}.
17571 Bear in mind that symbol visibility should be viewed @strong{as
17572 part of the API interface contract} and thus all new code should
17573 always specify visibility when it is not the default ie; declarations
17574 only for use within the local DSO should @strong{always} be marked explicitly
17575 as hidden as so to avoid PLT indirection overheads---making this
17576 abundantly clear also aids readability and self-documentation of the code.
17577 Note that due to ISO C++ specification requirements, operator new and
17578 operator delete must always be of default visibility.
17580 Be aware that headers from outside your project, in particular system
17581 headers and headers from any other library you use, may not be
17582 expecting to be compiled with visibility other than the default.  You
17583 may need to explicitly say @samp{#pragma GCC visibility push(default)}
17584 before including any such headers.
17586 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
17587 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
17588 no modifications.  However, this means that calls to @samp{extern}
17589 functions with no explicit visibility will use the PLT, so it is more
17590 effective to use @samp{__attribute ((visibility))} and/or
17591 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
17592 declarations should be treated as hidden.
17594 Note that @samp{-fvisibility} does affect C++ vague linkage
17595 entities. This means that, for instance, an exception class that will
17596 be thrown between DSOs must be explicitly marked with default
17597 visibility so that the @samp{type_info} nodes will be unified between
17598 the DSOs.
17600 An overview of these techniques, their benefits and how to use them
17601 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
17603 @end table
17605 @c man end
17607 @node Environment Variables
17608 @section Environment Variables Affecting GCC
17609 @cindex environment variables
17611 @c man begin ENVIRONMENT
17612 This section describes several environment variables that affect how GCC
17613 operates.  Some of them work by specifying directories or prefixes to use
17614 when searching for various kinds of files.  Some are used to specify other
17615 aspects of the compilation environment.
17617 Note that you can also specify places to search using options such as
17618 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
17619 take precedence over places specified using environment variables, which
17620 in turn take precedence over those specified by the configuration of GCC@.
17621 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
17622 GNU Compiler Collection (GCC) Internals}.
17624 @table @env
17625 @item LANG
17626 @itemx LC_CTYPE
17627 @c @itemx LC_COLLATE
17628 @itemx LC_MESSAGES
17629 @c @itemx LC_MONETARY
17630 @c @itemx LC_NUMERIC
17631 @c @itemx LC_TIME
17632 @itemx LC_ALL
17633 @findex LANG
17634 @findex LC_CTYPE
17635 @c @findex LC_COLLATE
17636 @findex LC_MESSAGES
17637 @c @findex LC_MONETARY
17638 @c @findex LC_NUMERIC
17639 @c @findex LC_TIME
17640 @findex LC_ALL
17641 @cindex locale
17642 These environment variables control the way that GCC uses
17643 localization information that allow GCC to work with different
17644 national conventions.  GCC inspects the locale categories
17645 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
17646 so.  These locale categories can be set to any value supported by your
17647 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
17648 Kingdom encoded in UTF-8.
17650 The @env{LC_CTYPE} environment variable specifies character
17651 classification.  GCC uses it to determine the character boundaries in
17652 a string; this is needed for some multibyte encodings that contain quote
17653 and escape characters that would otherwise be interpreted as a string
17654 end or escape.
17656 The @env{LC_MESSAGES} environment variable specifies the language to
17657 use in diagnostic messages.
17659 If the @env{LC_ALL} environment variable is set, it overrides the value
17660 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
17661 and @env{LC_MESSAGES} default to the value of the @env{LANG}
17662 environment variable.  If none of these variables are set, GCC
17663 defaults to traditional C English behavior.
17665 @item TMPDIR
17666 @findex TMPDIR
17667 If @env{TMPDIR} is set, it specifies the directory to use for temporary
17668 files.  GCC uses temporary files to hold the output of one stage of
17669 compilation which is to be used as input to the next stage: for example,
17670 the output of the preprocessor, which is the input to the compiler
17671 proper.
17673 @item GCC_EXEC_PREFIX
17674 @findex GCC_EXEC_PREFIX
17675 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
17676 names of the subprograms executed by the compiler.  No slash is added
17677 when this prefix is combined with the name of a subprogram, but you can
17678 specify a prefix that ends with a slash if you wish.
17680 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
17681 an appropriate prefix to use based on the pathname it was invoked with.
17683 If GCC cannot find the subprogram using the specified prefix, it
17684 tries looking in the usual places for the subprogram.
17686 The default value of @env{GCC_EXEC_PREFIX} is
17687 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
17688 the installed compiler. In many cases @var{prefix} is the value
17689 of @code{prefix} when you ran the @file{configure} script.
17691 Other prefixes specified with @option{-B} take precedence over this prefix.
17693 This prefix is also used for finding files such as @file{crt0.o} that are
17694 used for linking.
17696 In addition, the prefix is used in an unusual way in finding the
17697 directories to search for header files.  For each of the standard
17698 directories whose name normally begins with @samp{/usr/local/lib/gcc}
17699 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
17700 replacing that beginning with the specified prefix to produce an
17701 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
17702 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
17703 These alternate directories are searched first; the standard directories
17704 come next. If a standard directory begins with the configured
17705 @var{prefix} then the value of @var{prefix} is replaced by
17706 @env{GCC_EXEC_PREFIX} when looking for header files.
17708 @item COMPILER_PATH
17709 @findex COMPILER_PATH
17710 The value of @env{COMPILER_PATH} is a colon-separated list of
17711 directories, much like @env{PATH}.  GCC tries the directories thus
17712 specified when searching for subprograms, if it can't find the
17713 subprograms using @env{GCC_EXEC_PREFIX}.
17715 @item LIBRARY_PATH
17716 @findex LIBRARY_PATH
17717 The value of @env{LIBRARY_PATH} is a colon-separated list of
17718 directories, much like @env{PATH}.  When configured as a native compiler,
17719 GCC tries the directories thus specified when searching for special
17720 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
17721 using GCC also uses these directories when searching for ordinary
17722 libraries for the @option{-l} option (but directories specified with
17723 @option{-L} come first).
17725 @item LANG
17726 @findex LANG
17727 @cindex locale definition
17728 This variable is used to pass locale information to the compiler.  One way in
17729 which this information is used is to determine the character set to be used
17730 when character literals, string literals and comments are parsed in C and C++.
17731 When the compiler is configured to allow multibyte characters,
17732 the following values for @env{LANG} are recognized:
17734 @table @samp
17735 @item C-JIS
17736 Recognize JIS characters.
17737 @item C-SJIS
17738 Recognize SJIS characters.
17739 @item C-EUCJP
17740 Recognize EUCJP characters.
17741 @end table
17743 If @env{LANG} is not defined, or if it has some other value, then the
17744 compiler will use mblen and mbtowc as defined by the default locale to
17745 recognize and translate multibyte characters.
17746 @end table
17748 @noindent
17749 Some additional environments variables affect the behavior of the
17750 preprocessor.
17752 @include cppenv.texi
17754 @c man end
17756 @node Precompiled Headers
17757 @section Using Precompiled Headers
17758 @cindex precompiled headers
17759 @cindex speed of compilation
17761 Often large projects have many header files that are included in every
17762 source file.  The time the compiler takes to process these header files
17763 over and over again can account for nearly all of the time required to
17764 build the project.  To make builds faster, GCC allows users to
17765 `precompile' a header file; then, if builds can use the precompiled
17766 header file they will be much faster.
17768 To create a precompiled header file, simply compile it as you would any
17769 other file, if necessary using the @option{-x} option to make the driver
17770 treat it as a C or C++ header file.  You will probably want to use a
17771 tool like @command{make} to keep the precompiled header up-to-date when
17772 the headers it contains change.
17774 A precompiled header file will be searched for when @code{#include} is
17775 seen in the compilation.  As it searches for the included file
17776 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
17777 compiler looks for a precompiled header in each directory just before it
17778 looks for the include file in that directory.  The name searched for is
17779 the name specified in the @code{#include} with @samp{.gch} appended.  If
17780 the precompiled header file can't be used, it is ignored.
17782 For instance, if you have @code{#include "all.h"}, and you have
17783 @file{all.h.gch} in the same directory as @file{all.h}, then the
17784 precompiled header file will be used if possible, and the original
17785 header will be used otherwise.
17787 Alternatively, you might decide to put the precompiled header file in a
17788 directory and use @option{-I} to ensure that directory is searched
17789 before (or instead of) the directory containing the original header.
17790 Then, if you want to check that the precompiled header file is always
17791 used, you can put a file of the same name as the original header in this
17792 directory containing an @code{#error} command.
17794 This also works with @option{-include}.  So yet another way to use
17795 precompiled headers, good for projects not designed with precompiled
17796 header files in mind, is to simply take most of the header files used by
17797 a project, include them from another header file, precompile that header
17798 file, and @option{-include} the precompiled header.  If the header files
17799 have guards against multiple inclusion, they will be skipped because
17800 they've already been included (in the precompiled header).
17802 If you need to precompile the same header file for different
17803 languages, targets, or compiler options, you can instead make a
17804 @emph{directory} named like @file{all.h.gch}, and put each precompiled
17805 header in the directory, perhaps using @option{-o}.  It doesn't matter
17806 what you call the files in the directory, every precompiled header in
17807 the directory will be considered.  The first precompiled header
17808 encountered in the directory that is valid for this compilation will
17809 be used; they're searched in no particular order.
17811 There are many other possibilities, limited only by your imagination,
17812 good sense, and the constraints of your build system.
17814 A precompiled header file can be used only when these conditions apply:
17816 @itemize
17817 @item
17818 Only one precompiled header can be used in a particular compilation.
17820 @item
17821 A precompiled header can't be used once the first C token is seen.  You
17822 can have preprocessor directives before a precompiled header; you can
17823 even include a precompiled header from inside another header, so long as
17824 there are no C tokens before the @code{#include}.
17826 @item
17827 The precompiled header file must be produced for the same language as
17828 the current compilation.  You can't use a C precompiled header for a C++
17829 compilation.
17831 @item
17832 The precompiled header file must have been produced by the same compiler
17833 binary as the current compilation is using.
17835 @item
17836 Any macros defined before the precompiled header is included must
17837 either be defined in the same way as when the precompiled header was
17838 generated, or must not affect the precompiled header, which usually
17839 means that they don't appear in the precompiled header at all.
17841 The @option{-D} option is one way to define a macro before a
17842 precompiled header is included; using a @code{#define} can also do it.
17843 There are also some options that define macros implicitly, like
17844 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
17845 defined this way.
17847 @item If debugging information is output when using the precompiled
17848 header, using @option{-g} or similar, the same kind of debugging information
17849 must have been output when building the precompiled header.  However,
17850 a precompiled header built using @option{-g} can be used in a compilation
17851 when no debugging information is being output.
17853 @item The same @option{-m} options must generally be used when building
17854 and using the precompiled header.  @xref{Submodel Options},
17855 for any cases where this rule is relaxed.
17857 @item Each of the following options must be the same when building and using
17858 the precompiled header:
17860 @gccoptlist{-fexceptions}
17862 @item
17863 Some other command-line options starting with @option{-f},
17864 @option{-p}, or @option{-O} must be defined in the same way as when
17865 the precompiled header was generated.  At present, it's not clear
17866 which options are safe to change and which are not; the safest choice
17867 is to use exactly the same options when generating and using the
17868 precompiled header.  The following are known to be safe:
17870 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
17871 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
17872 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
17873 -pedantic-errors}
17875 @end itemize
17877 For all of these except the last, the compiler will automatically
17878 ignore the precompiled header if the conditions aren't met.  If you
17879 find an option combination that doesn't work and doesn't cause the
17880 precompiled header to be ignored, please consider filing a bug report,
17881 see @ref{Bugs}.
17883 If you do use differing options when generating and using the
17884 precompiled header, the actual behavior will be a mixture of the
17885 behavior for the options.  For instance, if you use @option{-g} to
17886 generate the precompiled header but not when using it, you may or may
17887 not get debugging information for routines in the precompiled header.