gcc:
[official-gcc.git] / gcc / doc / invoke.texi
blob9829c1f35b66e7eda01d39a45b5a0b8bd4b5e54d
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 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
261 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
262 -Wunknown-pragmas  -Wno-pragmas @gol
263 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
264 -Wunused-label  -Wunused-parameter -Wno-unused-result -Wunused-value  -Wunused-variable @gol
265 -Wunused-but-set-parameter -Wunused-but-set-variable -Wvariadic-macros -Wvla @gol
266 -Wvolatile-register-var  -Wwrite-strings}
268 @item C and Objective-C-only Warning Options
269 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
270 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
271 -Wold-style-declaration  -Wold-style-definition @gol
272 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
273 -Wdeclaration-after-statement -Wpointer-sign}
275 @item Debugging Options
276 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
277 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
278 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
279 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
280 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
281 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
282 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
283 -fdump-statistics @gol
284 -fdump-tree-all @gol
285 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
286 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
288 -fdump-tree-ch @gol
289 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-nrv -fdump-tree-vect @gol
299 -fdump-tree-sink @gol
300 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
301 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
302 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
303 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
304 -ftree-vectorizer-verbose=@var{n} @gol
305 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
306 -fdump-final-insns=@var{file} @gol
307 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
308 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
309 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
310 -fenable-icf-debug @gol
311 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
312 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
313 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
314 -ftest-coverage  -ftime-report -fvar-tracking @gol
315 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
316 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
317 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
318 -gvms  -gxcoff  -gxcoff+ @gol
319 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
320 -fdebug-prefix-map=@var{old}=@var{new} @gol
321 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
322 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
323 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
324 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
325 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
326 -print-sysroot -print-sysroot-headers-suffix @gol
327 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
329 @item Optimization Options
330 @xref{Optimize Options,,Options that Control Optimization}.
331 @gccoptlist{
332 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
333 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
334 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
335 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
336 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
337 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
338 -fdata-sections -fdce -fdce @gol
339 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
340 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
341 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
342 -fforward-propagate -ffunction-sections @gol
343 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
344 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
345 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
346 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol
347 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
348 -fipa-type-escape -fira-algorithm=@var{algorithm} @gol
349 -fira-region=@var{region} -fira-coalesce @gol
350 -fira-loop-pressure -fno-ira-share-save-slots @gol
351 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
352 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
353 -floop-block -floop-interchange -floop-strip-mine -fgraphite-identity @gol
354 -floop-parallelize-all -flto -flto-compression-level -flto-report -fltrans @gol
355 -fltrans-output-list -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
356 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
357 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
358 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
359 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
360 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
361 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
362 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
363 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
364 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
365 -fprofile-generate=@var{path} @gol
366 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
367 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
368 -freorder-blocks-and-partition -freorder-functions @gol
369 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
370 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
371 -fsched-spec-load -fsched-spec-load-dangerous @gol
372 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
373 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
374 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
375 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
376 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
377 -fselective-scheduling -fselective-scheduling2 @gol
378 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
379 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
380 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
381 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
382 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
383 -ftree-copyrename -ftree-dce @gol
384 -ftree-dominator-opts -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-im @gol
385 -ftree-phiprop -ftree-loop-distribution @gol
386 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
387 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
388 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
389 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
390 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
391 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
392 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
393 -fwhole-program -fwhopr -fwpa -fuse-linker-plugin @gol
394 --param @var{name}=@var{value}
395 -O  -O0  -O1  -O2  -O3  -Os}
397 @item Preprocessor Options
398 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
399 @gccoptlist{-A@var{question}=@var{answer} @gol
400 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
401 -C  -dD  -dI  -dM  -dN @gol
402 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
403 -idirafter @var{dir} @gol
404 -include @var{file}  -imacros @var{file} @gol
405 -iprefix @var{file}  -iwithprefix @var{dir} @gol
406 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
407 -imultilib @var{dir} -isysroot @var{dir} @gol
408 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
409 -P  -fworking-directory  -remap @gol
410 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
411 -Xpreprocessor @var{option}}
413 @item Assembler Option
414 @xref{Assembler Options,,Passing Options to the Assembler}.
415 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
417 @item Linker Options
418 @xref{Link Options,,Options for Linking}.
419 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
420 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
421 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
422 -shared-libgcc  -symbolic @gol
423 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
424 -u @var{symbol}}
426 @item Directory Options
427 @xref{Directory Options,,Options for Directory Search}.
428 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir}}
429 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I-
430 --sysroot=@var{dir}
432 @item Machine Dependent Options
433 @xref{Submodel Options,,Hardware Models and Configurations}.
434 @c This list is ordered alphanumerically by subsection name.
435 @c Try and put the significant identifier (CPU or system) first,
436 @c so users have a clue at guessing where the ones they want will be.
438 @emph{ARC Options}
439 @gccoptlist{-EB  -EL @gol
440 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
441 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
443 @emph{ARM Options}
444 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
445 -mabi=@var{name} @gol
446 -mapcs-stack-check  -mno-apcs-stack-check @gol
447 -mapcs-float  -mno-apcs-float @gol
448 -mapcs-reentrant  -mno-apcs-reentrant @gol
449 -msched-prolog  -mno-sched-prolog @gol
450 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
451 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
452 -mfp16-format=@var{name}
453 -mthumb-interwork  -mno-thumb-interwork @gol
454 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
455 -mstructure-size-boundary=@var{n} @gol
456 -mabort-on-noreturn @gol
457 -mlong-calls  -mno-long-calls @gol
458 -msingle-pic-base  -mno-single-pic-base @gol
459 -mpic-register=@var{reg} @gol
460 -mnop-fun-dllimport @gol
461 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
462 -mpoke-function-name @gol
463 -mthumb  -marm @gol
464 -mtpcs-frame  -mtpcs-leaf-frame @gol
465 -mcaller-super-interworking  -mcallee-super-interworking @gol
466 -mtp=@var{name} @gol
467 -mword-relocations @gol
468 -mfix-cortex-m3-ldrd}
470 @emph{AVR Options}
471 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
472 -mcall-prologues  -mtiny-stack  -mint8}
474 @emph{Blackfin Options}
475 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
476 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
477 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
478 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
479 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
480 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
481 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
482 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
483 -micplb}
485 @emph{CRIS Options}
486 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
487 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
488 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
489 -mstack-align  -mdata-align  -mconst-align @gol
490 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
491 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
492 -mmul-bug-workaround  -mno-mul-bug-workaround}
494 @emph{CRX Options}
495 @gccoptlist{-mmac -mpush-args}
497 @emph{Darwin Options}
498 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
499 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
500 -client_name  -compatibility_version  -current_version @gol
501 -dead_strip @gol
502 -dependency-file  -dylib_file  -dylinker_install_name @gol
503 -dynamic  -dynamiclib  -exported_symbols_list @gol
504 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
505 -force_flat_namespace  -headerpad_max_install_names @gol
506 -iframework @gol
507 -image_base  -init  -install_name  -keep_private_externs @gol
508 -multi_module  -multiply_defined  -multiply_defined_unused @gol
509 -noall_load   -no_dead_strip_inits_and_terms @gol
510 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
511 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
512 -private_bundle  -read_only_relocs  -sectalign @gol
513 -sectobjectsymbols  -whyload  -seg1addr @gol
514 -sectcreate  -sectobjectsymbols  -sectorder @gol
515 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
516 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
517 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
518 -single_module  -static  -sub_library  -sub_umbrella @gol
519 -twolevel_namespace  -umbrella  -undefined @gol
520 -unexported_symbols_list  -weak_reference_mismatches @gol
521 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
522 -mkernel -mone-byte-bool}
524 @emph{DEC Alpha Options}
525 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
526 -mieee  -mieee-with-inexact  -mieee-conformant @gol
527 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
528 -mtrap-precision=@var{mode}  -mbuild-constants @gol
529 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
530 -mbwx  -mmax  -mfix  -mcix @gol
531 -mfloat-vax  -mfloat-ieee @gol
532 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
533 -msmall-text  -mlarge-text @gol
534 -mmemory-latency=@var{time}}
536 @emph{DEC Alpha/VMS Options}
537 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
539 @emph{FR30 Options}
540 @gccoptlist{-msmall-model -mno-lsim}
542 @emph{FRV Options}
543 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
544 -mhard-float  -msoft-float @gol
545 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
546 -mdouble  -mno-double @gol
547 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
548 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
549 -mlinked-fp  -mlong-calls  -malign-labels @gol
550 -mlibrary-pic  -macc-4  -macc-8 @gol
551 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
552 -moptimize-membar -mno-optimize-membar @gol
553 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
554 -mvliw-branch  -mno-vliw-branch @gol
555 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
556 -mno-nested-cond-exec  -mtomcat-stats @gol
557 -mTLS -mtls @gol
558 -mcpu=@var{cpu}}
560 @emph{GNU/Linux Options}
561 @gccoptlist{-muclibc}
563 @emph{H8/300 Options}
564 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
566 @emph{HPPA Options}
567 @gccoptlist{-march=@var{architecture-type} @gol
568 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
569 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
570 -mfixed-range=@var{register-range} @gol
571 -mjump-in-delay -mlinker-opt -mlong-calls @gol
572 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
573 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
574 -mno-jump-in-delay  -mno-long-load-store @gol
575 -mno-portable-runtime  -mno-soft-float @gol
576 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
577 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
578 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
579 -munix=@var{unix-std}  -nolibdld  -static  -threads}
581 @emph{i386 and x86-64 Options}
582 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
583 -mfpmath=@var{unit} @gol
584 -masm=@var{dialect}  -mno-fancy-math-387 @gol
585 -mno-fp-ret-in-387  -msoft-float @gol
586 -mno-wide-multiply  -mrtd  -malign-double @gol
587 -mpreferred-stack-boundary=@var{num}
588 -mincoming-stack-boundary=@var{num}
589 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
590 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
591 -maes -mpclmul -mfused-madd @gol
592 -msse4a -m3dnow -mpopcnt -mabm -mfma4 -mxop -mlwp @gol
593 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
594 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
595 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
596 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
597 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
598 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
599 -mcmodel=@var{code-model} -mabi=@var{name} @gol
600 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
601 -msse2avx}
603 @emph{IA-64 Options}
604 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
605 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
606 -mconstant-gp  -mauto-pic  -mfused-madd @gol
607 -minline-float-divide-min-latency @gol
608 -minline-float-divide-max-throughput @gol
609 -mno-inline-float-divide @gol
610 -minline-int-divide-min-latency @gol
611 -minline-int-divide-max-throughput  @gol
612 -mno-inline-int-divide @gol
613 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
614 -mno-inline-sqrt @gol
615 -mdwarf2-asm -mearly-stop-bits @gol
616 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
617 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
618 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
619 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
620 -msched-spec-ldc -msched-spec-control-ldc @gol
621 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
622 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
623 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
624 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
626 @emph{IA-64/VMS Options}
627 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
629 @emph{LM32 Options}
630 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
631 -msign-extend-enabled -muser-enabled}
633 @emph{M32R/D Options}
634 @gccoptlist{-m32r2 -m32rx -m32r @gol
635 -mdebug @gol
636 -malign-loops -mno-align-loops @gol
637 -missue-rate=@var{number} @gol
638 -mbranch-cost=@var{number} @gol
639 -mmodel=@var{code-size-model-type} @gol
640 -msdata=@var{sdata-type} @gol
641 -mno-flush-func -mflush-func=@var{name} @gol
642 -mno-flush-trap -mflush-trap=@var{number} @gol
643 -G @var{num}}
645 @emph{M32C Options}
646 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
648 @emph{M680x0 Options}
649 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
650 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
651 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
652 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
653 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
654 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
655 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
656 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
657 -mxgot -mno-xgot}
659 @emph{M68hc1x Options}
660 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
661 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
662 -msoft-reg-count=@var{count}}
664 @emph{MCore Options}
665 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
666 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
667 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
668 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
669 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
671 @emph{MeP Options}
672 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
673 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
674 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
675 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
676 -mtiny=@var{n}}
678 @emph{MIPS Options}
679 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
680 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
681 -mips64  -mips64r2 @gol
682 -mips16  -mno-mips16  -mflip-mips16 @gol
683 -minterlink-mips16  -mno-interlink-mips16 @gol
684 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
685 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
686 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
687 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
688 -mfpu=@var{fpu-type} @gol
689 -msmartmips  -mno-smartmips @gol
690 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
691 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
692 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
693 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
694 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
695 -membedded-data  -mno-embedded-data @gol
696 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
697 -mcode-readable=@var{setting} @gol
698 -msplit-addresses  -mno-split-addresses @gol
699 -mexplicit-relocs  -mno-explicit-relocs @gol
700 -mcheck-zero-division  -mno-check-zero-division @gol
701 -mdivide-traps  -mdivide-breaks @gol
702 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
703 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
704 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
705 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
706 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
707 -mflush-func=@var{func}  -mno-flush-func @gol
708 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
709 -mfp-exceptions -mno-fp-exceptions @gol
710 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
711 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
713 @emph{MMIX Options}
714 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
715 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
716 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
717 -mno-base-addresses  -msingle-exit  -mno-single-exit}
719 @emph{MN10300 Options}
720 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
721 -mam33  -mno-am33 @gol
722 -mam33-2  -mno-am33-2 @gol
723 -mreturn-pointer-on-d0 @gol
724 -mno-crt0  -mrelax}
726 @emph{PDP-11 Options}
727 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
728 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
729 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
730 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
731 -mbranch-expensive  -mbranch-cheap @gol
732 -msplit  -mno-split  -munix-asm  -mdec-asm}
734 @emph{picoChip Options}
735 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
736 -msymbol-as-address -mno-inefficient-warnings}
738 @emph{PowerPC Options}
739 See RS/6000 and PowerPC Options.
741 @emph{RS/6000 and PowerPC Options}
742 @gccoptlist{-mcpu=@var{cpu-type} @gol
743 -mtune=@var{cpu-type} @gol
744 -mpower  -mno-power  -mpower2  -mno-power2 @gol
745 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
746 -maltivec  -mno-altivec @gol
747 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
748 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
749 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
750 -mfprnd  -mno-fprnd @gol
751 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
752 -mnew-mnemonics  -mold-mnemonics @gol
753 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
754 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
755 -malign-power  -malign-natural @gol
756 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
757 -msingle-float -mdouble-float -msimple-fpu @gol
758 -mstring  -mno-string  -mupdate  -mno-update @gol
759 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
760 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
761 -mstrict-align  -mno-strict-align  -mrelocatable @gol
762 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
763 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
764 -mdynamic-no-pic  -maltivec -mswdiv @gol
765 -mprioritize-restricted-insns=@var{priority} @gol
766 -msched-costly-dep=@var{dependence_type} @gol
767 -minsert-sched-nops=@var{scheme} @gol
768 -mcall-sysv  -mcall-netbsd @gol
769 -maix-struct-return  -msvr4-struct-return @gol
770 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
771 -misel -mno-isel @gol
772 -misel=yes  -misel=no @gol
773 -mspe -mno-spe @gol
774 -mspe=yes  -mspe=no @gol
775 -mpaired @gol
776 -mgen-cell-microcode -mwarn-cell-microcode @gol
777 -mvrsave -mno-vrsave @gol
778 -mmulhw -mno-mulhw @gol
779 -mdlmzb -mno-dlmzb @gol
780 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
781 -mprototype  -mno-prototype @gol
782 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
783 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
785 @emph{RX Options}
786 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
787 -mcpu= -patch=@gol
788 -mbig-endian-data -mlittle-endian-data @gol
789 -msmall-data @gol
790 -msim  -mno-sim@gol
791 -mas100-syntax -mno-as100-syntax@gol
792 -mrelax@gol
793 -mmax-constant-size=@gol
794 -mint-register=@gol
795 -msave-acc-in-interrupts}
797 @emph{S/390 and zSeries Options}
798 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
799 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
800 -mlong-double-64 -mlong-double-128 @gol
801 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
802 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
803 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
804 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
805 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
807 @emph{Score Options}
808 @gccoptlist{-meb -mel @gol
809 -mnhwloop @gol
810 -muls @gol
811 -mmac @gol
812 -mscore5 -mscore5u -mscore7 -mscore7d}
814 @emph{SH Options}
815 @gccoptlist{-m1  -m2  -m2e @gol
816 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
817 -m3  -m3e @gol
818 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
819 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
820 -m5-64media  -m5-64media-nofpu @gol
821 -m5-32media  -m5-32media-nofpu @gol
822 -m5-compact  -m5-compact-nofpu @gol
823 -mb  -ml  -mdalign  -mrelax @gol
824 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
825 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
826 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
827 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
828 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
829 -maccumulate-outgoing-args -minvalid-symbols}
831 @emph{SPARC Options}
832 @gccoptlist{-mcpu=@var{cpu-type} @gol
833 -mtune=@var{cpu-type} @gol
834 -mcmodel=@var{code-model} @gol
835 -m32  -m64  -mapp-regs  -mno-app-regs @gol
836 -mfaster-structs  -mno-faster-structs @gol
837 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
838 -mhard-quad-float  -msoft-quad-float @gol
839 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
840 -mstack-bias  -mno-stack-bias @gol
841 -munaligned-doubles  -mno-unaligned-doubles @gol
842 -mv8plus  -mno-v8plus  -mvis  -mno-vis
843 -threads -pthreads -pthread}
845 @emph{SPU Options}
846 @gccoptlist{-mwarn-reloc -merror-reloc @gol
847 -msafe-dma -munsafe-dma @gol
848 -mbranch-hints @gol
849 -msmall-mem -mlarge-mem -mstdmain @gol
850 -mfixed-range=@var{register-range} @gol
851 -mea32 -mea64 @gol
852 -maddress-space-conversion -mno-address-space-conversion @gol
853 -mcache-size=@var{cache-size} @gol
854 -matomic-updates -mno-atomic-updates}
856 @emph{System V Options}
857 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
859 @emph{V850 Options}
860 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
861 -mprolog-function  -mno-prolog-function  -mspace @gol
862 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
863 -mapp-regs  -mno-app-regs @gol
864 -mdisable-callt  -mno-disable-callt @gol
865 -mv850e1 @gol
866 -mv850e @gol
867 -mv850  -mbig-switch}
869 @emph{VAX Options}
870 @gccoptlist{-mg  -mgnu  -munix}
872 @emph{VxWorks Options}
873 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
874 -Xbind-lazy  -Xbind-now}
876 @emph{x86-64 Options}
877 See i386 and x86-64 Options.
879 @emph{i386 and x86-64 Windows Options}
880 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
881 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows
882 -fno-set-stack-executable}
884 @emph{Xstormy16 Options}
885 @gccoptlist{-msim}
887 @emph{Xtensa Options}
888 @gccoptlist{-mconst16 -mno-const16 @gol
889 -mfused-madd  -mno-fused-madd @gol
890 -mserialize-volatile  -mno-serialize-volatile @gol
891 -mtext-section-literals  -mno-text-section-literals @gol
892 -mtarget-align  -mno-target-align @gol
893 -mlongcalls  -mno-longcalls}
895 @emph{zSeries Options}
896 See S/390 and zSeries Options.
898 @item Code Generation Options
899 @xref{Code Gen Options,,Options for Code Generation Conventions}.
900 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
901 -ffixed-@var{reg}  -fexceptions @gol
902 -fnon-call-exceptions  -funwind-tables @gol
903 -fasynchronous-unwind-tables @gol
904 -finhibit-size-directive  -finstrument-functions @gol
905 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
906 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
907 -fno-common  -fno-ident @gol
908 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
909 -fno-jump-tables @gol
910 -frecord-gcc-switches @gol
911 -freg-struct-return  -fshort-enums @gol
912 -fshort-double  -fshort-wchar @gol
913 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
914 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
915 -fno-stack-limit @gol
916 -fleading-underscore  -ftls-model=@var{model} @gol
917 -ftrapv  -fwrapv  -fbounds-check @gol
918 -fvisibility}
919 @end table
921 @menu
922 * Overall Options::     Controlling the kind of output:
923                         an executable, object files, assembler files,
924                         or preprocessed source.
925 * C Dialect Options::   Controlling the variant of C language compiled.
926 * C++ Dialect Options:: Variations on C++.
927 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
928                         and Objective-C++.
929 * Language Independent Options:: Controlling how diagnostics should be
930                         formatted.
931 * Warning Options::     How picky should the compiler be?
932 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
933 * Optimize Options::    How much optimization?
934 * Preprocessor Options:: Controlling header files and macro definitions.
935                          Also, getting dependency information for Make.
936 * Assembler Options::   Passing options to the assembler.
937 * Link Options::        Specifying libraries and so on.
938 * Directory Options::   Where to find header files and libraries.
939                         Where to find the compiler executable files.
940 * Spec Files::          How to pass switches to sub-processes.
941 * Target Options::      Running a cross-compiler, or an old version of GCC.
942 @end menu
944 @node Overall Options
945 @section Options Controlling the Kind of Output
947 Compilation can involve up to four stages: preprocessing, compilation
948 proper, assembly and linking, always in that order.  GCC is capable of
949 preprocessing and compiling several files either into several
950 assembler input files, or into one assembler input file; then each
951 assembler input file produces an object file, and linking combines all
952 the object files (those newly compiled, and those specified as input)
953 into an executable file.
955 @cindex file name suffix
956 For any given input file, the file name suffix determines what kind of
957 compilation is done:
959 @table @gcctabopt
960 @item @var{file}.c
961 C source code which must be preprocessed.
963 @item @var{file}.i
964 C source code which should not be preprocessed.
966 @item @var{file}.ii
967 C++ source code which should not be preprocessed.
969 @item @var{file}.m
970 Objective-C source code.  Note that you must link with the @file{libobjc}
971 library to make an Objective-C program work.
973 @item @var{file}.mi
974 Objective-C source code which should not be preprocessed.
976 @item @var{file}.mm
977 @itemx @var{file}.M
978 Objective-C++ source code.  Note that you must link with the @file{libobjc}
979 library to make an Objective-C++ program work.  Note that @samp{.M} refers
980 to a literal capital M@.
982 @item @var{file}.mii
983 Objective-C++ source code which should not be preprocessed.
985 @item @var{file}.h
986 C, C++, Objective-C or Objective-C++ header file to be turned into a
987 precompiled header.
989 @item @var{file}.cc
990 @itemx @var{file}.cp
991 @itemx @var{file}.cxx
992 @itemx @var{file}.cpp
993 @itemx @var{file}.CPP
994 @itemx @var{file}.c++
995 @itemx @var{file}.C
996 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
997 the last two letters must both be literally @samp{x}.  Likewise,
998 @samp{.C} refers to a literal capital C@.
1000 @item @var{file}.mm
1001 @itemx @var{file}.M
1002 Objective-C++ source code which must be preprocessed.
1004 @item @var{file}.mii
1005 Objective-C++ source code which should not be preprocessed.
1007 @item @var{file}.hh
1008 @itemx @var{file}.H
1009 @itemx @var{file}.hp
1010 @itemx @var{file}.hxx
1011 @itemx @var{file}.hpp
1012 @itemx @var{file}.HPP
1013 @itemx @var{file}.h++
1014 @itemx @var{file}.tcc
1015 C++ header file to be turned into a precompiled header.
1017 @item @var{file}.f
1018 @itemx @var{file}.for
1019 @itemx @var{file}.ftn
1020 Fixed form Fortran source code which should not be preprocessed.
1022 @item @var{file}.F
1023 @itemx @var{file}.FOR
1024 @itemx @var{file}.fpp
1025 @itemx @var{file}.FPP
1026 @itemx @var{file}.FTN
1027 Fixed form Fortran source code which must be preprocessed (with the traditional
1028 preprocessor).
1030 @item @var{file}.f90
1031 @itemx @var{file}.f95
1032 @itemx @var{file}.f03
1033 @itemx @var{file}.f08
1034 Free form Fortran source code which should not be preprocessed.
1036 @item @var{file}.F90
1037 @itemx @var{file}.F95
1038 @itemx @var{file}.F03
1039 @itemx @var{file}.F08
1040 Free form Fortran source code which must be preprocessed (with the
1041 traditional preprocessor).
1043 @c FIXME: Descriptions of Java file types.
1044 @c @var{file}.java
1045 @c @var{file}.class
1046 @c @var{file}.zip
1047 @c @var{file}.jar
1049 @item @var{file}.ads
1050 Ada source code file which contains a library unit declaration (a
1051 declaration of a package, subprogram, or generic, or a generic
1052 instantiation), or a library unit renaming declaration (a package,
1053 generic, or subprogram renaming declaration).  Such files are also
1054 called @dfn{specs}.
1056 @item @var{file}.adb
1057 Ada source code file containing a library unit body (a subprogram or
1058 package body).  Such files are also called @dfn{bodies}.
1060 @c GCC also knows about some suffixes for languages not yet included:
1061 @c Pascal:
1062 @c @var{file}.p
1063 @c @var{file}.pas
1064 @c Ratfor:
1065 @c @var{file}.r
1067 @item @var{file}.s
1068 Assembler code.
1070 @item @var{file}.S
1071 @itemx @var{file}.sx
1072 Assembler code which must be preprocessed.
1074 @item @var{other}
1075 An object file to be fed straight into linking.
1076 Any file name with no recognized suffix is treated this way.
1077 @end table
1079 @opindex x
1080 You can specify the input language explicitly with the @option{-x} option:
1082 @table @gcctabopt
1083 @item -x @var{language}
1084 Specify explicitly the @var{language} for the following input files
1085 (rather than letting the compiler choose a default based on the file
1086 name suffix).  This option applies to all following input files until
1087 the next @option{-x} option.  Possible values for @var{language} are:
1088 @smallexample
1089 c  c-header  c-cpp-output
1090 c++  c++-header  c++-cpp-output
1091 objective-c  objective-c-header  objective-c-cpp-output
1092 objective-c++ objective-c++-header objective-c++-cpp-output
1093 assembler  assembler-with-cpp
1095 f77  f77-cpp-input f95  f95-cpp-input
1096 java
1097 @end smallexample
1099 @item -x none
1100 Turn off any specification of a language, so that subsequent files are
1101 handled according to their file name suffixes (as they are if @option{-x}
1102 has not been used at all).
1104 @item -pass-exit-codes
1105 @opindex pass-exit-codes
1106 Normally the @command{gcc} program will exit with the code of 1 if any
1107 phase of the compiler returns a non-success return code.  If you specify
1108 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1109 numerically highest error produced by any phase that returned an error
1110 indication.  The C, C++, and Fortran frontends return 4, if an internal
1111 compiler error is encountered.
1112 @end table
1114 If you only want some of the stages of compilation, you can use
1115 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1116 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1117 @command{gcc} is to stop.  Note that some combinations (for example,
1118 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1120 @table @gcctabopt
1121 @item -c
1122 @opindex c
1123 Compile or assemble the source files, but do not link.  The linking
1124 stage simply is not done.  The ultimate output is in the form of an
1125 object file for each source file.
1127 By default, the object file name for a source file is made by replacing
1128 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1130 Unrecognized input files, not requiring compilation or assembly, are
1131 ignored.
1133 @item -S
1134 @opindex S
1135 Stop after the stage of compilation proper; do not assemble.  The output
1136 is in the form of an assembler code file for each non-assembler input
1137 file specified.
1139 By default, the assembler file name for a source file is made by
1140 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1142 Input files that don't require compilation are ignored.
1144 @item -E
1145 @opindex E
1146 Stop after the preprocessing stage; do not run the compiler proper.  The
1147 output is in the form of preprocessed source code, which is sent to the
1148 standard output.
1150 Input files which don't require preprocessing are ignored.
1152 @cindex output file option
1153 @item -o @var{file}
1154 @opindex o
1155 Place output in file @var{file}.  This applies regardless to whatever
1156 sort of output is being produced, whether it be an executable file,
1157 an object file, an assembler file or preprocessed C code.
1159 If @option{-o} is not specified, the default is to put an executable
1160 file in @file{a.out}, the object file for
1161 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1162 assembler file in @file{@var{source}.s}, a precompiled header file in
1163 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1164 standard output.
1166 @item -v
1167 @opindex v
1168 Print (on standard error output) the commands executed to run the stages
1169 of compilation.  Also print the version number of the compiler driver
1170 program and of the preprocessor and the compiler proper.
1172 @item -###
1173 @opindex ###
1174 Like @option{-v} except the commands are not executed and all command
1175 arguments are quoted.  This is useful for shell scripts to capture the
1176 driver-generated command lines.
1178 @item -pipe
1179 @opindex pipe
1180 Use pipes rather than temporary files for communication between the
1181 various stages of compilation.  This fails to work on some systems where
1182 the assembler is unable to read from a pipe; but the GNU assembler has
1183 no trouble.
1185 @item -combine
1186 @opindex combine
1187 If you are compiling multiple source files, this option tells the driver
1188 to pass all the source files to the compiler at once (for those
1189 languages for which the compiler can handle this).  This will allow
1190 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1191 language for which this is supported is C@.  If you pass source files for
1192 multiple languages to the driver, using this option, the driver will invoke
1193 the compiler(s) that support IMA once each, passing each compiler all the
1194 source files appropriate for it.  For those languages that do not support
1195 IMA this option will be ignored, and the compiler will be invoked once for
1196 each source file in that language.  If you use this option in conjunction
1197 with @option{-save-temps}, the compiler will generate multiple
1198 pre-processed files
1199 (one for each source file), but only one (combined) @file{.o} or
1200 @file{.s} file.
1202 @item --help
1203 @opindex help
1204 Print (on the standard output) a description of the command line options
1205 understood by @command{gcc}.  If the @option{-v} option is also specified
1206 then @option{--help} will also be passed on to the various processes
1207 invoked by @command{gcc}, so that they can display the command line options
1208 they accept.  If the @option{-Wextra} option has also been specified
1209 (prior to the @option{--help} option), then command line options which
1210 have no documentation associated with them will also be displayed.
1212 @item --target-help
1213 @opindex target-help
1214 Print (on the standard output) a description of target-specific command
1215 line options for each tool.  For some targets extra target-specific
1216 information may also be printed.
1218 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1219 Print (on the standard output) a description of the command line
1220 options understood by the compiler that fit into all specified classes
1221 and qualifiers.  These are the supported classes:
1223 @table @asis
1224 @item @samp{optimizers}
1225 This will display all of the optimization options supported by the
1226 compiler.
1228 @item @samp{warnings}
1229 This will display all of the options controlling warning messages
1230 produced by the compiler.
1232 @item @samp{target}
1233 This will display target-specific options.  Unlike the
1234 @option{--target-help} option however, target-specific options of the
1235 linker and assembler will not be displayed.  This is because those
1236 tools do not currently support the extended @option{--help=} syntax.
1238 @item @samp{params}
1239 This will display the values recognized by the @option{--param}
1240 option.
1242 @item @var{language}
1243 This will display the options supported for @var{language}, where
1244 @var{language} is the name of one of the languages supported in this
1245 version of GCC.
1247 @item @samp{common}
1248 This will display the options that are common to all languages.
1249 @end table
1251 These are the supported qualifiers:
1253 @table @asis
1254 @item @samp{undocumented}
1255 Display only those options which are undocumented.
1257 @item @samp{joined}
1258 Display options which take an argument that appears after an equal
1259 sign in the same continuous piece of text, such as:
1260 @samp{--help=target}.
1262 @item @samp{separate}
1263 Display options which take an argument that appears as a separate word
1264 following the original option, such as: @samp{-o output-file}.
1265 @end table
1267 Thus for example to display all the undocumented target-specific
1268 switches supported by the compiler the following can be used:
1270 @smallexample
1271 --help=target,undocumented
1272 @end smallexample
1274 The sense of a qualifier can be inverted by prefixing it with the
1275 @samp{^} character, so for example to display all binary warning
1276 options (i.e., ones that are either on or off and that do not take an
1277 argument), which have a description the following can be used:
1279 @smallexample
1280 --help=warnings,^joined,^undocumented
1281 @end smallexample
1283 The argument to @option{--help=} should not consist solely of inverted
1284 qualifiers.
1286 Combining several classes is possible, although this usually
1287 restricts the output by so much that there is nothing to display.  One
1288 case where it does work however is when one of the classes is
1289 @var{target}.  So for example to display all the target-specific
1290 optimization options the following can be used:
1292 @smallexample
1293 --help=target,optimizers
1294 @end smallexample
1296 The @option{--help=} option can be repeated on the command line.  Each
1297 successive use will display its requested class of options, skipping
1298 those that have already been displayed.
1300 If the @option{-Q} option appears on the command line before the
1301 @option{--help=} option, then the descriptive text displayed by
1302 @option{--help=} is changed.  Instead of describing the displayed
1303 options, an indication is given as to whether the option is enabled,
1304 disabled or set to a specific value (assuming that the compiler
1305 knows this at the point where the @option{--help=} option is used).
1307 Here is a truncated example from the ARM port of @command{gcc}:
1309 @smallexample
1310   % gcc -Q -mabi=2 --help=target -c
1311   The following options are target specific:
1312   -mabi=                                2
1313   -mabort-on-noreturn                   [disabled]
1314   -mapcs                                [disabled]
1315 @end smallexample
1317 The output is sensitive to the effects of previous command line
1318 options, so for example it is possible to find out which optimizations
1319 are enabled at @option{-O2} by using:
1321 @smallexample
1322 -Q -O2 --help=optimizers
1323 @end smallexample
1325 Alternatively you can discover which binary optimizations are enabled
1326 by @option{-O3} by using:
1328 @smallexample
1329 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1330 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1331 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1332 @end smallexample
1334 @item -no-canonical-prefixes
1335 @opindex no-canonical-prefixes
1336 Do not expand any symbolic links, resolve references to @samp{/../}
1337 or @samp{/./}, or make the path absolute when generating a relative
1338 prefix.
1340 @item --version
1341 @opindex version
1342 Display the version number and copyrights of the invoked GCC@.
1344 @item -wrapper
1345 @opindex wrapper
1346 Invoke all subcommands under a wrapper program. It takes a single
1347 comma separated list as an argument, which will be used to invoke
1348 the wrapper:
1350 @smallexample
1351 gcc -c t.c -wrapper gdb,--args
1352 @end smallexample
1354 This will invoke all subprograms of gcc under "gdb --args",
1355 thus cc1 invocation will be "gdb --args cc1 ...".
1357 @item -fplugin=@var{name}.so
1358 Load the plugin code in file @var{name}.so, assumed to be a
1359 shared object to be dlopen'd by the compiler.  The base name of
1360 the shared object file is used to identify the plugin for the
1361 purposes of argument parsing (See
1362 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1363 Each plugin should define the callback functions specified in the
1364 Plugins API.
1366 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1367 Define an argument called @var{key} with a value of @var{value}
1368 for the plugin called @var{name}.
1370 @include @value{srcdir}/../libiberty/at-file.texi
1371 @end table
1373 @node Invoking G++
1374 @section Compiling C++ Programs
1376 @cindex suffixes for C++ source
1377 @cindex C++ source file suffixes
1378 C++ source files conventionally use one of the suffixes @samp{.C},
1379 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1380 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1381 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1382 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1383 files with these names and compiles them as C++ programs even if you
1384 call the compiler the same way as for compiling C programs (usually
1385 with the name @command{gcc}).
1387 @findex g++
1388 @findex c++
1389 However, the use of @command{gcc} does not add the C++ library.
1390 @command{g++} is a program that calls GCC and treats @samp{.c},
1391 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1392 files unless @option{-x} is used, and automatically specifies linking
1393 against the C++ library.  This program is also useful when
1394 precompiling a C header file with a @samp{.h} extension for use in C++
1395 compilations.  On many systems, @command{g++} is also installed with
1396 the name @command{c++}.
1398 @cindex invoking @command{g++}
1399 When you compile C++ programs, you may specify many of the same
1400 command-line options that you use for compiling programs in any
1401 language; or command-line options meaningful for C and related
1402 languages; or options that are meaningful only for C++ programs.
1403 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1404 explanations of options for languages related to C@.
1405 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1406 explanations of options that are meaningful only for C++ programs.
1408 @node C Dialect Options
1409 @section Options Controlling C Dialect
1410 @cindex dialect options
1411 @cindex language dialect options
1412 @cindex options, dialect
1414 The following options control the dialect of C (or languages derived
1415 from C, such as C++, Objective-C and Objective-C++) that the compiler
1416 accepts:
1418 @table @gcctabopt
1419 @cindex ANSI support
1420 @cindex ISO support
1421 @item -ansi
1422 @opindex ansi
1423 In C mode, this is equivalent to @samp{-std=c90}. In C++ mode, it is
1424 equivalent to @samp{-std=c++98}.
1426 This turns off certain features of GCC that are incompatible with ISO
1427 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1428 such as the @code{asm} and @code{typeof} keywords, and
1429 predefined macros such as @code{unix} and @code{vax} that identify the
1430 type of system you are using.  It also enables the undesirable and
1431 rarely used ISO trigraph feature.  For the C compiler,
1432 it disables recognition of C++ style @samp{//} comments as well as
1433 the @code{inline} keyword.
1435 The alternate keywords @code{__asm__}, @code{__extension__},
1436 @code{__inline__} and @code{__typeof__} continue to work despite
1437 @option{-ansi}.  You would not want to use them in an ISO C program, of
1438 course, but it is useful to put them in header files that might be included
1439 in compilations done with @option{-ansi}.  Alternate predefined macros
1440 such as @code{__unix__} and @code{__vax__} are also available, with or
1441 without @option{-ansi}.
1443 The @option{-ansi} option does not cause non-ISO programs to be
1444 rejected gratuitously.  For that, @option{-pedantic} is required in
1445 addition to @option{-ansi}.  @xref{Warning Options}.
1447 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1448 option is used.  Some header files may notice this macro and refrain
1449 from declaring certain functions or defining certain macros that the
1450 ISO standard doesn't call for; this is to avoid interfering with any
1451 programs that might use these names for other things.
1453 Functions that would normally be built in but do not have semantics
1454 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1455 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1456 built-in functions provided by GCC}, for details of the functions
1457 affected.
1459 @item -std=
1460 @opindex std
1461 Determine the language standard. @xref{Standards,,Language Standards
1462 Supported by GCC}, for details of these standard versions.  This option
1463 is currently only supported when compiling C or C++.
1465 The compiler can accept several base standards, such as @samp{c90} or
1466 @samp{c++98}, and GNU dialects of those standards, such as
1467 @samp{gnu90} or @samp{gnu++98}.  By specifying a base standard, the
1468 compiler will accept all programs following that standard and those
1469 using GNU extensions that do not contradict it.  For example,
1470 @samp{-std=c90} turns off certain features of GCC that are
1471 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1472 keywords, but not other GNU extensions that do not have a meaning in
1473 ISO C90, such as omitting the middle term of a @code{?:}
1474 expression. On the other hand, by specifying a GNU dialect of a
1475 standard, all features the compiler support are enabled, even when
1476 those features change the meaning of the base standard and some
1477 strict-conforming programs may be rejected.  The particular standard
1478 is used by @option{-pedantic} to identify which features are GNU
1479 extensions given that version of the standard. For example
1480 @samp{-std=gnu90 -pedantic} would warn about C++ style @samp{//}
1481 comments, while @samp{-std=gnu99 -pedantic} would not.
1483 A value for this option must be provided; possible values are
1485 @table @samp
1486 @item c90
1487 @itemx c89
1488 @itemx iso9899:1990
1489 Support all ISO C90 programs (certain GNU extensions that conflict
1490 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1492 @item iso9899:199409
1493 ISO C90 as modified in amendment 1.
1495 @item c99
1496 @itemx c9x
1497 @itemx iso9899:1999
1498 @itemx iso9899:199x
1499 ISO C99.  Note that this standard is not yet fully supported; see
1500 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1501 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1503 @item c1x
1504 ISO C1X, the draft of the next revision of the ISO C standard.
1505 Support is limited and experimental and features enabled by this
1506 option may be changed or removed if changed in or removed from the
1507 standard draft.
1509 @item gnu90
1510 @itemx gnu89
1511 GNU dialect of ISO C90 (including some C99 features). This
1512 is the default for C code.
1514 @item gnu99
1515 @itemx gnu9x
1516 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1517 this will become the default.  The name @samp{gnu9x} is deprecated.
1519 @item gnu1x
1520 GNU dialect of ISO C1X.  Support is limited and experimental and
1521 features enabled by this option may be changed or removed if changed
1522 in or removed from the standard draft.
1524 @item c++98
1525 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1526 C++ code.
1528 @item gnu++98
1529 GNU dialect of @option{-std=c++98}.  This is the default for
1530 C++ code.
1532 @item c++0x
1533 The working draft of the upcoming ISO C++0x standard. This option
1534 enables experimental features that are likely to be included in
1535 C++0x. The working draft is constantly changing, and any feature that is
1536 enabled by this flag may be removed from future versions of GCC if it is
1537 not part of the C++0x standard.
1539 @item gnu++0x
1540 GNU dialect of @option{-std=c++0x}. This option enables
1541 experimental features that may be removed in future versions of GCC.
1542 @end table
1544 @item -fgnu89-inline
1545 @opindex fgnu89-inline
1546 The option @option{-fgnu89-inline} tells GCC to use the traditional
1547 GNU semantics for @code{inline} functions when in C99 mode.
1548 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1549 is accepted and ignored by GCC versions 4.1.3 up to but not including
1550 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1551 C99 mode.  Using this option is roughly equivalent to adding the
1552 @code{gnu_inline} function attribute to all inline functions
1553 (@pxref{Function Attributes}).
1555 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1556 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1557 specifies the default behavior).  This option was first supported in
1558 GCC 4.3.  This option is not supported in @option{-std=c90} or
1559 @option{-std=gnu90} mode.
1561 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1562 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1563 in effect for @code{inline} functions.  @xref{Common Predefined
1564 Macros,,,cpp,The C Preprocessor}.
1566 @item -aux-info @var{filename}
1567 @opindex aux-info
1568 Output to the given filename prototyped declarations for all functions
1569 declared and/or defined in a translation unit, including those in header
1570 files.  This option is silently ignored in any language other than C@.
1572 Besides declarations, the file indicates, in comments, the origin of
1573 each declaration (source file and line), whether the declaration was
1574 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1575 @samp{O} for old, respectively, in the first character after the line
1576 number and the colon), and whether it came from a declaration or a
1577 definition (@samp{C} or @samp{F}, respectively, in the following
1578 character).  In the case of function definitions, a K&R-style list of
1579 arguments followed by their declarations is also provided, inside
1580 comments, after the declaration.
1582 @item -fno-asm
1583 @opindex fno-asm
1584 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1585 keyword, so that code can use these words as identifiers.  You can use
1586 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1587 instead.  @option{-ansi} implies @option{-fno-asm}.
1589 In C++, this switch only affects the @code{typeof} keyword, since
1590 @code{asm} and @code{inline} are standard keywords.  You may want to
1591 use the @option{-fno-gnu-keywords} flag instead, which has the same
1592 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1593 switch only affects the @code{asm} and @code{typeof} keywords, since
1594 @code{inline} is a standard keyword in ISO C99.
1596 @item -fno-builtin
1597 @itemx -fno-builtin-@var{function}
1598 @opindex fno-builtin
1599 @cindex built-in functions
1600 Don't recognize built-in functions that do not begin with
1601 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1602 functions provided by GCC}, for details of the functions affected,
1603 including those which are not built-in functions when @option{-ansi} or
1604 @option{-std} options for strict ISO C conformance are used because they
1605 do not have an ISO standard meaning.
1607 GCC normally generates special code to handle certain built-in functions
1608 more efficiently; for instance, calls to @code{alloca} may become single
1609 instructions that adjust the stack directly, and calls to @code{memcpy}
1610 may become inline copy loops.  The resulting code is often both smaller
1611 and faster, but since the function calls no longer appear as such, you
1612 cannot set a breakpoint on those calls, nor can you change the behavior
1613 of the functions by linking with a different library.  In addition,
1614 when a function is recognized as a built-in function, GCC may use
1615 information about that function to warn about problems with calls to
1616 that function, or to generate more efficient code, even if the
1617 resulting code still contains calls to that function.  For example,
1618 warnings are given with @option{-Wformat} for bad calls to
1619 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1620 known not to modify global memory.
1622 With the @option{-fno-builtin-@var{function}} option
1623 only the built-in function @var{function} is
1624 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1625 function is named that is not built-in in this version of GCC, this
1626 option is ignored.  There is no corresponding
1627 @option{-fbuiltin-@var{function}} option; if you wish to enable
1628 built-in functions selectively when using @option{-fno-builtin} or
1629 @option{-ffreestanding}, you may define macros such as:
1631 @smallexample
1632 #define abs(n)          __builtin_abs ((n))
1633 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1634 @end smallexample
1636 @item -fhosted
1637 @opindex fhosted
1638 @cindex hosted environment
1640 Assert that compilation takes place in a hosted environment.  This implies
1641 @option{-fbuiltin}.  A hosted environment is one in which the
1642 entire standard library is available, and in which @code{main} has a return
1643 type of @code{int}.  Examples are nearly everything except a kernel.
1644 This is equivalent to @option{-fno-freestanding}.
1646 @item -ffreestanding
1647 @opindex ffreestanding
1648 @cindex hosted environment
1650 Assert that compilation takes place in a freestanding environment.  This
1651 implies @option{-fno-builtin}.  A freestanding environment
1652 is one in which the standard library may not exist, and program startup may
1653 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1654 This is equivalent to @option{-fno-hosted}.
1656 @xref{Standards,,Language Standards Supported by GCC}, for details of
1657 freestanding and hosted environments.
1659 @item -fopenmp
1660 @opindex fopenmp
1661 @cindex openmp parallel
1662 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1663 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1664 compiler generates parallel code according to the OpenMP Application
1665 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1666 implies @option{-pthread}, and thus is only supported on targets that
1667 have support for @option{-pthread}.
1669 @item -fms-extensions
1670 @opindex fms-extensions
1671 Accept some non-standard constructs used in Microsoft header files.
1673 Some cases of unnamed fields in structures and unions are only
1674 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1675 fields within structs/unions}, for details.
1677 @item -trigraphs
1678 @opindex trigraphs
1679 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1680 options for strict ISO C conformance) implies @option{-trigraphs}.
1682 @item -no-integrated-cpp
1683 @opindex no-integrated-cpp
1684 Performs a compilation in two passes: preprocessing and compiling.  This
1685 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1686 @option{-B} option.  The user supplied compilation step can then add in
1687 an additional preprocessing step after normal preprocessing but before
1688 compiling.  The default is to use the integrated cpp (internal cpp)
1690 The semantics of this option will change if "cc1", "cc1plus", and
1691 "cc1obj" are merged.
1693 @cindex traditional C language
1694 @cindex C language, traditional
1695 @item -traditional
1696 @itemx -traditional-cpp
1697 @opindex traditional-cpp
1698 @opindex traditional
1699 Formerly, these options caused GCC to attempt to emulate a pre-standard
1700 C compiler.  They are now only supported with the @option{-E} switch.
1701 The preprocessor continues to support a pre-standard mode.  See the GNU
1702 CPP manual for details.
1704 @item -fcond-mismatch
1705 @opindex fcond-mismatch
1706 Allow conditional expressions with mismatched types in the second and
1707 third arguments.  The value of such an expression is void.  This option
1708 is not supported for C++.
1710 @item -flax-vector-conversions
1711 @opindex flax-vector-conversions
1712 Allow implicit conversions between vectors with differing numbers of
1713 elements and/or incompatible element types.  This option should not be
1714 used for new code.
1716 @item -funsigned-char
1717 @opindex funsigned-char
1718 Let the type @code{char} be unsigned, like @code{unsigned char}.
1720 Each kind of machine has a default for what @code{char} should
1721 be.  It is either like @code{unsigned char} by default or like
1722 @code{signed char} by default.
1724 Ideally, a portable program should always use @code{signed char} or
1725 @code{unsigned char} when it depends on the signedness of an object.
1726 But many programs have been written to use plain @code{char} and
1727 expect it to be signed, or expect it to be unsigned, depending on the
1728 machines they were written for.  This option, and its inverse, let you
1729 make such a program work with the opposite default.
1731 The type @code{char} is always a distinct type from each of
1732 @code{signed char} or @code{unsigned char}, even though its behavior
1733 is always just like one of those two.
1735 @item -fsigned-char
1736 @opindex fsigned-char
1737 Let the type @code{char} be signed, like @code{signed char}.
1739 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1740 the negative form of @option{-funsigned-char}.  Likewise, the option
1741 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1743 @item -fsigned-bitfields
1744 @itemx -funsigned-bitfields
1745 @itemx -fno-signed-bitfields
1746 @itemx -fno-unsigned-bitfields
1747 @opindex fsigned-bitfields
1748 @opindex funsigned-bitfields
1749 @opindex fno-signed-bitfields
1750 @opindex fno-unsigned-bitfields
1751 These options control whether a bit-field is signed or unsigned, when the
1752 declaration does not use either @code{signed} or @code{unsigned}.  By
1753 default, such a bit-field is signed, because this is consistent: the
1754 basic integer types such as @code{int} are signed types.
1755 @end table
1757 @node C++ Dialect Options
1758 @section Options Controlling C++ Dialect
1760 @cindex compiler options, C++
1761 @cindex C++ options, command line
1762 @cindex options, C++
1763 This section describes the command-line options that are only meaningful
1764 for C++ programs; but you can also use most of the GNU compiler options
1765 regardless of what language your program is in.  For example, you
1766 might compile a file @code{firstClass.C} like this:
1768 @smallexample
1769 g++ -g -frepo -O -c firstClass.C
1770 @end smallexample
1772 @noindent
1773 In this example, only @option{-frepo} is an option meant
1774 only for C++ programs; you can use the other options with any
1775 language supported by GCC@.
1777 Here is a list of options that are @emph{only} for compiling C++ programs:
1779 @table @gcctabopt
1781 @item -fabi-version=@var{n}
1782 @opindex fabi-version
1783 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1784 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1785 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1786 the version that conforms most closely to the C++ ABI specification.
1787 Therefore, the ABI obtained using version 0 will change as ABI bugs
1788 are fixed.
1790 The default is version 2.
1792 Version 3 corrects an error in mangling a constant address as a
1793 template argument.
1795 Version 4 implements a standard mangling for vector types.
1797 See also @option{-Wabi}.
1799 @item -fno-access-control
1800 @opindex fno-access-control
1801 Turn off all access checking.  This switch is mainly useful for working
1802 around bugs in the access control code.
1804 @item -fcheck-new
1805 @opindex fcheck-new
1806 Check that the pointer returned by @code{operator new} is non-null
1807 before attempting to modify the storage allocated.  This check is
1808 normally unnecessary because the C++ standard specifies that
1809 @code{operator new} will only return @code{0} if it is declared
1810 @samp{throw()}, in which case the compiler will always check the
1811 return value even without this option.  In all other cases, when
1812 @code{operator new} has a non-empty exception specification, memory
1813 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1814 @samp{new (nothrow)}.
1816 @item -fconserve-space
1817 @opindex fconserve-space
1818 Put uninitialized or runtime-initialized global variables into the
1819 common segment, as C does.  This saves space in the executable at the
1820 cost of not diagnosing duplicate definitions.  If you compile with this
1821 flag and your program mysteriously crashes after @code{main()} has
1822 completed, you may have an object that is being destroyed twice because
1823 two definitions were merged.
1825 This option is no longer useful on most targets, now that support has
1826 been added for putting variables into BSS without making them common.
1828 @item -fno-deduce-init-list
1829 @opindex fno-deduce-init-list
1830 Disable deduction of a template type parameter as
1831 std::initializer_list from a brace-enclosed initializer list, i.e.
1833 @smallexample
1834 template <class T> auto forward(T t) -> decltype (realfn (t))
1836   return realfn (t);
1839 void f()
1841   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1843 @end smallexample
1845 This option is present because this deduction is an extension to the
1846 current specification in the C++0x working draft, and there was
1847 some concern about potential overload resolution problems.
1849 @item -ffriend-injection
1850 @opindex ffriend-injection
1851 Inject friend functions into the enclosing namespace, so that they are
1852 visible outside the scope of the class in which they are declared.
1853 Friend functions were documented to work this way in the old Annotated
1854 C++ Reference Manual, and versions of G++ before 4.1 always worked
1855 that way.  However, in ISO C++ a friend function which is not declared
1856 in an enclosing scope can only be found using argument dependent
1857 lookup.  This option causes friends to be injected as they were in
1858 earlier releases.
1860 This option is for compatibility, and may be removed in a future
1861 release of G++.
1863 @item -fno-elide-constructors
1864 @opindex fno-elide-constructors
1865 The C++ standard allows an implementation to omit creating a temporary
1866 which is only used to initialize another object of the same type.
1867 Specifying this option disables that optimization, and forces G++ to
1868 call the copy constructor in all cases.
1870 @item -fno-enforce-eh-specs
1871 @opindex fno-enforce-eh-specs
1872 Don't generate code to check for violation of exception specifications
1873 at runtime.  This option violates the C++ standard, but may be useful
1874 for reducing code size in production builds, much like defining
1875 @samp{NDEBUG}.  This does not give user code permission to throw
1876 exceptions in violation of the exception specifications; the compiler
1877 will still optimize based on the specifications, so throwing an
1878 unexpected exception will result in undefined behavior.
1880 @item -ffor-scope
1881 @itemx -fno-for-scope
1882 @opindex ffor-scope
1883 @opindex fno-for-scope
1884 If @option{-ffor-scope} is specified, the scope of variables declared in
1885 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1886 as specified by the C++ standard.
1887 If @option{-fno-for-scope} is specified, the scope of variables declared in
1888 a @i{for-init-statement} extends to the end of the enclosing scope,
1889 as was the case in old versions of G++, and other (traditional)
1890 implementations of C++.
1892 The default if neither flag is given to follow the standard,
1893 but to allow and give a warning for old-style code that would
1894 otherwise be invalid, or have different behavior.
1896 @item -fno-gnu-keywords
1897 @opindex fno-gnu-keywords
1898 Do not recognize @code{typeof} as a keyword, so that code can use this
1899 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1900 @option{-ansi} implies @option{-fno-gnu-keywords}.
1902 @item -fno-implicit-templates
1903 @opindex fno-implicit-templates
1904 Never emit code for non-inline templates which are instantiated
1905 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1906 @xref{Template Instantiation}, for more information.
1908 @item -fno-implicit-inline-templates
1909 @opindex fno-implicit-inline-templates
1910 Don't emit code for implicit instantiations of inline templates, either.
1911 The default is to handle inlines differently so that compiles with and
1912 without optimization will need the same set of explicit instantiations.
1914 @item -fno-implement-inlines
1915 @opindex fno-implement-inlines
1916 To save space, do not emit out-of-line copies of inline functions
1917 controlled by @samp{#pragma implementation}.  This will cause linker
1918 errors if these functions are not inlined everywhere they are called.
1920 @item -fms-extensions
1921 @opindex fms-extensions
1922 Disable pedantic warnings about constructs used in MFC, such as implicit
1923 int and getting a pointer to member function via non-standard syntax.
1925 @item -fno-nonansi-builtins
1926 @opindex fno-nonansi-builtins
1927 Disable built-in declarations of functions that are not mandated by
1928 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1929 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1931 @item -fno-operator-names
1932 @opindex fno-operator-names
1933 Do not treat the operator name keywords @code{and}, @code{bitand},
1934 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1935 synonyms as keywords.
1937 @item -fno-optional-diags
1938 @opindex fno-optional-diags
1939 Disable diagnostics that the standard says a compiler does not need to
1940 issue.  Currently, the only such diagnostic issued by G++ is the one for
1941 a name having multiple meanings within a class.
1943 @item -fpermissive
1944 @opindex fpermissive
1945 Downgrade some diagnostics about nonconformant code from errors to
1946 warnings.  Thus, using @option{-fpermissive} will allow some
1947 nonconforming code to compile.
1949 @item -fno-pretty-templates
1950 @opindex fno-pretty-templates
1951 When an error message refers to a specialization of a function
1952 template, the compiler will normally print the signature of the
1953 template followed by the template arguments and any typedefs or
1954 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1955 rather than @code{void f(int)}) so that it's clear which template is
1956 involved.  When an error message refers to a specialization of a class
1957 template, the compiler will omit any template arguments which match
1958 the default template arguments for that template.  If either of these
1959 behaviors make it harder to understand the error message rather than
1960 easier, using @option{-fno-pretty-templates} will disable them.
1962 @item -frepo
1963 @opindex frepo
1964 Enable automatic template instantiation at link time.  This option also
1965 implies @option{-fno-implicit-templates}.  @xref{Template
1966 Instantiation}, for more information.
1968 @item -fno-rtti
1969 @opindex fno-rtti
1970 Disable generation of information about every class with virtual
1971 functions for use by the C++ runtime type identification features
1972 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1973 of the language, you can save some space by using this flag.  Note that
1974 exception handling uses the same information, but it will generate it as
1975 needed. The @samp{dynamic_cast} operator can still be used for casts that
1976 do not require runtime type information, i.e.@: casts to @code{void *} or to
1977 unambiguous base classes.
1979 @item -fstats
1980 @opindex fstats
1981 Emit statistics about front-end processing at the end of the compilation.
1982 This information is generally only useful to the G++ development team.
1984 @item -ftemplate-depth=@var{n}
1985 @opindex ftemplate-depth
1986 Set the maximum instantiation depth for template classes to @var{n}.
1987 A limit on the template instantiation depth is needed to detect
1988 endless recursions during template class instantiation.  ANSI/ISO C++
1989 conforming programs must not rely on a maximum depth greater than 17
1990 (changed to 1024 in C++0x).
1992 @item -fno-threadsafe-statics
1993 @opindex fno-threadsafe-statics
1994 Do not emit the extra code to use the routines specified in the C++
1995 ABI for thread-safe initialization of local statics.  You can use this
1996 option to reduce code size slightly in code that doesn't need to be
1997 thread-safe.
1999 @item -fuse-cxa-atexit
2000 @opindex fuse-cxa-atexit
2001 Register destructors for objects with static storage duration with the
2002 @code{__cxa_atexit} function rather than the @code{atexit} function.
2003 This option is required for fully standards-compliant handling of static
2004 destructors, but will only work if your C library supports
2005 @code{__cxa_atexit}.
2007 @item -fno-use-cxa-get-exception-ptr
2008 @opindex fno-use-cxa-get-exception-ptr
2009 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2010 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2011 if the runtime routine is not available.
2013 @item -fvisibility-inlines-hidden
2014 @opindex fvisibility-inlines-hidden
2015 This switch declares that the user does not attempt to compare
2016 pointers to inline methods where the addresses of the two functions
2017 were taken in different shared objects.
2019 The effect of this is that GCC may, effectively, mark inline methods with
2020 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2021 appear in the export table of a DSO and do not require a PLT indirection
2022 when used within the DSO@.  Enabling this option can have a dramatic effect
2023 on load and link times of a DSO as it massively reduces the size of the
2024 dynamic export table when the library makes heavy use of templates.
2026 The behavior of this switch is not quite the same as marking the
2027 methods as hidden directly, because it does not affect static variables
2028 local to the function or cause the compiler to deduce that
2029 the function is defined in only one shared object.
2031 You may mark a method as having a visibility explicitly to negate the
2032 effect of the switch for that method.  For example, if you do want to
2033 compare pointers to a particular inline method, you might mark it as
2034 having default visibility.  Marking the enclosing class with explicit
2035 visibility will have no effect.
2037 Explicitly instantiated inline methods are unaffected by this option
2038 as their linkage might otherwise cross a shared library boundary.
2039 @xref{Template Instantiation}.
2041 @item -fvisibility-ms-compat
2042 @opindex fvisibility-ms-compat
2043 This flag attempts to use visibility settings to make GCC's C++
2044 linkage model compatible with that of Microsoft Visual Studio.
2046 The flag makes these changes to GCC's linkage model:
2048 @enumerate
2049 @item
2050 It sets the default visibility to @code{hidden}, like
2051 @option{-fvisibility=hidden}.
2053 @item
2054 Types, but not their members, are not hidden by default.
2056 @item
2057 The One Definition Rule is relaxed for types without explicit
2058 visibility specifications which are defined in more than one different
2059 shared object: those declarations are permitted if they would have
2060 been permitted when this option was not used.
2061 @end enumerate
2063 In new code it is better to use @option{-fvisibility=hidden} and
2064 export those classes which are intended to be externally visible.
2065 Unfortunately it is possible for code to rely, perhaps accidentally,
2066 on the Visual Studio behavior.
2068 Among the consequences of these changes are that static data members
2069 of the same type with the same name but defined in different shared
2070 objects will be different, so changing one will not change the other;
2071 and that pointers to function members defined in different shared
2072 objects may not compare equal.  When this flag is given, it is a
2073 violation of the ODR to define types with the same name differently.
2075 @item -fno-weak
2076 @opindex fno-weak
2077 Do not use weak symbol support, even if it is provided by the linker.
2078 By default, G++ will use weak symbols if they are available.  This
2079 option exists only for testing, and should not be used by end-users;
2080 it will result in inferior code and has no benefits.  This option may
2081 be removed in a future release of G++.
2083 @item -nostdinc++
2084 @opindex nostdinc++
2085 Do not search for header files in the standard directories specific to
2086 C++, but do still search the other standard directories.  (This option
2087 is used when building the C++ library.)
2088 @end table
2090 In addition, these optimization, warning, and code generation options
2091 have meanings only for C++ programs:
2093 @table @gcctabopt
2094 @item -fno-default-inline
2095 @opindex fno-default-inline
2096 Do not assume @samp{inline} for functions defined inside a class scope.
2097 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2098 functions will have linkage like inline functions; they just won't be
2099 inlined by default.
2101 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2102 @opindex Wabi
2103 @opindex Wno-abi
2104 Warn when G++ generates code that is probably not compatible with the
2105 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2106 all such cases, there are probably some cases that are not warned about,
2107 even though G++ is generating incompatible code.  There may also be
2108 cases where warnings are emitted even though the code that is generated
2109 will be compatible.
2111 You should rewrite your code to avoid these warnings if you are
2112 concerned about the fact that code generated by G++ may not be binary
2113 compatible with code generated by other compilers.
2115 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2117 @itemize @bullet
2119 @item
2120 A template with a non-type template parameter of reference type is
2121 mangled incorrectly:
2122 @smallexample
2123 extern int N;
2124 template <int &> struct S @{@};
2125 void n (S<N>) @{2@}
2126 @end smallexample
2128 This is fixed in @option{-fabi-version=3}.
2130 @item
2131 SIMD vector types declared using @code{__attribute ((vector_size))} are
2132 mangled in a non-standard way that does not allow for overloading of
2133 functions taking vectors of different sizes.
2135 The mangling is changed in @option{-fabi-version=4}.
2136 @end itemize
2138 The known incompatibilities in @option{-fabi-version=1} include:
2140 @itemize @bullet
2142 @item
2143 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2144 pack data into the same byte as a base class.  For example:
2146 @smallexample
2147 struct A @{ virtual void f(); int f1 : 1; @};
2148 struct B : public A @{ int f2 : 1; @};
2149 @end smallexample
2151 @noindent
2152 In this case, G++ will place @code{B::f2} into the same byte
2153 as@code{A::f1}; other compilers will not.  You can avoid this problem
2154 by explicitly padding @code{A} so that its size is a multiple of the
2155 byte size on your platform; that will cause G++ and other compilers to
2156 layout @code{B} identically.
2158 @item
2159 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2160 tail padding when laying out virtual bases.  For example:
2162 @smallexample
2163 struct A @{ virtual void f(); char c1; @};
2164 struct B @{ B(); char c2; @};
2165 struct C : public A, public virtual B @{@};
2166 @end smallexample
2168 @noindent
2169 In this case, G++ will not place @code{B} into the tail-padding for
2170 @code{A}; other compilers will.  You can avoid this problem by
2171 explicitly padding @code{A} so that its size is a multiple of its
2172 alignment (ignoring virtual base classes); that will cause G++ and other
2173 compilers to layout @code{C} identically.
2175 @item
2176 Incorrect handling of bit-fields with declared widths greater than that
2177 of their underlying types, when the bit-fields appear in a union.  For
2178 example:
2180 @smallexample
2181 union U @{ int i : 4096; @};
2182 @end smallexample
2184 @noindent
2185 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2186 union too small by the number of bits in an @code{int}.
2188 @item
2189 Empty classes can be placed at incorrect offsets.  For example:
2191 @smallexample
2192 struct A @{@};
2194 struct B @{
2195   A a;
2196   virtual void f ();
2199 struct C : public B, public A @{@};
2200 @end smallexample
2202 @noindent
2203 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2204 it should be placed at offset zero.  G++ mistakenly believes that the
2205 @code{A} data member of @code{B} is already at offset zero.
2207 @item
2208 Names of template functions whose types involve @code{typename} or
2209 template template parameters can be mangled incorrectly.
2211 @smallexample
2212 template <typename Q>
2213 void f(typename Q::X) @{@}
2215 template <template <typename> class Q>
2216 void f(typename Q<int>::X) @{@}
2217 @end smallexample
2219 @noindent
2220 Instantiations of these templates may be mangled incorrectly.
2222 @end itemize
2224 It also warns psABI related changes.  The known psABI changes at this
2225 point include:
2227 @itemize @bullet
2229 @item
2230 For SYSV/x86-64, when passing union with long double, it is changed to
2231 pass in memory as specified in psABI.  For example:
2233 @smallexample
2234 union U @{
2235   long double ld;
2236   int i;
2238 @end smallexample
2240 @noindent
2241 @code{union U} will always be passed in memory.
2243 @end itemize
2245 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2246 @opindex Wctor-dtor-privacy
2247 @opindex Wno-ctor-dtor-privacy
2248 Warn when a class seems unusable because all the constructors or
2249 destructors in that class are private, and it has neither friends nor
2250 public static member functions.
2252 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2253 @opindex Wnon-virtual-dtor
2254 @opindex Wno-non-virtual-dtor
2255 Warn when a class has virtual functions and accessible non-virtual
2256 destructor, in which case it would be possible but unsafe to delete
2257 an instance of a derived class through a pointer to the base class.
2258 This warning is also enabled if -Weffc++ is specified.
2260 @item -Wreorder @r{(C++ and Objective-C++ only)}
2261 @opindex Wreorder
2262 @opindex Wno-reorder
2263 @cindex reordering, warning
2264 @cindex warning for reordering of member initializers
2265 Warn when the order of member initializers given in the code does not
2266 match the order in which they must be executed.  For instance:
2268 @smallexample
2269 struct A @{
2270   int i;
2271   int j;
2272   A(): j (0), i (1) @{ @}
2274 @end smallexample
2276 The compiler will rearrange the member initializers for @samp{i}
2277 and @samp{j} to match the declaration order of the members, emitting
2278 a warning to that effect.  This warning is enabled by @option{-Wall}.
2279 @end table
2281 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2283 @table @gcctabopt
2284 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2285 @opindex Weffc++
2286 @opindex Wno-effc++
2287 Warn about violations of the following style guidelines from Scott Meyers'
2288 @cite{Effective C++} book:
2290 @itemize @bullet
2291 @item
2292 Item 11:  Define a copy constructor and an assignment operator for classes
2293 with dynamically allocated memory.
2295 @item
2296 Item 12:  Prefer initialization to assignment in constructors.
2298 @item
2299 Item 14:  Make destructors virtual in base classes.
2301 @item
2302 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2304 @item
2305 Item 23:  Don't try to return a reference when you must return an object.
2307 @end itemize
2309 Also warn about violations of the following style guidelines from
2310 Scott Meyers' @cite{More Effective C++} book:
2312 @itemize @bullet
2313 @item
2314 Item 6:  Distinguish between prefix and postfix forms of increment and
2315 decrement operators.
2317 @item
2318 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2320 @end itemize
2322 When selecting this option, be aware that the standard library
2323 headers do not obey all of these guidelines; use @samp{grep -v}
2324 to filter out those warnings.
2326 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2327 @opindex Wstrict-null-sentinel
2328 @opindex Wno-strict-null-sentinel
2329 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2330 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2331 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2332 it is guaranteed to be of the same size as a pointer.  But this use is
2333 not portable across different compilers.
2335 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2336 @opindex Wno-non-template-friend
2337 @opindex Wnon-template-friend
2338 Disable warnings when non-templatized friend functions are declared
2339 within a template.  Since the advent of explicit template specification
2340 support in G++, if the name of the friend is an unqualified-id (i.e.,
2341 @samp{friend foo(int)}), the C++ language specification demands that the
2342 friend declare or define an ordinary, nontemplate function.  (Section
2343 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2344 could be interpreted as a particular specialization of a templatized
2345 function.  Because this non-conforming behavior is no longer the default
2346 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2347 check existing code for potential trouble spots and is on by default.
2348 This new compiler behavior can be turned off with
2349 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2350 but disables the helpful warning.
2352 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2353 @opindex Wold-style-cast
2354 @opindex Wno-old-style-cast
2355 Warn if an old-style (C-style) cast to a non-void type is used within
2356 a C++ program.  The new-style casts (@samp{dynamic_cast},
2357 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2358 less vulnerable to unintended effects and much easier to search for.
2360 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2361 @opindex Woverloaded-virtual
2362 @opindex Wno-overloaded-virtual
2363 @cindex overloaded virtual fn, warning
2364 @cindex warning for overloaded virtual fn
2365 Warn when a function declaration hides virtual functions from a
2366 base class.  For example, in:
2368 @smallexample
2369 struct A @{
2370   virtual void f();
2373 struct B: public A @{
2374   void f(int);
2376 @end smallexample
2378 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2379 like:
2381 @smallexample
2382 B* b;
2383 b->f();
2384 @end smallexample
2386 will fail to compile.
2388 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2389 @opindex Wno-pmf-conversions
2390 @opindex Wpmf-conversions
2391 Disable the diagnostic for converting a bound pointer to member function
2392 to a plain pointer.
2394 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2395 @opindex Wsign-promo
2396 @opindex Wno-sign-promo
2397 Warn when overload resolution chooses a promotion from unsigned or
2398 enumerated type to a signed type, over a conversion to an unsigned type of
2399 the same size.  Previous versions of G++ would try to preserve
2400 unsignedness, but the standard mandates the current behavior.
2402 @smallexample
2403 struct A @{
2404   operator int ();
2405   A& operator = (int);
2408 main ()
2410   A a,b;
2411   a = b;
2413 @end smallexample
2415 In this example, G++ will synthesize a default @samp{A& operator =
2416 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2417 @end table
2419 @node Objective-C and Objective-C++ Dialect Options
2420 @section Options Controlling Objective-C and Objective-C++ Dialects
2422 @cindex compiler options, Objective-C and Objective-C++
2423 @cindex Objective-C and Objective-C++ options, command line
2424 @cindex options, Objective-C and Objective-C++
2425 (NOTE: This manual does not describe the Objective-C and Objective-C++
2426 languages themselves.  See @xref{Standards,,Language Standards
2427 Supported by GCC}, for references.)
2429 This section describes the command-line options that are only meaningful
2430 for Objective-C and Objective-C++ programs, but you can also use most of
2431 the language-independent GNU compiler options.
2432 For example, you might compile a file @code{some_class.m} like this:
2434 @smallexample
2435 gcc -g -fgnu-runtime -O -c some_class.m
2436 @end smallexample
2438 @noindent
2439 In this example, @option{-fgnu-runtime} is an option meant only for
2440 Objective-C and Objective-C++ programs; you can use the other options with
2441 any language supported by GCC@.
2443 Note that since Objective-C is an extension of the C language, Objective-C
2444 compilations may also use options specific to the C front-end (e.g.,
2445 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2446 C++-specific options (e.g., @option{-Wabi}).
2448 Here is a list of options that are @emph{only} for compiling Objective-C
2449 and Objective-C++ programs:
2451 @table @gcctabopt
2452 @item -fconstant-string-class=@var{class-name}
2453 @opindex fconstant-string-class
2454 Use @var{class-name} as the name of the class to instantiate for each
2455 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2456 class name is @code{NXConstantString} if the GNU runtime is being used, and
2457 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2458 @option{-fconstant-cfstrings} option, if also present, will override the
2459 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2460 to be laid out as constant CoreFoundation strings.
2462 @item -fgnu-runtime
2463 @opindex fgnu-runtime
2464 Generate object code compatible with the standard GNU Objective-C
2465 runtime.  This is the default for most types of systems.
2467 @item -fnext-runtime
2468 @opindex fnext-runtime
2469 Generate output compatible with the NeXT runtime.  This is the default
2470 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2471 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2472 used.
2474 @item -fno-nil-receivers
2475 @opindex fno-nil-receivers
2476 Assume that all Objective-C message dispatches (e.g.,
2477 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2478 is not @code{nil}.  This allows for more efficient entry points in the runtime
2479 to be used.  Currently, this option is only available in conjunction with
2480 the NeXT runtime on Mac OS X 10.3 and later.
2482 @item -fobjc-call-cxx-cdtors
2483 @opindex fobjc-call-cxx-cdtors
2484 For each Objective-C class, check if any of its instance variables is a
2485 C++ object with a non-trivial default constructor.  If so, synthesize a
2486 special @code{- (id) .cxx_construct} instance method that will run
2487 non-trivial default constructors on any such instance variables, in order,
2488 and then return @code{self}.  Similarly, check if any instance variable
2489 is a C++ object with a non-trivial destructor, and if so, synthesize a
2490 special @code{- (void) .cxx_destruct} method that will run
2491 all such default destructors, in reverse order.
2493 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2494 thusly generated will only operate on instance variables declared in the
2495 current Objective-C class, and not those inherited from superclasses.  It
2496 is the responsibility of the Objective-C runtime to invoke all such methods
2497 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2498 will be invoked by the runtime immediately after a new object
2499 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2500 be invoked immediately before the runtime deallocates an object instance.
2502 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2503 support for invoking the @code{- (id) .cxx_construct} and
2504 @code{- (void) .cxx_destruct} methods.
2506 @item -fobjc-direct-dispatch
2507 @opindex fobjc-direct-dispatch
2508 Allow fast jumps to the message dispatcher.  On Darwin this is
2509 accomplished via the comm page.
2511 @item -fobjc-exceptions
2512 @opindex fobjc-exceptions
2513 Enable syntactic support for structured exception handling in Objective-C,
2514 similar to what is offered by C++ and Java.  This option is
2515 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2516 earlier.
2518 @smallexample
2519   @@try @{
2520     @dots{}
2521        @@throw expr;
2522     @dots{}
2523   @}
2524   @@catch (AnObjCClass *exc) @{
2525     @dots{}
2526       @@throw expr;
2527     @dots{}
2528       @@throw;
2529     @dots{}
2530   @}
2531   @@catch (AnotherClass *exc) @{
2532     @dots{}
2533   @}
2534   @@catch (id allOthers) @{
2535     @dots{}
2536   @}
2537   @@finally @{
2538     @dots{}
2539       @@throw expr;
2540     @dots{}
2541   @}
2542 @end smallexample
2544 The @code{@@throw} statement may appear anywhere in an Objective-C or
2545 Objective-C++ program; when used inside of a @code{@@catch} block, the
2546 @code{@@throw} may appear without an argument (as shown above), in which case
2547 the object caught by the @code{@@catch} will be rethrown.
2549 Note that only (pointers to) Objective-C objects may be thrown and
2550 caught using this scheme.  When an object is thrown, it will be caught
2551 by the nearest @code{@@catch} clause capable of handling objects of that type,
2552 analogously to how @code{catch} blocks work in C++ and Java.  A
2553 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2554 any and all Objective-C exceptions not caught by previous @code{@@catch}
2555 clauses (if any).
2557 The @code{@@finally} clause, if present, will be executed upon exit from the
2558 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2559 regardless of whether any exceptions are thrown, caught or rethrown
2560 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2561 of the @code{finally} clause in Java.
2563 There are several caveats to using the new exception mechanism:
2565 @itemize @bullet
2566 @item
2567 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2568 idioms provided by the @code{NSException} class, the new
2569 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2570 systems, due to additional functionality needed in the (NeXT) Objective-C
2571 runtime.
2573 @item
2574 As mentioned above, the new exceptions do not support handling
2575 types other than Objective-C objects.   Furthermore, when used from
2576 Objective-C++, the Objective-C exception model does not interoperate with C++
2577 exceptions at this time.  This means you cannot @code{@@throw} an exception
2578 from Objective-C and @code{catch} it in C++, or vice versa
2579 (i.e., @code{throw @dots{} @@catch}).
2580 @end itemize
2582 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2583 blocks for thread-safe execution:
2585 @smallexample
2586   @@synchronized (ObjCClass *guard) @{
2587     @dots{}
2588   @}
2589 @end smallexample
2591 Upon entering the @code{@@synchronized} block, a thread of execution shall
2592 first check whether a lock has been placed on the corresponding @code{guard}
2593 object by another thread.  If it has, the current thread shall wait until
2594 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2595 the current thread will place its own lock on it, execute the code contained in
2596 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2597 making @code{guard} available to other threads).
2599 Unlike Java, Objective-C does not allow for entire methods to be marked
2600 @code{@@synchronized}.  Note that throwing exceptions out of
2601 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2602 to be unlocked properly.
2604 @item -fobjc-gc
2605 @opindex fobjc-gc
2606 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2608 @item -freplace-objc-classes
2609 @opindex freplace-objc-classes
2610 Emit a special marker instructing @command{ld(1)} not to statically link in
2611 the resulting object file, and allow @command{dyld(1)} to load it in at
2612 run time instead.  This is used in conjunction with the Fix-and-Continue
2613 debugging mode, where the object file in question may be recompiled and
2614 dynamically reloaded in the course of program execution, without the need
2615 to restart the program itself.  Currently, Fix-and-Continue functionality
2616 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2617 and later.
2619 @item -fzero-link
2620 @opindex fzero-link
2621 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2622 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2623 compile time) with static class references that get initialized at load time,
2624 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2625 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2626 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2627 for individual class implementations to be modified during program execution.
2629 @item -gen-decls
2630 @opindex gen-decls
2631 Dump interface declarations for all classes seen in the source file to a
2632 file named @file{@var{sourcename}.decl}.
2634 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2635 @opindex Wassign-intercept
2636 @opindex Wno-assign-intercept
2637 Warn whenever an Objective-C assignment is being intercepted by the
2638 garbage collector.
2640 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2641 @opindex Wno-protocol
2642 @opindex Wprotocol
2643 If a class is declared to implement a protocol, a warning is issued for
2644 every method in the protocol that is not implemented by the class.  The
2645 default behavior is to issue a warning for every method not explicitly
2646 implemented in the class, even if a method implementation is inherited
2647 from the superclass.  If you use the @option{-Wno-protocol} option, then
2648 methods inherited from the superclass are considered to be implemented,
2649 and no warning is issued for them.
2651 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2652 @opindex Wselector
2653 @opindex Wno-selector
2654 Warn if multiple methods of different types for the same selector are
2655 found during compilation.  The check is performed on the list of methods
2656 in the final stage of compilation.  Additionally, a check is performed
2657 for each selector appearing in a @code{@@selector(@dots{})}
2658 expression, and a corresponding method for that selector has been found
2659 during compilation.  Because these checks scan the method table only at
2660 the end of compilation, these warnings are not produced if the final
2661 stage of compilation is not reached, for example because an error is
2662 found during compilation, or because the @option{-fsyntax-only} option is
2663 being used.
2665 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2666 @opindex Wstrict-selector-match
2667 @opindex Wno-strict-selector-match
2668 Warn if multiple methods with differing argument and/or return types are
2669 found for a given selector when attempting to send a message using this
2670 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2671 is off (which is the default behavior), the compiler will omit such warnings
2672 if any differences found are confined to types which share the same size
2673 and alignment.
2675 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2676 @opindex Wundeclared-selector
2677 @opindex Wno-undeclared-selector
2678 Warn if a @code{@@selector(@dots{})} expression referring to an
2679 undeclared selector is found.  A selector is considered undeclared if no
2680 method with that name has been declared before the
2681 @code{@@selector(@dots{})} expression, either explicitly in an
2682 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2683 an @code{@@implementation} section.  This option always performs its
2684 checks as soon as a @code{@@selector(@dots{})} expression is found,
2685 while @option{-Wselector} only performs its checks in the final stage of
2686 compilation.  This also enforces the coding style convention
2687 that methods and selectors must be declared before being used.
2689 @item -print-objc-runtime-info
2690 @opindex print-objc-runtime-info
2691 Generate C header describing the largest structure that is passed by
2692 value, if any.
2694 @end table
2696 @node Language Independent Options
2697 @section Options to Control Diagnostic Messages Formatting
2698 @cindex options to control diagnostics formatting
2699 @cindex diagnostic messages
2700 @cindex message formatting
2702 Traditionally, diagnostic messages have been formatted irrespective of
2703 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2704 below can be used to control the diagnostic messages formatting
2705 algorithm, e.g.@: how many characters per line, how often source location
2706 information should be reported.  Right now, only the C++ front end can
2707 honor these options.  However it is expected, in the near future, that
2708 the remaining front ends would be able to digest them correctly.
2710 @table @gcctabopt
2711 @item -fmessage-length=@var{n}
2712 @opindex fmessage-length
2713 Try to format error messages so that they fit on lines of about @var{n}
2714 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2715 the front ends supported by GCC@.  If @var{n} is zero, then no
2716 line-wrapping will be done; each error message will appear on a single
2717 line.
2719 @opindex fdiagnostics-show-location
2720 @item -fdiagnostics-show-location=once
2721 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2722 reporter to emit @emph{once} source location information; that is, in
2723 case the message is too long to fit on a single physical line and has to
2724 be wrapped, the source location won't be emitted (as prefix) again,
2725 over and over, in subsequent continuation lines.  This is the default
2726 behavior.
2728 @item -fdiagnostics-show-location=every-line
2729 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2730 messages reporter to emit the same source location information (as
2731 prefix) for physical lines that result from the process of breaking
2732 a message which is too long to fit on a single line.
2734 @item -fdiagnostics-show-option
2735 @opindex fdiagnostics-show-option
2736 This option instructs the diagnostic machinery to add text to each
2737 diagnostic emitted, which indicates which command line option directly
2738 controls that diagnostic, when such an option is known to the
2739 diagnostic machinery.
2741 @item -Wcoverage-mismatch
2742 @opindex Wcoverage-mismatch
2743 Warn if feedback profiles do not match when using the
2744 @option{-fprofile-use} option.
2745 If a source file was changed between @option{-fprofile-gen} and
2746 @option{-fprofile-use}, the files with the profile feedback can fail
2747 to match the source file and GCC can not use the profile feedback
2748 information.  By default, GCC emits an error message in this case.
2749 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2750 error.  GCC does not use appropriate feedback profiles, so using this
2751 option can result in poorly optimized code.  This option is useful
2752 only in the case of very minor changes such as bug fixes to an
2753 existing code-base.
2755 @end table
2757 @node Warning Options
2758 @section Options to Request or Suppress Warnings
2759 @cindex options to control warnings
2760 @cindex warning messages
2761 @cindex messages, warning
2762 @cindex suppressing warnings
2764 Warnings are diagnostic messages that report constructions which
2765 are not inherently erroneous but which are risky or suggest there
2766 may have been an error.
2768 The following language-independent options do not enable specific
2769 warnings but control the kinds of diagnostics produced by GCC.
2771 @table @gcctabopt
2772 @cindex syntax checking
2773 @item -fsyntax-only
2774 @opindex fsyntax-only
2775 Check the code for syntax errors, but don't do anything beyond that.
2777 @item -w
2778 @opindex w
2779 Inhibit all warning messages.
2781 @item -Werror
2782 @opindex Werror
2783 @opindex Wno-error
2784 Make all warnings into errors.
2786 @item -Werror=
2787 @opindex Werror=
2788 @opindex Wno-error=
2789 Make the specified warning into an error.  The specifier for a warning
2790 is appended, for example @option{-Werror=switch} turns the warnings
2791 controlled by @option{-Wswitch} into errors.  This switch takes a
2792 negative form, to be used to negate @option{-Werror} for specific
2793 warnings, for example @option{-Wno-error=switch} makes
2794 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2795 is in effect.  You can use the @option{-fdiagnostics-show-option}
2796 option to have each controllable warning amended with the option which
2797 controls it, to determine what to use with this option.
2799 Note that specifying @option{-Werror=}@var{foo} automatically implies
2800 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2801 imply anything.
2803 @item -Wfatal-errors
2804 @opindex Wfatal-errors
2805 @opindex Wno-fatal-errors
2806 This option causes the compiler to abort compilation on the first error
2807 occurred rather than trying to keep going and printing further error
2808 messages.
2810 @end table
2812 You can request many specific warnings with options beginning
2813 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2814 implicit declarations.  Each of these specific warning options also
2815 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2816 example, @option{-Wno-implicit}.  This manual lists only one of the
2817 two forms, whichever is not the default.  For further,
2818 language-specific options also refer to @ref{C++ Dialect Options} and
2819 @ref{Objective-C and Objective-C++ Dialect Options}.
2821 When an unrecognized warning label is requested (e.g.,
2822 @option{-Wunknown-warning}), GCC will emit a diagnostic stating
2823 that the option is not recognized.  However, if the @samp{-Wno-} form
2824 is used, the behavior is slightly different: No diagnostic will be
2825 produced for @option{-Wno-unknown-warning} unless other diagnostics
2826 are being produced.  This allows the use of new @option{-Wno-} options
2827 with old compilers, but if something goes wrong, the compiler will
2828 warn that an unrecognized option was used.
2830 @table @gcctabopt
2831 @item -pedantic
2832 @opindex pedantic
2833 Issue all the warnings demanded by strict ISO C and ISO C++;
2834 reject all programs that use forbidden extensions, and some other
2835 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2836 version of the ISO C standard specified by any @option{-std} option used.
2838 Valid ISO C and ISO C++ programs should compile properly with or without
2839 this option (though a rare few will require @option{-ansi} or a
2840 @option{-std} option specifying the required version of ISO C)@.  However,
2841 without this option, certain GNU extensions and traditional C and C++
2842 features are supported as well.  With this option, they are rejected.
2844 @option{-pedantic} does not cause warning messages for use of the
2845 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2846 warnings are also disabled in the expression that follows
2847 @code{__extension__}.  However, only system header files should use
2848 these escape routes; application programs should avoid them.
2849 @xref{Alternate Keywords}.
2851 Some users try to use @option{-pedantic} to check programs for strict ISO
2852 C conformance.  They soon find that it does not do quite what they want:
2853 it finds some non-ISO practices, but not all---only those for which
2854 ISO C @emph{requires} a diagnostic, and some others for which
2855 diagnostics have been added.
2857 A feature to report any failure to conform to ISO C might be useful in
2858 some instances, but would require considerable additional work and would
2859 be quite different from @option{-pedantic}.  We don't have plans to
2860 support such a feature in the near future.
2862 Where the standard specified with @option{-std} represents a GNU
2863 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
2864 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2865 extended dialect is based.  Warnings from @option{-pedantic} are given
2866 where they are required by the base standard.  (It would not make sense
2867 for such warnings to be given only for features not in the specified GNU
2868 C dialect, since by definition the GNU dialects of C include all
2869 features the compiler supports with the given option, and there would be
2870 nothing to warn about.)
2872 @item -pedantic-errors
2873 @opindex pedantic-errors
2874 Like @option{-pedantic}, except that errors are produced rather than
2875 warnings.
2877 @item -Wall
2878 @opindex Wall
2879 @opindex Wno-all
2880 This enables all the warnings about constructions that some users
2881 consider questionable, and that are easy to avoid (or modify to
2882 prevent the warning), even in conjunction with macros.  This also
2883 enables some language-specific warnings described in @ref{C++ Dialect
2884 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2886 @option{-Wall} turns on the following warning flags:
2888 @gccoptlist{-Waddress   @gol
2889 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2890 -Wc++0x-compat  @gol
2891 -Wchar-subscripts  @gol
2892 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2893 -Wimplicit-int  @gol
2894 -Wimplicit-function-declaration  @gol
2895 -Wcomment  @gol
2896 -Wformat   @gol
2897 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2898 -Wmissing-braces  @gol
2899 -Wnonnull  @gol
2900 -Wparentheses  @gol
2901 -Wpointer-sign  @gol
2902 -Wreorder   @gol
2903 -Wreturn-type  @gol
2904 -Wsequence-point  @gol
2905 -Wsign-compare @r{(only in C++)}  @gol
2906 -Wstrict-aliasing  @gol
2907 -Wstrict-overflow=1  @gol
2908 -Wswitch  @gol
2909 -Wtrigraphs  @gol
2910 -Wuninitialized  @gol
2911 -Wunknown-pragmas  @gol
2912 -Wunused-function  @gol
2913 -Wunused-label     @gol
2914 -Wunused-value     @gol
2915 -Wunused-variable  @gol
2916 -Wvolatile-register-var @gol
2919 Note that some warning flags are not implied by @option{-Wall}.  Some of
2920 them warn about constructions that users generally do not consider
2921 questionable, but which occasionally you might wish to check for;
2922 others warn about constructions that are necessary or hard to avoid in
2923 some cases, and there is no simple way to modify the code to suppress
2924 the warning. Some of them are enabled by @option{-Wextra} but many of
2925 them must be enabled individually.
2927 @item -Wextra
2928 @opindex W
2929 @opindex Wextra
2930 @opindex Wno-extra
2931 This enables some extra warning flags that are not enabled by
2932 @option{-Wall}. (This option used to be called @option{-W}.  The older
2933 name is still supported, but the newer name is more descriptive.)
2935 @gccoptlist{-Wclobbered  @gol
2936 -Wempty-body  @gol
2937 -Wignored-qualifiers @gol
2938 -Wmissing-field-initializers  @gol
2939 -Wmissing-parameter-type @r{(C only)}  @gol
2940 -Wold-style-declaration @r{(C only)}  @gol
2941 -Woverride-init  @gol
2942 -Wsign-compare  @gol
2943 -Wtype-limits  @gol
2944 -Wuninitialized  @gol
2945 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
2946 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2949 The option @option{-Wextra} also prints warning messages for the
2950 following cases:
2952 @itemize @bullet
2954 @item
2955 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2956 @samp{>}, or @samp{>=}.
2958 @item
2959 (C++ only) An enumerator and a non-enumerator both appear in a
2960 conditional expression.
2962 @item
2963 (C++ only) Ambiguous virtual bases.
2965 @item
2966 (C++ only) Subscripting an array which has been declared @samp{register}.
2968 @item
2969 (C++ only) Taking the address of a variable which has been declared
2970 @samp{register}.
2972 @item
2973 (C++ only) A base class is not initialized in a derived class' copy
2974 constructor.
2976 @end itemize
2978 @item -Wchar-subscripts
2979 @opindex Wchar-subscripts
2980 @opindex Wno-char-subscripts
2981 Warn if an array subscript has type @code{char}.  This is a common cause
2982 of error, as programmers often forget that this type is signed on some
2983 machines.
2984 This warning is enabled by @option{-Wall}.
2986 @item -Wcomment
2987 @opindex Wcomment
2988 @opindex Wno-comment
2989 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2990 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2991 This warning is enabled by @option{-Wall}.
2993 @item -Wno-cpp \
2994 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
2996 Suppress warning messages emitted by @code{#warning} directives.
2998 @item -Wformat
2999 @opindex Wformat
3000 @opindex Wno-format
3001 @opindex ffreestanding
3002 @opindex fno-builtin
3003 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3004 the arguments supplied have types appropriate to the format string
3005 specified, and that the conversions specified in the format string make
3006 sense.  This includes standard functions, and others specified by format
3007 attributes (@pxref{Function Attributes}), in the @code{printf},
3008 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3009 not in the C standard) families (or other target-specific families).
3010 Which functions are checked without format attributes having been
3011 specified depends on the standard version selected, and such checks of
3012 functions without the attribute specified are disabled by
3013 @option{-ffreestanding} or @option{-fno-builtin}.
3015 The formats are checked against the format features supported by GNU
3016 libc version 2.2.  These include all ISO C90 and C99 features, as well
3017 as features from the Single Unix Specification and some BSD and GNU
3018 extensions.  Other library implementations may not support all these
3019 features; GCC does not support warning about features that go beyond a
3020 particular library's limitations.  However, if @option{-pedantic} is used
3021 with @option{-Wformat}, warnings will be given about format features not
3022 in the selected standard version (but not for @code{strfmon} formats,
3023 since those are not in any version of the C standard).  @xref{C Dialect
3024 Options,,Options Controlling C Dialect}.
3026 Since @option{-Wformat} also checks for null format arguments for
3027 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3029 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3030 aspects of format checking, the options @option{-Wformat-y2k},
3031 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3032 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3033 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3035 @item -Wformat-y2k
3036 @opindex Wformat-y2k
3037 @opindex Wno-format-y2k
3038 If @option{-Wformat} is specified, also warn about @code{strftime}
3039 formats which may yield only a two-digit year.
3041 @item -Wno-format-contains-nul
3042 @opindex Wno-format-contains-nul
3043 @opindex Wformat-contains-nul
3044 If @option{-Wformat} is specified, do not warn about format strings that
3045 contain NUL bytes.
3047 @item -Wno-format-extra-args
3048 @opindex Wno-format-extra-args
3049 @opindex Wformat-extra-args
3050 If @option{-Wformat} is specified, do not warn about excess arguments to a
3051 @code{printf} or @code{scanf} format function.  The C standard specifies
3052 that such arguments are ignored.
3054 Where the unused arguments lie between used arguments that are
3055 specified with @samp{$} operand number specifications, normally
3056 warnings are still given, since the implementation could not know what
3057 type to pass to @code{va_arg} to skip the unused arguments.  However,
3058 in the case of @code{scanf} formats, this option will suppress the
3059 warning if the unused arguments are all pointers, since the Single
3060 Unix Specification says that such unused arguments are allowed.
3062 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3063 @opindex Wno-format-zero-length
3064 @opindex Wformat-zero-length
3065 If @option{-Wformat} is specified, do not warn about zero-length formats.
3066 The C standard specifies that zero-length formats are allowed.
3068 @item -Wformat-nonliteral
3069 @opindex Wformat-nonliteral
3070 @opindex Wno-format-nonliteral
3071 If @option{-Wformat} is specified, also warn if the format string is not a
3072 string literal and so cannot be checked, unless the format function
3073 takes its format arguments as a @code{va_list}.
3075 @item -Wformat-security
3076 @opindex Wformat-security
3077 @opindex Wno-format-security
3078 If @option{-Wformat} is specified, also warn about uses of format
3079 functions that represent possible security problems.  At present, this
3080 warns about calls to @code{printf} and @code{scanf} functions where the
3081 format string is not a string literal and there are no format arguments,
3082 as in @code{printf (foo);}.  This may be a security hole if the format
3083 string came from untrusted input and contains @samp{%n}.  (This is
3084 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3085 in future warnings may be added to @option{-Wformat-security} that are not
3086 included in @option{-Wformat-nonliteral}.)
3088 @item -Wformat=2
3089 @opindex Wformat=2
3090 @opindex Wno-format=2
3091 Enable @option{-Wformat} plus format checks not included in
3092 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3093 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3095 @item -Wnonnull @r{(C and Objective-C only)}
3096 @opindex Wnonnull
3097 @opindex Wno-nonnull
3098 Warn about passing a null pointer for arguments marked as
3099 requiring a non-null value by the @code{nonnull} function attribute.
3101 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3102 can be disabled with the @option{-Wno-nonnull} option.
3104 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3105 @opindex Winit-self
3106 @opindex Wno-init-self
3107 Warn about uninitialized variables which are initialized with themselves.
3108 Note this option can only be used with the @option{-Wuninitialized} option.
3110 For example, GCC will warn about @code{i} being uninitialized in the
3111 following snippet only when @option{-Winit-self} has been specified:
3112 @smallexample
3113 @group
3114 int f()
3116   int i = i;
3117   return i;
3119 @end group
3120 @end smallexample
3122 @item -Wimplicit-int @r{(C and Objective-C only)}
3123 @opindex Wimplicit-int
3124 @opindex Wno-implicit-int
3125 Warn when a declaration does not specify a type.
3126 This warning is enabled by @option{-Wall}.
3128 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3129 @opindex Wimplicit-function-declaration
3130 @opindex Wno-implicit-function-declaration
3131 Give a warning whenever a function is used before being declared. In
3132 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3133 enabled by default and it is made into an error by
3134 @option{-pedantic-errors}. This warning is also enabled by
3135 @option{-Wall}.
3137 @item -Wimplicit
3138 @opindex Wimplicit
3139 @opindex Wno-implicit
3140 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3141 This warning is enabled by @option{-Wall}.
3143 @item -Wignored-qualifiers @r{(C and C++ only)}
3144 @opindex Wignored-qualifiers
3145 @opindex Wno-ignored-qualifiers
3146 Warn if the return type of a function has a type qualifier
3147 such as @code{const}.  For ISO C such a type qualifier has no effect,
3148 since the value returned by a function is not an lvalue.
3149 For C++, the warning is only emitted for scalar types or @code{void}.
3150 ISO C prohibits qualified @code{void} return types on function
3151 definitions, so such return types always receive a warning
3152 even without this option.
3154 This warning is also enabled by @option{-Wextra}.
3156 @item -Wmain
3157 @opindex Wmain
3158 @opindex Wno-main
3159 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3160 a function with external linkage, returning int, taking either zero
3161 arguments, two, or three arguments of appropriate types.  This warning
3162 is enabled by default in C++ and is enabled by either @option{-Wall}
3163 or @option{-pedantic}.
3165 @item -Wmissing-braces
3166 @opindex Wmissing-braces
3167 @opindex Wno-missing-braces
3168 Warn if an aggregate or union initializer is not fully bracketed.  In
3169 the following example, the initializer for @samp{a} is not fully
3170 bracketed, but that for @samp{b} is fully bracketed.
3172 @smallexample
3173 int a[2][2] = @{ 0, 1, 2, 3 @};
3174 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3175 @end smallexample
3177 This warning is enabled by @option{-Wall}.
3179 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3180 @opindex Wmissing-include-dirs
3181 @opindex Wno-missing-include-dirs
3182 Warn if a user-supplied include directory does not exist.
3184 @item -Wparentheses
3185 @opindex Wparentheses
3186 @opindex Wno-parentheses
3187 Warn if parentheses are omitted in certain contexts, such
3188 as when there is an assignment in a context where a truth value
3189 is expected, or when operators are nested whose precedence people
3190 often get confused about.
3192 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3193 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3194 interpretation from that of ordinary mathematical notation.
3196 Also warn about constructions where there may be confusion to which
3197 @code{if} statement an @code{else} branch belongs.  Here is an example of
3198 such a case:
3200 @smallexample
3201 @group
3203   if (a)
3204     if (b)
3205       foo ();
3206   else
3207     bar ();
3209 @end group
3210 @end smallexample
3212 In C/C++, every @code{else} branch belongs to the innermost possible
3213 @code{if} statement, which in this example is @code{if (b)}.  This is
3214 often not what the programmer expected, as illustrated in the above
3215 example by indentation the programmer chose.  When there is the
3216 potential for this confusion, GCC will issue a warning when this flag
3217 is specified.  To eliminate the warning, add explicit braces around
3218 the innermost @code{if} statement so there is no way the @code{else}
3219 could belong to the enclosing @code{if}.  The resulting code would
3220 look like this:
3222 @smallexample
3223 @group
3225   if (a)
3226     @{
3227       if (b)
3228         foo ();
3229       else
3230         bar ();
3231     @}
3233 @end group
3234 @end smallexample
3236 This warning is enabled by @option{-Wall}.
3238 @item -Wsequence-point
3239 @opindex Wsequence-point
3240 @opindex Wno-sequence-point
3241 Warn about code that may have undefined semantics because of violations
3242 of sequence point rules in the C and C++ standards.
3244 The C and C++ standards defines the order in which expressions in a C/C++
3245 program are evaluated in terms of @dfn{sequence points}, which represent
3246 a partial ordering between the execution of parts of the program: those
3247 executed before the sequence point, and those executed after it.  These
3248 occur after the evaluation of a full expression (one which is not part
3249 of a larger expression), after the evaluation of the first operand of a
3250 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3251 function is called (but after the evaluation of its arguments and the
3252 expression denoting the called function), and in certain other places.
3253 Other than as expressed by the sequence point rules, the order of
3254 evaluation of subexpressions of an expression is not specified.  All
3255 these rules describe only a partial order rather than a total order,
3256 since, for example, if two functions are called within one expression
3257 with no sequence point between them, the order in which the functions
3258 are called is not specified.  However, the standards committee have
3259 ruled that function calls do not overlap.
3261 It is not specified when between sequence points modifications to the
3262 values of objects take effect.  Programs whose behavior depends on this
3263 have undefined behavior; the C and C++ standards specify that ``Between
3264 the previous and next sequence point an object shall have its stored
3265 value modified at most once by the evaluation of an expression.
3266 Furthermore, the prior value shall be read only to determine the value
3267 to be stored.''.  If a program breaks these rules, the results on any
3268 particular implementation are entirely unpredictable.
3270 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3271 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3272 diagnosed by this option, and it may give an occasional false positive
3273 result, but in general it has been found fairly effective at detecting
3274 this sort of problem in programs.
3276 The standard is worded confusingly, therefore there is some debate
3277 over the precise meaning of the sequence point rules in subtle cases.
3278 Links to discussions of the problem, including proposed formal
3279 definitions, may be found on the GCC readings page, at
3280 @w{@uref{http://gcc.gnu.org/readings.html}}.
3282 This warning is enabled by @option{-Wall} for C and C++.
3284 @item -Wreturn-type
3285 @opindex Wreturn-type
3286 @opindex Wno-return-type
3287 Warn whenever a function is defined with a return-type that defaults
3288 to @code{int}.  Also warn about any @code{return} statement with no
3289 return-value in a function whose return-type is not @code{void}
3290 (falling off the end of the function body is considered returning
3291 without a value), and about a @code{return} statement with an
3292 expression in a function whose return-type is @code{void}.
3294 For C++, a function without return type always produces a diagnostic
3295 message, even when @option{-Wno-return-type} is specified.  The only
3296 exceptions are @samp{main} and functions defined in system headers.
3298 This warning is enabled by @option{-Wall}.
3300 @item -Wswitch
3301 @opindex Wswitch
3302 @opindex Wno-switch
3303 Warn whenever a @code{switch} statement has an index of enumerated type
3304 and lacks a @code{case} for one or more of the named codes of that
3305 enumeration.  (The presence of a @code{default} label prevents this
3306 warning.)  @code{case} labels outside the enumeration range also
3307 provoke warnings when this option is used (even if there is a
3308 @code{default} label).
3309 This warning is enabled by @option{-Wall}.
3311 @item -Wswitch-default
3312 @opindex Wswitch-default
3313 @opindex Wno-switch-default
3314 Warn whenever a @code{switch} statement does not have a @code{default}
3315 case.
3317 @item -Wswitch-enum
3318 @opindex Wswitch-enum
3319 @opindex Wno-switch-enum
3320 Warn whenever a @code{switch} statement has an index of enumerated type
3321 and lacks a @code{case} for one or more of the named codes of that
3322 enumeration.  @code{case} labels outside the enumeration range also
3323 provoke warnings when this option is used.  The only difference
3324 between @option{-Wswitch} and this option is that this option gives a
3325 warning about an omitted enumeration code even if there is a
3326 @code{default} label.
3328 @item -Wsync-nand @r{(C and C++ only)}
3329 @opindex Wsync-nand
3330 @opindex Wno-sync-nand
3331 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3332 built-in functions are used.  These functions changed semantics in GCC 4.4.
3334 @item -Wtrigraphs
3335 @opindex Wtrigraphs
3336 @opindex Wno-trigraphs
3337 Warn if any trigraphs are encountered that might change the meaning of
3338 the program (trigraphs within comments are not warned about).
3339 This warning is enabled by @option{-Wall}.
3341 @item -Wunused-but-set-parameter
3342 @opindex Wunused-but-set-parameter
3343 @opindex Wno-unused-but-set-parameter
3344 Warn whenever a function parameter is assigned to, but otherwise unused
3345 (aside from its declaration).
3347 To suppress this warning use the @samp{unused} attribute
3348 (@pxref{Variable Attributes}).
3350 This warning is also enabled by @option{-Wunused} together with
3351 @option{-Wextra}.
3353 @item -Wunused-but-set-variable
3354 @opindex Wunused-but-set-variable
3355 @opindex Wno-unused-but-set-variable
3356 Warn whenever a local variable is assigned to, but otherwise unused
3357 (aside from its declaration).
3358 This warning is enabled by @option{-Wall}.
3360 To suppress this warning use the @samp{unused} attribute
3361 (@pxref{Variable Attributes}).
3363 This warning is also enabled by @option{-Wunused}, which is enabled
3364 by @option{-Wall}.
3366 @item -Wunused-function
3367 @opindex Wunused-function
3368 @opindex Wno-unused-function
3369 Warn whenever a static function is declared but not defined or a
3370 non-inline static function is unused.
3371 This warning is enabled by @option{-Wall}.
3373 @item -Wunused-label
3374 @opindex Wunused-label
3375 @opindex Wno-unused-label
3376 Warn whenever a label is declared but not used.
3377 This warning is enabled by @option{-Wall}.
3379 To suppress this warning use the @samp{unused} attribute
3380 (@pxref{Variable Attributes}).
3382 @item -Wunused-parameter
3383 @opindex Wunused-parameter
3384 @opindex Wno-unused-parameter
3385 Warn whenever a function parameter is unused aside from its declaration.
3387 To suppress this warning use the @samp{unused} attribute
3388 (@pxref{Variable Attributes}).
3390 @item -Wno-unused-result
3391 @opindex Wunused-result
3392 @opindex Wno-unused-result
3393 Do not warn if a caller of a function marked with attribute
3394 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3395 its return value. The default is @option{-Wunused-result}.
3397 @item -Wunused-variable
3398 @opindex Wunused-variable
3399 @opindex Wno-unused-variable
3400 Warn whenever a local variable or non-constant static variable is unused
3401 aside from its declaration.
3402 This warning is enabled by @option{-Wall}.
3404 To suppress this warning use the @samp{unused} attribute
3405 (@pxref{Variable Attributes}).
3407 @item -Wunused-value
3408 @opindex Wunused-value
3409 @opindex Wno-unused-value
3410 Warn whenever a statement computes a result that is explicitly not
3411 used. To suppress this warning cast the unused expression to
3412 @samp{void}. This includes an expression-statement or the left-hand
3413 side of a comma expression that contains no side effects. For example,
3414 an expression such as @samp{x[i,j]} will cause a warning, while
3415 @samp{x[(void)i,j]} will not.
3417 This warning is enabled by @option{-Wall}.
3419 @item -Wunused
3420 @opindex Wunused
3421 @opindex Wno-unused
3422 All the above @option{-Wunused} options combined.
3424 In order to get a warning about an unused function parameter, you must
3425 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3426 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3428 @item -Wuninitialized
3429 @opindex Wuninitialized
3430 @opindex Wno-uninitialized
3431 Warn if an automatic variable is used without first being initialized
3432 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3433 warn if a non-static reference or non-static @samp{const} member
3434 appears in a class without constructors.
3436 If you want to warn about code which uses the uninitialized value of the
3437 variable in its own initializer, use the @option{-Winit-self} option.
3439 These warnings occur for individual uninitialized or clobbered
3440 elements of structure, union or array variables as well as for
3441 variables which are uninitialized or clobbered as a whole.  They do
3442 not occur for variables or elements declared @code{volatile}.  Because
3443 these warnings depend on optimization, the exact variables or elements
3444 for which there are warnings will depend on the precise optimization
3445 options and version of GCC used.
3447 Note that there may be no warning about a variable that is used only
3448 to compute a value that itself is never used, because such
3449 computations may be deleted by data flow analysis before the warnings
3450 are printed.
3452 These warnings are made optional because GCC is not smart
3453 enough to see all the reasons why the code might be correct
3454 despite appearing to have an error.  Here is one example of how
3455 this can happen:
3457 @smallexample
3458 @group
3460   int x;
3461   switch (y)
3462     @{
3463     case 1: x = 1;
3464       break;
3465     case 2: x = 4;
3466       break;
3467     case 3: x = 5;
3468     @}
3469   foo (x);
3471 @end group
3472 @end smallexample
3474 @noindent
3475 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3476 always initialized, but GCC doesn't know this.  Here is
3477 another common case:
3479 @smallexample
3481   int save_y;
3482   if (change_y) save_y = y, y = new_y;
3483   @dots{}
3484   if (change_y) y = save_y;
3486 @end smallexample
3488 @noindent
3489 This has no bug because @code{save_y} is used only if it is set.
3491 @cindex @code{longjmp} warnings
3492 This option also warns when a non-volatile automatic variable might be
3493 changed by a call to @code{longjmp}.  These warnings as well are possible
3494 only in optimizing compilation.
3496 The compiler sees only the calls to @code{setjmp}.  It cannot know
3497 where @code{longjmp} will be called; in fact, a signal handler could
3498 call it at any point in the code.  As a result, you may get a warning
3499 even when there is in fact no problem because @code{longjmp} cannot
3500 in fact be called at the place which would cause a problem.
3502 Some spurious warnings can be avoided if you declare all the functions
3503 you use that never return as @code{noreturn}.  @xref{Function
3504 Attributes}.
3506 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3508 @item -Wunknown-pragmas
3509 @opindex Wunknown-pragmas
3510 @opindex Wno-unknown-pragmas
3511 @cindex warning for unknown pragmas
3512 @cindex unknown pragmas, warning
3513 @cindex pragmas, warning of unknown
3514 Warn when a #pragma directive is encountered which is not understood by
3515 GCC@.  If this command line option is used, warnings will even be issued
3516 for unknown pragmas in system header files.  This is not the case if
3517 the warnings were only enabled by the @option{-Wall} command line option.
3519 @item -Wno-pragmas
3520 @opindex Wno-pragmas
3521 @opindex Wpragmas
3522 Do not warn about misuses of pragmas, such as incorrect parameters,
3523 invalid syntax, or conflicts between pragmas.  See also
3524 @samp{-Wunknown-pragmas}.
3526 @item -Wstrict-aliasing
3527 @opindex Wstrict-aliasing
3528 @opindex Wno-strict-aliasing
3529 This option is only active when @option{-fstrict-aliasing} is active.
3530 It warns about code which might break the strict aliasing rules that the
3531 compiler is using for optimization.  The warning does not catch all
3532 cases, but does attempt to catch the more common pitfalls.  It is
3533 included in @option{-Wall}.
3534 It is equivalent to @option{-Wstrict-aliasing=3}
3536 @item -Wstrict-aliasing=n
3537 @opindex Wstrict-aliasing=n
3538 @opindex Wno-strict-aliasing=n
3539 This option is only active when @option{-fstrict-aliasing} is active.
3540 It warns about code which might break the strict aliasing rules that the
3541 compiler is using for optimization.
3542 Higher levels correspond to higher accuracy (fewer false positives).
3543 Higher levels also correspond to more effort, similar to the way -O works.
3544 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3545 with n=3.
3547 Level 1: Most aggressive, quick, least accurate.
3548 Possibly useful when higher levels
3549 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3550 false negatives.  However, it has many false positives.
3551 Warns for all pointer conversions between possibly incompatible types,
3552 even if never dereferenced.  Runs in the frontend only.
3554 Level 2: Aggressive, quick, not too precise.
3555 May still have many false positives (not as many as level 1 though),
3556 and few false negatives (but possibly more than level 1).
3557 Unlike level 1, it only warns when an address is taken.  Warns about
3558 incomplete types.  Runs in the frontend only.
3560 Level 3 (default for @option{-Wstrict-aliasing}):
3561 Should have very few false positives and few false
3562 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3563 Takes care of the common pun+dereference pattern in the frontend:
3564 @code{*(int*)&some_float}.
3565 If optimization is enabled, it also runs in the backend, where it deals
3566 with multiple statement cases using flow-sensitive points-to information.
3567 Only warns when the converted pointer is dereferenced.
3568 Does not warn about incomplete types.
3570 @item -Wstrict-overflow
3571 @itemx -Wstrict-overflow=@var{n}
3572 @opindex Wstrict-overflow
3573 @opindex Wno-strict-overflow
3574 This option is only active when @option{-fstrict-overflow} is active.
3575 It warns about cases where the compiler optimizes based on the
3576 assumption that signed overflow does not occur.  Note that it does not
3577 warn about all cases where the code might overflow: it only warns
3578 about cases where the compiler implements some optimization.  Thus
3579 this warning depends on the optimization level.
3581 An optimization which assumes that signed overflow does not occur is
3582 perfectly safe if the values of the variables involved are such that
3583 overflow never does, in fact, occur.  Therefore this warning can
3584 easily give a false positive: a warning about code which is not
3585 actually a problem.  To help focus on important issues, several
3586 warning levels are defined.  No warnings are issued for the use of
3587 undefined signed overflow when estimating how many iterations a loop
3588 will require, in particular when determining whether a loop will be
3589 executed at all.
3591 @table @gcctabopt
3592 @item -Wstrict-overflow=1
3593 Warn about cases which are both questionable and easy to avoid.  For
3594 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3595 compiler will simplify this to @code{1}.  This level of
3596 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3597 are not, and must be explicitly requested.
3599 @item -Wstrict-overflow=2
3600 Also warn about other cases where a comparison is simplified to a
3601 constant.  For example: @code{abs (x) >= 0}.  This can only be
3602 simplified when @option{-fstrict-overflow} is in effect, because
3603 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3604 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3605 @option{-Wstrict-overflow=2}.
3607 @item -Wstrict-overflow=3
3608 Also warn about other cases where a comparison is simplified.  For
3609 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3611 @item -Wstrict-overflow=4
3612 Also warn about other simplifications not covered by the above cases.
3613 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3615 @item -Wstrict-overflow=5
3616 Also warn about cases where the compiler reduces the magnitude of a
3617 constant involved in a comparison.  For example: @code{x + 2 > y} will
3618 be simplified to @code{x + 1 >= y}.  This is reported only at the
3619 highest warning level because this simplification applies to many
3620 comparisons, so this warning level will give a very large number of
3621 false positives.
3622 @end table
3624 @item -Warray-bounds
3625 @opindex Wno-array-bounds
3626 @opindex Warray-bounds
3627 This option is only active when @option{-ftree-vrp} is active
3628 (default for -O2 and above). It warns about subscripts to arrays
3629 that are always out of bounds. This warning is enabled by @option{-Wall}.
3631 @item -Wno-div-by-zero
3632 @opindex Wno-div-by-zero
3633 @opindex Wdiv-by-zero
3634 Do not warn about compile-time integer division by zero.  Floating point
3635 division by zero is not warned about, as it can be a legitimate way of
3636 obtaining infinities and NaNs.
3638 @item -Wsystem-headers
3639 @opindex Wsystem-headers
3640 @opindex Wno-system-headers
3641 @cindex warnings from system headers
3642 @cindex system headers, warnings from
3643 Print warning messages for constructs found in system header files.
3644 Warnings from system headers are normally suppressed, on the assumption
3645 that they usually do not indicate real problems and would only make the
3646 compiler output harder to read.  Using this command line option tells
3647 GCC to emit warnings from system headers as if they occurred in user
3648 code.  However, note that using @option{-Wall} in conjunction with this
3649 option will @emph{not} warn about unknown pragmas in system
3650 headers---for that, @option{-Wunknown-pragmas} must also be used.
3652 @item -Wfloat-equal
3653 @opindex Wfloat-equal
3654 @opindex Wno-float-equal
3655 Warn if floating point values are used in equality comparisons.
3657 The idea behind this is that sometimes it is convenient (for the
3658 programmer) to consider floating-point values as approximations to
3659 infinitely precise real numbers.  If you are doing this, then you need
3660 to compute (by analyzing the code, or in some other way) the maximum or
3661 likely maximum error that the computation introduces, and allow for it
3662 when performing comparisons (and when producing output, but that's a
3663 different problem).  In particular, instead of testing for equality, you
3664 would check to see whether the two values have ranges that overlap; and
3665 this is done with the relational operators, so equality comparisons are
3666 probably mistaken.
3668 @item -Wtraditional @r{(C and Objective-C only)}
3669 @opindex Wtraditional
3670 @opindex Wno-traditional
3671 Warn about certain constructs that behave differently in traditional and
3672 ISO C@.  Also warn about ISO C constructs that have no traditional C
3673 equivalent, and/or problematic constructs which should be avoided.
3675 @itemize @bullet
3676 @item
3677 Macro parameters that appear within string literals in the macro body.
3678 In traditional C macro replacement takes place within string literals,
3679 but does not in ISO C@.
3681 @item
3682 In traditional C, some preprocessor directives did not exist.
3683 Traditional preprocessors would only consider a line to be a directive
3684 if the @samp{#} appeared in column 1 on the line.  Therefore
3685 @option{-Wtraditional} warns about directives that traditional C
3686 understands but would ignore because the @samp{#} does not appear as the
3687 first character on the line.  It also suggests you hide directives like
3688 @samp{#pragma} not understood by traditional C by indenting them.  Some
3689 traditional implementations would not recognize @samp{#elif}, so it
3690 suggests avoiding it altogether.
3692 @item
3693 A function-like macro that appears without arguments.
3695 @item
3696 The unary plus operator.
3698 @item
3699 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3700 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3701 constants.)  Note, these suffixes appear in macros defined in the system
3702 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3703 Use of these macros in user code might normally lead to spurious
3704 warnings, however GCC's integrated preprocessor has enough context to
3705 avoid warning in these cases.
3707 @item
3708 A function declared external in one block and then used after the end of
3709 the block.
3711 @item
3712 A @code{switch} statement has an operand of type @code{long}.
3714 @item
3715 A non-@code{static} function declaration follows a @code{static} one.
3716 This construct is not accepted by some traditional C compilers.
3718 @item
3719 The ISO type of an integer constant has a different width or
3720 signedness from its traditional type.  This warning is only issued if
3721 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3722 typically represent bit patterns, are not warned about.
3724 @item
3725 Usage of ISO string concatenation is detected.
3727 @item
3728 Initialization of automatic aggregates.
3730 @item
3731 Identifier conflicts with labels.  Traditional C lacks a separate
3732 namespace for labels.
3734 @item
3735 Initialization of unions.  If the initializer is zero, the warning is
3736 omitted.  This is done under the assumption that the zero initializer in
3737 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3738 initializer warnings and relies on default initialization to zero in the
3739 traditional C case.
3741 @item
3742 Conversions by prototypes between fixed/floating point values and vice
3743 versa.  The absence of these prototypes when compiling with traditional
3744 C would cause serious problems.  This is a subset of the possible
3745 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3747 @item
3748 Use of ISO C style function definitions.  This warning intentionally is
3749 @emph{not} issued for prototype declarations or variadic functions
3750 because these ISO C features will appear in your code when using
3751 libiberty's traditional C compatibility macros, @code{PARAMS} and
3752 @code{VPARAMS}.  This warning is also bypassed for nested functions
3753 because that feature is already a GCC extension and thus not relevant to
3754 traditional C compatibility.
3755 @end itemize
3757 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3758 @opindex Wtraditional-conversion
3759 @opindex Wno-traditional-conversion
3760 Warn if a prototype causes a type conversion that is different from what
3761 would happen to the same argument in the absence of a prototype.  This
3762 includes conversions of fixed point to floating and vice versa, and
3763 conversions changing the width or signedness of a fixed point argument
3764 except when the same as the default promotion.
3766 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3767 @opindex Wdeclaration-after-statement
3768 @opindex Wno-declaration-after-statement
3769 Warn when a declaration is found after a statement in a block.  This
3770 construct, known from C++, was introduced with ISO C99 and is by default
3771 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3772 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3774 @item -Wundef
3775 @opindex Wundef
3776 @opindex Wno-undef
3777 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3779 @item -Wno-endif-labels
3780 @opindex Wno-endif-labels
3781 @opindex Wendif-labels
3782 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3784 @item -Wshadow
3785 @opindex Wshadow
3786 @opindex Wno-shadow
3787 Warn whenever a local variable shadows another local variable, parameter or
3788 global variable or whenever a built-in function is shadowed.
3790 @item -Wlarger-than=@var{len}
3791 @opindex Wlarger-than=@var{len}
3792 @opindex Wlarger-than-@var{len}
3793 Warn whenever an object of larger than @var{len} bytes is defined.
3795 @item -Wframe-larger-than=@var{len}
3796 @opindex Wframe-larger-than
3797 Warn if the size of a function frame is larger than @var{len} bytes.
3798 The computation done to determine the stack frame size is approximate
3799 and not conservative.
3800 The actual requirements may be somewhat greater than @var{len}
3801 even if you do not get a warning.  In addition, any space allocated
3802 via @code{alloca}, variable-length arrays, or related constructs
3803 is not included by the compiler when determining
3804 whether or not to issue a warning.
3806 @item -Wunsafe-loop-optimizations
3807 @opindex Wunsafe-loop-optimizations
3808 @opindex Wno-unsafe-loop-optimizations
3809 Warn if the loop cannot be optimized because the compiler could not
3810 assume anything on the bounds of the loop indices.  With
3811 @option{-funsafe-loop-optimizations} warn if the compiler made
3812 such assumptions.
3814 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3815 @opindex Wno-pedantic-ms-format
3816 @opindex Wpedantic-ms-format
3817 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3818 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3819 depending on the MS runtime, when you are using the options @option{-Wformat}
3820 and @option{-pedantic} without gnu-extensions.
3822 @item -Wpointer-arith
3823 @opindex Wpointer-arith
3824 @opindex Wno-pointer-arith
3825 Warn about anything that depends on the ``size of'' a function type or
3826 of @code{void}.  GNU C assigns these types a size of 1, for
3827 convenience in calculations with @code{void *} pointers and pointers
3828 to functions.  In C++, warn also when an arithmetic operation involves
3829 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3831 @item -Wtype-limits
3832 @opindex Wtype-limits
3833 @opindex Wno-type-limits
3834 Warn if a comparison is always true or always false due to the limited
3835 range of the data type, but do not warn for constant expressions.  For
3836 example, warn if an unsigned variable is compared against zero with
3837 @samp{<} or @samp{>=}.  This warning is also enabled by
3838 @option{-Wextra}.
3840 @item -Wbad-function-cast @r{(C and Objective-C only)}
3841 @opindex Wbad-function-cast
3842 @opindex Wno-bad-function-cast
3843 Warn whenever a function call is cast to a non-matching type.
3844 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3846 @item -Wc++-compat @r{(C and Objective-C only)}
3847 Warn about ISO C constructs that are outside of the common subset of
3848 ISO C and ISO C++, e.g.@: request for implicit conversion from
3849 @code{void *} to a pointer to non-@code{void} type.
3851 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3852 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3853 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3854 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3856 @item -Wcast-qual
3857 @opindex Wcast-qual
3858 @opindex Wno-cast-qual
3859 Warn whenever a pointer is cast so as to remove a type qualifier from
3860 the target type.  For example, warn if a @code{const char *} is cast
3861 to an ordinary @code{char *}.
3863 Also warn when making a cast which introduces a type qualifier in an
3864 unsafe way.  For example, casting @code{char **} to @code{const char **}
3865 is unsafe, as in this example:
3867 @smallexample
3868   /* p is char ** value.  */
3869   const char **q = (const char **) p;
3870   /* Assignment of readonly string to const char * is OK.  */
3871   *q = "string";
3872   /* Now char** pointer points to read-only memory.  */
3873   **p = 'b';
3874 @end smallexample
3876 @item -Wcast-align
3877 @opindex Wcast-align
3878 @opindex Wno-cast-align
3879 Warn whenever a pointer is cast such that the required alignment of the
3880 target is increased.  For example, warn if a @code{char *} is cast to
3881 an @code{int *} on machines where integers can only be accessed at
3882 two- or four-byte boundaries.
3884 @item -Wwrite-strings
3885 @opindex Wwrite-strings
3886 @opindex Wno-write-strings
3887 When compiling C, give string constants the type @code{const
3888 char[@var{length}]} so that copying the address of one into a
3889 non-@code{const} @code{char *} pointer will get a warning.  These
3890 warnings will help you find at compile time code that can try to write
3891 into a string constant, but only if you have been very careful about
3892 using @code{const} in declarations and prototypes.  Otherwise, it will
3893 just be a nuisance. This is why we did not make @option{-Wall} request
3894 these warnings.
3896 When compiling C++, warn about the deprecated conversion from string
3897 literals to @code{char *}.  This warning is enabled by default for C++
3898 programs.
3900 @item -Wclobbered
3901 @opindex Wclobbered
3902 @opindex Wno-clobbered
3903 Warn for variables that might be changed by @samp{longjmp} or
3904 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3906 @item -Wconversion
3907 @opindex Wconversion
3908 @opindex Wno-conversion
3909 Warn for implicit conversions that may alter a value. This includes
3910 conversions between real and integer, like @code{abs (x)} when
3911 @code{x} is @code{double}; conversions between signed and unsigned,
3912 like @code{unsigned ui = -1}; and conversions to smaller types, like
3913 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3914 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3915 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3916 conversions between signed and unsigned integers can be disabled by
3917 using @option{-Wno-sign-conversion}.
3919 For C++, also warn for confusing overload resolution for user-defined
3920 conversions; and conversions that will never use a type conversion
3921 operator: conversions to @code{void}, the same type, a base class or a
3922 reference to them. Warnings about conversions between signed and
3923 unsigned integers are disabled by default in C++ unless
3924 @option{-Wsign-conversion} is explicitly enabled.
3926 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
3927 @opindex Wconversion-null
3928 @opindex Wno-conversion-null
3929 Do not warn for conversions between @code{NULL} and non-pointer
3930 types. @option{-Wconversion-null} is enabled by default.
3932 @item -Wempty-body
3933 @opindex Wempty-body
3934 @opindex Wno-empty-body
3935 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3936 while} statement.  This warning is also enabled by @option{-Wextra}.
3938 @item -Wenum-compare
3939 @opindex Wenum-compare
3940 @opindex Wno-enum-compare
3941 Warn about a comparison between values of different enum types. In C++
3942 this warning is enabled by default.  In C this warning is enabled by
3943 @option{-Wall}.
3945 @item -Wjump-misses-init @r{(C, Objective-C only)}
3946 @opindex Wjump-misses-init
3947 @opindex Wno-jump-misses-init
3948 Warn if a @code{goto} statement or a @code{switch} statement jumps
3949 forward across the initialization of a variable, or jumps backward to a
3950 label after the variable has been initialized.  This only warns about
3951 variables which are initialized when they are declared.  This warning is
3952 only supported for C and Objective C; in C++ this sort of branch is an
3953 error in any case.
3955 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
3956 can be disabled with the @option{-Wno-jump-misses-init} option.
3958 @item -Wsign-compare
3959 @opindex Wsign-compare
3960 @opindex Wno-sign-compare
3961 @cindex warning for comparison of signed and unsigned values
3962 @cindex comparison of signed and unsigned values, warning
3963 @cindex signed and unsigned values, comparison warning
3964 Warn when a comparison between signed and unsigned values could produce
3965 an incorrect result when the signed value is converted to unsigned.
3966 This warning is also enabled by @option{-Wextra}; to get the other warnings
3967 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3969 @item -Wsign-conversion
3970 @opindex Wsign-conversion
3971 @opindex Wno-sign-conversion
3972 Warn for implicit conversions that may change the sign of an integer
3973 value, like assigning a signed integer expression to an unsigned
3974 integer variable. An explicit cast silences the warning. In C, this
3975 option is enabled also by @option{-Wconversion}.
3977 @item -Waddress
3978 @opindex Waddress
3979 @opindex Wno-address
3980 Warn about suspicious uses of memory addresses. These include using
3981 the address of a function in a conditional expression, such as
3982 @code{void func(void); if (func)}, and comparisons against the memory
3983 address of a string literal, such as @code{if (x == "abc")}.  Such
3984 uses typically indicate a programmer error: the address of a function
3985 always evaluates to true, so their use in a conditional usually
3986 indicate that the programmer forgot the parentheses in a function
3987 call; and comparisons against string literals result in unspecified
3988 behavior and are not portable in C, so they usually indicate that the
3989 programmer intended to use @code{strcmp}.  This warning is enabled by
3990 @option{-Wall}.
3992 @item -Wlogical-op
3993 @opindex Wlogical-op
3994 @opindex Wno-logical-op
3995 Warn about suspicious uses of logical operators in expressions.
3996 This includes using logical operators in contexts where a
3997 bit-wise operator is likely to be expected.
3999 @item -Waggregate-return
4000 @opindex Waggregate-return
4001 @opindex Wno-aggregate-return
4002 Warn if any functions that return structures or unions are defined or
4003 called.  (In languages where you can return an array, this also elicits
4004 a warning.)
4006 @item -Wno-attributes
4007 @opindex Wno-attributes
4008 @opindex Wattributes
4009 Do not warn if an unexpected @code{__attribute__} is used, such as
4010 unrecognized attributes, function attributes applied to variables,
4011 etc.  This will not stop errors for incorrect use of supported
4012 attributes.
4014 @item -Wno-builtin-macro-redefined
4015 @opindex Wno-builtin-macro-redefined
4016 @opindex Wbuiltin-macro-redefined
4017 Do not warn if certain built-in macros are redefined.  This suppresses
4018 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4019 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4021 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4022 @opindex Wstrict-prototypes
4023 @opindex Wno-strict-prototypes
4024 Warn if a function is declared or defined without specifying the
4025 argument types.  (An old-style function definition is permitted without
4026 a warning if preceded by a declaration which specifies the argument
4027 types.)
4029 @item -Wold-style-declaration @r{(C and Objective-C only)}
4030 @opindex Wold-style-declaration
4031 @opindex Wno-old-style-declaration
4032 Warn for obsolescent usages, according to the C Standard, in a
4033 declaration. For example, warn if storage-class specifiers like
4034 @code{static} are not the first things in a declaration.  This warning
4035 is also enabled by @option{-Wextra}.
4037 @item -Wold-style-definition @r{(C and Objective-C only)}
4038 @opindex Wold-style-definition
4039 @opindex Wno-old-style-definition
4040 Warn if an old-style function definition is used.  A warning is given
4041 even if there is a previous prototype.
4043 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4044 @opindex Wmissing-parameter-type
4045 @opindex Wno-missing-parameter-type
4046 A function parameter is declared without a type specifier in K&R-style
4047 functions:
4049 @smallexample
4050 void foo(bar) @{ @}
4051 @end smallexample
4053 This warning is also enabled by @option{-Wextra}.
4055 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4056 @opindex Wmissing-prototypes
4057 @opindex Wno-missing-prototypes
4058 Warn if a global function is defined without a previous prototype
4059 declaration.  This warning is issued even if the definition itself
4060 provides a prototype.  The aim is to detect global functions that fail
4061 to be declared in header files.
4063 @item -Wmissing-declarations
4064 @opindex Wmissing-declarations
4065 @opindex Wno-missing-declarations
4066 Warn if a global function is defined without a previous declaration.
4067 Do so even if the definition itself provides a prototype.
4068 Use this option to detect global functions that are not declared in
4069 header files.  In C++, no warnings are issued for function templates,
4070 or for inline functions, or for functions in anonymous namespaces.
4072 @item -Wmissing-field-initializers
4073 @opindex Wmissing-field-initializers
4074 @opindex Wno-missing-field-initializers
4075 @opindex W
4076 @opindex Wextra
4077 @opindex Wno-extra
4078 Warn if a structure's initializer has some fields missing.  For
4079 example, the following code would cause such a warning, because
4080 @code{x.h} is implicitly zero:
4082 @smallexample
4083 struct s @{ int f, g, h; @};
4084 struct s x = @{ 3, 4 @};
4085 @end smallexample
4087 This option does not warn about designated initializers, so the following
4088 modification would not trigger a warning:
4090 @smallexample
4091 struct s @{ int f, g, h; @};
4092 struct s x = @{ .f = 3, .g = 4 @};
4093 @end smallexample
4095 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4096 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4098 @item -Wmissing-noreturn
4099 @opindex Wmissing-noreturn
4100 @opindex Wno-missing-noreturn
4101 Warn about functions which might be candidates for attribute @code{noreturn}.
4102 Note these are only possible candidates, not absolute ones.  Care should
4103 be taken to manually verify functions actually do not ever return before
4104 adding the @code{noreturn} attribute, otherwise subtle code generation
4105 bugs could be introduced.  You will not get a warning for @code{main} in
4106 hosted C environments.
4108 @item -Wmissing-format-attribute
4109 @opindex Wmissing-format-attribute
4110 @opindex Wno-missing-format-attribute
4111 @opindex Wformat
4112 @opindex Wno-format
4113 Warn about function pointers which might be candidates for @code{format}
4114 attributes.  Note these are only possible candidates, not absolute ones.
4115 GCC will guess that function pointers with @code{format} attributes that
4116 are used in assignment, initialization, parameter passing or return
4117 statements should have a corresponding @code{format} attribute in the
4118 resulting type.  I.e.@: the left-hand side of the assignment or
4119 initialization, the type of the parameter variable, or the return type
4120 of the containing function respectively should also have a @code{format}
4121 attribute to avoid the warning.
4123 GCC will also warn about function definitions which might be
4124 candidates for @code{format} attributes.  Again, these are only
4125 possible candidates.  GCC will guess that @code{format} attributes
4126 might be appropriate for any function that calls a function like
4127 @code{vprintf} or @code{vscanf}, but this might not always be the
4128 case, and some functions for which @code{format} attributes are
4129 appropriate may not be detected.
4131 @item -Wno-multichar
4132 @opindex Wno-multichar
4133 @opindex Wmultichar
4134 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4135 Usually they indicate a typo in the user's code, as they have
4136 implementation-defined values, and should not be used in portable code.
4138 @item -Wnormalized=<none|id|nfc|nfkc>
4139 @opindex Wnormalized=
4140 @cindex NFC
4141 @cindex NFKC
4142 @cindex character set, input normalization
4143 In ISO C and ISO C++, two identifiers are different if they are
4144 different sequences of characters.  However, sometimes when characters
4145 outside the basic ASCII character set are used, you can have two
4146 different character sequences that look the same.  To avoid confusion,
4147 the ISO 10646 standard sets out some @dfn{normalization rules} which
4148 when applied ensure that two sequences that look the same are turned into
4149 the same sequence.  GCC can warn you if you are using identifiers which
4150 have not been normalized; this option controls that warning.
4152 There are four levels of warning that GCC supports.  The default is
4153 @option{-Wnormalized=nfc}, which warns about any identifier which is
4154 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4155 recommended form for most uses.
4157 Unfortunately, there are some characters which ISO C and ISO C++ allow
4158 in identifiers that when turned into NFC aren't allowable as
4159 identifiers.  That is, there's no way to use these symbols in portable
4160 ISO C or C++ and have all your identifiers in NFC@.
4161 @option{-Wnormalized=id} suppresses the warning for these characters.
4162 It is hoped that future versions of the standards involved will correct
4163 this, which is why this option is not the default.
4165 You can switch the warning off for all characters by writing
4166 @option{-Wnormalized=none}.  You would only want to do this if you
4167 were using some other normalization scheme (like ``D''), because
4168 otherwise you can easily create bugs that are literally impossible to see.
4170 Some characters in ISO 10646 have distinct meanings but look identical
4171 in some fonts or display methodologies, especially once formatting has
4172 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4173 LETTER N'', will display just like a regular @code{n} which has been
4174 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4175 normalization scheme to convert all these into a standard form as
4176 well, and GCC will warn if your code is not in NFKC if you use
4177 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4178 about every identifier that contains the letter O because it might be
4179 confused with the digit 0, and so is not the default, but may be
4180 useful as a local coding convention if the programming environment is
4181 unable to be fixed to display these characters distinctly.
4183 @item -Wno-deprecated
4184 @opindex Wno-deprecated
4185 @opindex Wdeprecated
4186 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4188 @item -Wno-deprecated-declarations
4189 @opindex Wno-deprecated-declarations
4190 @opindex Wdeprecated-declarations
4191 Do not warn about uses of functions (@pxref{Function Attributes}),
4192 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4193 Attributes}) marked as deprecated by using the @code{deprecated}
4194 attribute.
4196 @item -Wno-overflow
4197 @opindex Wno-overflow
4198 @opindex Woverflow
4199 Do not warn about compile-time overflow in constant expressions.
4201 @item -Woverride-init @r{(C and Objective-C only)}
4202 @opindex Woverride-init
4203 @opindex Wno-override-init
4204 @opindex W
4205 @opindex Wextra
4206 @opindex Wno-extra
4207 Warn if an initialized field without side effects is overridden when
4208 using designated initializers (@pxref{Designated Inits, , Designated
4209 Initializers}).
4211 This warning is included in @option{-Wextra}.  To get other
4212 @option{-Wextra} warnings without this one, use @samp{-Wextra
4213 -Wno-override-init}.
4215 @item -Wpacked
4216 @opindex Wpacked
4217 @opindex Wno-packed
4218 Warn if a structure is given the packed attribute, but the packed
4219 attribute has no effect on the layout or size of the structure.
4220 Such structures may be mis-aligned for little benefit.  For
4221 instance, in this code, the variable @code{f.x} in @code{struct bar}
4222 will be misaligned even though @code{struct bar} does not itself
4223 have the packed attribute:
4225 @smallexample
4226 @group
4227 struct foo @{
4228   int x;
4229   char a, b, c, d;
4230 @} __attribute__((packed));
4231 struct bar @{
4232   char z;
4233   struct foo f;
4235 @end group
4236 @end smallexample
4238 @item -Wpacked-bitfield-compat
4239 @opindex Wpacked-bitfield-compat
4240 @opindex Wno-packed-bitfield-compat
4241 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4242 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4243 the change can lead to differences in the structure layout.  GCC
4244 informs you when the offset of such a field has changed in GCC 4.4.
4245 For example there is no longer a 4-bit padding between field @code{a}
4246 and @code{b} in this structure:
4248 @smallexample
4249 struct foo
4251   char a:4;
4252   char b:8;
4253 @} __attribute__ ((packed));
4254 @end smallexample
4256 This warning is enabled by default.  Use
4257 @option{-Wno-packed-bitfield-compat} to disable this warning.
4259 @item -Wpadded
4260 @opindex Wpadded
4261 @opindex Wno-padded
4262 Warn if padding is included in a structure, either to align an element
4263 of the structure or to align the whole structure.  Sometimes when this
4264 happens it is possible to rearrange the fields of the structure to
4265 reduce the padding and so make the structure smaller.
4267 @item -Wredundant-decls
4268 @opindex Wredundant-decls
4269 @opindex Wno-redundant-decls
4270 Warn if anything is declared more than once in the same scope, even in
4271 cases where multiple declaration is valid and changes nothing.
4273 @item -Wnested-externs @r{(C and Objective-C only)}
4274 @opindex Wnested-externs
4275 @opindex Wno-nested-externs
4276 Warn if an @code{extern} declaration is encountered within a function.
4278 @item -Winline
4279 @opindex Winline
4280 @opindex Wno-inline
4281 Warn if a function can not be inlined and it was declared as inline.
4282 Even with this option, the compiler will not warn about failures to
4283 inline functions declared in system headers.
4285 The compiler uses a variety of heuristics to determine whether or not
4286 to inline a function.  For example, the compiler takes into account
4287 the size of the function being inlined and the amount of inlining
4288 that has already been done in the current function.  Therefore,
4289 seemingly insignificant changes in the source program can cause the
4290 warnings produced by @option{-Winline} to appear or disappear.
4292 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4293 @opindex Wno-invalid-offsetof
4294 @opindex Winvalid-offsetof
4295 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4296 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4297 to a non-POD type is undefined.  In existing C++ implementations,
4298 however, @samp{offsetof} typically gives meaningful results even when
4299 applied to certain kinds of non-POD types. (Such as a simple
4300 @samp{struct} that fails to be a POD type only by virtue of having a
4301 constructor.)  This flag is for users who are aware that they are
4302 writing nonportable code and who have deliberately chosen to ignore the
4303 warning about it.
4305 The restrictions on @samp{offsetof} may be relaxed in a future version
4306 of the C++ standard.
4308 @item -Wno-int-to-pointer-cast
4309 @opindex Wno-int-to-pointer-cast
4310 @opindex Wint-to-pointer-cast
4311 Suppress warnings from casts to pointer type of an integer of a
4312 different size. In C++, casting to a pointer type of smaller size is
4313 an error. @option{Wint-to-pointer-cast} is enabled by default.
4316 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4317 @opindex Wno-pointer-to-int-cast
4318 @opindex Wpointer-to-int-cast
4319 Suppress warnings from casts from a pointer to an integer type of a
4320 different size.
4322 @item -Winvalid-pch
4323 @opindex Winvalid-pch
4324 @opindex Wno-invalid-pch
4325 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4326 the search path but can't be used.
4328 @item -Wlong-long
4329 @opindex Wlong-long
4330 @opindex Wno-long-long
4331 Warn if @samp{long long} type is used.  This is enabled by either
4332 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4333 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4335 @item -Wvariadic-macros
4336 @opindex Wvariadic-macros
4337 @opindex Wno-variadic-macros
4338 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4339 alternate syntax when in pedantic ISO C99 mode.  This is default.
4340 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4342 @item -Wvla
4343 @opindex Wvla
4344 @opindex Wno-vla
4345 Warn if variable length array is used in the code.
4346 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4347 the variable length array.
4349 @item -Wvolatile-register-var
4350 @opindex Wvolatile-register-var
4351 @opindex Wno-volatile-register-var
4352 Warn if a register variable is declared volatile.  The volatile
4353 modifier does not inhibit all optimizations that may eliminate reads
4354 and/or writes to register variables.  This warning is enabled by
4355 @option{-Wall}.
4357 @item -Wdisabled-optimization
4358 @opindex Wdisabled-optimization
4359 @opindex Wno-disabled-optimization
4360 Warn if a requested optimization pass is disabled.  This warning does
4361 not generally indicate that there is anything wrong with your code; it
4362 merely indicates that GCC's optimizers were unable to handle the code
4363 effectively.  Often, the problem is that your code is too big or too
4364 complex; GCC will refuse to optimize programs when the optimization
4365 itself is likely to take inordinate amounts of time.
4367 @item -Wpointer-sign @r{(C and Objective-C only)}
4368 @opindex Wpointer-sign
4369 @opindex Wno-pointer-sign
4370 Warn for pointer argument passing or assignment with different signedness.
4371 This option is only supported for C and Objective-C@.  It is implied by
4372 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4373 @option{-Wno-pointer-sign}.
4375 @item -Wstack-protector
4376 @opindex Wstack-protector
4377 @opindex Wno-stack-protector
4378 This option is only active when @option{-fstack-protector} is active.  It
4379 warns about functions that will not be protected against stack smashing.
4381 @item -Wno-mudflap
4382 @opindex Wno-mudflap
4383 Suppress warnings about constructs that cannot be instrumented by
4384 @option{-fmudflap}.
4386 @item -Woverlength-strings
4387 @opindex Woverlength-strings
4388 @opindex Wno-overlength-strings
4389 Warn about string constants which are longer than the ``minimum
4390 maximum'' length specified in the C standard.  Modern compilers
4391 generally allow string constants which are much longer than the
4392 standard's minimum limit, but very portable programs should avoid
4393 using longer strings.
4395 The limit applies @emph{after} string constant concatenation, and does
4396 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4397 C99, it was raised to 4095.  C++98 does not specify a normative
4398 minimum maximum, so we do not diagnose overlength strings in C++@.
4400 This option is implied by @option{-pedantic}, and can be disabled with
4401 @option{-Wno-overlength-strings}.
4403 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4404 @opindex Wunsuffixed-float-constants
4406 GCC will issue a warning for any floating constant that does not have
4407 a suffix.  When used together with @option{-Wsystem-headers} it will
4408 warn about such constants in system header files.  This can be useful
4409 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4410 from the decimal floating-point extension to C99.
4411 @end table
4413 @node Debugging Options
4414 @section Options for Debugging Your Program or GCC
4415 @cindex options, debugging
4416 @cindex debugging information options
4418 GCC has various special options that are used for debugging
4419 either your program or GCC:
4421 @table @gcctabopt
4422 @item -g
4423 @opindex g
4424 Produce debugging information in the operating system's native format
4425 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4426 information.
4428 On most systems that use stabs format, @option{-g} enables use of extra
4429 debugging information that only GDB can use; this extra information
4430 makes debugging work better in GDB but will probably make other debuggers
4431 crash or
4432 refuse to read the program.  If you want to control for certain whether
4433 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4434 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4436 GCC allows you to use @option{-g} with
4437 @option{-O}.  The shortcuts taken by optimized code may occasionally
4438 produce surprising results: some variables you declared may not exist
4439 at all; flow of control may briefly move where you did not expect it;
4440 some statements may not be executed because they compute constant
4441 results or their values were already at hand; some statements may
4442 execute in different places because they were moved out of loops.
4444 Nevertheless it proves possible to debug optimized output.  This makes
4445 it reasonable to use the optimizer for programs that might have bugs.
4447 The following options are useful when GCC is generated with the
4448 capability for more than one debugging format.
4450 @item -ggdb
4451 @opindex ggdb
4452 Produce debugging information for use by GDB@.  This means to use the
4453 most expressive format available (DWARF 2, stabs, or the native format
4454 if neither of those are supported), including GDB extensions if at all
4455 possible.
4457 @item -gstabs
4458 @opindex gstabs
4459 Produce debugging information in stabs format (if that is supported),
4460 without GDB extensions.  This is the format used by DBX on most BSD
4461 systems.  On MIPS, Alpha and System V Release 4 systems this option
4462 produces stabs debugging output which is not understood by DBX or SDB@.
4463 On System V Release 4 systems this option requires the GNU assembler.
4465 @item -feliminate-unused-debug-symbols
4466 @opindex feliminate-unused-debug-symbols
4467 Produce debugging information in stabs format (if that is supported),
4468 for only symbols that are actually used.
4470 @item -femit-class-debug-always
4471 Instead of emitting debugging information for a C++ class in only one
4472 object file, emit it in all object files using the class.  This option
4473 should be used only with debuggers that are unable to handle the way GCC
4474 normally emits debugging information for classes because using this
4475 option will increase the size of debugging information by as much as a
4476 factor of two.
4478 @item -gstabs+
4479 @opindex gstabs+
4480 Produce debugging information in stabs format (if that is supported),
4481 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4482 use of these extensions is likely to make other debuggers crash or
4483 refuse to read the program.
4485 @item -gcoff
4486 @opindex gcoff
4487 Produce debugging information in COFF format (if that is supported).
4488 This is the format used by SDB on most System V systems prior to
4489 System V Release 4.
4491 @item -gxcoff
4492 @opindex gxcoff
4493 Produce debugging information in XCOFF format (if that is supported).
4494 This is the format used by the DBX debugger on IBM RS/6000 systems.
4496 @item -gxcoff+
4497 @opindex gxcoff+
4498 Produce debugging information in XCOFF format (if that is supported),
4499 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4500 use of these extensions is likely to make other debuggers crash or
4501 refuse to read the program, and may cause assemblers other than the GNU
4502 assembler (GAS) to fail with an error.
4504 @item -gdwarf-@var{version}
4505 @opindex gdwarf-@var{version}
4506 Produce debugging information in DWARF format (if that is
4507 supported).  This is the format used by DBX on IRIX 6.  The value
4508 of @var{version} may be either 2, 3 or 4; the default version is 2.
4510 Note that with DWARF version 2 some ports require, and will always
4511 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4513 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4514 for maximum benefit.
4516 @item -gstrict-dwarf
4517 @opindex gstrict-dwarf
4518 Disallow using extensions of later DWARF standard version than selected
4519 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4520 DWARF extensions from later standard versions is allowed.
4522 @item -gno-strict-dwarf
4523 @opindex gno-strict-dwarf
4524 Allow using extensions of later DWARF standard version than selected with
4525 @option{-gdwarf-@var{version}}.
4527 @item -gvms
4528 @opindex gvms
4529 Produce debugging information in VMS debug format (if that is
4530 supported).  This is the format used by DEBUG on VMS systems.
4532 @item -g@var{level}
4533 @itemx -ggdb@var{level}
4534 @itemx -gstabs@var{level}
4535 @itemx -gcoff@var{level}
4536 @itemx -gxcoff@var{level}
4537 @itemx -gvms@var{level}
4538 Request debugging information and also use @var{level} to specify how
4539 much information.  The default level is 2.
4541 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4542 @option{-g}.
4544 Level 1 produces minimal information, enough for making backtraces in
4545 parts of the program that you don't plan to debug.  This includes
4546 descriptions of functions and external variables, but no information
4547 about local variables and no line numbers.
4549 Level 3 includes extra information, such as all the macro definitions
4550 present in the program.  Some debuggers support macro expansion when
4551 you use @option{-g3}.
4553 @option{-gdwarf-2} does not accept a concatenated debug level, because
4554 GCC used to support an option @option{-gdwarf} that meant to generate
4555 debug information in version 1 of the DWARF format (which is very
4556 different from version 2), and it would have been too confusing.  That
4557 debug format is long obsolete, but the option cannot be changed now.
4558 Instead use an additional @option{-g@var{level}} option to change the
4559 debug level for DWARF.
4561 @item -gtoggle
4562 @opindex gtoggle
4563 Turn off generation of debug info, if leaving out this option would have
4564 generated it, or turn it on at level 2 otherwise.  The position of this
4565 argument in the command line does not matter, it takes effect after all
4566 other options are processed, and it does so only once, no matter how
4567 many times it is given.  This is mainly intended to be used with
4568 @option{-fcompare-debug}.
4570 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4571 @opindex fdump-final-insns
4572 Dump the final internal representation (RTL) to @var{file}.  If the
4573 optional argument is omitted (or if @var{file} is @code{.}), the name
4574 of the dump file will be determined by appending @code{.gkd} to the
4575 compilation output file name.
4577 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4578 @opindex fcompare-debug
4579 @opindex fno-compare-debug
4580 If no error occurs during compilation, run the compiler a second time,
4581 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4582 passed to the second compilation.  Dump the final internal
4583 representation in both compilations, and print an error if they differ.
4585 If the equal sign is omitted, the default @option{-gtoggle} is used.
4587 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4588 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4589 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4590 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4591 is used.
4593 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4594 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4595 of the final representation and the second compilation, preventing even
4596 @env{GCC_COMPARE_DEBUG} from taking effect.
4598 To verify full coverage during @option{-fcompare-debug} testing, set
4599 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4600 which GCC will reject as an invalid option in any actual compilation
4601 (rather than preprocessing, assembly or linking).  To get just a
4602 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4603 not overridden} will do.
4605 @item -fcompare-debug-second
4606 @opindex fcompare-debug-second
4607 This option is implicitly passed to the compiler for the second
4608 compilation requested by @option{-fcompare-debug}, along with options to
4609 silence warnings, and omitting other options that would cause
4610 side-effect compiler outputs to files or to the standard output.  Dump
4611 files and preserved temporary files are renamed so as to contain the
4612 @code{.gk} additional extension during the second compilation, to avoid
4613 overwriting those generated by the first.
4615 When this option is passed to the compiler driver, it causes the
4616 @emph{first} compilation to be skipped, which makes it useful for little
4617 other than debugging the compiler proper.
4619 @item -feliminate-dwarf2-dups
4620 @opindex feliminate-dwarf2-dups
4621 Compress DWARF2 debugging information by eliminating duplicated
4622 information about each symbol.  This option only makes sense when
4623 generating DWARF2 debugging information with @option{-gdwarf-2}.
4625 @item -femit-struct-debug-baseonly
4626 Emit debug information for struct-like types
4627 only when the base name of the compilation source file
4628 matches the base name of file in which the struct was defined.
4630 This option substantially reduces the size of debugging information,
4631 but at significant potential loss in type information to the debugger.
4632 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4633 See @option{-femit-struct-debug-detailed} for more detailed control.
4635 This option works only with DWARF 2.
4637 @item -femit-struct-debug-reduced
4638 Emit debug information for struct-like types
4639 only when the base name of the compilation source file
4640 matches the base name of file in which the type was defined,
4641 unless the struct is a template or defined in a system header.
4643 This option significantly reduces the size of debugging information,
4644 with some potential loss in type information to the debugger.
4645 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4646 See @option{-femit-struct-debug-detailed} for more detailed control.
4648 This option works only with DWARF 2.
4650 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4651 Specify the struct-like types
4652 for which the compiler will generate debug information.
4653 The intent is to reduce duplicate struct debug information
4654 between different object files within the same program.
4656 This option is a detailed version of
4657 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4658 which will serve for most needs.
4660 A specification has the syntax
4661 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4663 The optional first word limits the specification to
4664 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4665 A struct type is used directly when it is the type of a variable, member.
4666 Indirect uses arise through pointers to structs.
4667 That is, when use of an incomplete struct would be legal, the use is indirect.
4668 An example is
4669 @samp{struct one direct; struct two * indirect;}.
4671 The optional second word limits the specification to
4672 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4673 Generic structs are a bit complicated to explain.
4674 For C++, these are non-explicit specializations of template classes,
4675 or non-template classes within the above.
4676 Other programming languages have generics,
4677 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4679 The third word specifies the source files for those
4680 structs for which the compiler will emit debug information.
4681 The values @samp{none} and @samp{any} have the normal meaning.
4682 The value @samp{base} means that
4683 the base of name of the file in which the type declaration appears
4684 must match the base of the name of the main compilation file.
4685 In practice, this means that
4686 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4687 but types declared in other header will not.
4688 The value @samp{sys} means those types satisfying @samp{base}
4689 or declared in system or compiler headers.
4691 You may need to experiment to determine the best settings for your application.
4693 The default is @samp{-femit-struct-debug-detailed=all}.
4695 This option works only with DWARF 2.
4697 @item -fenable-icf-debug
4698 @opindex fenable-icf-debug
4699 Generate additional debug information to support identical code folding (ICF).
4700 This option only works with DWARF version 2 or higher.
4702 @item -fno-merge-debug-strings
4703 @opindex fmerge-debug-strings
4704 @opindex fno-merge-debug-strings
4705 Direct the linker to not merge together strings in the debugging
4706 information which are identical in different object files.  Merging is
4707 not supported by all assemblers or linkers.  Merging decreases the size
4708 of the debug information in the output file at the cost of increasing
4709 link processing time.  Merging is enabled by default.
4711 @item -fdebug-prefix-map=@var{old}=@var{new}
4712 @opindex fdebug-prefix-map
4713 When compiling files in directory @file{@var{old}}, record debugging
4714 information describing them as in @file{@var{new}} instead.
4716 @item -fno-dwarf2-cfi-asm
4717 @opindex fdwarf2-cfi-asm
4718 @opindex fno-dwarf2-cfi-asm
4719 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4720 instead of using GAS @code{.cfi_*} directives.
4722 @cindex @command{prof}
4723 @item -p
4724 @opindex p
4725 Generate extra code to write profile information suitable for the
4726 analysis program @command{prof}.  You must use this option when compiling
4727 the source files you want data about, and you must also use it when
4728 linking.
4730 @cindex @command{gprof}
4731 @item -pg
4732 @opindex pg
4733 Generate extra code to write profile information suitable for the
4734 analysis program @command{gprof}.  You must use this option when compiling
4735 the source files you want data about, and you must also use it when
4736 linking.
4738 @item -Q
4739 @opindex Q
4740 Makes the compiler print out each function name as it is compiled, and
4741 print some statistics about each pass when it finishes.
4743 @item -ftime-report
4744 @opindex ftime-report
4745 Makes the compiler print some statistics about the time consumed by each
4746 pass when it finishes.
4748 @item -fmem-report
4749 @opindex fmem-report
4750 Makes the compiler print some statistics about permanent memory
4751 allocation when it finishes.
4753 @item -fpre-ipa-mem-report
4754 @opindex fpre-ipa-mem-report
4755 @item -fpost-ipa-mem-report
4756 @opindex fpost-ipa-mem-report
4757 Makes the compiler print some statistics about permanent memory
4758 allocation before or after interprocedural optimization.
4760 @item -fprofile-arcs
4761 @opindex fprofile-arcs
4762 Add code so that program flow @dfn{arcs} are instrumented.  During
4763 execution the program records how many times each branch and call is
4764 executed and how many times it is taken or returns.  When the compiled
4765 program exits it saves this data to a file called
4766 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4767 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4768 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4769 @var{auxname} is generated from the name of the output file, if
4770 explicitly specified and it is not the final executable, otherwise it is
4771 the basename of the source file.  In both cases any suffix is removed
4772 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4773 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4774 @xref{Cross-profiling}.
4776 @cindex @command{gcov}
4777 @item --coverage
4778 @opindex coverage
4780 This option is used to compile and link code instrumented for coverage
4781 analysis.  The option is a synonym for @option{-fprofile-arcs}
4782 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4783 linking).  See the documentation for those options for more details.
4785 @itemize
4787 @item
4788 Compile the source files with @option{-fprofile-arcs} plus optimization
4789 and code generation options.  For test coverage analysis, use the
4790 additional @option{-ftest-coverage} option.  You do not need to profile
4791 every source file in a program.
4793 @item
4794 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4795 (the latter implies the former).
4797 @item
4798 Run the program on a representative workload to generate the arc profile
4799 information.  This may be repeated any number of times.  You can run
4800 concurrent instances of your program, and provided that the file system
4801 supports locking, the data files will be correctly updated.  Also
4802 @code{fork} calls are detected and correctly handled (double counting
4803 will not happen).
4805 @item
4806 For profile-directed optimizations, compile the source files again with
4807 the same optimization and code generation options plus
4808 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4809 Control Optimization}).
4811 @item
4812 For test coverage analysis, use @command{gcov} to produce human readable
4813 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4814 @command{gcov} documentation for further information.
4816 @end itemize
4818 With @option{-fprofile-arcs}, for each function of your program GCC
4819 creates a program flow graph, then finds a spanning tree for the graph.
4820 Only arcs that are not on the spanning tree have to be instrumented: the
4821 compiler adds code to count the number of times that these arcs are
4822 executed.  When an arc is the only exit or only entrance to a block, the
4823 instrumentation code can be added to the block; otherwise, a new basic
4824 block must be created to hold the instrumentation code.
4826 @need 2000
4827 @item -ftest-coverage
4828 @opindex ftest-coverage
4829 Produce a notes file that the @command{gcov} code-coverage utility
4830 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4831 show program coverage.  Each source file's note file is called
4832 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4833 above for a description of @var{auxname} and instructions on how to
4834 generate test coverage data.  Coverage data will match the source files
4835 more closely, if you do not optimize.
4837 @item -fdbg-cnt-list
4838 @opindex fdbg-cnt-list
4839 Print the name and the counter upperbound for all debug counters.
4841 @item -fdbg-cnt=@var{counter-value-list}
4842 @opindex fdbg-cnt
4843 Set the internal debug counter upperbound. @var{counter-value-list}
4844 is a comma-separated list of @var{name}:@var{value} pairs
4845 which sets the upperbound of each debug counter @var{name} to @var{value}.
4846 All debug counters have the initial upperbound of @var{UINT_MAX},
4847 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4848 e.g. With -fdbg-cnt=dce:10,tail_call:0
4849 dbg_cnt(dce) will return true only for first 10 invocations
4850 and dbg_cnt(tail_call) will return false always.
4852 @item -d@var{letters}
4853 @itemx -fdump-rtl-@var{pass}
4854 @opindex d
4855 Says to make debugging dumps during compilation at times specified by
4856 @var{letters}.  This is used for debugging the RTL-based passes of the
4857 compiler.  The file names for most of the dumps are made by appending
4858 a pass number and a word to the @var{dumpname}, and the files are
4859 created in the directory of the output file.  @var{dumpname} is
4860 generated from the name of the output file, if explicitly specified
4861 and it is not an executable, otherwise it is the basename of the
4862 source file. These switches may have different effects when
4863 @option{-E} is used for preprocessing.
4865 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4866 @option{-d} option @var{letters}.  Here are the possible
4867 letters for use in @var{pass} and @var{letters}, and their meanings:
4869 @table @gcctabopt
4871 @item -fdump-rtl-alignments
4872 @opindex fdump-rtl-alignments
4873 Dump after branch alignments have been computed.
4875 @item -fdump-rtl-asmcons
4876 @opindex fdump-rtl-asmcons
4877 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4879 @item -fdump-rtl-auto_inc_dec
4880 @opindex fdump-rtl-auto_inc_dec
4881 Dump after auto-inc-dec discovery.  This pass is only run on
4882 architectures that have auto inc or auto dec instructions.
4884 @item -fdump-rtl-barriers
4885 @opindex fdump-rtl-barriers
4886 Dump after cleaning up the barrier instructions.
4888 @item -fdump-rtl-bbpart
4889 @opindex fdump-rtl-bbpart
4890 Dump after partitioning hot and cold basic blocks.
4892 @item -fdump-rtl-bbro
4893 @opindex fdump-rtl-bbro
4894 Dump after block reordering.
4896 @item -fdump-rtl-btl1
4897 @itemx -fdump-rtl-btl2
4898 @opindex fdump-rtl-btl2
4899 @opindex fdump-rtl-btl2
4900 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4901 after the two branch
4902 target load optimization passes.
4904 @item -fdump-rtl-bypass
4905 @opindex fdump-rtl-bypass
4906 Dump after jump bypassing and control flow optimizations.
4908 @item -fdump-rtl-combine
4909 @opindex fdump-rtl-combine
4910 Dump after the RTL instruction combination pass.
4912 @item -fdump-rtl-compgotos
4913 @opindex fdump-rtl-compgotos
4914 Dump after duplicating the computed gotos.
4916 @item -fdump-rtl-ce1
4917 @itemx -fdump-rtl-ce2
4918 @itemx -fdump-rtl-ce3
4919 @opindex fdump-rtl-ce1
4920 @opindex fdump-rtl-ce2
4921 @opindex fdump-rtl-ce3
4922 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
4923 @option{-fdump-rtl-ce3} enable dumping after the three
4924 if conversion passes.
4926 @itemx -fdump-rtl-cprop_hardreg
4927 @opindex fdump-rtl-cprop_hardreg
4928 Dump after hard register copy propagation.
4930 @itemx -fdump-rtl-csa
4931 @opindex fdump-rtl-csa
4932 Dump after combining stack adjustments.
4934 @item -fdump-rtl-cse1
4935 @itemx -fdump-rtl-cse2
4936 @opindex fdump-rtl-cse1
4937 @opindex fdump-rtl-cse2
4938 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
4939 the two common sub-expression elimination passes.
4941 @itemx -fdump-rtl-dce
4942 @opindex fdump-rtl-dce
4943 Dump after the standalone dead code elimination passes.
4945 @itemx -fdump-rtl-dbr
4946 @opindex fdump-rtl-dbr
4947 Dump after delayed branch scheduling.
4949 @item -fdump-rtl-dce1
4950 @itemx -fdump-rtl-dce2
4951 @opindex fdump-rtl-dce1
4952 @opindex fdump-rtl-dce2
4953 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
4954 the two dead store elimination passes.
4956 @item -fdump-rtl-eh
4957 @opindex fdump-rtl-eh
4958 Dump after finalization of EH handling code.
4960 @item -fdump-rtl-eh_ranges
4961 @opindex fdump-rtl-eh_ranges
4962 Dump after conversion of EH handling range regions.
4964 @item -fdump-rtl-expand
4965 @opindex fdump-rtl-expand
4966 Dump after RTL generation.
4968 @item -fdump-rtl-fwprop1
4969 @itemx -fdump-rtl-fwprop2
4970 @opindex fdump-rtl-fwprop1
4971 @opindex fdump-rtl-fwprop2
4972 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
4973 dumping after the two forward propagation passes.
4975 @item -fdump-rtl-gcse1
4976 @itemx -fdump-rtl-gcse2
4977 @opindex fdump-rtl-gcse1
4978 @opindex fdump-rtl-gcse2
4979 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
4980 after global common subexpression elimination.
4982 @item -fdump-rtl-init-regs
4983 @opindex fdump-rtl-init-regs
4984 Dump after the initialization of the registers.
4986 @item -fdump-rtl-initvals
4987 @opindex fdump-rtl-initvals
4988 Dump after the computation of the initial value sets.
4990 @itemx -fdump-rtl-into_cfglayout
4991 @opindex fdump-rtl-into_cfglayout
4992 Dump after converting to cfglayout mode.
4994 @item -fdump-rtl-ira
4995 @opindex fdump-rtl-ira
4996 Dump after iterated register allocation.
4998 @item -fdump-rtl-jump
4999 @opindex fdump-rtl-jump
5000 Dump after the second jump optimization.
5002 @item -fdump-rtl-loop2
5003 @opindex fdump-rtl-loop2
5004 @option{-fdump-rtl-loop2} enables dumping after the rtl
5005 loop optimization passes.
5007 @item -fdump-rtl-mach
5008 @opindex fdump-rtl-mach
5009 Dump after performing the machine dependent reorganization pass, if that
5010 pass exists.
5012 @item -fdump-rtl-mode_sw
5013 @opindex fdump-rtl-mode_sw
5014 Dump after removing redundant mode switches.
5016 @item -fdump-rtl-rnreg
5017 @opindex fdump-rtl-rnreg
5018 Dump after register renumbering.
5020 @itemx -fdump-rtl-outof_cfglayout
5021 @opindex fdump-rtl-outof_cfglayout
5022 Dump after converting from cfglayout mode.
5024 @item -fdump-rtl-peephole2
5025 @opindex fdump-rtl-peephole2
5026 Dump after the peephole pass.
5028 @item -fdump-rtl-postreload
5029 @opindex fdump-rtl-postreload
5030 Dump after post-reload optimizations.
5032 @itemx -fdump-rtl-pro_and_epilogue
5033 @opindex fdump-rtl-pro_and_epilogue
5034 Dump after generating the function pro and epilogues.
5036 @item -fdump-rtl-regmove
5037 @opindex fdump-rtl-regmove
5038 Dump after the register move pass.
5040 @item -fdump-rtl-sched1
5041 @itemx -fdump-rtl-sched2
5042 @opindex fdump-rtl-sched1
5043 @opindex fdump-rtl-sched2
5044 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5045 after the basic block scheduling passes.
5047 @item -fdump-rtl-see
5048 @opindex fdump-rtl-see
5049 Dump after sign extension elimination.
5051 @item -fdump-rtl-seqabstr
5052 @opindex fdump-rtl-seqabstr
5053 Dump after common sequence discovery.
5055 @item -fdump-rtl-shorten
5056 @opindex fdump-rtl-shorten
5057 Dump after shortening branches.
5059 @item -fdump-rtl-sibling
5060 @opindex fdump-rtl-sibling
5061 Dump after sibling call optimizations.
5063 @item -fdump-rtl-split1
5064 @itemx -fdump-rtl-split2
5065 @itemx -fdump-rtl-split3
5066 @itemx -fdump-rtl-split4
5067 @itemx -fdump-rtl-split5
5068 @opindex fdump-rtl-split1
5069 @opindex fdump-rtl-split2
5070 @opindex fdump-rtl-split3
5071 @opindex fdump-rtl-split4
5072 @opindex fdump-rtl-split5
5073 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5074 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5075 @option{-fdump-rtl-split5} enable dumping after five rounds of
5076 instruction splitting.
5078 @item -fdump-rtl-sms
5079 @opindex fdump-rtl-sms
5080 Dump after modulo scheduling.  This pass is only run on some
5081 architectures.
5083 @item -fdump-rtl-stack
5084 @opindex fdump-rtl-stack
5085 Dump after conversion from GCC's "flat register file" registers to the
5086 x87's stack-like registers.  This pass is only run on x86 variants.
5088 @item -fdump-rtl-subreg1
5089 @itemx -fdump-rtl-subreg2
5090 @opindex fdump-rtl-subreg1
5091 @opindex fdump-rtl-subreg2
5092 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5093 the two subreg expansion passes.
5095 @item -fdump-rtl-unshare
5096 @opindex fdump-rtl-unshare
5097 Dump after all rtl has been unshared.
5099 @item -fdump-rtl-vartrack
5100 @opindex fdump-rtl-vartrack
5101 Dump after variable tracking.
5103 @item -fdump-rtl-vregs
5104 @opindex fdump-rtl-vregs
5105 Dump after converting virtual registers to hard registers.
5107 @item -fdump-rtl-web
5108 @opindex fdump-rtl-web
5109 Dump after live range splitting.
5111 @item -fdump-rtl-regclass
5112 @itemx -fdump-rtl-subregs_of_mode_init
5113 @itemx -fdump-rtl-subregs_of_mode_finish
5114 @itemx -fdump-rtl-dfinit
5115 @itemx -fdump-rtl-dfinish
5116 @opindex fdump-rtl-regclass
5117 @opindex fdump-rtl-subregs_of_mode_init
5118 @opindex fdump-rtl-subregs_of_mode_finish
5119 @opindex fdump-rtl-dfinit
5120 @opindex fdump-rtl-dfinish
5121 These dumps are defined but always produce empty files.
5123 @item -fdump-rtl-all
5124 @opindex fdump-rtl-all
5125 Produce all the dumps listed above.
5127 @item -dA
5128 @opindex dA
5129 Annotate the assembler output with miscellaneous debugging information.
5131 @item -dD
5132 @opindex dD
5133 Dump all macro definitions, at the end of preprocessing, in addition to
5134 normal output.
5136 @item -dH
5137 @opindex dH
5138 Produce a core dump whenever an error occurs.
5140 @item -dm
5141 @opindex dm
5142 Print statistics on memory usage, at the end of the run, to
5143 standard error.
5145 @item -dp
5146 @opindex dp
5147 Annotate the assembler output with a comment indicating which
5148 pattern and alternative was used.  The length of each instruction is
5149 also printed.
5151 @item -dP
5152 @opindex dP
5153 Dump the RTL in the assembler output as a comment before each instruction.
5154 Also turns on @option{-dp} annotation.
5156 @item -dv
5157 @opindex dv
5158 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5159 dump a representation of the control flow graph suitable for viewing with VCG
5160 to @file{@var{file}.@var{pass}.vcg}.
5162 @item -dx
5163 @opindex dx
5164 Just generate RTL for a function instead of compiling it.  Usually used
5165 with @option{-fdump-rtl-expand}.
5167 @item -dy
5168 @opindex dy
5169 Dump debugging information during parsing, to standard error.
5170 @end table
5172 @item -fdump-noaddr
5173 @opindex fdump-noaddr
5174 When doing debugging dumps, suppress address output.  This makes it more
5175 feasible to use diff on debugging dumps for compiler invocations with
5176 different compiler binaries and/or different
5177 text / bss / data / heap / stack / dso start locations.
5179 @item -fdump-unnumbered
5180 @opindex fdump-unnumbered
5181 When doing debugging dumps, suppress instruction numbers and address output.
5182 This makes it more feasible to use diff on debugging dumps for compiler
5183 invocations with different options, in particular with and without
5184 @option{-g}.
5186 @item -fdump-unnumbered-links
5187 @opindex fdump-unnumbered-links
5188 When doing debugging dumps (see @option{-d} option above), suppress
5189 instruction numbers for the links to the previous and next instructions
5190 in a sequence.
5192 @item -fdump-translation-unit @r{(C++ only)}
5193 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5194 @opindex fdump-translation-unit
5195 Dump a representation of the tree structure for the entire translation
5196 unit to a file.  The file name is made by appending @file{.tu} to the
5197 source file name, and the file is created in the same directory as the
5198 output file.  If the @samp{-@var{options}} form is used, @var{options}
5199 controls the details of the dump as described for the
5200 @option{-fdump-tree} options.
5202 @item -fdump-class-hierarchy @r{(C++ only)}
5203 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5204 @opindex fdump-class-hierarchy
5205 Dump a representation of each class's hierarchy and virtual function
5206 table layout to a file.  The file name is made by appending
5207 @file{.class} to the source file name, and the file is created in the
5208 same directory as the output file.  If the @samp{-@var{options}} form
5209 is used, @var{options} controls the details of the dump as described
5210 for the @option{-fdump-tree} options.
5212 @item -fdump-ipa-@var{switch}
5213 @opindex fdump-ipa
5214 Control the dumping at various stages of inter-procedural analysis
5215 language tree to a file.  The file name is generated by appending a
5216 switch specific suffix to the source file name, and the file is created
5217 in the same directory as the output file.  The following dumps are
5218 possible:
5220 @table @samp
5221 @item all
5222 Enables all inter-procedural analysis dumps.
5224 @item cgraph
5225 Dumps information about call-graph optimization, unused function removal,
5226 and inlining decisions.
5228 @item inline
5229 Dump after function inlining.
5231 @end table
5233 @item -fdump-statistics-@var{option}
5234 @opindex fdump-statistics
5235 Enable and control dumping of pass statistics in a separate file.  The
5236 file name is generated by appending a suffix ending in
5237 @samp{.statistics} to the source file name, and the file is created in
5238 the same directory as the output file.  If the @samp{-@var{option}}
5239 form is used, @samp{-stats} will cause counters to be summed over the
5240 whole compilation unit while @samp{-details} will dump every event as
5241 the passes generate them.  The default with no option is to sum
5242 counters for each function compiled.
5244 @item -fdump-tree-@var{switch}
5245 @itemx -fdump-tree-@var{switch}-@var{options}
5246 @opindex fdump-tree
5247 Control the dumping at various stages of processing the intermediate
5248 language tree to a file.  The file name is generated by appending a
5249 switch specific suffix to the source file name, and the file is
5250 created in the same directory as the output file.  If the
5251 @samp{-@var{options}} form is used, @var{options} is a list of
5252 @samp{-} separated options that control the details of the dump.  Not
5253 all options are applicable to all dumps, those which are not
5254 meaningful will be ignored.  The following options are available
5256 @table @samp
5257 @item address
5258 Print the address of each node.  Usually this is not meaningful as it
5259 changes according to the environment and source file.  Its primary use
5260 is for tying up a dump file with a debug environment.
5261 @item asmname
5262 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5263 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5264 use working backward from mangled names in the assembly file.
5265 @item slim
5266 Inhibit dumping of members of a scope or body of a function merely
5267 because that scope has been reached.  Only dump such items when they
5268 are directly reachable by some other path.  When dumping pretty-printed
5269 trees, this option inhibits dumping the bodies of control structures.
5270 @item raw
5271 Print a raw representation of the tree.  By default, trees are
5272 pretty-printed into a C-like representation.
5273 @item details
5274 Enable more detailed dumps (not honored by every dump option).
5275 @item stats
5276 Enable dumping various statistics about the pass (not honored by every dump
5277 option).
5278 @item blocks
5279 Enable showing basic block boundaries (disabled in raw dumps).
5280 @item vops
5281 Enable showing virtual operands for every statement.
5282 @item lineno
5283 Enable showing line numbers for statements.
5284 @item uid
5285 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5286 @item verbose
5287 Enable showing the tree dump for each statement.
5288 @item eh
5289 Enable showing the EH region number holding each statement.
5290 @item all
5291 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5292 and @option{lineno}.
5293 @end table
5295 The following tree dumps are possible:
5296 @table @samp
5298 @item original
5299 @opindex fdump-tree-original
5300 Dump before any tree based optimization, to @file{@var{file}.original}.
5302 @item optimized
5303 @opindex fdump-tree-optimized
5304 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5306 @item gimple
5307 @opindex fdump-tree-gimple
5308 Dump each function before and after the gimplification pass to a file.  The
5309 file name is made by appending @file{.gimple} to the source file name.
5311 @item cfg
5312 @opindex fdump-tree-cfg
5313 Dump the control flow graph of each function to a file.  The file name is
5314 made by appending @file{.cfg} to the source file name.
5316 @item vcg
5317 @opindex fdump-tree-vcg
5318 Dump the control flow graph of each function to a file in VCG format.  The
5319 file name is made by appending @file{.vcg} to the source file name.  Note
5320 that if the file contains more than one function, the generated file cannot
5321 be used directly by VCG@.  You will need to cut and paste each function's
5322 graph into its own separate file first.
5324 @item ch
5325 @opindex fdump-tree-ch
5326 Dump each function after copying loop headers.  The file name is made by
5327 appending @file{.ch} to the source file name.
5329 @item ssa
5330 @opindex fdump-tree-ssa
5331 Dump SSA related information to a file.  The file name is made by appending
5332 @file{.ssa} to the source file name.
5334 @item alias
5335 @opindex fdump-tree-alias
5336 Dump aliasing information for each function.  The file name is made by
5337 appending @file{.alias} to the source file name.
5339 @item ccp
5340 @opindex fdump-tree-ccp
5341 Dump each function after CCP@.  The file name is made by appending
5342 @file{.ccp} to the source file name.
5344 @item storeccp
5345 @opindex fdump-tree-storeccp
5346 Dump each function after STORE-CCP@.  The file name is made by appending
5347 @file{.storeccp} to the source file name.
5349 @item pre
5350 @opindex fdump-tree-pre
5351 Dump trees after partial redundancy elimination.  The file name is made
5352 by appending @file{.pre} to the source file name.
5354 @item fre
5355 @opindex fdump-tree-fre
5356 Dump trees after full redundancy elimination.  The file name is made
5357 by appending @file{.fre} to the source file name.
5359 @item copyprop
5360 @opindex fdump-tree-copyprop
5361 Dump trees after copy propagation.  The file name is made
5362 by appending @file{.copyprop} to the source file name.
5364 @item store_copyprop
5365 @opindex fdump-tree-store_copyprop
5366 Dump trees after store copy-propagation.  The file name is made
5367 by appending @file{.store_copyprop} to the source file name.
5369 @item dce
5370 @opindex fdump-tree-dce
5371 Dump each function after dead code elimination.  The file name is made by
5372 appending @file{.dce} to the source file name.
5374 @item mudflap
5375 @opindex fdump-tree-mudflap
5376 Dump each function after adding mudflap instrumentation.  The file name is
5377 made by appending @file{.mudflap} to the source file name.
5379 @item sra
5380 @opindex fdump-tree-sra
5381 Dump each function after performing scalar replacement of aggregates.  The
5382 file name is made by appending @file{.sra} to the source file name.
5384 @item sink
5385 @opindex fdump-tree-sink
5386 Dump each function after performing code sinking.  The file name is made
5387 by appending @file{.sink} to the source file name.
5389 @item dom
5390 @opindex fdump-tree-dom
5391 Dump each function after applying dominator tree optimizations.  The file
5392 name is made by appending @file{.dom} to the source file name.
5394 @item dse
5395 @opindex fdump-tree-dse
5396 Dump each function after applying dead store elimination.  The file
5397 name is made by appending @file{.dse} to the source file name.
5399 @item phiopt
5400 @opindex fdump-tree-phiopt
5401 Dump each function after optimizing PHI nodes into straightline code.  The file
5402 name is made by appending @file{.phiopt} to the source file name.
5404 @item forwprop
5405 @opindex fdump-tree-forwprop
5406 Dump each function after forward propagating single use variables.  The file
5407 name is made by appending @file{.forwprop} to the source file name.
5409 @item copyrename
5410 @opindex fdump-tree-copyrename
5411 Dump each function after applying the copy rename optimization.  The file
5412 name is made by appending @file{.copyrename} to the source file name.
5414 @item nrv
5415 @opindex fdump-tree-nrv
5416 Dump each function after applying the named return value optimization on
5417 generic trees.  The file name is made by appending @file{.nrv} to the source
5418 file name.
5420 @item vect
5421 @opindex fdump-tree-vect
5422 Dump each function after applying vectorization of loops.  The file name is
5423 made by appending @file{.vect} to the source file name.
5425 @item slp
5426 @opindex fdump-tree-slp
5427 Dump each function after applying vectorization of basic blocks.  The file name
5428 is made by appending @file{.slp} to the source file name.
5430 @item vrp
5431 @opindex fdump-tree-vrp
5432 Dump each function after Value Range Propagation (VRP).  The file name
5433 is made by appending @file{.vrp} to the source file name.
5435 @item all
5436 @opindex fdump-tree-all
5437 Enable all the available tree dumps with the flags provided in this option.
5438 @end table
5440 @item -ftree-vectorizer-verbose=@var{n}
5441 @opindex ftree-vectorizer-verbose
5442 This option controls the amount of debugging output the vectorizer prints.
5443 This information is written to standard error, unless
5444 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5445 in which case it is output to the usual dump listing file, @file{.vect}.
5446 For @var{n}=0 no diagnostic information is reported.
5447 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5448 and the total number of loops that got vectorized.
5449 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5450 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5451 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5452 level that @option{-fdump-tree-vect-stats} uses.
5453 Higher verbosity levels mean either more information dumped for each
5454 reported loop, or same amount of information reported for more loops:
5455 if @var{n}=3, vectorizer cost model information is reported.
5456 If @var{n}=4, alignment related information is added to the reports.
5457 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5458 memory access-patterns) is added to the reports.
5459 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5460 that did not pass the first analysis phase (i.e., may not be countable, or
5461 may have complicated control-flow).
5462 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5463 If @var{n}=8, SLP related information is added to the reports.
5464 For @var{n}=9, all the information the vectorizer generates during its
5465 analysis and transformation is reported.  This is the same verbosity level
5466 that @option{-fdump-tree-vect-details} uses.
5468 @item -frandom-seed=@var{string}
5469 @opindex frandom-seed
5470 This option provides a seed that GCC uses when it would otherwise use
5471 random numbers.  It is used to generate certain symbol names
5472 that have to be different in every compiled file.  It is also used to
5473 place unique stamps in coverage data files and the object files that
5474 produce them.  You can use the @option{-frandom-seed} option to produce
5475 reproducibly identical object files.
5477 The @var{string} should be different for every file you compile.
5479 @item -fsched-verbose=@var{n}
5480 @opindex fsched-verbose
5481 On targets that use instruction scheduling, this option controls the
5482 amount of debugging output the scheduler prints.  This information is
5483 written to standard error, unless @option{-fdump-rtl-sched1} or
5484 @option{-fdump-rtl-sched2} is specified, in which case it is output
5485 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5486 respectively.  However for @var{n} greater than nine, the output is
5487 always printed to standard error.
5489 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5490 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5491 For @var{n} greater than one, it also output basic block probabilities,
5492 detailed ready list information and unit/insn info.  For @var{n} greater
5493 than two, it includes RTL at abort point, control-flow and regions info.
5494 And for @var{n} over four, @option{-fsched-verbose} also includes
5495 dependence info.
5497 @item -save-temps
5498 @itemx -save-temps=cwd
5499 @opindex save-temps
5500 Store the usual ``temporary'' intermediate files permanently; place them
5501 in the current directory and name them based on the source file.  Thus,
5502 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5503 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5504 preprocessed @file{foo.i} output file even though the compiler now
5505 normally uses an integrated preprocessor.
5507 When used in combination with the @option{-x} command line option,
5508 @option{-save-temps} is sensible enough to avoid over writing an
5509 input source file with the same extension as an intermediate file.
5510 The corresponding intermediate file may be obtained by renaming the
5511 source file before using @option{-save-temps}.
5513 If you invoke GCC in parallel, compiling several different source
5514 files that share a common base name in different subdirectories or the
5515 same source file compiled for multiple output destinations, it is
5516 likely that the different parallel compilers will interfere with each
5517 other, and overwrite the temporary files.  For instance:
5519 @smallexample
5520 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5521 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5522 @end smallexample
5524 may result in @file{foo.i} and @file{foo.o} being written to
5525 simultaneously by both compilers.
5527 @item -save-temps=obj
5528 @opindex save-temps=obj
5529 Store the usual ``temporary'' intermediate files permanently.  If the
5530 @option{-o} option is used, the temporary files are based on the
5531 object file.  If the @option{-o} option is not used, the
5532 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5534 For example:
5536 @smallexample
5537 gcc -save-temps=obj -c foo.c
5538 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5539 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5540 @end smallexample
5542 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5543 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5544 @file{dir2/yfoobar.o}.
5546 @item -time@r{[}=@var{file}@r{]}
5547 @opindex time
5548 Report the CPU time taken by each subprocess in the compilation
5549 sequence.  For C source files, this is the compiler proper and assembler
5550 (plus the linker if linking is done).
5552 Without the specification of an output file, the output looks like this:
5554 @smallexample
5555 # cc1 0.12 0.01
5556 # as 0.00 0.01
5557 @end smallexample
5559 The first number on each line is the ``user time'', that is time spent
5560 executing the program itself.  The second number is ``system time'',
5561 time spent executing operating system routines on behalf of the program.
5562 Both numbers are in seconds.
5564 With the specification of an output file, the output is appended to the
5565 named file, and it looks like this:
5567 @smallexample
5568 0.12 0.01 cc1 @var{options}
5569 0.00 0.01 as @var{options}
5570 @end smallexample
5572 The ``user time'' and the ``system time'' are moved before the program
5573 name, and the options passed to the program are displayed, so that one
5574 can later tell what file was being compiled, and with which options.
5576 @item -fvar-tracking
5577 @opindex fvar-tracking
5578 Run variable tracking pass.  It computes where variables are stored at each
5579 position in code.  Better debugging information is then generated
5580 (if the debugging information format supports this information).
5582 It is enabled by default when compiling with optimization (@option{-Os},
5583 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5584 the debug info format supports it.
5586 @item -fvar-tracking-assignments
5587 @opindex fvar-tracking-assignments
5588 @opindex fno-var-tracking-assignments
5589 Annotate assignments to user variables early in the compilation and
5590 attempt to carry the annotations over throughout the compilation all the
5591 way to the end, in an attempt to improve debug information while
5592 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5594 It can be enabled even if var-tracking is disabled, in which case
5595 annotations will be created and maintained, but discarded at the end.
5597 @item -fvar-tracking-assignments-toggle
5598 @opindex fvar-tracking-assignments-toggle
5599 @opindex fno-var-tracking-assignments-toggle
5600 Toggle @option{-fvar-tracking-assignments}, in the same way that
5601 @option{-gtoggle} toggles @option{-g}.
5603 @item -print-file-name=@var{library}
5604 @opindex print-file-name
5605 Print the full absolute name of the library file @var{library} that
5606 would be used when linking---and don't do anything else.  With this
5607 option, GCC does not compile or link anything; it just prints the
5608 file name.
5610 @item -print-multi-directory
5611 @opindex print-multi-directory
5612 Print the directory name corresponding to the multilib selected by any
5613 other switches present in the command line.  This directory is supposed
5614 to exist in @env{GCC_EXEC_PREFIX}.
5616 @item -print-multi-lib
5617 @opindex print-multi-lib
5618 Print the mapping from multilib directory names to compiler switches
5619 that enable them.  The directory name is separated from the switches by
5620 @samp{;}, and each switch starts with an @samp{@@} instead of the
5621 @samp{-}, without spaces between multiple switches.  This is supposed to
5622 ease shell-processing.
5624 @item -print-multi-os-directory
5625 @opindex print-multi-os-directory
5626 Print the path to OS libraries for the selected
5627 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
5628 present in the @file{lib} subdirectory and no multilibs are used, this is
5629 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5630 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5631 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5632 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5634 @item -print-prog-name=@var{program}
5635 @opindex print-prog-name
5636 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5638 @item -print-libgcc-file-name
5639 @opindex print-libgcc-file-name
5640 Same as @option{-print-file-name=libgcc.a}.
5642 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5643 but you do want to link with @file{libgcc.a}.  You can do
5645 @smallexample
5646 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5647 @end smallexample
5649 @item -print-search-dirs
5650 @opindex print-search-dirs
5651 Print the name of the configured installation directory and a list of
5652 program and library directories @command{gcc} will search---and don't do anything else.
5654 This is useful when @command{gcc} prints the error message
5655 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5656 To resolve this you either need to put @file{cpp0} and the other compiler
5657 components where @command{gcc} expects to find them, or you can set the environment
5658 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5659 Don't forget the trailing @samp{/}.
5660 @xref{Environment Variables}.
5662 @item -print-sysroot
5663 @opindex print-sysroot
5664 Print the target sysroot directory that will be used during
5665 compilation.  This is the target sysroot specified either at configure
5666 time or using the @option{--sysroot} option, possibly with an extra
5667 suffix that depends on compilation options.  If no target sysroot is
5668 specified, the option prints nothing.
5670 @item -print-sysroot-headers-suffix
5671 @opindex print-sysroot-headers-suffix
5672 Print the suffix added to the target sysroot when searching for
5673 headers, or give an error if the compiler is not configured with such
5674 a suffix---and don't do anything else.
5676 @item -dumpmachine
5677 @opindex dumpmachine
5678 Print the compiler's target machine (for example,
5679 @samp{i686-pc-linux-gnu})---and don't do anything else.
5681 @item -dumpversion
5682 @opindex dumpversion
5683 Print the compiler version (for example, @samp{3.0})---and don't do
5684 anything else.
5686 @item -dumpspecs
5687 @opindex dumpspecs
5688 Print the compiler's built-in specs---and don't do anything else.  (This
5689 is used when GCC itself is being built.)  @xref{Spec Files}.
5691 @item -feliminate-unused-debug-types
5692 @opindex feliminate-unused-debug-types
5693 Normally, when producing DWARF2 output, GCC will emit debugging
5694 information for all types declared in a compilation
5695 unit, regardless of whether or not they are actually used
5696 in that compilation unit.  Sometimes this is useful, such as
5697 if, in the debugger, you want to cast a value to a type that is
5698 not actually used in your program (but is declared).  More often,
5699 however, this results in a significant amount of wasted space.
5700 With this option, GCC will avoid producing debug symbol output
5701 for types that are nowhere used in the source file being compiled.
5702 @end table
5704 @node Optimize Options
5705 @section Options That Control Optimization
5706 @cindex optimize options
5707 @cindex options, optimization
5709 These options control various sorts of optimizations.
5711 Without any optimization option, the compiler's goal is to reduce the
5712 cost of compilation and to make debugging produce the expected
5713 results.  Statements are independent: if you stop the program with a
5714 breakpoint between statements, you can then assign a new value to any
5715 variable or change the program counter to any other statement in the
5716 function and get exactly the results you would expect from the source
5717 code.
5719 Turning on optimization flags makes the compiler attempt to improve
5720 the performance and/or code size at the expense of compilation time
5721 and possibly the ability to debug the program.
5723 The compiler performs optimization based on the knowledge it has of the
5724 program.  Compiling multiple files at once to a single output file mode allows
5725 the compiler to use information gained from all of the files when compiling
5726 each of them.
5728 Not all optimizations are controlled directly by a flag.  Only
5729 optimizations that have a flag are listed in this section.
5731 Most optimizations are only enabled if an @option{-O} level is set on
5732 the command line.  Otherwise they are disabled, even if individual             
5733 optimization flags are specified.
5735 Depending on the target and how GCC was configured, a slightly different
5736 set of optimizations may be enabled at each @option{-O} level than
5737 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5738 to find out the exact set of optimizations that are enabled at each level.
5739 @xref{Overall Options}, for examples.
5741 @table @gcctabopt
5742 @item -O
5743 @itemx -O1
5744 @opindex O
5745 @opindex O1
5746 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5747 more memory for a large function.
5749 With @option{-O}, the compiler tries to reduce code size and execution
5750 time, without performing any optimizations that take a great deal of
5751 compilation time.
5753 @option{-O} turns on the following optimization flags:
5754 @gccoptlist{
5755 -fauto-inc-dec @gol
5756 -fcprop-registers @gol
5757 -fdce @gol
5758 -fdefer-pop @gol
5759 -fdelayed-branch @gol
5760 -fdse @gol
5761 -fguess-branch-probability @gol
5762 -fif-conversion2 @gol
5763 -fif-conversion @gol
5764 -fipa-pure-const @gol
5765 -fipa-reference @gol
5766 -fmerge-constants
5767 -fsplit-wide-types @gol
5768 -ftree-builtin-call-dce @gol
5769 -ftree-ccp @gol
5770 -ftree-ch @gol
5771 -ftree-copyrename @gol
5772 -ftree-dce @gol
5773 -ftree-dominator-opts @gol
5774 -ftree-dse @gol
5775 -ftree-forwprop @gol
5776 -ftree-fre @gol
5777 -ftree-phiprop @gol
5778 -ftree-sra @gol
5779 -ftree-pta @gol
5780 -ftree-ter @gol
5781 -funit-at-a-time}
5783 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5784 where doing so does not interfere with debugging.
5786 @item -O2
5787 @opindex O2
5788 Optimize even more.  GCC performs nearly all supported optimizations
5789 that do not involve a space-speed tradeoff.
5790 As compared to @option{-O}, this option increases both compilation time
5791 and the performance of the generated code.
5793 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5794 also turns on the following optimization flags:
5795 @gccoptlist{-fthread-jumps @gol
5796 -falign-functions  -falign-jumps @gol
5797 -falign-loops  -falign-labels @gol
5798 -fcaller-saves @gol
5799 -fcrossjumping @gol
5800 -fcse-follow-jumps  -fcse-skip-blocks @gol
5801 -fdelete-null-pointer-checks @gol
5802 -fexpensive-optimizations @gol
5803 -fgcse  -fgcse-lm  @gol
5804 -finline-small-functions @gol
5805 -findirect-inlining @gol
5806 -fipa-sra @gol
5807 -foptimize-sibling-calls @gol
5808 -fpeephole2 @gol
5809 -fregmove @gol
5810 -freorder-blocks  -freorder-functions @gol
5811 -frerun-cse-after-loop  @gol
5812 -fsched-interblock  -fsched-spec @gol
5813 -fschedule-insns  -fschedule-insns2 @gol
5814 -fstrict-aliasing -fstrict-overflow @gol
5815 -ftree-switch-conversion @gol
5816 -ftree-pre @gol
5817 -ftree-vrp}
5819 Please note the warning under @option{-fgcse} about
5820 invoking @option{-O2} on programs that use computed gotos.
5822 @item -O3
5823 @opindex O3
5824 Optimize yet more.  @option{-O3} turns on all optimizations specified
5825 by @option{-O2} and also turns on the @option{-finline-functions},
5826 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5827 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5829 @item -O0
5830 @opindex O0
5831 Reduce compilation time and make debugging produce the expected
5832 results.  This is the default.
5834 @item -Os
5835 @opindex Os
5836 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5837 do not typically increase code size.  It also performs further
5838 optimizations designed to reduce code size.
5840 @option{-Os} disables the following optimization flags:
5841 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5842 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5843 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5845 If you use multiple @option{-O} options, with or without level numbers,
5846 the last such option is the one that is effective.
5847 @end table
5849 Options of the form @option{-f@var{flag}} specify machine-independent
5850 flags.  Most flags have both positive and negative forms; the negative
5851 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5852 below, only one of the forms is listed---the one you typically will
5853 use.  You can figure out the other form by either removing @samp{no-}
5854 or adding it.
5856 The following options control specific optimizations.  They are either
5857 activated by @option{-O} options or are related to ones that are.  You
5858 can use the following flags in the rare cases when ``fine-tuning'' of
5859 optimizations to be performed is desired.
5861 @table @gcctabopt
5862 @item -fno-default-inline
5863 @opindex fno-default-inline
5864 Do not make member functions inline by default merely because they are
5865 defined inside the class scope (C++ only).  Otherwise, when you specify
5866 @w{@option{-O}}, member functions defined inside class scope are compiled
5867 inline by default; i.e., you don't need to add @samp{inline} in front of
5868 the member function name.
5870 @item -fno-defer-pop
5871 @opindex fno-defer-pop
5872 Always pop the arguments to each function call as soon as that function
5873 returns.  For machines which must pop arguments after a function call,
5874 the compiler normally lets arguments accumulate on the stack for several
5875 function calls and pops them all at once.
5877 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5879 @item -fforward-propagate
5880 @opindex fforward-propagate
5881 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5882 instructions and checks if the result can be simplified.  If loop unrolling
5883 is active, two passes are performed and the second is scheduled after
5884 loop unrolling.
5886 This option is enabled by default at optimization levels @option{-O},
5887 @option{-O2}, @option{-O3}, @option{-Os}.
5889 @item -fomit-frame-pointer
5890 @opindex fomit-frame-pointer
5891 Don't keep the frame pointer in a register for functions that
5892 don't need one.  This avoids the instructions to save, set up and
5893 restore frame pointers; it also makes an extra register available
5894 in many functions.  @strong{It also makes debugging impossible on
5895 some machines.}
5897 On some machines, such as the VAX, this flag has no effect, because
5898 the standard calling sequence automatically handles the frame pointer
5899 and nothing is saved by pretending it doesn't exist.  The
5900 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5901 whether a target machine supports this flag.  @xref{Registers,,Register
5902 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5904 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5906 @item -foptimize-sibling-calls
5907 @opindex foptimize-sibling-calls
5908 Optimize sibling and tail recursive calls.
5910 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5912 @item -fno-inline
5913 @opindex fno-inline
5914 Don't pay attention to the @code{inline} keyword.  Normally this option
5915 is used to keep the compiler from expanding any functions inline.
5916 Note that if you are not optimizing, no functions can be expanded inline.
5918 @item -finline-small-functions
5919 @opindex finline-small-functions
5920 Integrate functions into their callers when their body is smaller than expected
5921 function call code (so overall size of program gets smaller).  The compiler
5922 heuristically decides which functions are simple enough to be worth integrating
5923 in this way.
5925 Enabled at level @option{-O2}.
5927 @item -findirect-inlining
5928 @opindex findirect-inlining
5929 Inline also indirect calls that are discovered to be known at compile
5930 time thanks to previous inlining.  This option has any effect only
5931 when inlining itself is turned on by the @option{-finline-functions}
5932 or @option{-finline-small-functions} options.
5934 Enabled at level @option{-O2}.
5936 @item -finline-functions
5937 @opindex finline-functions
5938 Integrate all simple functions into their callers.  The compiler
5939 heuristically decides which functions are simple enough to be worth
5940 integrating in this way.
5942 If all calls to a given function are integrated, and the function is
5943 declared @code{static}, then the function is normally not output as
5944 assembler code in its own right.
5946 Enabled at level @option{-O3}.
5948 @item -finline-functions-called-once
5949 @opindex finline-functions-called-once
5950 Consider all @code{static} functions called once for inlining into their
5951 caller even if they are not marked @code{inline}.  If a call to a given
5952 function is integrated, then the function is not output as assembler code
5953 in its own right.
5955 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
5957 @item -fearly-inlining
5958 @opindex fearly-inlining
5959 Inline functions marked by @code{always_inline} and functions whose body seems
5960 smaller than the function call overhead early before doing
5961 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5962 makes profiling significantly cheaper and usually inlining faster on programs
5963 having large chains of nested wrapper functions.
5965 Enabled by default.
5967 @item -fipa-sra
5968 @opindex fipa-sra
5969 Perform interprocedural scalar replacement of aggregates, removal of
5970 unused parameters and replacement of parameters passed by reference
5971 by parameters passed by value.
5973 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
5975 @item -finline-limit=@var{n}
5976 @opindex finline-limit
5977 By default, GCC limits the size of functions that can be inlined.  This flag
5978 allows coarse control of this limit.  @var{n} is the size of functions that
5979 can be inlined in number of pseudo instructions.
5981 Inlining is actually controlled by a number of parameters, which may be
5982 specified individually by using @option{--param @var{name}=@var{value}}.
5983 The @option{-finline-limit=@var{n}} option sets some of these parameters
5984 as follows:
5986 @table @gcctabopt
5987 @item max-inline-insns-single
5988 is set to @var{n}/2.
5989 @item max-inline-insns-auto
5990 is set to @var{n}/2.
5991 @end table
5993 See below for a documentation of the individual
5994 parameters controlling inlining and for the defaults of these parameters.
5996 @emph{Note:} there may be no value to @option{-finline-limit} that results
5997 in default behavior.
5999 @emph{Note:} pseudo instruction represents, in this particular context, an
6000 abstract measurement of function's size.  In no way does it represent a count
6001 of assembly instructions and as such its exact meaning might change from one
6002 release to an another.
6004 @item -fkeep-inline-functions
6005 @opindex fkeep-inline-functions
6006 In C, emit @code{static} functions that are declared @code{inline}
6007 into the object file, even if the function has been inlined into all
6008 of its callers.  This switch does not affect functions using the
6009 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6010 inline functions into the object file.
6012 @item -fkeep-static-consts
6013 @opindex fkeep-static-consts
6014 Emit variables declared @code{static const} when optimization isn't turned
6015 on, even if the variables aren't referenced.
6017 GCC enables this option by default.  If you want to force the compiler to
6018 check if the variable was referenced, regardless of whether or not
6019 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6021 @item -fmerge-constants
6022 @opindex fmerge-constants
6023 Attempt to merge identical constants (string constants and floating point
6024 constants) across compilation units.
6026 This option is the default for optimized compilation if the assembler and
6027 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6028 behavior.
6030 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6032 @item -fmerge-all-constants
6033 @opindex fmerge-all-constants
6034 Attempt to merge identical constants and identical variables.
6036 This option implies @option{-fmerge-constants}.  In addition to
6037 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6038 arrays or initialized constant variables with integral or floating point
6039 types.  Languages like C or C++ require each variable, including multiple
6040 instances of the same variable in recursive calls, to have distinct locations,
6041 so using this option will result in non-conforming
6042 behavior.
6044 @item -fmodulo-sched
6045 @opindex fmodulo-sched
6046 Perform swing modulo scheduling immediately before the first scheduling
6047 pass.  This pass looks at innermost loops and reorders their
6048 instructions by overlapping different iterations.
6050 @item -fmodulo-sched-allow-regmoves
6051 @opindex fmodulo-sched-allow-regmoves
6052 Perform more aggressive SMS based modulo scheduling with register moves
6053 allowed.  By setting this flag certain anti-dependences edges will be
6054 deleted which will trigger the generation of reg-moves based on the
6055 life-range analysis.  This option is effective only with
6056 @option{-fmodulo-sched} enabled.
6058 @item -fno-branch-count-reg
6059 @opindex fno-branch-count-reg
6060 Do not use ``decrement and branch'' instructions on a count register,
6061 but instead generate a sequence of instructions that decrement a
6062 register, compare it against zero, then branch based upon the result.
6063 This option is only meaningful on architectures that support such
6064 instructions, which include x86, PowerPC, IA-64 and S/390.
6066 The default is @option{-fbranch-count-reg}.
6068 @item -fno-function-cse
6069 @opindex fno-function-cse
6070 Do not put function addresses in registers; make each instruction that
6071 calls a constant function contain the function's address explicitly.
6073 This option results in less efficient code, but some strange hacks
6074 that alter the assembler output may be confused by the optimizations
6075 performed when this option is not used.
6077 The default is @option{-ffunction-cse}
6079 @item -fno-zero-initialized-in-bss
6080 @opindex fno-zero-initialized-in-bss
6081 If the target supports a BSS section, GCC by default puts variables that
6082 are initialized to zero into BSS@.  This can save space in the resulting
6083 code.
6085 This option turns off this behavior because some programs explicitly
6086 rely on variables going to the data section.  E.g., so that the
6087 resulting executable can find the beginning of that section and/or make
6088 assumptions based on that.
6090 The default is @option{-fzero-initialized-in-bss}.
6092 @item -fmudflap -fmudflapth -fmudflapir
6093 @opindex fmudflap
6094 @opindex fmudflapth
6095 @opindex fmudflapir
6096 @cindex bounds checking
6097 @cindex mudflap
6098 For front-ends that support it (C and C++), instrument all risky
6099 pointer/array dereferencing operations, some standard library
6100 string/heap functions, and some other associated constructs with
6101 range/validity tests.  Modules so instrumented should be immune to
6102 buffer overflows, invalid heap use, and some other classes of C/C++
6103 programming errors.  The instrumentation relies on a separate runtime
6104 library (@file{libmudflap}), which will be linked into a program if
6105 @option{-fmudflap} is given at link time.  Run-time behavior of the
6106 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6107 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6108 for its options.
6110 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6111 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6112 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6113 instrumentation should ignore pointer reads.  This produces less
6114 instrumentation (and therefore faster execution) and still provides
6115 some protection against outright memory corrupting writes, but allows
6116 erroneously read data to propagate within a program.
6118 @item -fthread-jumps
6119 @opindex fthread-jumps
6120 Perform optimizations where we check to see if a jump branches to a
6121 location where another comparison subsumed by the first is found.  If
6122 so, the first branch is redirected to either the destination of the
6123 second branch or a point immediately following it, depending on whether
6124 the condition is known to be true or false.
6126 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6128 @item -fsplit-wide-types
6129 @opindex fsplit-wide-types
6130 When using a type that occupies multiple registers, such as @code{long
6131 long} on a 32-bit system, split the registers apart and allocate them
6132 independently.  This normally generates better code for those types,
6133 but may make debugging more difficult.
6135 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6136 @option{-Os}.
6138 @item -fcse-follow-jumps
6139 @opindex fcse-follow-jumps
6140 In common subexpression elimination (CSE), scan through jump instructions
6141 when the target of the jump is not reached by any other path.  For
6142 example, when CSE encounters an @code{if} statement with an
6143 @code{else} clause, CSE will follow the jump when the condition
6144 tested is false.
6146 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6148 @item -fcse-skip-blocks
6149 @opindex fcse-skip-blocks
6150 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6151 follow jumps which conditionally skip over blocks.  When CSE
6152 encounters a simple @code{if} statement with no else clause,
6153 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6154 body of the @code{if}.
6156 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6158 @item -frerun-cse-after-loop
6159 @opindex frerun-cse-after-loop
6160 Re-run common subexpression elimination after loop optimizations has been
6161 performed.
6163 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6165 @item -fgcse
6166 @opindex fgcse
6167 Perform a global common subexpression elimination pass.
6168 This pass also performs global constant and copy propagation.
6170 @emph{Note:} When compiling a program using computed gotos, a GCC
6171 extension, you may get better runtime performance if you disable
6172 the global common subexpression elimination pass by adding
6173 @option{-fno-gcse} to the command line.
6175 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6177 @item -fgcse-lm
6178 @opindex fgcse-lm
6179 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6180 attempt to move loads which are only killed by stores into themselves.  This
6181 allows a loop containing a load/store sequence to be changed to a load outside
6182 the loop, and a copy/store within the loop.
6184 Enabled by default when gcse is enabled.
6186 @item -fgcse-sm
6187 @opindex fgcse-sm
6188 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6189 global common subexpression elimination.  This pass will attempt to move
6190 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6191 loops containing a load/store sequence can be changed to a load before
6192 the loop and a store after the loop.
6194 Not enabled at any optimization level.
6196 @item -fgcse-las
6197 @opindex fgcse-las
6198 When @option{-fgcse-las} is enabled, the global common subexpression
6199 elimination pass eliminates redundant loads that come after stores to the
6200 same memory location (both partial and full redundancies).
6202 Not enabled at any optimization level.
6204 @item -fgcse-after-reload
6205 @opindex fgcse-after-reload
6206 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6207 pass is performed after reload.  The purpose of this pass is to cleanup
6208 redundant spilling.
6210 @item -funsafe-loop-optimizations
6211 @opindex funsafe-loop-optimizations
6212 If given, the loop optimizer will assume that loop indices do not
6213 overflow, and that the loops with nontrivial exit condition are not
6214 infinite.  This enables a wider range of loop optimizations even if
6215 the loop optimizer itself cannot prove that these assumptions are valid.
6216 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6217 if it finds this kind of loop.
6219 @item -fcrossjumping
6220 @opindex fcrossjumping
6221 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6222 resulting code may or may not perform better than without cross-jumping.
6224 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6226 @item -fauto-inc-dec
6227 @opindex fauto-inc-dec
6228 Combine increments or decrements of addresses with memory accesses.
6229 This pass is always skipped on architectures that do not have
6230 instructions to support this.  Enabled by default at @option{-O} and
6231 higher on architectures that support this.
6233 @item -fdce
6234 @opindex fdce
6235 Perform dead code elimination (DCE) on RTL@.
6236 Enabled by default at @option{-O} and higher.
6238 @item -fdse
6239 @opindex fdse
6240 Perform dead store elimination (DSE) on RTL@.
6241 Enabled by default at @option{-O} and higher.
6243 @item -fif-conversion
6244 @opindex fif-conversion
6245 Attempt to transform conditional jumps into branch-less equivalents.  This
6246 include use of conditional moves, min, max, set flags and abs instructions, and
6247 some tricks doable by standard arithmetics.  The use of conditional execution
6248 on chips where it is available is controlled by @code{if-conversion2}.
6250 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6252 @item -fif-conversion2
6253 @opindex fif-conversion2
6254 Use conditional execution (where available) to transform conditional jumps into
6255 branch-less equivalents.
6257 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6259 @item -fdelete-null-pointer-checks
6260 @opindex fdelete-null-pointer-checks
6261 Assume that programs cannot safely dereference null pointers, and that
6262 no code or data element resides there.  This enables simple constant
6263 folding optimizations at all optimization levels.  In addition, other
6264 optimization passes in GCC use this flag to control global dataflow
6265 analyses that eliminate useless checks for null pointers; these assume
6266 that if a pointer is checked after it has already been dereferenced,
6267 it cannot be null.
6269 Note however that in some environments this assumption is not true.
6270 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6271 for programs which depend on that behavior.
6273 Some targets, especially embedded ones, disable this option at all levels.
6274 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6275 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6276 are enabled independently at different optimization levels.
6278 @item -fexpensive-optimizations
6279 @opindex fexpensive-optimizations
6280 Perform a number of minor optimizations that are relatively expensive.
6282 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6284 @item -foptimize-register-move
6285 @itemx -fregmove
6286 @opindex foptimize-register-move
6287 @opindex fregmove
6288 Attempt to reassign register numbers in move instructions and as
6289 operands of other simple instructions in order to maximize the amount of
6290 register tying.  This is especially helpful on machines with two-operand
6291 instructions.
6293 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6294 optimization.
6296 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6298 @item -fira-algorithm=@var{algorithm}
6299 Use specified coloring algorithm for the integrated register
6300 allocator.  The @var{algorithm} argument should be @code{priority} or
6301 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6302 the second one specifies Chaitin-Briggs coloring.  The second
6303 algorithm can be unimplemented for some architectures.  If it is
6304 implemented, it is the default because Chaitin-Briggs coloring as a
6305 rule generates a better code.
6307 @item -fira-region=@var{region}
6308 Use specified regions for the integrated register allocator.  The
6309 @var{region} argument should be one of @code{all}, @code{mixed}, or
6310 @code{one}.  The first value means using all loops as register
6311 allocation regions, the second value which is the default means using
6312 all loops except for loops with small register pressure as the
6313 regions, and third one means using all function as a single region.
6314 The first value can give best result for machines with small size and
6315 irregular register set, the third one results in faster and generates
6316 decent code and the smallest size code, and the default value usually
6317 give the best results in most cases and for most architectures.
6319 @item -fira-coalesce
6320 @opindex fira-coalesce
6321 Do optimistic register coalescing.  This option might be profitable for
6322 architectures with big regular register files.
6324 @item -fira-loop-pressure
6325 @opindex fira-loop-pressure
6326 Use IRA to evaluate register pressure in loops for decision to move
6327 loop invariants.  Usage of this option usually results in generation
6328 of faster and smaller code on machines with big register files (>= 32
6329 registers) but it can slow compiler down.
6331 This option is enabled at level @option{-O3} for some targets.
6333 @item -fno-ira-share-save-slots
6334 @opindex fno-ira-share-save-slots
6335 Switch off sharing stack slots used for saving call used hard
6336 registers living through a call.  Each hard register will get a
6337 separate stack slot and as a result function stack frame will be
6338 bigger.
6340 @item -fno-ira-share-spill-slots
6341 @opindex fno-ira-share-spill-slots
6342 Switch off sharing stack slots allocated for pseudo-registers.  Each
6343 pseudo-register which did not get a hard register will get a separate
6344 stack slot and as a result function stack frame will be bigger.
6346 @item -fira-verbose=@var{n}
6347 @opindex fira-verbose
6348 Set up how verbose dump file for the integrated register allocator
6349 will be.  Default value is 5.  If the value is greater or equal to 10,
6350 the dump file will be stderr as if the value were @var{n} minus 10.
6352 @item -fdelayed-branch
6353 @opindex fdelayed-branch
6354 If supported for the target machine, attempt to reorder instructions
6355 to exploit instruction slots available after delayed branch
6356 instructions.
6358 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6360 @item -fschedule-insns
6361 @opindex fschedule-insns
6362 If supported for the target machine, attempt to reorder instructions to
6363 eliminate execution stalls due to required data being unavailable.  This
6364 helps machines that have slow floating point or memory load instructions
6365 by allowing other instructions to be issued until the result of the load
6366 or floating point instruction is required.
6368 Enabled at levels @option{-O2}, @option{-O3}.
6370 @item -fschedule-insns2
6371 @opindex fschedule-insns2
6372 Similar to @option{-fschedule-insns}, but requests an additional pass of
6373 instruction scheduling after register allocation has been done.  This is
6374 especially useful on machines with a relatively small number of
6375 registers and where memory load instructions take more than one cycle.
6377 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6379 @item -fno-sched-interblock
6380 @opindex fno-sched-interblock
6381 Don't schedule instructions across basic blocks.  This is normally
6382 enabled by default when scheduling before register allocation, i.e.@:
6383 with @option{-fschedule-insns} or at @option{-O2} or higher.
6385 @item -fno-sched-spec
6386 @opindex fno-sched-spec
6387 Don't allow speculative motion of non-load instructions.  This is normally
6388 enabled by default when scheduling before register allocation, i.e.@:
6389 with @option{-fschedule-insns} or at @option{-O2} or higher.
6391 @item -fsched-pressure
6392 @opindex fsched-pressure
6393 Enable register pressure sensitive insn scheduling before the register
6394 allocation.  This only makes sense when scheduling before register
6395 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6396 @option{-O2} or higher.  Usage of this option can improve the
6397 generated code and decrease its size by preventing register pressure
6398 increase above the number of available hard registers and as a
6399 consequence register spills in the register allocation.
6401 @item -fsched-spec-load
6402 @opindex fsched-spec-load
6403 Allow speculative motion of some load instructions.  This only makes
6404 sense when scheduling before register allocation, i.e.@: with
6405 @option{-fschedule-insns} or at @option{-O2} or higher.
6407 @item -fsched-spec-load-dangerous
6408 @opindex fsched-spec-load-dangerous
6409 Allow speculative motion of more load instructions.  This only makes
6410 sense when scheduling before register allocation, i.e.@: with
6411 @option{-fschedule-insns} or at @option{-O2} or higher.
6413 @item -fsched-stalled-insns
6414 @itemx -fsched-stalled-insns=@var{n}
6415 @opindex fsched-stalled-insns
6416 Define how many insns (if any) can be moved prematurely from the queue
6417 of stalled insns into the ready list, during the second scheduling pass.
6418 @option{-fno-sched-stalled-insns} means that no insns will be moved
6419 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6420 on how many queued insns can be moved prematurely.
6421 @option{-fsched-stalled-insns} without a value is equivalent to
6422 @option{-fsched-stalled-insns=1}.
6424 @item -fsched-stalled-insns-dep
6425 @itemx -fsched-stalled-insns-dep=@var{n}
6426 @opindex fsched-stalled-insns-dep
6427 Define how many insn groups (cycles) will be examined for a dependency
6428 on a stalled insn that is candidate for premature removal from the queue
6429 of stalled insns.  This has an effect only during the second scheduling pass,
6430 and only if @option{-fsched-stalled-insns} is used.
6431 @option{-fno-sched-stalled-insns-dep} is equivalent to
6432 @option{-fsched-stalled-insns-dep=0}.
6433 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6434 @option{-fsched-stalled-insns-dep=1}.
6436 @item -fsched2-use-superblocks
6437 @opindex fsched2-use-superblocks
6438 When scheduling after register allocation, do use superblock scheduling
6439 algorithm.  Superblock scheduling allows motion across basic block boundaries
6440 resulting on faster schedules.  This option is experimental, as not all machine
6441 descriptions used by GCC model the CPU closely enough to avoid unreliable
6442 results from the algorithm.
6444 This only makes sense when scheduling after register allocation, i.e.@: with
6445 @option{-fschedule-insns2} or at @option{-O2} or higher.
6447 @item -fsched-group-heuristic
6448 @opindex fsched-group-heuristic
6449 Enable the group heuristic in the scheduler.  This heuristic favors 
6450 the instruction that belongs to a schedule group.  This is enabled 
6451 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6452 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6454 @item -fsched-critical-path-heuristic
6455 @opindex fsched-critical-path-heuristic
6456 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6457 instructions on the critical path.  This is enabled by default when 
6458 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6459 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6461 @item -fsched-spec-insn-heuristic
6462 @opindex fsched-spec-insn-heuristic
6463 Enable the speculative instruction heuristic in the scheduler.  This 
6464 heuristic favors speculative instructions with greater dependency weakness.  
6465 This is enabled by default when scheduling is enabled, i.e.@: 
6466 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6467 or at @option{-O2} or higher.
6469 @item -fsched-rank-heuristic
6470 @opindex fsched-rank-heuristic
6471 Enable the rank heuristic in the scheduler.  This heuristic favors 
6472 the instruction belonging to a basic block with greater size or frequency.  
6473 This is enabled by default when scheduling is enabled, i.e.@: 
6474 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6475 at @option{-O2} or higher.
6477 @item -fsched-last-insn-heuristic
6478 @opindex fsched-last-insn-heuristic
6479 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6480 favors the instruction that is less dependent on the last instruction
6481 scheduled.  This is enabled by default when scheduling is enabled, 
6482 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6483 at @option{-O2} or higher.
6485 @item -fsched-dep-count-heuristic
6486 @opindex fsched-dep-count-heuristic
6487 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6488 favors the instruction that has more instructions depending on it.  
6489 This is enabled by default when scheduling is enabled, i.e.@: 
6490 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6491 at @option{-O2} or higher.
6493 @item -freschedule-modulo-scheduled-loops
6494 @opindex freschedule-modulo-scheduled-loops
6495 The modulo scheduling comes before the traditional scheduling, if a loop
6496 was modulo scheduled we may want to prevent the later scheduling passes
6497 from changing its schedule, we use this option to control that.
6499 @item -fselective-scheduling
6500 @opindex fselective-scheduling
6501 Schedule instructions using selective scheduling algorithm.  Selective
6502 scheduling runs instead of the first scheduler pass.
6504 @item -fselective-scheduling2
6505 @opindex fselective-scheduling2
6506 Schedule instructions using selective scheduling algorithm.  Selective
6507 scheduling runs instead of the second scheduler pass.
6509 @item -fsel-sched-pipelining
6510 @opindex fsel-sched-pipelining
6511 Enable software pipelining of innermost loops during selective scheduling.
6512 This option has no effect until one of @option{-fselective-scheduling} or
6513 @option{-fselective-scheduling2} is turned on.
6515 @item -fsel-sched-pipelining-outer-loops
6516 @opindex fsel-sched-pipelining-outer-loops
6517 When pipelining loops during selective scheduling, also pipeline outer loops.
6518 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6520 @item -fcaller-saves
6521 @opindex fcaller-saves
6522 Enable values to be allocated in registers that will be clobbered by
6523 function calls, by emitting extra instructions to save and restore the
6524 registers around such calls.  Such allocation is done only when it
6525 seems to result in better code than would otherwise be produced.
6527 This option is always enabled by default on certain machines, usually
6528 those which have no call-preserved registers to use instead.
6530 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6532 @item -fconserve-stack
6533 @opindex fconserve-stack
6534 Attempt to minimize stack usage.  The compiler will attempt to use less
6535 stack space, even if that makes the program slower.  This option
6536 implies setting the @option{large-stack-frame} parameter to 100
6537 and the @option{large-stack-frame-growth} parameter to 400.
6539 @item -ftree-reassoc
6540 @opindex ftree-reassoc
6541 Perform reassociation on trees.  This flag is enabled by default
6542 at @option{-O} and higher.
6544 @item -ftree-pre
6545 @opindex ftree-pre
6546 Perform partial redundancy elimination (PRE) on trees.  This flag is
6547 enabled by default at @option{-O2} and @option{-O3}.
6549 @item -ftree-forwprop
6550 @opindex ftree-forwprop
6551 Perform forward propagation on trees.  This flag is enabled by default
6552 at @option{-O} and higher.
6554 @item -ftree-fre
6555 @opindex ftree-fre
6556 Perform full redundancy elimination (FRE) on trees.  The difference
6557 between FRE and PRE is that FRE only considers expressions
6558 that are computed on all paths leading to the redundant computation.
6559 This analysis is faster than PRE, though it exposes fewer redundancies.
6560 This flag is enabled by default at @option{-O} and higher.
6562 @item -ftree-phiprop
6563 @opindex ftree-phiprop
6564 Perform hoisting of loads from conditional pointers on trees.  This
6565 pass is enabled by default at @option{-O} and higher.
6567 @item -ftree-copy-prop
6568 @opindex ftree-copy-prop
6569 Perform copy propagation on trees.  This pass eliminates unnecessary
6570 copy operations.  This flag is enabled by default at @option{-O} and
6571 higher.
6573 @item -fipa-pure-const
6574 @opindex fipa-pure-const
6575 Discover which functions are pure or constant.
6576 Enabled by default at @option{-O} and higher.
6578 @item -fipa-reference
6579 @opindex fipa-reference
6580 Discover which static variables do not escape cannot escape the
6581 compilation unit.
6582 Enabled by default at @option{-O} and higher.
6584 @item -fipa-struct-reorg
6585 @opindex fipa-struct-reorg
6586 Perform structure reorganization optimization, that change C-like structures
6587 layout in order to better utilize spatial locality.  This transformation is
6588 affective for programs containing arrays of structures.  Available in two
6589 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6590 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
6591 to provide the safety of this transformation.  It works only in whole program
6592 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6593 enabled.  Structures considered @samp{cold} by this transformation are not
6594 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6596 With this flag, the program debug info reflects a new structure layout.
6598 @item -fipa-pta
6599 @opindex fipa-pta
6600 Perform interprocedural pointer analysis and interprocedural modification
6601 and reference analysis.  This option can cause excessive memory and
6602 compile-time usage on large compilation units.  It is not enabled by
6603 default at any optimization level.
6605 @item -fipa-cp
6606 @opindex fipa-cp
6607 Perform interprocedural constant propagation.
6608 This optimization analyzes the program to determine when values passed
6609 to functions are constants and then optimizes accordingly.
6610 This optimization can substantially increase performance
6611 if the application has constants passed to functions.
6612 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6614 @item -fipa-cp-clone
6615 @opindex fipa-cp-clone
6616 Perform function cloning to make interprocedural constant propagation stronger.
6617 When enabled, interprocedural constant propagation will perform function cloning
6618 when externally visible function can be called with constant arguments.
6619 Because this optimization can create multiple copies of functions,
6620 it may significantly increase code size
6621 (see @option{--param ipcp-unit-growth=@var{value}}).
6622 This flag is enabled by default at @option{-O3}.
6624 @item -fipa-matrix-reorg
6625 @opindex fipa-matrix-reorg
6626 Perform matrix flattening and transposing.
6627 Matrix flattening tries to replace an @math{m}-dimensional matrix
6628 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6629 This reduces the level of indirection needed for accessing the elements
6630 of the matrix. The second optimization is matrix transposing that
6631 attempts to change the order of the matrix's dimensions in order to
6632 improve cache locality.
6633 Both optimizations need the @option{-fwhole-program} flag.
6634 Transposing is enabled only if profiling information is available.
6636 @item -ftree-sink
6637 @opindex ftree-sink
6638 Perform forward store motion  on trees.  This flag is
6639 enabled by default at @option{-O} and higher.
6641 @item -ftree-ccp
6642 @opindex ftree-ccp
6643 Perform sparse conditional constant propagation (CCP) on trees.  This
6644 pass only operates on local scalar variables and is enabled by default
6645 at @option{-O} and higher.
6647 @item -ftree-switch-conversion
6648 Perform conversion of simple initializations in a switch to
6649 initializations from a scalar array.  This flag is enabled by default
6650 at @option{-O2} and higher.
6652 @item -ftree-dce
6653 @opindex ftree-dce
6654 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6655 default at @option{-O} and higher.
6657 @item -ftree-builtin-call-dce
6658 @opindex ftree-builtin-call-dce
6659 Perform conditional dead code elimination (DCE) for calls to builtin functions
6660 that may set @code{errno} but are otherwise side-effect free.  This flag is
6661 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6662 specified.
6664 @item -ftree-dominator-opts
6665 @opindex ftree-dominator-opts
6666 Perform a variety of simple scalar cleanups (constant/copy
6667 propagation, redundancy elimination, range propagation and expression
6668 simplification) based on a dominator tree traversal.  This also
6669 performs jump threading (to reduce jumps to jumps). This flag is
6670 enabled by default at @option{-O} and higher.
6672 @item -ftree-dse
6673 @opindex ftree-dse
6674 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6675 a memory location which will later be overwritten by another store without
6676 any intervening loads.  In this case the earlier store can be deleted.  This
6677 flag is enabled by default at @option{-O} and higher.
6679 @item -ftree-ch
6680 @opindex ftree-ch
6681 Perform loop header copying on trees.  This is beneficial since it increases
6682 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6683 is enabled by default at @option{-O} and higher.  It is not enabled
6684 for @option{-Os}, since it usually increases code size.
6686 @item -ftree-loop-optimize
6687 @opindex ftree-loop-optimize
6688 Perform loop optimizations on trees.  This flag is enabled by default
6689 at @option{-O} and higher.
6691 @item -ftree-loop-linear
6692 @opindex ftree-loop-linear
6693 Perform linear loop transformations on tree.  This flag can improve cache
6694 performance and allow further loop optimizations to take place.
6696 @item -floop-interchange
6697 Perform loop interchange transformations on loops.  Interchanging two
6698 nested loops switches the inner and outer loops.  For example, given a
6699 loop like:
6700 @smallexample
6701 DO J = 1, M
6702   DO I = 1, N
6703     A(J, I) = A(J, I) * C
6704   ENDDO
6705 ENDDO
6706 @end smallexample
6707 loop interchange will transform the loop as if the user had written:
6708 @smallexample
6709 DO I = 1, N
6710   DO J = 1, M
6711     A(J, I) = A(J, I) * C
6712   ENDDO
6713 ENDDO
6714 @end smallexample
6715 which can be beneficial when @code{N} is larger than the caches,
6716 because in Fortran, the elements of an array are stored in memory
6717 contiguously by column, and the original loop iterates over rows,
6718 potentially creating at each access a cache miss.  This optimization
6719 applies to all the languages supported by GCC and is not limited to
6720 Fortran.  To use this code transformation, GCC has to be configured
6721 with @option{--with-ppl} and @option{--with-cloog} to enable the
6722 Graphite loop transformation infrastructure.
6724 @item -floop-strip-mine
6725 Perform loop strip mining transformations on loops.  Strip mining
6726 splits a loop into two nested loops.  The outer loop has strides
6727 equal to the strip size and the inner loop has strides of the
6728 original loop within a strip.  The strip length can be changed
6729 using the @option{loop-block-tile-size} parameter.  For example,
6730 given a loop like:
6731 @smallexample
6732 DO I = 1, N
6733   A(I) = A(I) + C
6734 ENDDO
6735 @end smallexample
6736 loop strip mining will transform the loop as if the user had written:
6737 @smallexample
6738 DO II = 1, N, 51
6739   DO I = II, min (II + 50, N)
6740     A(I) = A(I) + C
6741   ENDDO
6742 ENDDO
6743 @end smallexample
6744 This optimization applies to all the languages supported by GCC and is
6745 not limited to Fortran.  To use this code transformation, GCC has to
6746 be configured with @option{--with-ppl} and @option{--with-cloog} to
6747 enable the Graphite loop transformation infrastructure.
6749 @item -floop-block
6750 Perform loop blocking transformations on loops.  Blocking strip mines
6751 each loop in the loop nest such that the memory accesses of the
6752 element loops fit inside caches.  The strip length can be changed
6753 using the @option{loop-block-tile-size} parameter.  For example, given
6754 a loop like:
6755 @smallexample
6756 DO I = 1, N
6757   DO J = 1, M
6758     A(J, I) = B(I) + C(J)
6759   ENDDO
6760 ENDDO
6761 @end smallexample
6762 loop blocking will transform the loop as if the user had written:
6763 @smallexample
6764 DO II = 1, N, 51
6765   DO JJ = 1, M, 51
6766     DO I = II, min (II + 50, N)
6767       DO J = JJ, min (JJ + 50, M)
6768         A(J, I) = B(I) + C(J)
6769       ENDDO
6770     ENDDO
6771   ENDDO
6772 ENDDO
6773 @end smallexample
6774 which can be beneficial when @code{M} is larger than the caches,
6775 because the innermost loop will iterate over a smaller amount of data
6776 that can be kept in the caches.  This optimization applies to all the
6777 languages supported by GCC and is not limited to Fortran.  To use this
6778 code transformation, GCC has to be configured with @option{--with-ppl}
6779 and @option{--with-cloog} to enable the Graphite loop transformation
6780 infrastructure.
6782 @item -fgraphite-identity
6783 @opindex fgraphite-identity
6784 Enable the identity transformation for graphite.  For every SCoP we generate
6785 the polyhedral representation and transform it back to gimple.  Using
6786 @option{-fgraphite-identity} we can check the costs or benefits of the
6787 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
6788 are also performed by the code generator CLooG, like index splitting and
6789 dead code elimination in loops.
6791 @item -floop-parallelize-all
6792 Use the Graphite data dependence analysis to identify loops that can
6793 be parallelized.  Parallelize all the loops that can be analyzed to
6794 not contain loop carried dependences without checking that it is
6795 profitable to parallelize the loops.
6797 @item -fcheck-data-deps
6798 @opindex fcheck-data-deps
6799 Compare the results of several data dependence analyzers.  This option
6800 is used for debugging the data dependence analyzers.
6802 @item -ftree-loop-distribution
6803 Perform loop distribution.  This flag can improve cache performance on
6804 big loop bodies and allow further loop optimizations, like
6805 parallelization or vectorization, to take place.  For example, the loop
6806 @smallexample
6807 DO I = 1, N
6808   A(I) = B(I) + C
6809   D(I) = E(I) * F
6810 ENDDO
6811 @end smallexample
6812 is transformed to
6813 @smallexample
6814 DO I = 1, N
6815    A(I) = B(I) + C
6816 ENDDO
6817 DO I = 1, N
6818    D(I) = E(I) * F
6819 ENDDO
6820 @end smallexample
6822 @item -ftree-loop-im
6823 @opindex ftree-loop-im
6824 Perform loop invariant motion on trees.  This pass moves only invariants that
6825 would be hard to handle at RTL level (function calls, operations that expand to
6826 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6827 operands of conditions that are invariant out of the loop, so that we can use
6828 just trivial invariantness analysis in loop unswitching.  The pass also includes
6829 store motion.
6831 @item -ftree-loop-ivcanon
6832 @opindex ftree-loop-ivcanon
6833 Create a canonical counter for number of iterations in the loop for that
6834 determining number of iterations requires complicated analysis.  Later
6835 optimizations then may determine the number easily.  Useful especially
6836 in connection with unrolling.
6838 @item -fivopts
6839 @opindex fivopts
6840 Perform induction variable optimizations (strength reduction, induction
6841 variable merging and induction variable elimination) on trees.
6843 @item -ftree-parallelize-loops=n
6844 @opindex ftree-parallelize-loops
6845 Parallelize loops, i.e., split their iteration space to run in n threads.
6846 This is only possible for loops whose iterations are independent
6847 and can be arbitrarily reordered.  The optimization is only
6848 profitable on multiprocessor machines, for loops that are CPU-intensive,
6849 rather than constrained e.g.@: by memory bandwidth.  This option
6850 implies @option{-pthread}, and thus is only supported on targets
6851 that have support for @option{-pthread}.
6853 @item -ftree-pta
6854 @opindex ftree-pta
6855 Perform function-local points-to analysis on trees.  This flag is
6856 enabled by default at @option{-O} and higher.
6858 @item -ftree-sra
6859 @opindex ftree-sra
6860 Perform scalar replacement of aggregates.  This pass replaces structure
6861 references with scalars to prevent committing structures to memory too
6862 early.  This flag is enabled by default at @option{-O} and higher.
6864 @item -ftree-copyrename
6865 @opindex ftree-copyrename
6866 Perform copy renaming on trees.  This pass attempts to rename compiler
6867 temporaries to other variables at copy locations, usually resulting in
6868 variable names which more closely resemble the original variables.  This flag
6869 is enabled by default at @option{-O} and higher.
6871 @item -ftree-ter
6872 @opindex ftree-ter
6873 Perform temporary expression replacement during the SSA->normal phase.  Single
6874 use/single def temporaries are replaced at their use location with their
6875 defining expression.  This results in non-GIMPLE code, but gives the expanders
6876 much more complex trees to work on resulting in better RTL generation.  This is
6877 enabled by default at @option{-O} and higher.
6879 @item -ftree-vectorize
6880 @opindex ftree-vectorize
6881 Perform loop vectorization on trees. This flag is enabled by default at
6882 @option{-O3}.
6884 @item -ftree-slp-vectorize
6885 @opindex ftree-slp-vectorize
6886 Perform basic block vectorization on trees. This flag is enabled by default at
6887 @option{-O3} and when @option{-ftree-vectorize} is enabled.
6889 @item -ftree-vect-loop-version
6890 @opindex ftree-vect-loop-version
6891 Perform loop versioning when doing loop vectorization on trees.  When a loop
6892 appears to be vectorizable except that data alignment or data dependence cannot
6893 be determined at compile time then vectorized and non-vectorized versions of
6894 the loop are generated along with runtime checks for alignment or dependence
6895 to control which version is executed.  This option is enabled by default
6896 except at level @option{-Os} where it is disabled.
6898 @item -fvect-cost-model
6899 @opindex fvect-cost-model
6900 Enable cost model for vectorization.
6902 @item -ftree-vrp
6903 @opindex ftree-vrp
6904 Perform Value Range Propagation on trees.  This is similar to the
6905 constant propagation pass, but instead of values, ranges of values are
6906 propagated.  This allows the optimizers to remove unnecessary range
6907 checks like array bound checks and null pointer checks.  This is
6908 enabled by default at @option{-O2} and higher.  Null pointer check
6909 elimination is only done if @option{-fdelete-null-pointer-checks} is
6910 enabled.
6912 @item -ftracer
6913 @opindex ftracer
6914 Perform tail duplication to enlarge superblock size.  This transformation
6915 simplifies the control flow of the function allowing other optimizations to do
6916 better job.
6918 @item -funroll-loops
6919 @opindex funroll-loops
6920 Unroll loops whose number of iterations can be determined at compile
6921 time or upon entry to the loop.  @option{-funroll-loops} implies
6922 @option{-frerun-cse-after-loop}.  This option makes code larger,
6923 and may or may not make it run faster.
6925 @item -funroll-all-loops
6926 @opindex funroll-all-loops
6927 Unroll all loops, even if their number of iterations is uncertain when
6928 the loop is entered.  This usually makes programs run more slowly.
6929 @option{-funroll-all-loops} implies the same options as
6930 @option{-funroll-loops},
6932 @item -fsplit-ivs-in-unroller
6933 @opindex fsplit-ivs-in-unroller
6934 Enables expressing of values of induction variables in later iterations
6935 of the unrolled loop using the value in the first iteration.  This breaks
6936 long dependency chains, thus improving efficiency of the scheduling passes.
6938 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6939 same effect.  However in cases the loop body is more complicated than
6940 a single basic block, this is not reliable.  It also does not work at all
6941 on some of the architectures due to restrictions in the CSE pass.
6943 This optimization is enabled by default.
6945 @item -fvariable-expansion-in-unroller
6946 @opindex fvariable-expansion-in-unroller
6947 With this option, the compiler will create multiple copies of some
6948 local variables when unrolling a loop which can result in superior code.
6950 @item -fpredictive-commoning
6951 @opindex fpredictive-commoning
6952 Perform predictive commoning optimization, i.e., reusing computations
6953 (especially memory loads and stores) performed in previous
6954 iterations of loops.
6956 This option is enabled at level @option{-O3}.
6958 @item -fprefetch-loop-arrays
6959 @opindex fprefetch-loop-arrays
6960 If supported by the target machine, generate instructions to prefetch
6961 memory to improve the performance of loops that access large arrays.
6963 This option may generate better or worse code; results are highly
6964 dependent on the structure of loops within the source code.
6966 Disabled at level @option{-Os}.
6968 @item -fno-peephole
6969 @itemx -fno-peephole2
6970 @opindex fno-peephole
6971 @opindex fno-peephole2
6972 Disable any machine-specific peephole optimizations.  The difference
6973 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6974 are implemented in the compiler; some targets use one, some use the
6975 other, a few use both.
6977 @option{-fpeephole} is enabled by default.
6978 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6980 @item -fno-guess-branch-probability
6981 @opindex fno-guess-branch-probability
6982 Do not guess branch probabilities using heuristics.
6984 GCC will use heuristics to guess branch probabilities if they are
6985 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6986 heuristics are based on the control flow graph.  If some branch probabilities
6987 are specified by @samp{__builtin_expect}, then the heuristics will be
6988 used to guess branch probabilities for the rest of the control flow graph,
6989 taking the @samp{__builtin_expect} info into account.  The interactions
6990 between the heuristics and @samp{__builtin_expect} can be complex, and in
6991 some cases, it may be useful to disable the heuristics so that the effects
6992 of @samp{__builtin_expect} are easier to understand.
6994 The default is @option{-fguess-branch-probability} at levels
6995 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6997 @item -freorder-blocks
6998 @opindex freorder-blocks
6999 Reorder basic blocks in the compiled function in order to reduce number of
7000 taken branches and improve code locality.
7002 Enabled at levels @option{-O2}, @option{-O3}.
7004 @item -freorder-blocks-and-partition
7005 @opindex freorder-blocks-and-partition
7006 In addition to reordering basic blocks in the compiled function, in order
7007 to reduce number of taken branches, partitions hot and cold basic blocks
7008 into separate sections of the assembly and .o files, to improve
7009 paging and cache locality performance.
7011 This optimization is automatically turned off in the presence of
7012 exception handling, for linkonce sections, for functions with a user-defined
7013 section attribute and on any architecture that does not support named
7014 sections.
7016 @item -freorder-functions
7017 @opindex freorder-functions
7018 Reorder functions in the object file in order to
7019 improve code locality.  This is implemented by using special
7020 subsections @code{.text.hot} for most frequently executed functions and
7021 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7022 the linker so object file format must support named sections and linker must
7023 place them in a reasonable way.
7025 Also profile feedback must be available in to make this option effective.  See
7026 @option{-fprofile-arcs} for details.
7028 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7030 @item -fstrict-aliasing
7031 @opindex fstrict-aliasing
7032 Allow the compiler to assume the strictest aliasing rules applicable to
7033 the language being compiled.  For C (and C++), this activates
7034 optimizations based on the type of expressions.  In particular, an
7035 object of one type is assumed never to reside at the same address as an
7036 object of a different type, unless the types are almost the same.  For
7037 example, an @code{unsigned int} can alias an @code{int}, but not a
7038 @code{void*} or a @code{double}.  A character type may alias any other
7039 type.
7041 @anchor{Type-punning}Pay special attention to code like this:
7042 @smallexample
7043 union a_union @{
7044   int i;
7045   double d;
7048 int f() @{
7049   union a_union t;
7050   t.d = 3.0;
7051   return t.i;
7053 @end smallexample
7054 The practice of reading from a different union member than the one most
7055 recently written to (called ``type-punning'') is common.  Even with
7056 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7057 is accessed through the union type.  So, the code above will work as
7058 expected.  @xref{Structures unions enumerations and bit-fields
7059 implementation}.  However, this code might not:
7060 @smallexample
7061 int f() @{
7062   union a_union t;
7063   int* ip;
7064   t.d = 3.0;
7065   ip = &t.i;
7066   return *ip;
7068 @end smallexample
7070 Similarly, access by taking the address, casting the resulting pointer
7071 and dereferencing the result has undefined behavior, even if the cast
7072 uses a union type, e.g.:
7073 @smallexample
7074 int f() @{
7075   double d = 3.0;
7076   return ((union a_union *) &d)->i;
7078 @end smallexample
7080 The @option{-fstrict-aliasing} option is enabled at levels
7081 @option{-O2}, @option{-O3}, @option{-Os}.
7083 @item -fstrict-overflow
7084 @opindex fstrict-overflow
7085 Allow the compiler to assume strict signed overflow rules, depending
7086 on the language being compiled.  For C (and C++) this means that
7087 overflow when doing arithmetic with signed numbers is undefined, which
7088 means that the compiler may assume that it will not happen.  This
7089 permits various optimizations.  For example, the compiler will assume
7090 that an expression like @code{i + 10 > i} will always be true for
7091 signed @code{i}.  This assumption is only valid if signed overflow is
7092 undefined, as the expression is false if @code{i + 10} overflows when
7093 using twos complement arithmetic.  When this option is in effect any
7094 attempt to determine whether an operation on signed numbers will
7095 overflow must be written carefully to not actually involve overflow.
7097 This option also allows the compiler to assume strict pointer
7098 semantics: given a pointer to an object, if adding an offset to that
7099 pointer does not produce a pointer to the same object, the addition is
7100 undefined.  This permits the compiler to conclude that @code{p + u >
7101 p} is always true for a pointer @code{p} and unsigned integer
7102 @code{u}.  This assumption is only valid because pointer wraparound is
7103 undefined, as the expression is false if @code{p + u} overflows using
7104 twos complement arithmetic.
7106 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7107 that integer signed overflow is fully defined: it wraps.  When
7108 @option{-fwrapv} is used, there is no difference between
7109 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7110 integers.  With @option{-fwrapv} certain types of overflow are
7111 permitted.  For example, if the compiler gets an overflow when doing
7112 arithmetic on constants, the overflowed value can still be used with
7113 @option{-fwrapv}, but not otherwise.
7115 The @option{-fstrict-overflow} option is enabled at levels
7116 @option{-O2}, @option{-O3}, @option{-Os}.
7118 @item -falign-functions
7119 @itemx -falign-functions=@var{n}
7120 @opindex falign-functions
7121 Align the start of functions to the next power-of-two greater than
7122 @var{n}, skipping up to @var{n} bytes.  For instance,
7123 @option{-falign-functions=32} aligns functions to the next 32-byte
7124 boundary, but @option{-falign-functions=24} would align to the next
7125 32-byte boundary only if this can be done by skipping 23 bytes or less.
7127 @option{-fno-align-functions} and @option{-falign-functions=1} are
7128 equivalent and mean that functions will not be aligned.
7130 Some assemblers only support this flag when @var{n} is a power of two;
7131 in that case, it is rounded up.
7133 If @var{n} is not specified or is zero, use a machine-dependent default.
7135 Enabled at levels @option{-O2}, @option{-O3}.
7137 @item -falign-labels
7138 @itemx -falign-labels=@var{n}
7139 @opindex falign-labels
7140 Align all branch targets to a power-of-two boundary, skipping up to
7141 @var{n} bytes like @option{-falign-functions}.  This option can easily
7142 make code slower, because it must insert dummy operations for when the
7143 branch target is reached in the usual flow of the code.
7145 @option{-fno-align-labels} and @option{-falign-labels=1} are
7146 equivalent and mean that labels will not be aligned.
7148 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7149 are greater than this value, then their values are used instead.
7151 If @var{n} is not specified or is zero, use a machine-dependent default
7152 which is very likely to be @samp{1}, meaning no alignment.
7154 Enabled at levels @option{-O2}, @option{-O3}.
7156 @item -falign-loops
7157 @itemx -falign-loops=@var{n}
7158 @opindex falign-loops
7159 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7160 like @option{-falign-functions}.  The hope is that the loop will be
7161 executed many times, which will make up for any execution of the dummy
7162 operations.
7164 @option{-fno-align-loops} and @option{-falign-loops=1} are
7165 equivalent and mean that loops will not be aligned.
7167 If @var{n} is not specified or is zero, use a machine-dependent default.
7169 Enabled at levels @option{-O2}, @option{-O3}.
7171 @item -falign-jumps
7172 @itemx -falign-jumps=@var{n}
7173 @opindex falign-jumps
7174 Align branch targets to a power-of-two boundary, for branch targets
7175 where the targets can only be reached by jumping, skipping up to @var{n}
7176 bytes like @option{-falign-functions}.  In this case, no dummy operations
7177 need be executed.
7179 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7180 equivalent and mean that loops will not be aligned.
7182 If @var{n} is not specified or is zero, use a machine-dependent default.
7184 Enabled at levels @option{-O2}, @option{-O3}.
7186 @item -funit-at-a-time
7187 @opindex funit-at-a-time
7188 This option is left for compatibility reasons. @option{-funit-at-a-time}
7189 has no effect, while @option{-fno-unit-at-a-time} implies
7190 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7192 Enabled by default.
7194 @item -fno-toplevel-reorder
7195 @opindex fno-toplevel-reorder
7196 Do not reorder top-level functions, variables, and @code{asm}
7197 statements.  Output them in the same order that they appear in the
7198 input file.  When this option is used, unreferenced static variables
7199 will not be removed.  This option is intended to support existing code
7200 which relies on a particular ordering.  For new code, it is better to
7201 use attributes.
7203 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7204 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7205 targets.
7207 @item -fweb
7208 @opindex fweb
7209 Constructs webs as commonly used for register allocation purposes and assign
7210 each web individual pseudo register.  This allows the register allocation pass
7211 to operate on pseudos directly, but also strengthens several other optimization
7212 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7213 however, make debugging impossible, since variables will no longer stay in a
7214 ``home register''.
7216 Enabled by default with @option{-funroll-loops}.
7218 @item -fwhole-program
7219 @opindex fwhole-program
7220 Assume that the current compilation unit represents the whole program being
7221 compiled.  All public functions and variables with the exception of @code{main}
7222 and those merged by attribute @code{externally_visible} become static functions
7223 and in effect are optimized more aggressively by interprocedural optimizers.
7224 While this option is equivalent to proper use of the @code{static} keyword for
7225 programs consisting of a single file, in combination with option
7226 @option{-combine}, @option{-flto} or @option{-fwhopr} this flag can be used to
7227 compile many smaller scale programs since the functions and variables become
7228 local for the whole combined compilation unit, not for the single source file
7229 itself.
7231 This option implies @option{-fwhole-file} for Fortran programs.
7233 @item -flto
7234 @opindex flto
7235 This option runs the standard link-time optimizer.  When invoked
7236 with source code, it generates GIMPLE (one of GCC's internal
7237 representations) and writes it to special ELF sections in the object
7238 file.  When the object files are linked together, all the function
7239 bodies are read from these ELF sections and instantiated as if they
7240 had been part of the same translation unit.
7242 To use the link-timer optimizer, @option{-flto} needs to be specified at
7243 compile time and during the final link.  For example,
7245 @smallexample
7246 gcc -c -O2 -flto foo.c
7247 gcc -c -O2 -flto bar.c
7248 gcc -o myprog -flto -O2 foo.o bar.o
7249 @end smallexample
7251 The first two invocations to GCC will save a bytecode representation
7252 of GIMPLE into special ELF sections inside @file{foo.o} and
7253 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7254 @file{foo.o} and @file{bar.o}, merge the two files into a single
7255 internal image, and compile the result as usual.  Since both
7256 @file{foo.o} and @file{bar.o} are merged into a single image, this
7257 causes all the inter-procedural analyses and optimizations in GCC to
7258 work across the two files as if they were a single one.  This means,
7259 for example, that the inliner will be able to inline functions in
7260 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7262 Another (simpler) way to enable link-time optimization is,
7264 @smallexample
7265 gcc -o myprog -flto -O2 foo.c bar.c
7266 @end smallexample
7268 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7269 merge them together into a single GIMPLE representation and optimize
7270 them as usual to produce @file{myprog}.
7272 The only important thing to keep in mind is that to enable link-time
7273 optimizations the @option{-flto} flag needs to be passed to both the
7274 compile and the link commands.
7276 Note that when a file is compiled with @option{-flto}, the generated
7277 object file will be larger than a regular object file because it will
7278 contain GIMPLE bytecodes and the usual final code.  This means that
7279 object files with LTO information can be linked as a normal object
7280 file.  So, in the previous example, if the final link is done with
7282 @smallexample
7283 gcc -o myprog foo.o bar.o
7284 @end smallexample
7286 The only difference will be that no inter-procedural optimizations
7287 will be applied to produce @file{myprog}.  The two object files
7288 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7289 linker.
7291 Additionally, the optimization flags used to compile individual files
7292 are not necessarily related to those used at link-time.  For instance,
7294 @smallexample
7295 gcc -c -O0 -flto foo.c
7296 gcc -c -O0 -flto bar.c
7297 gcc -o myprog -flto -O3 foo.o bar.o
7298 @end smallexample
7300 This will produce individual object files with unoptimized assembler
7301 code, but the resulting binary @file{myprog} will be optimized at
7302 @option{-O3}.  Now, if the final binary is generated without
7303 @option{-flto}, then @file{myprog} will not be optimized.
7305 When producing the final binary with @option{-flto}, GCC will only
7306 apply link-time optimizations to those files that contain bytecode.
7307 Therefore, you can mix and match object files and libraries with
7308 GIMPLE bytecodes and final object code.  GCC will automatically select
7309 which files to optimize in LTO mode and which files to link without
7310 further processing.
7312 There are some code generation flags that GCC will preserve when
7313 generating bytecodes, as they need to be used during the final link
7314 stage.  Currently, the following options are saved into the GIMPLE
7315 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7316 @option{-m} target flags.
7318 At link time, these options are read-in and reapplied.  Note that the
7319 current implementation makes no attempt at recognizing conflicting
7320 values for these options.  If two or more files have a conflicting
7321 value (e.g., one file is compiled with @option{-fPIC} and another
7322 isn't), the compiler will simply use the last value read from the
7323 bytecode files.  It is recommended, then, that all the files
7324 participating in the same link be compiled with the same options.
7326 Another feature of LTO is that it is possible to apply interprocedural
7327 optimizations on files written in different languages.  This requires
7328 some support in the language front end.  Currently, the C, C++ and
7329 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7330 something like this should work
7332 @smallexample
7333 gcc -c -flto foo.c
7334 g++ -c -flto bar.cc
7335 gfortran -c -flto baz.f90
7336 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7337 @end smallexample
7339 Notice that the final link is done with @command{g++} to get the C++
7340 runtime libraries and @option{-lgfortran} is added to get the Fortran
7341 runtime libraries.  In general, when mixing languages in LTO mode, you
7342 should use the same link command used when mixing languages in a
7343 regular (non-LTO) compilation.  This means that if your build process
7344 was mixing languages before, all you need to add is @option{-flto} to
7345 all the compile and link commands.
7347 If LTO encounters objects with C linkage declared with incompatible
7348 types in separate translation units to be linked together (undefined
7349 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
7350 issued.  The behavior is still undefined at runtime.
7352 If object files containing GIMPLE bytecode are stored in a library
7353 archive, say @file{libfoo.a}, it is possible to extract and use them
7354 in an LTO link if you are using @command{gold} as the linker (which,
7355 in turn requires GCC to be configured with @option{--enable-gold}).
7356 To enable this feature, use the flag @option{-fuse-linker-plugin} at
7357 link-time:
7359 @smallexample
7360 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7361 @end smallexample
7363 With the linker plugin enabled, @command{gold} will extract the needed
7364 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7365 to make them part of the aggregated GIMPLE image to be optimized.
7367 If you are not using @command{gold} and/or do not specify
7368 @option{-fuse-linker-plugin} then the objects inside @file{libfoo.a}
7369 will be extracted and linked as usual, but they will not participate
7370 in the LTO optimization process.
7372 Link time optimizations do not require the presence of the whole
7373 program to operate.  If the program does not require any symbols to
7374 be exported, it is possible to combine @option{-flto} and
7375 @option{-fwhopr} with @option{-fwhole-program} to allow the
7376 interprocedural optimizers to use more aggressive assumptions which
7377 may lead to improved optimization opportunities.
7379 Regarding portability: the current implementation of LTO makes no
7380 attempt at generating bytecode that can be ported between different
7381 types of hosts.  The bytecode files are versioned and there is a
7382 strict version check, so bytecode files generated in one version of
7383 GCC will not work with an older/newer version of GCC.
7385 Link time optimization does not play well with generating debugging
7386 information.  Combining @option{-flto} or @option{-fwhopr} with
7387 @option{-g} is experimental.
7389 This option is disabled by default.
7391 @item -fwhopr
7392 @opindex fwhopr
7393 This option is identical in functionality to @option{-flto} but it
7394 differs in how the final link stage is executed.  Instead of loading
7395 all the function bodies in memory, the callgraph is analyzed and
7396 optimization decisions are made (whole program analysis or WPA). Once
7397 optimization decisions are made, the callgraph is partitioned and the
7398 different sections are compiled separately (local transformations or
7399 LTRANS)@.  This process allows optimizations on very large programs
7400 that otherwise would not fit in memory.  This option enables
7401 @option{-fwpa} and @option{-fltrans} automatically.
7403 Disabled by default.
7405 This option is experimental.
7407 @item -fwpa
7408 @opindex fwpa
7409 This is an internal option used by GCC when compiling with
7410 @option{-fwhopr}.  You should never need to use it.
7412 This option runs the link-time optimizer in the whole-program-analysis
7413 (WPA) mode, which reads in summary information from all inputs and
7414 performs a whole-program analysis based on summary information only.
7415 It generates object files for subsequent runs of the link-time
7416 optimizer where individual object files are optimized using both
7417 summary information from the WPA mode and the actual function bodies.
7418 It then drives the LTRANS phase.
7420 Disabled by default.
7422 @item -fltrans
7423 @opindex fltrans
7424 This is an internal option used by GCC when compiling with
7425 @option{-fwhopr}.  You should never need to use it.
7427 This option runs the link-time optimizer in the local-transformation (LTRANS)
7428 mode, which reads in output from a previous run of the LTO in WPA mode.
7429 In the LTRANS mode, LTO optimizes an object and produces the final assembly.
7431 Disabled by default.
7433 @item -fltrans-output-list=@var{file}
7434 @opindex fltrans-output-list
7435 This is an internal option used by GCC when compiling with
7436 @option{-fwhopr}.  You should never need to use it.
7438 This option specifies a file to which the names of LTRANS output files are
7439 written.  This option is only meaningful in conjunction with @option{-fwpa}.
7441 Disabled by default.
7443 @item -flto-compression-level=@var{n}
7444 This option specifies the level of compression used for intermediate
7445 language written to LTO object files, and is only meaningful in
7446 conjunction with LTO mode (@option{-fwhopr}, @option{-flto}).  Valid
7447 values are 0 (no compression) to 9 (maximum compression).  Values
7448 outside this range are clamped to either 0 or 9.  If the option is not
7449 given, a default balanced compression setting is used.
7451 @item -flto-report
7452 Prints a report with internal details on the workings of the link-time
7453 optimizer.  The contents of this report vary from version to version,
7454 it is meant to be useful to GCC developers when processing object
7455 files in LTO mode (via @option{-fwhopr} or @option{-flto}).
7457 Disabled by default.
7459 @item -fuse-linker-plugin
7460 Enables the extraction of objects with GIMPLE bytecode information
7461 from library archives.  This option relies on features available only
7462 in @command{gold}, so to use this you must configure GCC with
7463 @option{--enable-gold}.  See @option{-flto} for a description on the
7464 effect of this flag and how to use it.
7466 Disabled by default.
7468 @item -fcprop-registers
7469 @opindex fcprop-registers
7470 After register allocation and post-register allocation instruction splitting,
7471 we perform a copy-propagation pass to try to reduce scheduling dependencies
7472 and occasionally eliminate the copy.
7474 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7476 @item -fprofile-correction
7477 @opindex fprofile-correction
7478 Profiles collected using an instrumented binary for multi-threaded programs may
7479 be inconsistent due to missed counter updates. When this option is specified,
7480 GCC will use heuristics to correct or smooth out such inconsistencies. By
7481 default, GCC will emit an error message when an inconsistent profile is detected.
7483 @item -fprofile-dir=@var{path}
7484 @opindex fprofile-dir
7486 Set the directory to search the profile data files in to @var{path}.
7487 This option affects only the profile data generated by
7488 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7489 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7490 and its related options.
7491 By default, GCC will use the current directory as @var{path}
7492 thus the profile data file will appear in the same directory as the object file.
7494 @item -fprofile-generate
7495 @itemx -fprofile-generate=@var{path}
7496 @opindex fprofile-generate
7498 Enable options usually used for instrumenting application to produce
7499 profile useful for later recompilation with profile feedback based
7500 optimization.  You must use @option{-fprofile-generate} both when
7501 compiling and when linking your program.
7503 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7505 If @var{path} is specified, GCC will look at the @var{path} to find
7506 the profile feedback data files. See @option{-fprofile-dir}.
7508 @item -fprofile-use
7509 @itemx -fprofile-use=@var{path}
7510 @opindex fprofile-use
7511 Enable profile feedback directed optimizations, and optimizations
7512 generally profitable only with profile feedback available.
7514 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7515 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7517 By default, GCC emits an error message if the feedback profiles do not
7518 match the source code.  This error can be turned into a warning by using
7519 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7520 code.
7522 If @var{path} is specified, GCC will look at the @var{path} to find
7523 the profile feedback data files. See @option{-fprofile-dir}.
7524 @end table
7526 The following options control compiler behavior regarding floating
7527 point arithmetic.  These options trade off between speed and
7528 correctness.  All must be specifically enabled.
7530 @table @gcctabopt
7531 @item -ffloat-store
7532 @opindex ffloat-store
7533 Do not store floating point variables in registers, and inhibit other
7534 options that might change whether a floating point value is taken from a
7535 register or memory.
7537 @cindex floating point precision
7538 This option prevents undesirable excess precision on machines such as
7539 the 68000 where the floating registers (of the 68881) keep more
7540 precision than a @code{double} is supposed to have.  Similarly for the
7541 x86 architecture.  For most programs, the excess precision does only
7542 good, but a few programs rely on the precise definition of IEEE floating
7543 point.  Use @option{-ffloat-store} for such programs, after modifying
7544 them to store all pertinent intermediate computations into variables.
7546 @item -fexcess-precision=@var{style}
7547 @opindex fexcess-precision
7548 This option allows further control over excess precision on machines
7549 where floating-point registers have more precision than the IEEE
7550 @code{float} and @code{double} types and the processor does not
7551 support operations rounding to those types.  By default,
7552 @option{-fexcess-precision=fast} is in effect; this means that
7553 operations are carried out in the precision of the registers and that
7554 it is unpredictable when rounding to the types specified in the source
7555 code takes place.  When compiling C, if
7556 @option{-fexcess-precision=standard} is specified then excess
7557 precision will follow the rules specified in ISO C99; in particular,
7558 both casts and assignments cause values to be rounded to their
7559 semantic types (whereas @option{-ffloat-store} only affects
7560 assignments).  This option is enabled by default for C if a strict
7561 conformance option such as @option{-std=c99} is used.
7563 @opindex mfpmath
7564 @option{-fexcess-precision=standard} is not implemented for languages
7565 other than C, and has no effect if
7566 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7567 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7568 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7569 semantics apply without excess precision, and in the latter, rounding
7570 is unpredictable.
7572 @item -ffast-math
7573 @opindex ffast-math
7574 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7575 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7576 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7578 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7580 This option is not turned on by any @option{-O} option since
7581 it can result in incorrect output for programs which depend on
7582 an exact implementation of IEEE or ISO rules/specifications for
7583 math functions. It may, however, yield faster code for programs
7584 that do not require the guarantees of these specifications.
7586 @item -fno-math-errno
7587 @opindex fno-math-errno
7588 Do not set ERRNO after calling math functions that are executed
7589 with a single instruction, e.g., sqrt.  A program that relies on
7590 IEEE exceptions for math error handling may want to use this flag
7591 for speed while maintaining IEEE arithmetic compatibility.
7593 This option is not turned on by any @option{-O} option since
7594 it can result in incorrect output for programs which depend on
7595 an exact implementation of IEEE or ISO rules/specifications for
7596 math functions. It may, however, yield faster code for programs
7597 that do not require the guarantees of these specifications.
7599 The default is @option{-fmath-errno}.
7601 On Darwin systems, the math library never sets @code{errno}.  There is
7602 therefore no reason for the compiler to consider the possibility that
7603 it might, and @option{-fno-math-errno} is the default.
7605 @item -funsafe-math-optimizations
7606 @opindex funsafe-math-optimizations
7608 Allow optimizations for floating-point arithmetic that (a) assume
7609 that arguments and results are valid and (b) may violate IEEE or
7610 ANSI standards.  When used at link-time, it may include libraries
7611 or startup files that change the default FPU control word or other
7612 similar optimizations.
7614 This option is not turned on by any @option{-O} option since
7615 it can result in incorrect output for programs which depend on
7616 an exact implementation of IEEE or ISO rules/specifications for
7617 math functions. It may, however, yield faster code for programs
7618 that do not require the guarantees of these specifications.
7619 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7620 @option{-fassociative-math} and @option{-freciprocal-math}.
7622 The default is @option{-fno-unsafe-math-optimizations}.
7624 @item -fassociative-math
7625 @opindex fassociative-math
7627 Allow re-association of operands in series of floating-point operations.
7628 This violates the ISO C and C++ language standard by possibly changing
7629 computation result.  NOTE: re-ordering may change the sign of zero as
7630 well as ignore NaNs and inhibit or create underflow or overflow (and
7631 thus cannot be used on a code which relies on rounding behavior like
7632 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7633 and thus may not be used when ordered comparisons are required.
7634 This option requires that both @option{-fno-signed-zeros} and
7635 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7636 much sense with @option{-frounding-math}. For Fortran the option
7637 is automatically enabled when both @option{-fno-signed-zeros} and
7638 @option{-fno-trapping-math} are in effect.
7640 The default is @option{-fno-associative-math}.
7642 @item -freciprocal-math
7643 @opindex freciprocal-math
7645 Allow the reciprocal of a value to be used instead of dividing by
7646 the value if this enables optimizations.  For example @code{x / y}
7647 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7648 is subject to common subexpression elimination.  Note that this loses
7649 precision and increases the number of flops operating on the value.
7651 The default is @option{-fno-reciprocal-math}.
7653 @item -ffinite-math-only
7654 @opindex ffinite-math-only
7655 Allow optimizations for floating-point arithmetic that assume
7656 that arguments and results are not NaNs or +-Infs.
7658 This option is not turned on by any @option{-O} option since
7659 it can result in incorrect output for programs which depend on
7660 an exact implementation of IEEE or ISO rules/specifications for
7661 math functions. It may, however, yield faster code for programs
7662 that do not require the guarantees of these specifications.
7664 The default is @option{-fno-finite-math-only}.
7666 @item -fno-signed-zeros
7667 @opindex fno-signed-zeros
7668 Allow optimizations for floating point arithmetic that ignore the
7669 signedness of zero.  IEEE arithmetic specifies the behavior of
7670 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7671 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7672 This option implies that the sign of a zero result isn't significant.
7674 The default is @option{-fsigned-zeros}.
7676 @item -fno-trapping-math
7677 @opindex fno-trapping-math
7678 Compile code assuming that floating-point operations cannot generate
7679 user-visible traps.  These traps include division by zero, overflow,
7680 underflow, inexact result and invalid operation.  This option requires
7681 that @option{-fno-signaling-nans} be in effect.  Setting this option may
7682 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7684 This option should never be turned on by any @option{-O} option since
7685 it can result in incorrect output for programs which depend on
7686 an exact implementation of IEEE or ISO rules/specifications for
7687 math functions.
7689 The default is @option{-ftrapping-math}.
7691 @item -frounding-math
7692 @opindex frounding-math
7693 Disable transformations and optimizations that assume default floating
7694 point rounding behavior.  This is round-to-zero for all floating point
7695 to integer conversions, and round-to-nearest for all other arithmetic
7696 truncations.  This option should be specified for programs that change
7697 the FP rounding mode dynamically, or that may be executed with a
7698 non-default rounding mode.  This option disables constant folding of
7699 floating point expressions at compile-time (which may be affected by
7700 rounding mode) and arithmetic transformations that are unsafe in the
7701 presence of sign-dependent rounding modes.
7703 The default is @option{-fno-rounding-math}.
7705 This option is experimental and does not currently guarantee to
7706 disable all GCC optimizations that are affected by rounding mode.
7707 Future versions of GCC may provide finer control of this setting
7708 using C99's @code{FENV_ACCESS} pragma.  This command line option
7709 will be used to specify the default state for @code{FENV_ACCESS}.
7711 @item -fsignaling-nans
7712 @opindex fsignaling-nans
7713 Compile code assuming that IEEE signaling NaNs may generate user-visible
7714 traps during floating-point operations.  Setting this option disables
7715 optimizations that may change the number of exceptions visible with
7716 signaling NaNs.  This option implies @option{-ftrapping-math}.
7718 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7719 be defined.
7721 The default is @option{-fno-signaling-nans}.
7723 This option is experimental and does not currently guarantee to
7724 disable all GCC optimizations that affect signaling NaN behavior.
7726 @item -fsingle-precision-constant
7727 @opindex fsingle-precision-constant
7728 Treat floating point constant as single precision constant instead of
7729 implicitly converting it to double precision constant.
7731 @item -fcx-limited-range
7732 @opindex fcx-limited-range
7733 When enabled, this option states that a range reduction step is not
7734 needed when performing complex division.  Also, there is no checking
7735 whether the result of a complex multiplication or division is @code{NaN
7736 + I*NaN}, with an attempt to rescue the situation in that case.  The
7737 default is @option{-fno-cx-limited-range}, but is enabled by
7738 @option{-ffast-math}.
7740 This option controls the default setting of the ISO C99
7741 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
7742 all languages.
7744 @item -fcx-fortran-rules
7745 @opindex fcx-fortran-rules
7746 Complex multiplication and division follow Fortran rules.  Range
7747 reduction is done as part of complex division, but there is no checking
7748 whether the result of a complex multiplication or division is @code{NaN
7749 + I*NaN}, with an attempt to rescue the situation in that case.
7751 The default is @option{-fno-cx-fortran-rules}.
7753 @end table
7755 The following options control optimizations that may improve
7756 performance, but are not enabled by any @option{-O} options.  This
7757 section includes experimental options that may produce broken code.
7759 @table @gcctabopt
7760 @item -fbranch-probabilities
7761 @opindex fbranch-probabilities
7762 After running a program compiled with @option{-fprofile-arcs}
7763 (@pxref{Debugging Options,, Options for Debugging Your Program or
7764 @command{gcc}}), you can compile it a second time using
7765 @option{-fbranch-probabilities}, to improve optimizations based on
7766 the number of times each branch was taken.  When the program
7767 compiled with @option{-fprofile-arcs} exits it saves arc execution
7768 counts to a file called @file{@var{sourcename}.gcda} for each source
7769 file.  The information in this data file is very dependent on the
7770 structure of the generated code, so you must use the same source code
7771 and the same optimization options for both compilations.
7773 With @option{-fbranch-probabilities}, GCC puts a
7774 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7775 These can be used to improve optimization.  Currently, they are only
7776 used in one place: in @file{reorg.c}, instead of guessing which path a
7777 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
7778 exactly determine which path is taken more often.
7780 @item -fprofile-values
7781 @opindex fprofile-values
7782 If combined with @option{-fprofile-arcs}, it adds code so that some
7783 data about values of expressions in the program is gathered.
7785 With @option{-fbranch-probabilities}, it reads back the data gathered
7786 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
7787 notes to instructions for their later usage in optimizations.
7789 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
7791 @item -fvpt
7792 @opindex fvpt
7793 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7794 a code to gather information about values of expressions.
7796 With @option{-fbranch-probabilities}, it reads back the data gathered
7797 and actually performs the optimizations based on them.
7798 Currently the optimizations include specialization of division operation
7799 using the knowledge about the value of the denominator.
7801 @item -frename-registers
7802 @opindex frename-registers
7803 Attempt to avoid false dependencies in scheduled code by making use
7804 of registers left over after register allocation.  This optimization
7805 will most benefit processors with lots of registers.  Depending on the
7806 debug information format adopted by the target, however, it can
7807 make debugging impossible, since variables will no longer stay in
7808 a ``home register''.
7810 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
7812 @item -ftracer
7813 @opindex ftracer
7814 Perform tail duplication to enlarge superblock size.  This transformation
7815 simplifies the control flow of the function allowing other optimizations to do
7816 better job.
7818 Enabled with @option{-fprofile-use}.
7820 @item -funroll-loops
7821 @opindex funroll-loops
7822 Unroll loops whose number of iterations can be determined at compile time or
7823 upon entry to the loop.  @option{-funroll-loops} implies
7824 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
7825 It also turns on complete loop peeling (i.e.@: complete removal of loops with
7826 small constant number of iterations).  This option makes code larger, and may
7827 or may not make it run faster.
7829 Enabled with @option{-fprofile-use}.
7831 @item -funroll-all-loops
7832 @opindex funroll-all-loops
7833 Unroll all loops, even if their number of iterations is uncertain when
7834 the loop is entered.  This usually makes programs run more slowly.
7835 @option{-funroll-all-loops} implies the same options as
7836 @option{-funroll-loops}.
7838 @item -fpeel-loops
7839 @opindex fpeel-loops
7840 Peels the loops for that there is enough information that they do not
7841 roll much (from profile feedback).  It also turns on complete loop peeling
7842 (i.e.@: complete removal of loops with small constant number of iterations).
7844 Enabled with @option{-fprofile-use}.
7846 @item -fmove-loop-invariants
7847 @opindex fmove-loop-invariants
7848 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
7849 at level @option{-O1}
7851 @item -funswitch-loops
7852 @opindex funswitch-loops
7853 Move branches with loop invariant conditions out of the loop, with duplicates
7854 of the loop on both branches (modified according to result of the condition).
7856 @item -ffunction-sections
7857 @itemx -fdata-sections
7858 @opindex ffunction-sections
7859 @opindex fdata-sections
7860 Place each function or data item into its own section in the output
7861 file if the target supports arbitrary sections.  The name of the
7862 function or the name of the data item determines the section's name
7863 in the output file.
7865 Use these options on systems where the linker can perform optimizations
7866 to improve locality of reference in the instruction space.  Most systems
7867 using the ELF object format and SPARC processors running Solaris 2 have
7868 linkers with such optimizations.  AIX may have these optimizations in
7869 the future.
7871 Only use these options when there are significant benefits from doing
7872 so.  When you specify these options, the assembler and linker will
7873 create larger object and executable files and will also be slower.
7874 You will not be able to use @code{gprof} on all systems if you
7875 specify this option and you may have problems with debugging if
7876 you specify both this option and @option{-g}.
7878 @item -fbranch-target-load-optimize
7879 @opindex fbranch-target-load-optimize
7880 Perform branch target register load optimization before prologue / epilogue
7881 threading.
7882 The use of target registers can typically be exposed only during reload,
7883 thus hoisting loads out of loops and doing inter-block scheduling needs
7884 a separate optimization pass.
7886 @item -fbranch-target-load-optimize2
7887 @opindex fbranch-target-load-optimize2
7888 Perform branch target register load optimization after prologue / epilogue
7889 threading.
7891 @item -fbtr-bb-exclusive
7892 @opindex fbtr-bb-exclusive
7893 When performing branch target register load optimization, don't reuse
7894 branch target registers in within any basic block.
7896 @item -fstack-protector
7897 @opindex fstack-protector
7898 Emit extra code to check for buffer overflows, such as stack smashing
7899 attacks.  This is done by adding a guard variable to functions with
7900 vulnerable objects.  This includes functions that call alloca, and
7901 functions with buffers larger than 8 bytes.  The guards are initialized
7902 when a function is entered and then checked when the function exits.
7903 If a guard check fails, an error message is printed and the program exits.
7905 @item -fstack-protector-all
7906 @opindex fstack-protector-all
7907 Like @option{-fstack-protector} except that all functions are protected.
7909 @item -fsection-anchors
7910 @opindex fsection-anchors
7911 Try to reduce the number of symbolic address calculations by using
7912 shared ``anchor'' symbols to address nearby objects.  This transformation
7913 can help to reduce the number of GOT entries and GOT accesses on some
7914 targets.
7916 For example, the implementation of the following function @code{foo}:
7918 @smallexample
7919 static int a, b, c;
7920 int foo (void) @{ return a + b + c; @}
7921 @end smallexample
7923 would usually calculate the addresses of all three variables, but if you
7924 compile it with @option{-fsection-anchors}, it will access the variables
7925 from a common anchor point instead.  The effect is similar to the
7926 following pseudocode (which isn't valid C):
7928 @smallexample
7929 int foo (void)
7931   register int *xr = &x;
7932   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
7934 @end smallexample
7936 Not all targets support this option.
7938 @item --param @var{name}=@var{value}
7939 @opindex param
7940 In some places, GCC uses various constants to control the amount of
7941 optimization that is done.  For example, GCC will not inline functions
7942 that contain more that a certain number of instructions.  You can
7943 control some of these constants on the command-line using the
7944 @option{--param} option.
7946 The names of specific parameters, and the meaning of the values, are
7947 tied to the internals of the compiler, and are subject to change
7948 without notice in future releases.
7950 In each case, the @var{value} is an integer.  The allowable choices for
7951 @var{name} are given in the following table:
7953 @table @gcctabopt
7954 @item struct-reorg-cold-struct-ratio
7955 The threshold ratio (as a percentage) between a structure frequency
7956 and the frequency of the hottest structure in the program.  This parameter
7957 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
7958 We say that if the ratio of a structure frequency, calculated by profiling,
7959 to the hottest structure frequency in the program is less than this
7960 parameter, then structure reorganization is not applied to this structure.
7961 The default is 10.
7963 @item predictable-branch-outcome
7964 When branch is predicted to be taken with probability lower than this threshold
7965 (in percent), then it is considered well predictable. The default is 10.
7967 @item max-crossjump-edges
7968 The maximum number of incoming edges to consider for crossjumping.
7969 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
7970 the number of edges incoming to each block.  Increasing values mean
7971 more aggressive optimization, making the compile time increase with
7972 probably small improvement in executable size.
7974 @item min-crossjump-insns
7975 The minimum number of instructions which must be matched at the end
7976 of two blocks before crossjumping will be performed on them.  This
7977 value is ignored in the case where all instructions in the block being
7978 crossjumped from are matched.  The default value is 5.
7980 @item max-grow-copy-bb-insns
7981 The maximum code size expansion factor when copying basic blocks
7982 instead of jumping.  The expansion is relative to a jump instruction.
7983 The default value is 8.
7985 @item max-goto-duplication-insns
7986 The maximum number of instructions to duplicate to a block that jumps
7987 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
7988 passes, GCC factors computed gotos early in the compilation process,
7989 and unfactors them as late as possible.  Only computed jumps at the
7990 end of a basic blocks with no more than max-goto-duplication-insns are
7991 unfactored.  The default value is 8.
7993 @item max-delay-slot-insn-search
7994 The maximum number of instructions to consider when looking for an
7995 instruction to fill a delay slot.  If more than this arbitrary number of
7996 instructions is searched, the time savings from filling the delay slot
7997 will be minimal so stop searching.  Increasing values mean more
7998 aggressive optimization, making the compile time increase with probably
7999 small improvement in executable run time.
8001 @item max-delay-slot-live-search
8002 When trying to fill delay slots, the maximum number of instructions to
8003 consider when searching for a block with valid live register
8004 information.  Increasing this arbitrarily chosen value means more
8005 aggressive optimization, increasing the compile time.  This parameter
8006 should be removed when the delay slot code is rewritten to maintain the
8007 control-flow graph.
8009 @item max-gcse-memory
8010 The approximate maximum amount of memory that will be allocated in
8011 order to perform the global common subexpression elimination
8012 optimization.  If more memory than specified is required, the
8013 optimization will not be done.
8015 @item max-pending-list-length
8016 The maximum number of pending dependencies scheduling will allow
8017 before flushing the current state and starting over.  Large functions
8018 with few branches or calls can create excessively large lists which
8019 needlessly consume memory and resources.
8021 @item max-inline-insns-single
8022 Several parameters control the tree inliner used in gcc.
8023 This number sets the maximum number of instructions (counted in GCC's
8024 internal representation) in a single function that the tree inliner
8025 will consider for inlining.  This only affects functions declared
8026 inline and methods implemented in a class declaration (C++).
8027 The default value is 300.
8029 @item max-inline-insns-auto
8030 When you use @option{-finline-functions} (included in @option{-O3}),
8031 a lot of functions that would otherwise not be considered for inlining
8032 by the compiler will be investigated.  To those functions, a different
8033 (more restrictive) limit compared to functions declared inline can
8034 be applied.
8035 The default value is 50.
8037 @item large-function-insns
8038 The limit specifying really large functions.  For functions larger than this
8039 limit after inlining, inlining is constrained by
8040 @option{--param large-function-growth}.  This parameter is useful primarily
8041 to avoid extreme compilation time caused by non-linear algorithms used by the
8042 backend.
8043 The default value is 2700.
8045 @item large-function-growth
8046 Specifies maximal growth of large function caused by inlining in percents.
8047 The default value is 100 which limits large function growth to 2.0 times
8048 the original size.
8050 @item large-unit-insns
8051 The limit specifying large translation unit.  Growth caused by inlining of
8052 units larger than this limit is limited by @option{--param inline-unit-growth}.
8053 For small units this might be too tight (consider unit consisting of function A
8054 that is inline and B that just calls A three time.  If B is small relative to
8055 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8056 large units consisting of small inlineable functions however the overall unit
8057 growth limit is needed to avoid exponential explosion of code size.  Thus for
8058 smaller units, the size is increased to @option{--param large-unit-insns}
8059 before applying @option{--param inline-unit-growth}.  The default is 10000
8061 @item inline-unit-growth
8062 Specifies maximal overall growth of the compilation unit caused by inlining.
8063 The default value is 30 which limits unit growth to 1.3 times the original
8064 size.
8066 @item ipcp-unit-growth
8067 Specifies maximal overall growth of the compilation unit caused by
8068 interprocedural constant propagation.  The default value is 10 which limits
8069 unit growth to 1.1 times the original size.
8071 @item large-stack-frame
8072 The limit specifying large stack frames.  While inlining the algorithm is trying
8073 to not grow past this limit too much.  Default value is 256 bytes.
8075 @item large-stack-frame-growth
8076 Specifies maximal growth of large stack frames caused by inlining in percents.
8077 The default value is 1000 which limits large stack frame growth to 11 times
8078 the original size.
8080 @item max-inline-insns-recursive
8081 @itemx max-inline-insns-recursive-auto
8082 Specifies maximum number of instructions out-of-line copy of self recursive inline
8083 function can grow into by performing recursive inlining.
8085 For functions declared inline @option{--param max-inline-insns-recursive} is
8086 taken into account.  For function not declared inline, recursive inlining
8087 happens only when @option{-finline-functions} (included in @option{-O3}) is
8088 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8089 default value is 450.
8091 @item max-inline-recursive-depth
8092 @itemx max-inline-recursive-depth-auto
8093 Specifies maximum recursion depth used by the recursive inlining.
8095 For functions declared inline @option{--param max-inline-recursive-depth} is
8096 taken into account.  For function not declared inline, recursive inlining
8097 happens only when @option{-finline-functions} (included in @option{-O3}) is
8098 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8099 default value is 8.
8101 @item min-inline-recursive-probability
8102 Recursive inlining is profitable only for function having deep recursion
8103 in average and can hurt for function having little recursion depth by
8104 increasing the prologue size or complexity of function body to other
8105 optimizers.
8107 When profile feedback is available (see @option{-fprofile-generate}) the actual
8108 recursion depth can be guessed from probability that function will recurse via
8109 given call expression.  This parameter limits inlining only to call expression
8110 whose probability exceeds given threshold (in percents).  The default value is
8113 @item early-inlining-insns
8114 Specify growth that early inliner can make.  In effect it increases amount of
8115 inlining for code having large abstraction penalty.  The default value is 8.
8117 @item max-early-inliner-iterations
8118 @itemx max-early-inliner-iterations
8119 Limit of iterations of early inliner.  This basically bounds number of nested
8120 indirect calls early inliner can resolve.  Deeper chains are still handled by
8121 late inlining.
8123 @item min-vect-loop-bound
8124 The minimum number of iterations under which a loop will not get vectorized
8125 when @option{-ftree-vectorize} is used.  The number of iterations after
8126 vectorization needs to be greater than the value specified by this option
8127 to allow vectorization.  The default value is 0.
8129 @item max-unrolled-insns
8130 The maximum number of instructions that a loop should have if that loop
8131 is unrolled, and if the loop is unrolled, it determines how many times
8132 the loop code is unrolled.
8134 @item max-average-unrolled-insns
8135 The maximum number of instructions biased by probabilities of their execution
8136 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8137 it determines how many times the loop code is unrolled.
8139 @item max-unroll-times
8140 The maximum number of unrollings of a single loop.
8142 @item max-peeled-insns
8143 The maximum number of instructions that a loop should have if that loop
8144 is peeled, and if the loop is peeled, it determines how many times
8145 the loop code is peeled.
8147 @item max-peel-times
8148 The maximum number of peelings of a single loop.
8150 @item max-completely-peeled-insns
8151 The maximum number of insns of a completely peeled loop.
8153 @item max-completely-peel-times
8154 The maximum number of iterations of a loop to be suitable for complete peeling.
8156 @item max-completely-peel-loop-nest-depth
8157 The maximum depth of a loop nest suitable for complete peeling.
8159 @item max-unswitch-insns
8160 The maximum number of insns of an unswitched loop.
8162 @item max-unswitch-level
8163 The maximum number of branches unswitched in a single loop.
8165 @item lim-expensive
8166 The minimum cost of an expensive expression in the loop invariant motion.
8168 @item iv-consider-all-candidates-bound
8169 Bound on number of candidates for induction variables below that
8170 all candidates are considered for each use in induction variable
8171 optimizations.  Only the most relevant candidates are considered
8172 if there are more candidates, to avoid quadratic time complexity.
8174 @item iv-max-considered-uses
8175 The induction variable optimizations give up on loops that contain more
8176 induction variable uses.
8178 @item iv-always-prune-cand-set-bound
8179 If number of candidates in the set is smaller than this value,
8180 we always try to remove unnecessary ivs from the set during its
8181 optimization when a new iv is added to the set.
8183 @item scev-max-expr-size
8184 Bound on size of expressions used in the scalar evolutions analyzer.
8185 Large expressions slow the analyzer.
8187 @item omega-max-vars
8188 The maximum number of variables in an Omega constraint system.
8189 The default value is 128.
8191 @item omega-max-geqs
8192 The maximum number of inequalities in an Omega constraint system.
8193 The default value is 256.
8195 @item omega-max-eqs
8196 The maximum number of equalities in an Omega constraint system.
8197 The default value is 128.
8199 @item omega-max-wild-cards
8200 The maximum number of wildcard variables that the Omega solver will
8201 be able to insert.  The default value is 18.
8203 @item omega-hash-table-size
8204 The size of the hash table in the Omega solver.  The default value is
8205 550.
8207 @item omega-max-keys
8208 The maximal number of keys used by the Omega solver.  The default
8209 value is 500.
8211 @item omega-eliminate-redundant-constraints
8212 When set to 1, use expensive methods to eliminate all redundant
8213 constraints.  The default value is 0.
8215 @item vect-max-version-for-alignment-checks
8216 The maximum number of runtime checks that can be performed when
8217 doing loop versioning for alignment in the vectorizer.  See option
8218 ftree-vect-loop-version for more information.
8220 @item vect-max-version-for-alias-checks
8221 The maximum number of runtime checks that can be performed when
8222 doing loop versioning for alias in the vectorizer.  See option
8223 ftree-vect-loop-version for more information.
8225 @item max-iterations-to-track
8227 The maximum number of iterations of a loop the brute force algorithm
8228 for analysis of # of iterations of the loop tries to evaluate.
8230 @item hot-bb-count-fraction
8231 Select fraction of the maximal count of repetitions of basic block in program
8232 given basic block needs to have to be considered hot.
8234 @item hot-bb-frequency-fraction
8235 Select fraction of the maximal frequency of executions of basic block in
8236 function given basic block needs to have to be considered hot
8238 @item max-predicted-iterations
8239 The maximum number of loop iterations we predict statically.  This is useful
8240 in cases where function contain single loop with known bound and other loop
8241 with unknown.  We predict the known number of iterations correctly, while
8242 the unknown number of iterations average to roughly 10.  This means that the
8243 loop without bounds would appear artificially cold relative to the other one.
8245 @item align-threshold
8247 Select fraction of the maximal frequency of executions of basic block in
8248 function given basic block will get aligned.
8250 @item align-loop-iterations
8252 A loop expected to iterate at lest the selected number of iterations will get
8253 aligned.
8255 @item tracer-dynamic-coverage
8256 @itemx tracer-dynamic-coverage-feedback
8258 This value is used to limit superblock formation once the given percentage of
8259 executed instructions is covered.  This limits unnecessary code size
8260 expansion.
8262 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8263 feedback is available.  The real profiles (as opposed to statically estimated
8264 ones) are much less balanced allowing the threshold to be larger value.
8266 @item tracer-max-code-growth
8267 Stop tail duplication once code growth has reached given percentage.  This is
8268 rather hokey argument, as most of the duplicates will be eliminated later in
8269 cross jumping, so it may be set to much higher values than is the desired code
8270 growth.
8272 @item tracer-min-branch-ratio
8274 Stop reverse growth when the reverse probability of best edge is less than this
8275 threshold (in percent).
8277 @item tracer-min-branch-ratio
8278 @itemx tracer-min-branch-ratio-feedback
8280 Stop forward growth if the best edge do have probability lower than this
8281 threshold.
8283 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8284 compilation for profile feedback and one for compilation without.  The value
8285 for compilation with profile feedback needs to be more conservative (higher) in
8286 order to make tracer effective.
8288 @item max-cse-path-length
8290 Maximum number of basic blocks on path that cse considers.  The default is 10.
8292 @item max-cse-insns
8293 The maximum instructions CSE process before flushing. The default is 1000.
8295 @item ggc-min-expand
8297 GCC uses a garbage collector to manage its own memory allocation.  This
8298 parameter specifies the minimum percentage by which the garbage
8299 collector's heap should be allowed to expand between collections.
8300 Tuning this may improve compilation speed; it has no effect on code
8301 generation.
8303 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8304 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8305 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8306 GCC is not able to calculate RAM on a particular platform, the lower
8307 bound of 30% is used.  Setting this parameter and
8308 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8309 every opportunity.  This is extremely slow, but can be useful for
8310 debugging.
8312 @item ggc-min-heapsize
8314 Minimum size of the garbage collector's heap before it begins bothering
8315 to collect garbage.  The first collection occurs after the heap expands
8316 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8317 tuning this may improve compilation speed, and has no effect on code
8318 generation.
8320 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8321 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8322 with a lower bound of 4096 (four megabytes) and an upper bound of
8323 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8324 particular platform, the lower bound is used.  Setting this parameter
8325 very large effectively disables garbage collection.  Setting this
8326 parameter and @option{ggc-min-expand} to zero causes a full collection
8327 to occur at every opportunity.
8329 @item max-reload-search-insns
8330 The maximum number of instruction reload should look backward for equivalent
8331 register.  Increasing values mean more aggressive optimization, making the
8332 compile time increase with probably slightly better performance.  The default
8333 value is 100.
8335 @item max-cselib-memory-locations
8336 The maximum number of memory locations cselib should take into account.
8337 Increasing values mean more aggressive optimization, making the compile time
8338 increase with probably slightly better performance.  The default value is 500.
8340 @item reorder-blocks-duplicate
8341 @itemx reorder-blocks-duplicate-feedback
8343 Used by basic block reordering pass to decide whether to use unconditional
8344 branch or duplicate the code on its destination.  Code is duplicated when its
8345 estimated size is smaller than this value multiplied by the estimated size of
8346 unconditional jump in the hot spots of the program.
8348 The @option{reorder-block-duplicate-feedback} is used only when profile
8349 feedback is available and may be set to higher values than
8350 @option{reorder-block-duplicate} since information about the hot spots is more
8351 accurate.
8353 @item max-sched-ready-insns
8354 The maximum number of instructions ready to be issued the scheduler should
8355 consider at any given time during the first scheduling pass.  Increasing
8356 values mean more thorough searches, making the compilation time increase
8357 with probably little benefit.  The default value is 100.
8359 @item max-sched-region-blocks
8360 The maximum number of blocks in a region to be considered for
8361 interblock scheduling.  The default value is 10.
8363 @item max-pipeline-region-blocks
8364 The maximum number of blocks in a region to be considered for
8365 pipelining in the selective scheduler.  The default value is 15.
8367 @item max-sched-region-insns
8368 The maximum number of insns in a region to be considered for
8369 interblock scheduling.  The default value is 100.
8371 @item max-pipeline-region-insns
8372 The maximum number of insns in a region to be considered for
8373 pipelining in the selective scheduler.  The default value is 200.
8375 @item min-spec-prob
8376 The minimum probability (in percents) of reaching a source block
8377 for interblock speculative scheduling.  The default value is 40.
8379 @item max-sched-extend-regions-iters
8380 The maximum number of iterations through CFG to extend regions.
8381 0 - disable region extension,
8382 N - do at most N iterations.
8383 The default value is 0.
8385 @item max-sched-insn-conflict-delay
8386 The maximum conflict delay for an insn to be considered for speculative motion.
8387 The default value is 3.
8389 @item sched-spec-prob-cutoff
8390 The minimal probability of speculation success (in percents), so that
8391 speculative insn will be scheduled.
8392 The default value is 40.
8394 @item sched-mem-true-dep-cost
8395 Minimal distance (in CPU cycles) between store and load targeting same
8396 memory locations.  The default value is 1.
8398 @item selsched-max-lookahead
8399 The maximum size of the lookahead window of selective scheduling.  It is a
8400 depth of search for available instructions.
8401 The default value is 50.
8403 @item selsched-max-sched-times
8404 The maximum number of times that an instruction will be scheduled during
8405 selective scheduling.  This is the limit on the number of iterations
8406 through which the instruction may be pipelined.  The default value is 2.
8408 @item selsched-max-insns-to-rename
8409 The maximum number of best instructions in the ready list that are considered
8410 for renaming in the selective scheduler.  The default value is 2.
8412 @item max-last-value-rtl
8413 The maximum size measured as number of RTLs that can be recorded in an expression
8414 in combiner for a pseudo register as last known value of that register.  The default
8415 is 10000.
8417 @item integer-share-limit
8418 Small integer constants can use a shared data structure, reducing the
8419 compiler's memory usage and increasing its speed.  This sets the maximum
8420 value of a shared integer constant.  The default value is 256.
8422 @item min-virtual-mappings
8423 Specifies the minimum number of virtual mappings in the incremental
8424 SSA updater that should be registered to trigger the virtual mappings
8425 heuristic defined by virtual-mappings-ratio.  The default value is
8426 100.
8428 @item virtual-mappings-ratio
8429 If the number of virtual mappings is virtual-mappings-ratio bigger
8430 than the number of virtual symbols to be updated, then the incremental
8431 SSA updater switches to a full update for those symbols.  The default
8432 ratio is 3.
8434 @item ssp-buffer-size
8435 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8436 protection when @option{-fstack-protection} is used.
8438 @item max-jump-thread-duplication-stmts
8439 Maximum number of statements allowed in a block that needs to be
8440 duplicated when threading jumps.
8442 @item max-fields-for-field-sensitive
8443 Maximum number of fields in a structure we will treat in
8444 a field sensitive manner during pointer analysis.  The default is zero
8445 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8447 @item prefetch-latency
8448 Estimate on average number of instructions that are executed before
8449 prefetch finishes.  The distance we prefetch ahead is proportional
8450 to this constant.  Increasing this number may also lead to less
8451 streams being prefetched (see @option{simultaneous-prefetches}).
8453 @item simultaneous-prefetches
8454 Maximum number of prefetches that can run at the same time.
8456 @item l1-cache-line-size
8457 The size of cache line in L1 cache, in bytes.
8459 @item l1-cache-size
8460 The size of L1 cache, in kilobytes.
8462 @item l2-cache-size
8463 The size of L2 cache, in kilobytes.
8465 @item min-insn-to-prefetch-ratio
8466 The minimum ratio between the number of instructions and the
8467 number of prefetches to enable prefetching in a loop with an
8468 unknown trip count.
8470 @item prefetch-min-insn-to-mem-ratio
8471 The minimum ratio between the number of instructions and the
8472 number of memory references to enable prefetching in a loop.
8474 @item use-canonical-types
8475 Whether the compiler should use the ``canonical'' type system.  By
8476 default, this should always be 1, which uses a more efficient internal
8477 mechanism for comparing types in C++ and Objective-C++.  However, if
8478 bugs in the canonical type system are causing compilation failures,
8479 set this value to 0 to disable canonical types.
8481 @item switch-conversion-max-branch-ratio
8482 Switch initialization conversion will refuse to create arrays that are
8483 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8484 branches in the switch.
8486 @item max-partial-antic-length
8487 Maximum length of the partial antic set computed during the tree
8488 partial redundancy elimination optimization (@option{-ftree-pre}) when
8489 optimizing at @option{-O3} and above.  For some sorts of source code
8490 the enhanced partial redundancy elimination optimization can run away,
8491 consuming all of the memory available on the host machine.  This
8492 parameter sets a limit on the length of the sets that are computed,
8493 which prevents the runaway behavior.  Setting a value of 0 for
8494 this parameter will allow an unlimited set length.
8496 @item sccvn-max-scc-size
8497 Maximum size of a strongly connected component (SCC) during SCCVN
8498 processing.  If this limit is hit, SCCVN processing for the whole
8499 function will not be done and optimizations depending on it will
8500 be disabled.  The default maximum SCC size is 10000.
8502 @item ira-max-loops-num
8503 IRA uses a regional register allocation by default.  If a function
8504 contains loops more than number given by the parameter, only at most
8505 given number of the most frequently executed loops will form regions
8506 for the regional register allocation.  The default value of the
8507 parameter is 100.
8509 @item ira-max-conflict-table-size
8510 Although IRA uses a sophisticated algorithm of compression conflict
8511 table, the table can be still big for huge functions.  If the conflict
8512 table for a function could be more than size in MB given by the
8513 parameter, the conflict table is not built and faster, simpler, and
8514 lower quality register allocation algorithm will be used.  The
8515 algorithm do not use pseudo-register conflicts.  The default value of
8516 the parameter is 2000.
8518 @item ira-loop-reserved-regs
8519 IRA can be used to evaluate more accurate register pressure in loops
8520 for decision to move loop invariants (see @option{-O3}).  The number
8521 of available registers reserved for some other purposes is described
8522 by this parameter.  The default value of the parameter is 2 which is
8523 minimal number of registers needed for execution of typical
8524 instruction.  This value is the best found from numerous experiments.
8526 @item loop-invariant-max-bbs-in-loop
8527 Loop invariant motion can be very expensive, both in compile time and
8528 in amount of needed compile time memory, with very large loops.  Loops
8529 with more basic blocks than this parameter won't have loop invariant
8530 motion optimization performed on them.  The default value of the
8531 parameter is 1000 for -O1 and 10000 for -O2 and above.
8533 @item max-vartrack-size
8534 Sets a maximum number of hash table slots to use during variable
8535 tracking dataflow analysis of any function.  If this limit is exceeded
8536 with variable tracking at assignments enabled, analysis for that
8537 function is retried without it, after removing all debug insns from
8538 the function.  If the limit is exceeded even without debug insns, var
8539 tracking analysis is completely disabled for the function.  Setting
8540 the parameter to zero makes it unlimited.
8542 @item min-nondebug-insn-uid
8543 Use uids starting at this parameter for nondebug insns.  The range below
8544 the parameter is reserved exclusively for debug insns created by
8545 @option{-fvar-tracking-assignments}, but debug insns may get
8546 (non-overlapping) uids above it if the reserved range is exhausted.
8548 @item ipa-sra-ptr-growth-factor
8549 IPA-SRA will replace a pointer to an aggregate with one or more new
8550 parameters only when their cumulative size is less or equal to
8551 @option{ipa-sra-ptr-growth-factor} times the size of the original
8552 pointer parameter.
8554 @item graphite-max-nb-scop-params
8555 To avoid exponential effects in the Graphite loop transforms, the
8556 number of parameters in a Static Control Part (SCoP) is bounded.  The
8557 default value is 10 parameters.  A variable whose value is unknown at
8558 compile time and defined outside a SCoP is a parameter of the SCoP.
8560 @item graphite-max-bbs-per-function
8561 To avoid exponential effects in the detection of SCoPs, the size of
8562 the functions analyzed by Graphite is bounded.  The default value is
8563 100 basic blocks.
8565 @item loop-block-tile-size
8566 Loop blocking or strip mining transforms, enabled with
8567 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
8568 loop in the loop nest by a given number of iterations.  The strip
8569 length can be changed using the @option{loop-block-tile-size}
8570 parameter.  The default value is 51 iterations.
8572 @end table
8573 @end table
8575 @node Preprocessor Options
8576 @section Options Controlling the Preprocessor
8577 @cindex preprocessor options
8578 @cindex options, preprocessor
8580 These options control the C preprocessor, which is run on each C source
8581 file before actual compilation.
8583 If you use the @option{-E} option, nothing is done except preprocessing.
8584 Some of these options make sense only together with @option{-E} because
8585 they cause the preprocessor output to be unsuitable for actual
8586 compilation.
8588 @table @gcctabopt
8589 @item -Wp,@var{option}
8590 @opindex Wp
8591 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8592 and pass @var{option} directly through to the preprocessor.  If
8593 @var{option} contains commas, it is split into multiple options at the
8594 commas.  However, many options are modified, translated or interpreted
8595 by the compiler driver before being passed to the preprocessor, and
8596 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8597 interface is undocumented and subject to change, so whenever possible
8598 you should avoid using @option{-Wp} and let the driver handle the
8599 options instead.
8601 @item -Xpreprocessor @var{option}
8602 @opindex Xpreprocessor
8603 Pass @var{option} as an option to the preprocessor.  You can use this to
8604 supply system-specific preprocessor options which GCC does not know how to
8605 recognize.
8607 If you want to pass an option that takes an argument, you must use
8608 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8609 @end table
8611 @include cppopts.texi
8613 @node Assembler Options
8614 @section Passing Options to the Assembler
8616 @c prevent bad page break with this line
8617 You can pass options to the assembler.
8619 @table @gcctabopt
8620 @item -Wa,@var{option}
8621 @opindex Wa
8622 Pass @var{option} as an option to the assembler.  If @var{option}
8623 contains commas, it is split into multiple options at the commas.
8625 @item -Xassembler @var{option}
8626 @opindex Xassembler
8627 Pass @var{option} as an option to the assembler.  You can use this to
8628 supply system-specific assembler options which GCC does not know how to
8629 recognize.
8631 If you want to pass an option that takes an argument, you must use
8632 @option{-Xassembler} twice, once for the option and once for the argument.
8634 @end table
8636 @node Link Options
8637 @section Options for Linking
8638 @cindex link options
8639 @cindex options, linking
8641 These options come into play when the compiler links object files into
8642 an executable output file.  They are meaningless if the compiler is
8643 not doing a link step.
8645 @table @gcctabopt
8646 @cindex file names
8647 @item @var{object-file-name}
8648 A file name that does not end in a special recognized suffix is
8649 considered to name an object file or library.  (Object files are
8650 distinguished from libraries by the linker according to the file
8651 contents.)  If linking is done, these object files are used as input
8652 to the linker.
8654 @item -c
8655 @itemx -S
8656 @itemx -E
8657 @opindex c
8658 @opindex S
8659 @opindex E
8660 If any of these options is used, then the linker is not run, and
8661 object file names should not be used as arguments.  @xref{Overall
8662 Options}.
8664 @cindex Libraries
8665 @item -l@var{library}
8666 @itemx -l @var{library}
8667 @opindex l
8668 Search the library named @var{library} when linking.  (The second
8669 alternative with the library as a separate argument is only for
8670 POSIX compliance and is not recommended.)
8672 It makes a difference where in the command you write this option; the
8673 linker searches and processes libraries and object files in the order they
8674 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8675 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8676 to functions in @samp{z}, those functions may not be loaded.
8678 The linker searches a standard list of directories for the library,
8679 which is actually a file named @file{lib@var{library}.a}.  The linker
8680 then uses this file as if it had been specified precisely by name.
8682 The directories searched include several standard system directories
8683 plus any that you specify with @option{-L}.
8685 Normally the files found this way are library files---archive files
8686 whose members are object files.  The linker handles an archive file by
8687 scanning through it for members which define symbols that have so far
8688 been referenced but not defined.  But if the file that is found is an
8689 ordinary object file, it is linked in the usual fashion.  The only
8690 difference between using an @option{-l} option and specifying a file name
8691 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8692 and searches several directories.
8694 @item -lobjc
8695 @opindex lobjc
8696 You need this special case of the @option{-l} option in order to
8697 link an Objective-C or Objective-C++ program.
8699 @item -nostartfiles
8700 @opindex nostartfiles
8701 Do not use the standard system startup files when linking.
8702 The standard system libraries are used normally, unless @option{-nostdlib}
8703 or @option{-nodefaultlibs} is used.
8705 @item -nodefaultlibs
8706 @opindex nodefaultlibs
8707 Do not use the standard system libraries when linking.
8708 Only the libraries you specify will be passed to the linker, options
8709 specifying linkage of the system libraries, such as @code{-static-libgcc}
8710 or @code{-shared-libgcc}, will be ignored.
8711 The standard startup files are used normally, unless @option{-nostartfiles}
8712 is used.  The compiler may generate calls to @code{memcmp},
8713 @code{memset}, @code{memcpy} and @code{memmove}.
8714 These entries are usually resolved by entries in
8715 libc.  These entry points should be supplied through some other
8716 mechanism when this option is specified.
8718 @item -nostdlib
8719 @opindex nostdlib
8720 Do not use the standard system startup files or libraries when linking.
8721 No startup files and only the libraries you specify will be passed to
8722 the linker, options specifying linkage of the system libraries, such as
8723 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8724 The compiler may generate calls to @code{memcmp}, @code{memset},
8725 @code{memcpy} and @code{memmove}.
8726 These entries are usually resolved by entries in
8727 libc.  These entry points should be supplied through some other
8728 mechanism when this option is specified.
8730 @cindex @option{-lgcc}, use with @option{-nostdlib}
8731 @cindex @option{-nostdlib} and unresolved references
8732 @cindex unresolved references and @option{-nostdlib}
8733 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8734 @cindex @option{-nodefaultlibs} and unresolved references
8735 @cindex unresolved references and @option{-nodefaultlibs}
8736 One of the standard libraries bypassed by @option{-nostdlib} and
8737 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8738 that GCC uses to overcome shortcomings of particular machines, or special
8739 needs for some languages.
8740 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8741 Collection (GCC) Internals},
8742 for more discussion of @file{libgcc.a}.)
8743 In most cases, you need @file{libgcc.a} even when you want to avoid
8744 other standard libraries.  In other words, when you specify @option{-nostdlib}
8745 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8746 This ensures that you have no unresolved references to internal GCC
8747 library subroutines.  (For example, @samp{__main}, used to ensure C++
8748 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8749 GNU Compiler Collection (GCC) Internals}.)
8751 @item -pie
8752 @opindex pie
8753 Produce a position independent executable on targets which support it.
8754 For predictable results, you must also specify the same set of options
8755 that were used to generate code (@option{-fpie}, @option{-fPIE},
8756 or model suboptions) when you specify this option.
8758 @item -rdynamic
8759 @opindex rdynamic
8760 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8761 that support it. This instructs the linker to add all symbols, not
8762 only used ones, to the dynamic symbol table. This option is needed
8763 for some uses of @code{dlopen} or to allow obtaining backtraces
8764 from within a program.
8766 @item -s
8767 @opindex s
8768 Remove all symbol table and relocation information from the executable.
8770 @item -static
8771 @opindex static
8772 On systems that support dynamic linking, this prevents linking with the shared
8773 libraries.  On other systems, this option has no effect.
8775 @item -shared
8776 @opindex shared
8777 Produce a shared object which can then be linked with other objects to
8778 form an executable.  Not all systems support this option.  For predictable
8779 results, you must also specify the same set of options that were used to
8780 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
8781 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
8782 needs to build supplementary stub code for constructors to work.  On
8783 multi-libbed systems, @samp{gcc -shared} must select the correct support
8784 libraries to link against.  Failing to supply the correct flags may lead
8785 to subtle defects.  Supplying them in cases where they are not necessary
8786 is innocuous.}
8788 @item -shared-libgcc
8789 @itemx -static-libgcc
8790 @opindex shared-libgcc
8791 @opindex static-libgcc
8792 On systems that provide @file{libgcc} as a shared library, these options
8793 force the use of either the shared or static version respectively.
8794 If no shared version of @file{libgcc} was built when the compiler was
8795 configured, these options have no effect.
8797 There are several situations in which an application should use the
8798 shared @file{libgcc} instead of the static version.  The most common
8799 of these is when the application wishes to throw and catch exceptions
8800 across different shared libraries.  In that case, each of the libraries
8801 as well as the application itself should use the shared @file{libgcc}.
8803 Therefore, the G++ and GCJ drivers automatically add
8804 @option{-shared-libgcc} whenever you build a shared library or a main
8805 executable, because C++ and Java programs typically use exceptions, so
8806 this is the right thing to do.
8808 If, instead, you use the GCC driver to create shared libraries, you may
8809 find that they will not always be linked with the shared @file{libgcc}.
8810 If GCC finds, at its configuration time, that you have a non-GNU linker
8811 or a GNU linker that does not support option @option{--eh-frame-hdr},
8812 it will link the shared version of @file{libgcc} into shared libraries
8813 by default.  Otherwise, it will take advantage of the linker and optimize
8814 away the linking with the shared version of @file{libgcc}, linking with
8815 the static version of libgcc by default.  This allows exceptions to
8816 propagate through such shared libraries, without incurring relocation
8817 costs at library load time.
8819 However, if a library or main executable is supposed to throw or catch
8820 exceptions, you must link it using the G++ or GCJ driver, as appropriate
8821 for the languages used in the program, or using the option
8822 @option{-shared-libgcc}, such that it is linked with the shared
8823 @file{libgcc}.
8825 @item -static-libstdc++
8826 When the @command{g++} program is used to link a C++ program, it will
8827 normally automatically link against @option{libstdc++}.  If
8828 @file{libstdc++} is available as a shared library, and the
8829 @option{-static} option is not used, then this will link against the
8830 shared version of @file{libstdc++}.  That is normally fine.  However, it
8831 is sometimes useful to freeze the version of @file{libstdc++} used by
8832 the program without going all the way to a fully static link.  The
8833 @option{-static-libstdc++} option directs the @command{g++} driver to
8834 link @file{libstdc++} statically, without necessarily linking other
8835 libraries statically.
8837 @item -symbolic
8838 @opindex symbolic
8839 Bind references to global symbols when building a shared object.  Warn
8840 about any unresolved references (unless overridden by the link editor
8841 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
8842 this option.
8844 @item -T @var{script}
8845 @opindex T
8846 @cindex linker script
8847 Use @var{script} as the linker script.  This option is supported by most
8848 systems using the GNU linker.  On some targets, such as bare-board
8849 targets without an operating system, the @option{-T} option may be required
8850 when linking to avoid references to undefined symbols.
8852 @item -Xlinker @var{option}
8853 @opindex Xlinker
8854 Pass @var{option} as an option to the linker.  You can use this to
8855 supply system-specific linker options which GCC does not know how to
8856 recognize.
8858 If you want to pass an option that takes a separate argument, you must use
8859 @option{-Xlinker} twice, once for the option and once for the argument.
8860 For example, to pass @option{-assert definitions}, you must write
8861 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
8862 @option{-Xlinker "-assert definitions"}, because this passes the entire
8863 string as a single argument, which is not what the linker expects.
8865 When using the GNU linker, it is usually more convenient to pass
8866 arguments to linker options using the @option{@var{option}=@var{value}}
8867 syntax than as separate arguments.  For example, you can specify
8868 @samp{-Xlinker -Map=output.map} rather than
8869 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
8870 this syntax for command-line options.
8872 @item -Wl,@var{option}
8873 @opindex Wl
8874 Pass @var{option} as an option to the linker.  If @var{option} contains
8875 commas, it is split into multiple options at the commas.  You can use this
8876 syntax to pass an argument to the option.
8877 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
8878 linker.  When using the GNU linker, you can also get the same effect with
8879 @samp{-Wl,-Map=output.map}.
8881 @item -u @var{symbol}
8882 @opindex u
8883 Pretend the symbol @var{symbol} is undefined, to force linking of
8884 library modules to define it.  You can use @option{-u} multiple times with
8885 different symbols to force loading of additional library modules.
8886 @end table
8888 @node Directory Options
8889 @section Options for Directory Search
8890 @cindex directory options
8891 @cindex options, directory search
8892 @cindex search path
8894 These options specify directories to search for header files, for
8895 libraries and for parts of the compiler:
8897 @table @gcctabopt
8898 @item -I@var{dir}
8899 @opindex I
8900 Add the directory @var{dir} to the head of the list of directories to be
8901 searched for header files.  This can be used to override a system header
8902 file, substituting your own version, since these directories are
8903 searched before the system header file directories.  However, you should
8904 not use this option to add directories that contain vendor-supplied
8905 system header files (use @option{-isystem} for that).  If you use more than
8906 one @option{-I} option, the directories are scanned in left-to-right
8907 order; the standard system directories come after.
8909 If a standard system include directory, or a directory specified with
8910 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
8911 option will be ignored.  The directory will still be searched but as a
8912 system directory at its normal position in the system include chain.
8913 This is to ensure that GCC's procedure to fix buggy system headers and
8914 the ordering for the include_next directive are not inadvertently changed.
8915 If you really need to change the search order for system directories,
8916 use the @option{-nostdinc} and/or @option{-isystem} options.
8918 @item -iplugindir=@var{dir}
8919 Set the directory to search for plugins which are passed
8920 by @option{-fplugin=@var{name}} instead of
8921 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
8922 to be used by the user, but only passed by the driver.
8924 @item -iquote@var{dir}
8925 @opindex iquote
8926 Add the directory @var{dir} to the head of the list of directories to
8927 be searched for header files only for the case of @samp{#include
8928 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
8929 otherwise just like @option{-I}.
8931 @item -L@var{dir}
8932 @opindex L
8933 Add directory @var{dir} to the list of directories to be searched
8934 for @option{-l}.
8936 @item -B@var{prefix}
8937 @opindex B
8938 This option specifies where to find the executables, libraries,
8939 include files, and data files of the compiler itself.
8941 The compiler driver program runs one or more of the subprograms
8942 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
8943 @var{prefix} as a prefix for each program it tries to run, both with and
8944 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
8946 For each subprogram to be run, the compiler driver first tries the
8947 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
8948 was not specified, the driver tries two standard prefixes, which are
8949 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
8950 those results in a file name that is found, the unmodified program
8951 name is searched for using the directories specified in your
8952 @env{PATH} environment variable.
8954 The compiler will check to see if the path provided by the @option{-B}
8955 refers to a directory, and if necessary it will add a directory
8956 separator character at the end of the path.
8958 @option{-B} prefixes that effectively specify directory names also apply
8959 to libraries in the linker, because the compiler translates these
8960 options into @option{-L} options for the linker.  They also apply to
8961 includes files in the preprocessor, because the compiler translates these
8962 options into @option{-isystem} options for the preprocessor.  In this case,
8963 the compiler appends @samp{include} to the prefix.
8965 The run-time support file @file{libgcc.a} can also be searched for using
8966 the @option{-B} prefix, if needed.  If it is not found there, the two
8967 standard prefixes above are tried, and that is all.  The file is left
8968 out of the link if it is not found by those means.
8970 Another way to specify a prefix much like the @option{-B} prefix is to use
8971 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
8972 Variables}.
8974 As a special kludge, if the path provided by @option{-B} is
8975 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
8976 9, then it will be replaced by @file{[dir/]include}.  This is to help
8977 with boot-strapping the compiler.
8979 @item -specs=@var{file}
8980 @opindex specs
8981 Process @var{file} after the compiler reads in the standard @file{specs}
8982 file, in order to override the defaults that the @file{gcc} driver
8983 program uses when determining what switches to pass to @file{cc1},
8984 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
8985 @option{-specs=@var{file}} can be specified on the command line, and they
8986 are processed in order, from left to right.
8988 @item --sysroot=@var{dir}
8989 @opindex sysroot
8990 Use @var{dir} as the logical root directory for headers and libraries.
8991 For example, if the compiler would normally search for headers in
8992 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
8993 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
8995 If you use both this option and the @option{-isysroot} option, then
8996 the @option{--sysroot} option will apply to libraries, but the
8997 @option{-isysroot} option will apply to header files.
8999 The GNU linker (beginning with version 2.16) has the necessary support
9000 for this option.  If your linker does not support this option, the
9001 header file aspect of @option{--sysroot} will still work, but the
9002 library aspect will not.
9004 @item -I-
9005 @opindex I-
9006 This option has been deprecated.  Please use @option{-iquote} instead for
9007 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9008 Any directories you specify with @option{-I} options before the @option{-I-}
9009 option are searched only for the case of @samp{#include "@var{file}"};
9010 they are not searched for @samp{#include <@var{file}>}.
9012 If additional directories are specified with @option{-I} options after
9013 the @option{-I-}, these directories are searched for all @samp{#include}
9014 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9015 this way.)
9017 In addition, the @option{-I-} option inhibits the use of the current
9018 directory (where the current input file came from) as the first search
9019 directory for @samp{#include "@var{file}"}.  There is no way to
9020 override this effect of @option{-I-}.  With @option{-I.} you can specify
9021 searching the directory which was current when the compiler was
9022 invoked.  That is not exactly the same as what the preprocessor does
9023 by default, but it is often satisfactory.
9025 @option{-I-} does not inhibit the use of the standard system directories
9026 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9027 independent.
9028 @end table
9030 @c man end
9032 @node Spec Files
9033 @section Specifying subprocesses and the switches to pass to them
9034 @cindex Spec Files
9036 @command{gcc} is a driver program.  It performs its job by invoking a
9037 sequence of other programs to do the work of compiling, assembling and
9038 linking.  GCC interprets its command-line parameters and uses these to
9039 deduce which programs it should invoke, and which command-line options
9040 it ought to place on their command lines.  This behavior is controlled
9041 by @dfn{spec strings}.  In most cases there is one spec string for each
9042 program that GCC can invoke, but a few programs have multiple spec
9043 strings to control their behavior.  The spec strings built into GCC can
9044 be overridden by using the @option{-specs=} command-line switch to specify
9045 a spec file.
9047 @dfn{Spec files} are plaintext files that are used to construct spec
9048 strings.  They consist of a sequence of directives separated by blank
9049 lines.  The type of directive is determined by the first non-whitespace
9050 character on the line and it can be one of the following:
9052 @table @code
9053 @item %@var{command}
9054 Issues a @var{command} to the spec file processor.  The commands that can
9055 appear here are:
9057 @table @code
9058 @item %include <@var{file}>
9059 @cindex %include
9060 Search for @var{file} and insert its text at the current point in the
9061 specs file.
9063 @item %include_noerr <@var{file}>
9064 @cindex %include_noerr
9065 Just like @samp{%include}, but do not generate an error message if the include
9066 file cannot be found.
9068 @item %rename @var{old_name} @var{new_name}
9069 @cindex %rename
9070 Rename the spec string @var{old_name} to @var{new_name}.
9072 @end table
9074 @item *[@var{spec_name}]:
9075 This tells the compiler to create, override or delete the named spec
9076 string.  All lines after this directive up to the next directive or
9077 blank line are considered to be the text for the spec string.  If this
9078 results in an empty string then the spec will be deleted.  (Or, if the
9079 spec did not exist, then nothing will happened.)  Otherwise, if the spec
9080 does not currently exist a new spec will be created.  If the spec does
9081 exist then its contents will be overridden by the text of this
9082 directive, unless the first character of that text is the @samp{+}
9083 character, in which case the text will be appended to the spec.
9085 @item [@var{suffix}]:
9086 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9087 and up to the next directive or blank line are considered to make up the
9088 spec string for the indicated suffix.  When the compiler encounters an
9089 input file with the named suffix, it will processes the spec string in
9090 order to work out how to compile that file.  For example:
9092 @smallexample
9093 .ZZ:
9094 z-compile -input %i
9095 @end smallexample
9097 This says that any input file whose name ends in @samp{.ZZ} should be
9098 passed to the program @samp{z-compile}, which should be invoked with the
9099 command-line switch @option{-input} and with the result of performing the
9100 @samp{%i} substitution.  (See below.)
9102 As an alternative to providing a spec string, the text that follows a
9103 suffix directive can be one of the following:
9105 @table @code
9106 @item @@@var{language}
9107 This says that the suffix is an alias for a known @var{language}.  This is
9108 similar to using the @option{-x} command-line switch to GCC to specify a
9109 language explicitly.  For example:
9111 @smallexample
9112 .ZZ:
9113 @@c++
9114 @end smallexample
9116 Says that .ZZ files are, in fact, C++ source files.
9118 @item #@var{name}
9119 This causes an error messages saying:
9121 @smallexample
9122 @var{name} compiler not installed on this system.
9123 @end smallexample
9124 @end table
9126 GCC already has an extensive list of suffixes built into it.
9127 This directive will add an entry to the end of the list of suffixes, but
9128 since the list is searched from the end backwards, it is effectively
9129 possible to override earlier entries using this technique.
9131 @end table
9133 GCC has the following spec strings built into it.  Spec files can
9134 override these strings or create their own.  Note that individual
9135 targets can also add their own spec strings to this list.
9137 @smallexample
9138 asm          Options to pass to the assembler
9139 asm_final    Options to pass to the assembler post-processor
9140 cpp          Options to pass to the C preprocessor
9141 cc1          Options to pass to the C compiler
9142 cc1plus      Options to pass to the C++ compiler
9143 endfile      Object files to include at the end of the link
9144 link         Options to pass to the linker
9145 lib          Libraries to include on the command line to the linker
9146 libgcc       Decides which GCC support library to pass to the linker
9147 linker       Sets the name of the linker
9148 predefines   Defines to be passed to the C preprocessor
9149 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9150              by default
9151 startfile    Object files to include at the start of the link
9152 @end smallexample
9154 Here is a small example of a spec file:
9156 @smallexample
9157 %rename lib                 old_lib
9159 *lib:
9160 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9161 @end smallexample
9163 This example renames the spec called @samp{lib} to @samp{old_lib} and
9164 then overrides the previous definition of @samp{lib} with a new one.
9165 The new definition adds in some extra command-line options before
9166 including the text of the old definition.
9168 @dfn{Spec strings} are a list of command-line options to be passed to their
9169 corresponding program.  In addition, the spec strings can contain
9170 @samp{%}-prefixed sequences to substitute variable text or to
9171 conditionally insert text into the command line.  Using these constructs
9172 it is possible to generate quite complex command lines.
9174 Here is a table of all defined @samp{%}-sequences for spec
9175 strings.  Note that spaces are not generated automatically around the
9176 results of expanding these sequences.  Therefore you can concatenate them
9177 together or combine them with constant text in a single argument.
9179 @table @code
9180 @item %%
9181 Substitute one @samp{%} into the program name or argument.
9183 @item %i
9184 Substitute the name of the input file being processed.
9186 @item %b
9187 Substitute the basename of the input file being processed.
9188 This is the substring up to (and not including) the last period
9189 and not including the directory.
9191 @item %B
9192 This is the same as @samp{%b}, but include the file suffix (text after
9193 the last period).
9195 @item %d
9196 Marks the argument containing or following the @samp{%d} as a
9197 temporary file name, so that that file will be deleted if GCC exits
9198 successfully.  Unlike @samp{%g}, this contributes no text to the
9199 argument.
9201 @item %g@var{suffix}
9202 Substitute a file name that has suffix @var{suffix} and is chosen
9203 once per compilation, and mark the argument in the same way as
9204 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9205 name is now chosen in a way that is hard to predict even when previously
9206 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9207 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9208 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9209 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9210 was simply substituted with a file name chosen once per compilation,
9211 without regard to any appended suffix (which was therefore treated
9212 just like ordinary text), making such attacks more likely to succeed.
9214 @item %u@var{suffix}
9215 Like @samp{%g}, but generates a new temporary file name even if
9216 @samp{%u@var{suffix}} was already seen.
9218 @item %U@var{suffix}
9219 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9220 new one if there is no such last file name.  In the absence of any
9221 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9222 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9223 would involve the generation of two distinct file names, one
9224 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9225 simply substituted with a file name chosen for the previous @samp{%u},
9226 without regard to any appended suffix.
9228 @item %j@var{suffix}
9229 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9230 writable, and if save-temps is off; otherwise, substitute the name
9231 of a temporary file, just like @samp{%u}.  This temporary file is not
9232 meant for communication between processes, but rather as a junk
9233 disposal mechanism.
9235 @item %|@var{suffix}
9236 @itemx %m@var{suffix}
9237 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9238 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9239 all.  These are the two most common ways to instruct a program that it
9240 should read from standard input or write to standard output.  If you
9241 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9242 construct: see for example @file{f/lang-specs.h}.
9244 @item %.@var{SUFFIX}
9245 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9246 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9247 terminated by the next space or %.
9249 @item %w
9250 Marks the argument containing or following the @samp{%w} as the
9251 designated output file of this compilation.  This puts the argument
9252 into the sequence of arguments that @samp{%o} will substitute later.
9254 @item %o
9255 Substitutes the names of all the output files, with spaces
9256 automatically placed around them.  You should write spaces
9257 around the @samp{%o} as well or the results are undefined.
9258 @samp{%o} is for use in the specs for running the linker.
9259 Input files whose names have no recognized suffix are not compiled
9260 at all, but they are included among the output files, so they will
9261 be linked.
9263 @item %O
9264 Substitutes the suffix for object files.  Note that this is
9265 handled specially when it immediately follows @samp{%g, %u, or %U},
9266 because of the need for those to form complete file names.  The
9267 handling is such that @samp{%O} is treated exactly as if it had already
9268 been substituted, except that @samp{%g, %u, and %U} do not currently
9269 support additional @var{suffix} characters following @samp{%O} as they would
9270 following, for example, @samp{.o}.
9272 @item %p
9273 Substitutes the standard macro predefinitions for the
9274 current target machine.  Use this when running @code{cpp}.
9276 @item %P
9277 Like @samp{%p}, but puts @samp{__} before and after the name of each
9278 predefined macro, except for macros that start with @samp{__} or with
9279 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9282 @item %I
9283 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9284 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9285 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9286 and @option{-imultilib} as necessary.
9288 @item %s
9289 Current argument is the name of a library or startup file of some sort.
9290 Search for that file in a standard list of directories and substitute
9291 the full name found.  The current working directory is included in the
9292 list of directories scanned.
9294 @item %T
9295 Current argument is the name of a linker script.  Search for that file
9296 in the current list of directories to scan for libraries. If the file
9297 is located insert a @option{--script} option into the command line
9298 followed by the full path name found.  If the file is not found then
9299 generate an error message.  Note: the current working directory is not
9300 searched.
9302 @item %e@var{str}
9303 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9304 Use this when inconsistent options are detected.
9306 @item %(@var{name})
9307 Substitute the contents of spec string @var{name} at this point.
9309 @item %[@var{name}]
9310 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9312 @item %x@{@var{option}@}
9313 Accumulate an option for @samp{%X}.
9315 @item %X
9316 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9317 spec string.
9319 @item %Y
9320 Output the accumulated assembler options specified by @option{-Wa}.
9322 @item %Z
9323 Output the accumulated preprocessor options specified by @option{-Wp}.
9325 @item %a
9326 Process the @code{asm} spec.  This is used to compute the
9327 switches to be passed to the assembler.
9329 @item %A
9330 Process the @code{asm_final} spec.  This is a spec string for
9331 passing switches to an assembler post-processor, if such a program is
9332 needed.
9334 @item %l
9335 Process the @code{link} spec.  This is the spec for computing the
9336 command line passed to the linker.  Typically it will make use of the
9337 @samp{%L %G %S %D and %E} sequences.
9339 @item %D
9340 Dump out a @option{-L} option for each directory that GCC believes might
9341 contain startup files.  If the target supports multilibs then the
9342 current multilib directory will be prepended to each of these paths.
9344 @item %L
9345 Process the @code{lib} spec.  This is a spec string for deciding which
9346 libraries should be included on the command line to the linker.
9348 @item %G
9349 Process the @code{libgcc} spec.  This is a spec string for deciding
9350 which GCC support library should be included on the command line to the linker.
9352 @item %S
9353 Process the @code{startfile} spec.  This is a spec for deciding which
9354 object files should be the first ones passed to the linker.  Typically
9355 this might be a file named @file{crt0.o}.
9357 @item %E
9358 Process the @code{endfile} spec.  This is a spec string that specifies
9359 the last object files that will be passed to the linker.
9361 @item %C
9362 Process the @code{cpp} spec.  This is used to construct the arguments
9363 to be passed to the C preprocessor.
9365 @item %1
9366 Process the @code{cc1} spec.  This is used to construct the options to be
9367 passed to the actual C compiler (@samp{cc1}).
9369 @item %2
9370 Process the @code{cc1plus} spec.  This is used to construct the options to be
9371 passed to the actual C++ compiler (@samp{cc1plus}).
9373 @item %*
9374 Substitute the variable part of a matched option.  See below.
9375 Note that each comma in the substituted string is replaced by
9376 a single space.
9378 @item %<@code{S}
9379 Remove all occurrences of @code{-S} from the command line.  Note---this
9380 command is position dependent.  @samp{%} commands in the spec string
9381 before this one will see @code{-S}, @samp{%} commands in the spec string
9382 after this one will not.
9384 @item %:@var{function}(@var{args})
9385 Call the named function @var{function}, passing it @var{args}.
9386 @var{args} is first processed as a nested spec string, then split
9387 into an argument vector in the usual fashion.  The function returns
9388 a string which is processed as if it had appeared literally as part
9389 of the current spec.
9391 The following built-in spec functions are provided:
9393 @table @code
9394 @item @code{getenv}
9395 The @code{getenv} spec function takes two arguments: an environment
9396 variable name and a string.  If the environment variable is not
9397 defined, a fatal error is issued.  Otherwise, the return value is the
9398 value of the environment variable concatenated with the string.  For
9399 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9401 @smallexample
9402 %:getenv(TOPDIR /include)
9403 @end smallexample
9405 expands to @file{/path/to/top/include}.
9407 @item @code{if-exists}
9408 The @code{if-exists} spec function takes one argument, an absolute
9409 pathname to a file.  If the file exists, @code{if-exists} returns the
9410 pathname.  Here is a small example of its usage:
9412 @smallexample
9413 *startfile:
9414 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9415 @end smallexample
9417 @item @code{if-exists-else}
9418 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9419 spec function, except that it takes two arguments.  The first argument is
9420 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9421 returns the pathname.  If it does not exist, it returns the second argument.
9422 This way, @code{if-exists-else} can be used to select one file or another,
9423 based on the existence of the first.  Here is a small example of its usage:
9425 @smallexample
9426 *startfile:
9427 crt0%O%s %:if-exists(crti%O%s) \
9428 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9429 @end smallexample
9431 @item @code{replace-outfile}
9432 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9433 first argument in the outfiles array and replaces it with the second argument.  Here
9434 is a small example of its usage:
9436 @smallexample
9437 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9438 @end smallexample
9440 @item @code{print-asm-header}
9441 The @code{print-asm-header} function takes no arguments and simply
9442 prints a banner like:
9444 @smallexample
9445 Assembler options
9446 =================
9448 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9449 @end smallexample
9451 It is used to separate compiler options from assembler options
9452 in the @option{--target-help} output.
9453 @end table
9455 @item %@{@code{S}@}
9456 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9457 If that switch was not specified, this substitutes nothing.  Note that
9458 the leading dash is omitted when specifying this option, and it is
9459 automatically inserted if the substitution is performed.  Thus the spec
9460 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9461 and would output the command line option @option{-foo}.
9463 @item %W@{@code{S}@}
9464 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9465 deleted on failure.
9467 @item %@{@code{S}*@}
9468 Substitutes all the switches specified to GCC whose names start
9469 with @code{-S}, but which also take an argument.  This is used for
9470 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9471 GCC considers @option{-o foo} as being
9472 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9473 text, including the space.  Thus two arguments would be generated.
9475 @item %@{@code{S}*&@code{T}*@}
9476 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9477 (the order of @code{S} and @code{T} in the spec is not significant).
9478 There can be any number of ampersand-separated variables; for each the
9479 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9481 @item %@{@code{S}:@code{X}@}
9482 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9484 @item %@{!@code{S}:@code{X}@}
9485 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9487 @item %@{@code{S}*:@code{X}@}
9488 Substitutes @code{X} if one or more switches whose names start with
9489 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9490 once, no matter how many such switches appeared.  However, if @code{%*}
9491 appears somewhere in @code{X}, then @code{X} will be substituted once
9492 for each matching switch, with the @code{%*} replaced by the part of
9493 that switch that matched the @code{*}.
9495 @item %@{.@code{S}:@code{X}@}
9496 Substitutes @code{X}, if processing a file with suffix @code{S}.
9498 @item %@{!.@code{S}:@code{X}@}
9499 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9501 @item %@{,@code{S}:@code{X}@}
9502 Substitutes @code{X}, if processing a file for language @code{S}.
9504 @item %@{!,@code{S}:@code{X}@}
9505 Substitutes @code{X}, if not processing a file for language @code{S}.
9507 @item %@{@code{S}|@code{P}:@code{X}@}
9508 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9509 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9510 @code{*} sequences as well, although they have a stronger binding than
9511 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9512 alternatives must be starred, and only the first matching alternative
9513 is substituted.
9515 For example, a spec string like this:
9517 @smallexample
9518 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9519 @end smallexample
9521 will output the following command-line options from the following input
9522 command-line options:
9524 @smallexample
9525 fred.c        -foo -baz
9526 jim.d         -bar -boggle
9527 -d fred.c     -foo -baz -boggle
9528 -d jim.d      -bar -baz -boggle
9529 @end smallexample
9531 @item %@{S:X; T:Y; :D@}
9533 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9534 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9535 be as many clauses as you need.  This may be combined with @code{.},
9536 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9539 @end table
9541 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9542 construct may contain other nested @samp{%} constructs or spaces, or
9543 even newlines.  They are processed as usual, as described above.
9544 Trailing white space in @code{X} is ignored.  White space may also
9545 appear anywhere on the left side of the colon in these constructs,
9546 except between @code{.} or @code{*} and the corresponding word.
9548 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9549 handled specifically in these constructs.  If another value of
9550 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9551 @option{-W} switch is found later in the command line, the earlier
9552 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9553 just one letter, which passes all matching options.
9555 The character @samp{|} at the beginning of the predicate text is used to
9556 indicate that a command should be piped to the following command, but
9557 only if @option{-pipe} is specified.
9559 It is built into GCC which switches take arguments and which do not.
9560 (You might think it would be useful to generalize this to allow each
9561 compiler's spec to say which switches take arguments.  But this cannot
9562 be done in a consistent fashion.  GCC cannot even decide which input
9563 files have been specified without knowing which switches take arguments,
9564 and it must know which input files to compile in order to tell which
9565 compilers to run).
9567 GCC also knows implicitly that arguments starting in @option{-l} are to be
9568 treated as compiler output files, and passed to the linker in their
9569 proper position among the other output files.
9571 @c man begin OPTIONS
9573 @node Target Options
9574 @section Specifying Target Machine and Compiler Version
9575 @cindex target options
9576 @cindex cross compiling
9577 @cindex specifying machine version
9578 @cindex specifying compiler version and target machine
9579 @cindex compiler version, specifying
9580 @cindex target machine, specifying
9582 The usual way to run GCC is to run the executable called @file{gcc}, or
9583 @file{<machine>-gcc} when cross-compiling, or
9584 @file{<machine>-gcc-<version>} to run a version other than the one that
9585 was installed last.
9587 @node Submodel Options
9588 @section Hardware Models and Configurations
9589 @cindex submodel options
9590 @cindex specifying hardware config
9591 @cindex hardware models and configurations, specifying
9592 @cindex machine dependent options
9594 Each target machine types can have its own
9595 special options, starting with @samp{-m}, to choose among various
9596 hardware models or configurations---for example, 68010 vs 68020,
9597 floating coprocessor or none.  A single installed version of the
9598 compiler can compile for any model or configuration, according to the
9599 options specified.
9601 Some configurations of the compiler also support additional special
9602 options, usually for compatibility with other compilers on the same
9603 platform.
9605 @c This list is ordered alphanumerically by subsection name.
9606 @c It should be the same order and spelling as these options are listed
9607 @c in Machine Dependent Options
9609 @menu
9610 * ARC Options::
9611 * ARM Options::
9612 * AVR Options::
9613 * Blackfin Options::
9614 * CRIS Options::
9615 * CRX Options::
9616 * Darwin Options::
9617 * DEC Alpha Options::
9618 * DEC Alpha/VMS Options::
9619 * FR30 Options::
9620 * FRV Options::
9621 * GNU/Linux Options::
9622 * H8/300 Options::
9623 * HPPA Options::
9624 * i386 and x86-64 Options::
9625 * i386 and x86-64 Windows Options::
9626 * IA-64 Options::
9627 * IA-64/VMS Options::
9628 * LM32 Options::
9629 * M32C Options::
9630 * M32R/D Options::
9631 * M680x0 Options::
9632 * M68hc1x Options::
9633 * MCore Options::
9634 * MeP Options::
9635 * MIPS Options::
9636 * MMIX Options::
9637 * MN10300 Options::
9638 * PDP-11 Options::
9639 * picoChip Options::
9640 * PowerPC Options::
9641 * RS/6000 and PowerPC Options::
9642 * RX Options::
9643 * S/390 and zSeries Options::
9644 * Score Options::
9645 * SH Options::
9646 * SPARC Options::
9647 * SPU Options::
9648 * System V Options::
9649 * V850 Options::
9650 * VAX Options::
9651 * VxWorks Options::
9652 * x86-64 Options::
9653 * Xstormy16 Options::
9654 * Xtensa Options::
9655 * zSeries Options::
9656 @end menu
9658 @node ARC Options
9659 @subsection ARC Options
9660 @cindex ARC Options
9662 These options are defined for ARC implementations:
9664 @table @gcctabopt
9665 @item -EL
9666 @opindex EL
9667 Compile code for little endian mode.  This is the default.
9669 @item -EB
9670 @opindex EB
9671 Compile code for big endian mode.
9673 @item -mmangle-cpu
9674 @opindex mmangle-cpu
9675 Prepend the name of the cpu to all public symbol names.
9676 In multiple-processor systems, there are many ARC variants with different
9677 instruction and register set characteristics.  This flag prevents code
9678 compiled for one cpu to be linked with code compiled for another.
9679 No facility exists for handling variants that are ``almost identical''.
9680 This is an all or nothing option.
9682 @item -mcpu=@var{cpu}
9683 @opindex mcpu
9684 Compile code for ARC variant @var{cpu}.
9685 Which variants are supported depend on the configuration.
9686 All variants support @option{-mcpu=base}, this is the default.
9688 @item -mtext=@var{text-section}
9689 @itemx -mdata=@var{data-section}
9690 @itemx -mrodata=@var{readonly-data-section}
9691 @opindex mtext
9692 @opindex mdata
9693 @opindex mrodata
9694 Put functions, data, and readonly data in @var{text-section},
9695 @var{data-section}, and @var{readonly-data-section} respectively
9696 by default.  This can be overridden with the @code{section} attribute.
9697 @xref{Variable Attributes}.
9699 @item -mfix-cortex-m3-ldrd
9700 @opindex mfix-cortex-m3-ldrd
9701 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
9702 with overlapping destination and base registers are used.  This option avoids
9703 generating these instructions.  This option is enabled by default when
9704 @option{-mcpu=cortex-m3} is specified.
9706 @end table
9708 @node ARM Options
9709 @subsection ARM Options
9710 @cindex ARM options
9712 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9713 architectures:
9715 @table @gcctabopt
9716 @item -mabi=@var{name}
9717 @opindex mabi
9718 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9719 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9721 @item -mapcs-frame
9722 @opindex mapcs-frame
9723 Generate a stack frame that is compliant with the ARM Procedure Call
9724 Standard for all functions, even if this is not strictly necessary for
9725 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9726 with this option will cause the stack frames not to be generated for
9727 leaf functions.  The default is @option{-mno-apcs-frame}.
9729 @item -mapcs
9730 @opindex mapcs
9731 This is a synonym for @option{-mapcs-frame}.
9733 @ignore
9734 @c not currently implemented
9735 @item -mapcs-stack-check
9736 @opindex mapcs-stack-check
9737 Generate code to check the amount of stack space available upon entry to
9738 every function (that actually uses some stack space).  If there is
9739 insufficient space available then either the function
9740 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9741 called, depending upon the amount of stack space required.  The run time
9742 system is required to provide these functions.  The default is
9743 @option{-mno-apcs-stack-check}, since this produces smaller code.
9745 @c not currently implemented
9746 @item -mapcs-float
9747 @opindex mapcs-float
9748 Pass floating point arguments using the float point registers.  This is
9749 one of the variants of the APCS@.  This option is recommended if the
9750 target hardware has a floating point unit or if a lot of floating point
9751 arithmetic is going to be performed by the code.  The default is
9752 @option{-mno-apcs-float}, since integer only code is slightly increased in
9753 size if @option{-mapcs-float} is used.
9755 @c not currently implemented
9756 @item -mapcs-reentrant
9757 @opindex mapcs-reentrant
9758 Generate reentrant, position independent code.  The default is
9759 @option{-mno-apcs-reentrant}.
9760 @end ignore
9762 @item -mthumb-interwork
9763 @opindex mthumb-interwork
9764 Generate code which supports calling between the ARM and Thumb
9765 instruction sets.  Without this option the two instruction sets cannot
9766 be reliably used inside one program.  The default is
9767 @option{-mno-thumb-interwork}, since slightly larger code is generated
9768 when @option{-mthumb-interwork} is specified.
9770 @item -mno-sched-prolog
9771 @opindex mno-sched-prolog
9772 Prevent the reordering of instructions in the function prolog, or the
9773 merging of those instruction with the instructions in the function's
9774 body.  This means that all functions will start with a recognizable set
9775 of instructions (or in fact one of a choice from a small set of
9776 different function prologues), and this information can be used to
9777 locate the start if functions inside an executable piece of code.  The
9778 default is @option{-msched-prolog}.
9780 @item -mfloat-abi=@var{name}
9781 @opindex mfloat-abi
9782 Specifies which floating-point ABI to use.  Permissible values
9783 are: @samp{soft}, @samp{softfp} and @samp{hard}.
9785 Specifying @samp{soft} causes GCC to generate output containing
9786 library calls for floating-point operations.
9787 @samp{softfp} allows the generation of code using hardware floating-point
9788 instructions, but still uses the soft-float calling conventions.
9789 @samp{hard} allows generation of floating-point instructions
9790 and uses FPU-specific calling conventions.
9792 The default depends on the specific target configuration.  Note that
9793 the hard-float and soft-float ABIs are not link-compatible; you must
9794 compile your entire program with the same ABI, and link with a
9795 compatible set of libraries.
9797 @item -mhard-float
9798 @opindex mhard-float
9799 Equivalent to @option{-mfloat-abi=hard}.
9801 @item -msoft-float
9802 @opindex msoft-float
9803 Equivalent to @option{-mfloat-abi=soft}.
9805 @item -mlittle-endian
9806 @opindex mlittle-endian
9807 Generate code for a processor running in little-endian mode.  This is
9808 the default for all standard configurations.
9810 @item -mbig-endian
9811 @opindex mbig-endian
9812 Generate code for a processor running in big-endian mode; the default is
9813 to compile code for a little-endian processor.
9815 @item -mwords-little-endian
9816 @opindex mwords-little-endian
9817 This option only applies when generating code for big-endian processors.
9818 Generate code for a little-endian word order but a big-endian byte
9819 order.  That is, a byte order of the form @samp{32107654}.  Note: this
9820 option should only be used if you require compatibility with code for
9821 big-endian ARM processors generated by versions of the compiler prior to
9822 2.8.
9824 @item -mcpu=@var{name}
9825 @opindex mcpu
9826 This specifies the name of the target ARM processor.  GCC uses this name
9827 to determine what kind of instructions it can emit when generating
9828 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
9829 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
9830 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
9831 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
9832 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
9833 @samp{arm720},
9834 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
9835 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
9836 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
9837 @samp{strongarm1110},
9838 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
9839 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
9840 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
9841 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
9842 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
9843 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
9844 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
9845 @samp{cortex-a5}, @samp{cortex-a8}, @samp{cortex-a9},
9846 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
9847 @samp{cortex-m1},
9848 @samp{cortex-m0},
9849 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9851 @item -mtune=@var{name}
9852 @opindex mtune
9853 This option is very similar to the @option{-mcpu=} option, except that
9854 instead of specifying the actual target processor type, and hence
9855 restricting which instructions can be used, it specifies that GCC should
9856 tune the performance of the code as if the target were of the type
9857 specified in this option, but still choosing the instructions that it
9858 will generate based on the cpu specified by a @option{-mcpu=} option.
9859 For some ARM implementations better performance can be obtained by using
9860 this option.
9862 @item -march=@var{name}
9863 @opindex march
9864 This specifies the name of the target ARM architecture.  GCC uses this
9865 name to determine what kind of instructions it can emit when generating
9866 assembly code.  This option can be used in conjunction with or instead
9867 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
9868 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
9869 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
9870 @samp{armv6}, @samp{armv6j},
9871 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
9872 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
9873 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9875 @item -mfpu=@var{name}
9876 @itemx -mfpe=@var{number}
9877 @itemx -mfp=@var{number}
9878 @opindex mfpu
9879 @opindex mfpe
9880 @opindex mfp
9881 This specifies what floating point hardware (or hardware emulation) is
9882 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
9883 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
9884 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
9885 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
9886 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
9887 @option{-mfp} and @option{-mfpe} are synonyms for
9888 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
9889 of GCC@.
9891 If @option{-msoft-float} is specified this specifies the format of
9892 floating point values.
9894 @item -mfp16-format=@var{name}
9895 @opindex mfp16-format
9896 Specify the format of the @code{__fp16} half-precision floating-point type.
9897 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
9898 the default is @samp{none}, in which case the @code{__fp16} type is not
9899 defined.  @xref{Half-Precision}, for more information.
9901 @item -mstructure-size-boundary=@var{n}
9902 @opindex mstructure-size-boundary
9903 The size of all structures and unions will be rounded up to a multiple
9904 of the number of bits set by this option.  Permissible values are 8, 32
9905 and 64.  The default value varies for different toolchains.  For the COFF
9906 targeted toolchain the default value is 8.  A value of 64 is only allowed
9907 if the underlying ABI supports it.
9909 Specifying the larger number can produce faster, more efficient code, but
9910 can also increase the size of the program.  Different values are potentially
9911 incompatible.  Code compiled with one value cannot necessarily expect to
9912 work with code or libraries compiled with another value, if they exchange
9913 information using structures or unions.
9915 @item -mabort-on-noreturn
9916 @opindex mabort-on-noreturn
9917 Generate a call to the function @code{abort} at the end of a
9918 @code{noreturn} function.  It will be executed if the function tries to
9919 return.
9921 @item -mlong-calls
9922 @itemx -mno-long-calls
9923 @opindex mlong-calls
9924 @opindex mno-long-calls
9925 Tells the compiler to perform function calls by first loading the
9926 address of the function into a register and then performing a subroutine
9927 call on this register.  This switch is needed if the target function
9928 will lie outside of the 64 megabyte addressing range of the offset based
9929 version of subroutine call instruction.
9931 Even if this switch is enabled, not all function calls will be turned
9932 into long calls.  The heuristic is that static functions, functions
9933 which have the @samp{short-call} attribute, functions that are inside
9934 the scope of a @samp{#pragma no_long_calls} directive and functions whose
9935 definitions have already been compiled within the current compilation
9936 unit, will not be turned into long calls.  The exception to this rule is
9937 that weak function definitions, functions with the @samp{long-call}
9938 attribute or the @samp{section} attribute, and functions that are within
9939 the scope of a @samp{#pragma long_calls} directive, will always be
9940 turned into long calls.
9942 This feature is not enabled by default.  Specifying
9943 @option{-mno-long-calls} will restore the default behavior, as will
9944 placing the function calls within the scope of a @samp{#pragma
9945 long_calls_off} directive.  Note these switches have no effect on how
9946 the compiler generates code to handle function calls via function
9947 pointers.
9949 @item -msingle-pic-base
9950 @opindex msingle-pic-base
9951 Treat the register used for PIC addressing as read-only, rather than
9952 loading it in the prologue for each function.  The run-time system is
9953 responsible for initializing this register with an appropriate value
9954 before execution begins.
9956 @item -mpic-register=@var{reg}
9957 @opindex mpic-register
9958 Specify the register to be used for PIC addressing.  The default is R10
9959 unless stack-checking is enabled, when R9 is used.
9961 @item -mcirrus-fix-invalid-insns
9962 @opindex mcirrus-fix-invalid-insns
9963 @opindex mno-cirrus-fix-invalid-insns
9964 Insert NOPs into the instruction stream to in order to work around
9965 problems with invalid Maverick instruction combinations.  This option
9966 is only valid if the @option{-mcpu=ep9312} option has been used to
9967 enable generation of instructions for the Cirrus Maverick floating
9968 point co-processor.  This option is not enabled by default, since the
9969 problem is only present in older Maverick implementations.  The default
9970 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
9971 switch.
9973 @item -mpoke-function-name
9974 @opindex mpoke-function-name
9975 Write the name of each function into the text section, directly
9976 preceding the function prologue.  The generated code is similar to this:
9978 @smallexample
9979      t0
9980          .ascii "arm_poke_function_name", 0
9981          .align
9982      t1
9983          .word 0xff000000 + (t1 - t0)
9984      arm_poke_function_name
9985          mov     ip, sp
9986          stmfd   sp!, @{fp, ip, lr, pc@}
9987          sub     fp, ip, #4
9988 @end smallexample
9990 When performing a stack backtrace, code can inspect the value of
9991 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
9992 location @code{pc - 12} and the top 8 bits are set, then we know that
9993 there is a function name embedded immediately preceding this location
9994 and has length @code{((pc[-3]) & 0xff000000)}.
9996 @item -mthumb
9997 @opindex mthumb
9998 Generate code for the Thumb instruction set.  The default is to
9999 use the 32-bit ARM instruction set.
10000 This option automatically enables either 16-bit Thumb-1 or
10001 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
10002 and @option{-march=@var{name}} options.  This option is not passed to the
10003 assembler. If you want to force assembler files to be interpreted as Thumb code,
10004 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
10005 option directly to the assembler by prefixing it with @option{-Wa}.
10007 @item -mtpcs-frame
10008 @opindex mtpcs-frame
10009 Generate a stack frame that is compliant with the Thumb Procedure Call
10010 Standard for all non-leaf functions.  (A leaf function is one that does
10011 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
10013 @item -mtpcs-leaf-frame
10014 @opindex mtpcs-leaf-frame
10015 Generate a stack frame that is compliant with the Thumb Procedure Call
10016 Standard for all leaf functions.  (A leaf function is one that does
10017 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
10019 @item -mcallee-super-interworking
10020 @opindex mcallee-super-interworking
10021 Gives all externally visible functions in the file being compiled an ARM
10022 instruction set header which switches to Thumb mode before executing the
10023 rest of the function.  This allows these functions to be called from
10024 non-interworking code.  This option is not valid in AAPCS configurations
10025 because interworking is enabled by default.
10027 @item -mcaller-super-interworking
10028 @opindex mcaller-super-interworking
10029 Allows calls via function pointers (including virtual functions) to
10030 execute correctly regardless of whether the target code has been
10031 compiled for interworking or not.  There is a small overhead in the cost
10032 of executing a function pointer if this option is enabled.  This option
10033 is not valid in AAPCS configurations because interworking is enabled
10034 by default.
10036 @item -mtp=@var{name}
10037 @opindex mtp
10038 Specify the access model for the thread local storage pointer.  The valid
10039 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
10040 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
10041 (supported in the arm6k architecture), and @option{auto}, which uses the
10042 best available method for the selected processor.  The default setting is
10043 @option{auto}.
10045 @item -mword-relocations
10046 @opindex mword-relocations
10047 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
10048 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
10049 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
10050 is specified.
10052 @end table
10054 @node AVR Options
10055 @subsection AVR Options
10056 @cindex AVR Options
10058 These options are defined for AVR implementations:
10060 @table @gcctabopt
10061 @item -mmcu=@var{mcu}
10062 @opindex mmcu
10063 Specify ATMEL AVR instruction set or MCU type.
10065 Instruction set avr1 is for the minimal AVR core, not supported by the C
10066 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10067 attiny11, attiny12, attiny15, attiny28).
10069 Instruction set avr2 (default) is for the classic AVR core with up to
10070 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10071 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10072 at90c8534, at90s8535).
10074 Instruction set avr3 is for the classic AVR core with up to 128K program
10075 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10077 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10078 memory space (MCU types: atmega8, atmega83, atmega85).
10080 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10081 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10082 atmega64, atmega128, at43usb355, at94k).
10084 @item -mno-interrupts
10085 @opindex mno-interrupts
10086 Generated code is not compatible with hardware interrupts.
10087 Code size will be smaller.
10089 @item -mcall-prologues
10090 @opindex mcall-prologues
10091 Functions prologues/epilogues expanded as call to appropriate
10092 subroutines.  Code size will be smaller.
10094 @item -mtiny-stack
10095 @opindex mtiny-stack
10096 Change only the low 8 bits of the stack pointer.
10098 @item -mint8
10099 @opindex mint8
10100 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10101 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10102 and long long will be 4 bytes.  Please note that this option does not
10103 comply to the C standards, but it will provide you with smaller code
10104 size.
10105 @end table
10107 @node Blackfin Options
10108 @subsection Blackfin Options
10109 @cindex Blackfin Options
10111 @table @gcctabopt
10112 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10113 @opindex mcpu=
10114 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
10115 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10116 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10117 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10118 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10119 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10120 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10121 @samp{bf561}.
10122 The optional @var{sirevision} specifies the silicon revision of the target
10123 Blackfin processor.  Any workarounds available for the targeted silicon revision
10124 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
10125 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10126 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
10127 hexadecimal digits representing the major and minor numbers in the silicon
10128 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10129 is not defined.  If @var{sirevision} is @samp{any}, the
10130 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10131 If this optional @var{sirevision} is not used, GCC assumes the latest known
10132 silicon revision of the targeted Blackfin processor.
10134 Support for @samp{bf561} is incomplete.  For @samp{bf561},
10135 Only the processor macro is defined.
10136 Without this option, @samp{bf532} is used as the processor by default.
10137 The corresponding predefined processor macros for @var{cpu} is to
10138 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10139 provided by libgloss to be linked in if @option{-msim} is not given.
10141 @item -msim
10142 @opindex msim
10143 Specifies that the program will be run on the simulator.  This causes
10144 the simulator BSP provided by libgloss to be linked in.  This option
10145 has effect only for @samp{bfin-elf} toolchain.
10146 Certain other options, such as @option{-mid-shared-library} and
10147 @option{-mfdpic}, imply @option{-msim}.
10149 @item -momit-leaf-frame-pointer
10150 @opindex momit-leaf-frame-pointer
10151 Don't keep the frame pointer in a register for leaf functions.  This
10152 avoids the instructions to save, set up and restore frame pointers and
10153 makes an extra register available in leaf functions.  The option
10154 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10155 which might make debugging harder.
10157 @item -mspecld-anomaly
10158 @opindex mspecld-anomaly
10159 When enabled, the compiler will ensure that the generated code does not
10160 contain speculative loads after jump instructions. If this option is used,
10161 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10163 @item -mno-specld-anomaly
10164 @opindex mno-specld-anomaly
10165 Don't generate extra code to prevent speculative loads from occurring.
10167 @item -mcsync-anomaly
10168 @opindex mcsync-anomaly
10169 When enabled, the compiler will ensure that the generated code does not
10170 contain CSYNC or SSYNC instructions too soon after conditional branches.
10171 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10173 @item -mno-csync-anomaly
10174 @opindex mno-csync-anomaly
10175 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10176 occurring too soon after a conditional branch.
10178 @item -mlow-64k
10179 @opindex mlow-64k
10180 When enabled, the compiler is free to take advantage of the knowledge that
10181 the entire program fits into the low 64k of memory.
10183 @item -mno-low-64k
10184 @opindex mno-low-64k
10185 Assume that the program is arbitrarily large.  This is the default.
10187 @item -mstack-check-l1
10188 @opindex mstack-check-l1
10189 Do stack checking using information placed into L1 scratchpad memory by the
10190 uClinux kernel.
10192 @item -mid-shared-library
10193 @opindex mid-shared-library
10194 Generate code that supports shared libraries via the library ID method.
10195 This allows for execute in place and shared libraries in an environment
10196 without virtual memory management.  This option implies @option{-fPIC}.
10197 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10199 @item -mno-id-shared-library
10200 @opindex mno-id-shared-library
10201 Generate code that doesn't assume ID based shared libraries are being used.
10202 This is the default.
10204 @item -mleaf-id-shared-library
10205 @opindex mleaf-id-shared-library
10206 Generate code that supports shared libraries via the library ID method,
10207 but assumes that this library or executable won't link against any other
10208 ID shared libraries.  That allows the compiler to use faster code for jumps
10209 and calls.
10211 @item -mno-leaf-id-shared-library
10212 @opindex mno-leaf-id-shared-library
10213 Do not assume that the code being compiled won't link against any ID shared
10214 libraries.  Slower code will be generated for jump and call insns.
10216 @item -mshared-library-id=n
10217 @opindex mshared-library-id
10218 Specified the identification number of the ID based shared library being
10219 compiled.  Specifying a value of 0 will generate more compact code, specifying
10220 other values will force the allocation of that number to the current
10221 library but is no more space or time efficient than omitting this option.
10223 @item -msep-data
10224 @opindex msep-data
10225 Generate code that allows the data segment to be located in a different
10226 area of memory from the text segment.  This allows for execute in place in
10227 an environment without virtual memory management by eliminating relocations
10228 against the text section.
10230 @item -mno-sep-data
10231 @opindex mno-sep-data
10232 Generate code that assumes that the data segment follows the text segment.
10233 This is the default.
10235 @item -mlong-calls
10236 @itemx -mno-long-calls
10237 @opindex mlong-calls
10238 @opindex mno-long-calls
10239 Tells the compiler to perform function calls by first loading the
10240 address of the function into a register and then performing a subroutine
10241 call on this register.  This switch is needed if the target function
10242 will lie outside of the 24 bit addressing range of the offset based
10243 version of subroutine call instruction.
10245 This feature is not enabled by default.  Specifying
10246 @option{-mno-long-calls} will restore the default behavior.  Note these
10247 switches have no effect on how the compiler generates code to handle
10248 function calls via function pointers.
10250 @item -mfast-fp
10251 @opindex mfast-fp
10252 Link with the fast floating-point library. This library relaxes some of
10253 the IEEE floating-point standard's rules for checking inputs against
10254 Not-a-Number (NAN), in the interest of performance.
10256 @item -minline-plt
10257 @opindex minline-plt
10258 Enable inlining of PLT entries in function calls to functions that are
10259 not known to bind locally.  It has no effect without @option{-mfdpic}.
10261 @item -mmulticore
10262 @opindex mmulticore
10263 Build standalone application for multicore Blackfin processor. Proper
10264 start files and link scripts will be used to support multicore.
10265 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10266 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10267 @option{-mcorea} or @option{-mcoreb}. If it's used without
10268 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10269 programming model is used. In this model, the main function of Core B
10270 should be named as coreb_main. If it's used with @option{-mcorea} or
10271 @option{-mcoreb}, one application per core programming model is used.
10272 If this option is not used, single core application programming
10273 model is used.
10275 @item -mcorea
10276 @opindex mcorea
10277 Build standalone application for Core A of BF561 when using
10278 one application per core programming model. Proper start files
10279 and link scripts will be used to support Core A. This option
10280 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10282 @item -mcoreb
10283 @opindex mcoreb
10284 Build standalone application for Core B of BF561 when using
10285 one application per core programming model. Proper start files
10286 and link scripts will be used to support Core B. This option
10287 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10288 should be used instead of main. It must be used with
10289 @option{-mmulticore}.
10291 @item -msdram
10292 @opindex msdram
10293 Build standalone application for SDRAM. Proper start files and
10294 link scripts will be used to put the application into SDRAM.
10295 Loader should initialize SDRAM before loading the application
10296 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10298 @item -micplb
10299 @opindex micplb
10300 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
10301 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
10302 are enabled; for standalone applications the default is off.
10303 @end table
10305 @node CRIS Options
10306 @subsection CRIS Options
10307 @cindex CRIS Options
10309 These options are defined specifically for the CRIS ports.
10311 @table @gcctabopt
10312 @item -march=@var{architecture-type}
10313 @itemx -mcpu=@var{architecture-type}
10314 @opindex march
10315 @opindex mcpu
10316 Generate code for the specified architecture.  The choices for
10317 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10318 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10319 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10320 @samp{v10}.
10322 @item -mtune=@var{architecture-type}
10323 @opindex mtune
10324 Tune to @var{architecture-type} everything applicable about the generated
10325 code, except for the ABI and the set of available instructions.  The
10326 choices for @var{architecture-type} are the same as for
10327 @option{-march=@var{architecture-type}}.
10329 @item -mmax-stack-frame=@var{n}
10330 @opindex mmax-stack-frame
10331 Warn when the stack frame of a function exceeds @var{n} bytes.
10333 @item -metrax4
10334 @itemx -metrax100
10335 @opindex metrax4
10336 @opindex metrax100
10337 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10338 @option{-march=v3} and @option{-march=v8} respectively.
10340 @item -mmul-bug-workaround
10341 @itemx -mno-mul-bug-workaround
10342 @opindex mmul-bug-workaround
10343 @opindex mno-mul-bug-workaround
10344 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10345 models where it applies.  This option is active by default.
10347 @item -mpdebug
10348 @opindex mpdebug
10349 Enable CRIS-specific verbose debug-related information in the assembly
10350 code.  This option also has the effect to turn off the @samp{#NO_APP}
10351 formatted-code indicator to the assembler at the beginning of the
10352 assembly file.
10354 @item -mcc-init
10355 @opindex mcc-init
10356 Do not use condition-code results from previous instruction; always emit
10357 compare and test instructions before use of condition codes.
10359 @item -mno-side-effects
10360 @opindex mno-side-effects
10361 Do not emit instructions with side-effects in addressing modes other than
10362 post-increment.
10364 @item -mstack-align
10365 @itemx -mno-stack-align
10366 @itemx -mdata-align
10367 @itemx -mno-data-align
10368 @itemx -mconst-align
10369 @itemx -mno-const-align
10370 @opindex mstack-align
10371 @opindex mno-stack-align
10372 @opindex mdata-align
10373 @opindex mno-data-align
10374 @opindex mconst-align
10375 @opindex mno-const-align
10376 These options (no-options) arranges (eliminate arrangements) for the
10377 stack-frame, individual data and constants to be aligned for the maximum
10378 single data access size for the chosen CPU model.  The default is to
10379 arrange for 32-bit alignment.  ABI details such as structure layout are
10380 not affected by these options.
10382 @item -m32-bit
10383 @itemx -m16-bit
10384 @itemx -m8-bit
10385 @opindex m32-bit
10386 @opindex m16-bit
10387 @opindex m8-bit
10388 Similar to the stack- data- and const-align options above, these options
10389 arrange for stack-frame, writable data and constants to all be 32-bit,
10390 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10392 @item -mno-prologue-epilogue
10393 @itemx -mprologue-epilogue
10394 @opindex mno-prologue-epilogue
10395 @opindex mprologue-epilogue
10396 With @option{-mno-prologue-epilogue}, the normal function prologue and
10397 epilogue that sets up the stack-frame are omitted and no return
10398 instructions or return sequences are generated in the code.  Use this
10399 option only together with visual inspection of the compiled code: no
10400 warnings or errors are generated when call-saved registers must be saved,
10401 or storage for local variable needs to be allocated.
10403 @item -mno-gotplt
10404 @itemx -mgotplt
10405 @opindex mno-gotplt
10406 @opindex mgotplt
10407 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10408 instruction sequences that load addresses for functions from the PLT part
10409 of the GOT rather than (traditional on other architectures) calls to the
10410 PLT@.  The default is @option{-mgotplt}.
10412 @item -melf
10413 @opindex melf
10414 Legacy no-op option only recognized with the cris-axis-elf and
10415 cris-axis-linux-gnu targets.
10417 @item -mlinux
10418 @opindex mlinux
10419 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10421 @item -sim
10422 @opindex sim
10423 This option, recognized for the cris-axis-elf arranges
10424 to link with input-output functions from a simulator library.  Code,
10425 initialized data and zero-initialized data are allocated consecutively.
10427 @item -sim2
10428 @opindex sim2
10429 Like @option{-sim}, but pass linker options to locate initialized data at
10430 0x40000000 and zero-initialized data at 0x80000000.
10431 @end table
10433 @node CRX Options
10434 @subsection CRX Options
10435 @cindex CRX Options
10437 These options are defined specifically for the CRX ports.
10439 @table @gcctabopt
10441 @item -mmac
10442 @opindex mmac
10443 Enable the use of multiply-accumulate instructions. Disabled by default.
10445 @item -mpush-args
10446 @opindex mpush-args
10447 Push instructions will be used to pass outgoing arguments when functions
10448 are called. Enabled by default.
10449 @end table
10451 @node Darwin Options
10452 @subsection Darwin Options
10453 @cindex Darwin options
10455 These options are defined for all architectures running the Darwin operating
10456 system.
10458 FSF GCC on Darwin does not create ``fat'' object files; it will create
10459 an object file for the single architecture that it was built to
10460 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10461 @option{-arch} options are used; it does so by running the compiler or
10462 linker multiple times and joining the results together with
10463 @file{lipo}.
10465 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10466 @samp{i686}) is determined by the flags that specify the ISA
10467 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10468 @option{-force_cpusubtype_ALL} option can be used to override this.
10470 The Darwin tools vary in their behavior when presented with an ISA
10471 mismatch.  The assembler, @file{as}, will only permit instructions to
10472 be used that are valid for the subtype of the file it is generating,
10473 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10474 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10475 and print an error if asked to create a shared library with a less
10476 restrictive subtype than its input files (for instance, trying to put
10477 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10478 for executables, @file{ld}, will quietly give the executable the most
10479 restrictive subtype of any of its input files.
10481 @table @gcctabopt
10482 @item -F@var{dir}
10483 @opindex F
10484 Add the framework directory @var{dir} to the head of the list of
10485 directories to be searched for header files.  These directories are
10486 interleaved with those specified by @option{-I} options and are
10487 scanned in a left-to-right order.
10489 A framework directory is a directory with frameworks in it.  A
10490 framework is a directory with a @samp{"Headers"} and/or
10491 @samp{"PrivateHeaders"} directory contained directly in it that ends
10492 in @samp{".framework"}.  The name of a framework is the name of this
10493 directory excluding the @samp{".framework"}.  Headers associated with
10494 the framework are found in one of those two directories, with
10495 @samp{"Headers"} being searched first.  A subframework is a framework
10496 directory that is in a framework's @samp{"Frameworks"} directory.
10497 Includes of subframework headers can only appear in a header of a
10498 framework that contains the subframework, or in a sibling subframework
10499 header.  Two subframeworks are siblings if they occur in the same
10500 framework.  A subframework should not have the same name as a
10501 framework, a warning will be issued if this is violated.  Currently a
10502 subframework cannot have subframeworks, in the future, the mechanism
10503 may be extended to support this.  The standard frameworks can be found
10504 in @samp{"/System/Library/Frameworks"} and
10505 @samp{"/Library/Frameworks"}.  An example include looks like
10506 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10507 the name of the framework and header.h is found in the
10508 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10510 @item -iframework@var{dir}
10511 @opindex iframework
10512 Like @option{-F} except the directory is a treated as a system
10513 directory.  The main difference between this @option{-iframework} and
10514 @option{-F} is that with @option{-iframework} the compiler does not
10515 warn about constructs contained within header files found via
10516 @var{dir}.  This option is valid only for the C family of languages.
10518 @item -gused
10519 @opindex gused
10520 Emit debugging information for symbols that are used.  For STABS
10521 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10522 This is by default ON@.
10524 @item -gfull
10525 @opindex gfull
10526 Emit debugging information for all symbols and types.
10528 @item -mmacosx-version-min=@var{version}
10529 The earliest version of MacOS X that this executable will run on
10530 is @var{version}.  Typical values of @var{version} include @code{10.1},
10531 @code{10.2}, and @code{10.3.9}.
10533 If the compiler was built to use the system's headers by default,
10534 then the default for this option is the system version on which the
10535 compiler is running, otherwise the default is to make choices which
10536 are compatible with as many systems and code bases as possible.
10538 @item -mkernel
10539 @opindex mkernel
10540 Enable kernel development mode.  The @option{-mkernel} option sets
10541 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10542 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10543 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10544 applicable.  This mode also sets @option{-mno-altivec},
10545 @option{-msoft-float}, @option{-fno-builtin} and
10546 @option{-mlong-branch} for PowerPC targets.
10548 @item -mone-byte-bool
10549 @opindex mone-byte-bool
10550 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10551 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10552 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10553 option has no effect on x86.
10555 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10556 to generate code that is not binary compatible with code generated
10557 without that switch.  Using this switch may require recompiling all
10558 other modules in a program, including system libraries.  Use this
10559 switch to conform to a non-default data model.
10561 @item -mfix-and-continue
10562 @itemx -ffix-and-continue
10563 @itemx -findirect-data
10564 @opindex mfix-and-continue
10565 @opindex ffix-and-continue
10566 @opindex findirect-data
10567 Generate code suitable for fast turn around development.  Needed to
10568 enable gdb to dynamically load @code{.o} files into already running
10569 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10570 are provided for backwards compatibility.
10572 @item -all_load
10573 @opindex all_load
10574 Loads all members of static archive libraries.
10575 See man ld(1) for more information.
10577 @item -arch_errors_fatal
10578 @opindex arch_errors_fatal
10579 Cause the errors having to do with files that have the wrong architecture
10580 to be fatal.
10582 @item -bind_at_load
10583 @opindex bind_at_load
10584 Causes the output file to be marked such that the dynamic linker will
10585 bind all undefined references when the file is loaded or launched.
10587 @item -bundle
10588 @opindex bundle
10589 Produce a Mach-o bundle format file.
10590 See man ld(1) for more information.
10592 @item -bundle_loader @var{executable}
10593 @opindex bundle_loader
10594 This option specifies the @var{executable} that will be loading the build
10595 output file being linked.  See man ld(1) for more information.
10597 @item -dynamiclib
10598 @opindex dynamiclib
10599 When passed this option, GCC will produce a dynamic library instead of
10600 an executable when linking, using the Darwin @file{libtool} command.
10602 @item -force_cpusubtype_ALL
10603 @opindex force_cpusubtype_ALL
10604 This causes GCC's output file to have the @var{ALL} subtype, instead of
10605 one controlled by the @option{-mcpu} or @option{-march} option.
10607 @item -allowable_client  @var{client_name}
10608 @itemx -client_name
10609 @itemx -compatibility_version
10610 @itemx -current_version
10611 @itemx -dead_strip
10612 @itemx -dependency-file
10613 @itemx -dylib_file
10614 @itemx -dylinker_install_name
10615 @itemx -dynamic
10616 @itemx -exported_symbols_list
10617 @itemx -filelist
10618 @itemx -flat_namespace
10619 @itemx -force_flat_namespace
10620 @itemx -headerpad_max_install_names
10621 @itemx -image_base
10622 @itemx -init
10623 @itemx -install_name
10624 @itemx -keep_private_externs
10625 @itemx -multi_module
10626 @itemx -multiply_defined
10627 @itemx -multiply_defined_unused
10628 @itemx -noall_load
10629 @itemx -no_dead_strip_inits_and_terms
10630 @itemx -nofixprebinding
10631 @itemx -nomultidefs
10632 @itemx -noprebind
10633 @itemx -noseglinkedit
10634 @itemx -pagezero_size
10635 @itemx -prebind
10636 @itemx -prebind_all_twolevel_modules
10637 @itemx -private_bundle
10638 @itemx -read_only_relocs
10639 @itemx -sectalign
10640 @itemx -sectobjectsymbols
10641 @itemx -whyload
10642 @itemx -seg1addr
10643 @itemx -sectcreate
10644 @itemx -sectobjectsymbols
10645 @itemx -sectorder
10646 @itemx -segaddr
10647 @itemx -segs_read_only_addr
10648 @itemx -segs_read_write_addr
10649 @itemx -seg_addr_table
10650 @itemx -seg_addr_table_filename
10651 @itemx -seglinkedit
10652 @itemx -segprot
10653 @itemx -segs_read_only_addr
10654 @itemx -segs_read_write_addr
10655 @itemx -single_module
10656 @itemx -static
10657 @itemx -sub_library
10658 @itemx -sub_umbrella
10659 @itemx -twolevel_namespace
10660 @itemx -umbrella
10661 @itemx -undefined
10662 @itemx -unexported_symbols_list
10663 @itemx -weak_reference_mismatches
10664 @itemx -whatsloaded
10665 @opindex allowable_client
10666 @opindex client_name
10667 @opindex compatibility_version
10668 @opindex current_version
10669 @opindex dead_strip
10670 @opindex dependency-file
10671 @opindex dylib_file
10672 @opindex dylinker_install_name
10673 @opindex dynamic
10674 @opindex exported_symbols_list
10675 @opindex filelist
10676 @opindex flat_namespace
10677 @opindex force_flat_namespace
10678 @opindex headerpad_max_install_names
10679 @opindex image_base
10680 @opindex init
10681 @opindex install_name
10682 @opindex keep_private_externs
10683 @opindex multi_module
10684 @opindex multiply_defined
10685 @opindex multiply_defined_unused
10686 @opindex noall_load
10687 @opindex no_dead_strip_inits_and_terms
10688 @opindex nofixprebinding
10689 @opindex nomultidefs
10690 @opindex noprebind
10691 @opindex noseglinkedit
10692 @opindex pagezero_size
10693 @opindex prebind
10694 @opindex prebind_all_twolevel_modules
10695 @opindex private_bundle
10696 @opindex read_only_relocs
10697 @opindex sectalign
10698 @opindex sectobjectsymbols
10699 @opindex whyload
10700 @opindex seg1addr
10701 @opindex sectcreate
10702 @opindex sectobjectsymbols
10703 @opindex sectorder
10704 @opindex segaddr
10705 @opindex segs_read_only_addr
10706 @opindex segs_read_write_addr
10707 @opindex seg_addr_table
10708 @opindex seg_addr_table_filename
10709 @opindex seglinkedit
10710 @opindex segprot
10711 @opindex segs_read_only_addr
10712 @opindex segs_read_write_addr
10713 @opindex single_module
10714 @opindex static
10715 @opindex sub_library
10716 @opindex sub_umbrella
10717 @opindex twolevel_namespace
10718 @opindex umbrella
10719 @opindex undefined
10720 @opindex unexported_symbols_list
10721 @opindex weak_reference_mismatches
10722 @opindex whatsloaded
10723 These options are passed to the Darwin linker.  The Darwin linker man page
10724 describes them in detail.
10725 @end table
10727 @node DEC Alpha Options
10728 @subsection DEC Alpha Options
10730 These @samp{-m} options are defined for the DEC Alpha implementations:
10732 @table @gcctabopt
10733 @item -mno-soft-float
10734 @itemx -msoft-float
10735 @opindex mno-soft-float
10736 @opindex msoft-float
10737 Use (do not use) the hardware floating-point instructions for
10738 floating-point operations.  When @option{-msoft-float} is specified,
10739 functions in @file{libgcc.a} will be used to perform floating-point
10740 operations.  Unless they are replaced by routines that emulate the
10741 floating-point operations, or compiled in such a way as to call such
10742 emulations routines, these routines will issue floating-point
10743 operations.   If you are compiling for an Alpha without floating-point
10744 operations, you must ensure that the library is built so as not to call
10745 them.
10747 Note that Alpha implementations without floating-point operations are
10748 required to have floating-point registers.
10750 @item -mfp-reg
10751 @itemx -mno-fp-regs
10752 @opindex mfp-reg
10753 @opindex mno-fp-regs
10754 Generate code that uses (does not use) the floating-point register set.
10755 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
10756 register set is not used, floating point operands are passed in integer
10757 registers as if they were integers and floating-point results are passed
10758 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
10759 so any function with a floating-point argument or return value called by code
10760 compiled with @option{-mno-fp-regs} must also be compiled with that
10761 option.
10763 A typical use of this option is building a kernel that does not use,
10764 and hence need not save and restore, any floating-point registers.
10766 @item -mieee
10767 @opindex mieee
10768 The Alpha architecture implements floating-point hardware optimized for
10769 maximum performance.  It is mostly compliant with the IEEE floating
10770 point standard.  However, for full compliance, software assistance is
10771 required.  This option generates code fully IEEE compliant code
10772 @emph{except} that the @var{inexact-flag} is not maintained (see below).
10773 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
10774 defined during compilation.  The resulting code is less efficient but is
10775 able to correctly support denormalized numbers and exceptional IEEE
10776 values such as not-a-number and plus/minus infinity.  Other Alpha
10777 compilers call this option @option{-ieee_with_no_inexact}.
10779 @item -mieee-with-inexact
10780 @opindex mieee-with-inexact
10781 This is like @option{-mieee} except the generated code also maintains
10782 the IEEE @var{inexact-flag}.  Turning on this option causes the
10783 generated code to implement fully-compliant IEEE math.  In addition to
10784 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
10785 macro.  On some Alpha implementations the resulting code may execute
10786 significantly slower than the code generated by default.  Since there is
10787 very little code that depends on the @var{inexact-flag}, you should
10788 normally not specify this option.  Other Alpha compilers call this
10789 option @option{-ieee_with_inexact}.
10791 @item -mfp-trap-mode=@var{trap-mode}
10792 @opindex mfp-trap-mode
10793 This option controls what floating-point related traps are enabled.
10794 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
10795 The trap mode can be set to one of four values:
10797 @table @samp
10798 @item n
10799 This is the default (normal) setting.  The only traps that are enabled
10800 are the ones that cannot be disabled in software (e.g., division by zero
10801 trap).
10803 @item u
10804 In addition to the traps enabled by @samp{n}, underflow traps are enabled
10805 as well.
10807 @item su
10808 Like @samp{u}, but the instructions are marked to be safe for software
10809 completion (see Alpha architecture manual for details).
10811 @item sui
10812 Like @samp{su}, but inexact traps are enabled as well.
10813 @end table
10815 @item -mfp-rounding-mode=@var{rounding-mode}
10816 @opindex mfp-rounding-mode
10817 Selects the IEEE rounding mode.  Other Alpha compilers call this option
10818 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
10821 @table @samp
10822 @item n
10823 Normal IEEE rounding mode.  Floating point numbers are rounded towards
10824 the nearest machine number or towards the even machine number in case
10825 of a tie.
10827 @item m
10828 Round towards minus infinity.
10830 @item c
10831 Chopped rounding mode.  Floating point numbers are rounded towards zero.
10833 @item d
10834 Dynamic rounding mode.  A field in the floating point control register
10835 (@var{fpcr}, see Alpha architecture reference manual) controls the
10836 rounding mode in effect.  The C library initializes this register for
10837 rounding towards plus infinity.  Thus, unless your program modifies the
10838 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
10839 @end table
10841 @item -mtrap-precision=@var{trap-precision}
10842 @opindex mtrap-precision
10843 In the Alpha architecture, floating point traps are imprecise.  This
10844 means without software assistance it is impossible to recover from a
10845 floating trap and program execution normally needs to be terminated.
10846 GCC can generate code that can assist operating system trap handlers
10847 in determining the exact location that caused a floating point trap.
10848 Depending on the requirements of an application, different levels of
10849 precisions can be selected:
10851 @table @samp
10852 @item p
10853 Program precision.  This option is the default and means a trap handler
10854 can only identify which program caused a floating point exception.
10856 @item f
10857 Function precision.  The trap handler can determine the function that
10858 caused a floating point exception.
10860 @item i
10861 Instruction precision.  The trap handler can determine the exact
10862 instruction that caused a floating point exception.
10863 @end table
10865 Other Alpha compilers provide the equivalent options called
10866 @option{-scope_safe} and @option{-resumption_safe}.
10868 @item -mieee-conformant
10869 @opindex mieee-conformant
10870 This option marks the generated code as IEEE conformant.  You must not
10871 use this option unless you also specify @option{-mtrap-precision=i} and either
10872 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
10873 is to emit the line @samp{.eflag 48} in the function prologue of the
10874 generated assembly file.  Under DEC Unix, this has the effect that
10875 IEEE-conformant math library routines will be linked in.
10877 @item -mbuild-constants
10878 @opindex mbuild-constants
10879 Normally GCC examines a 32- or 64-bit integer constant to
10880 see if it can construct it from smaller constants in two or three
10881 instructions.  If it cannot, it will output the constant as a literal and
10882 generate code to load it from the data segment at runtime.
10884 Use this option to require GCC to construct @emph{all} integer constants
10885 using code, even if it takes more instructions (the maximum is six).
10887 You would typically use this option to build a shared library dynamic
10888 loader.  Itself a shared library, it must relocate itself in memory
10889 before it can find the variables and constants in its own data segment.
10891 @item -malpha-as
10892 @itemx -mgas
10893 @opindex malpha-as
10894 @opindex mgas
10895 Select whether to generate code to be assembled by the vendor-supplied
10896 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
10898 @item -mbwx
10899 @itemx -mno-bwx
10900 @itemx -mcix
10901 @itemx -mno-cix
10902 @itemx -mfix
10903 @itemx -mno-fix
10904 @itemx -mmax
10905 @itemx -mno-max
10906 @opindex mbwx
10907 @opindex mno-bwx
10908 @opindex mcix
10909 @opindex mno-cix
10910 @opindex mfix
10911 @opindex mno-fix
10912 @opindex mmax
10913 @opindex mno-max
10914 Indicate whether GCC should generate code to use the optional BWX,
10915 CIX, FIX and MAX instruction sets.  The default is to use the instruction
10916 sets supported by the CPU type specified via @option{-mcpu=} option or that
10917 of the CPU on which GCC was built if none was specified.
10919 @item -mfloat-vax
10920 @itemx -mfloat-ieee
10921 @opindex mfloat-vax
10922 @opindex mfloat-ieee
10923 Generate code that uses (does not use) VAX F and G floating point
10924 arithmetic instead of IEEE single and double precision.
10926 @item -mexplicit-relocs
10927 @itemx -mno-explicit-relocs
10928 @opindex mexplicit-relocs
10929 @opindex mno-explicit-relocs
10930 Older Alpha assemblers provided no way to generate symbol relocations
10931 except via assembler macros.  Use of these macros does not allow
10932 optimal instruction scheduling.  GNU binutils as of version 2.12
10933 supports a new syntax that allows the compiler to explicitly mark
10934 which relocations should apply to which instructions.  This option
10935 is mostly useful for debugging, as GCC detects the capabilities of
10936 the assembler when it is built and sets the default accordingly.
10938 @item -msmall-data
10939 @itemx -mlarge-data
10940 @opindex msmall-data
10941 @opindex mlarge-data
10942 When @option{-mexplicit-relocs} is in effect, static data is
10943 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
10944 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
10945 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
10946 16-bit relocations off of the @code{$gp} register.  This limits the
10947 size of the small data area to 64KB, but allows the variables to be
10948 directly accessed via a single instruction.
10950 The default is @option{-mlarge-data}.  With this option the data area
10951 is limited to just below 2GB@.  Programs that require more than 2GB of
10952 data must use @code{malloc} or @code{mmap} to allocate the data in the
10953 heap instead of in the program's data segment.
10955 When generating code for shared libraries, @option{-fpic} implies
10956 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
10958 @item -msmall-text
10959 @itemx -mlarge-text
10960 @opindex msmall-text
10961 @opindex mlarge-text
10962 When @option{-msmall-text} is used, the compiler assumes that the
10963 code of the entire program (or shared library) fits in 4MB, and is
10964 thus reachable with a branch instruction.  When @option{-msmall-data}
10965 is used, the compiler can assume that all local symbols share the
10966 same @code{$gp} value, and thus reduce the number of instructions
10967 required for a function call from 4 to 1.
10969 The default is @option{-mlarge-text}.
10971 @item -mcpu=@var{cpu_type}
10972 @opindex mcpu
10973 Set the instruction set and instruction scheduling parameters for
10974 machine type @var{cpu_type}.  You can specify either the @samp{EV}
10975 style name or the corresponding chip number.  GCC supports scheduling
10976 parameters for the EV4, EV5 and EV6 family of processors and will
10977 choose the default values for the instruction set from the processor
10978 you specify.  If you do not specify a processor type, GCC will default
10979 to the processor on which the compiler was built.
10981 Supported values for @var{cpu_type} are
10983 @table @samp
10984 @item ev4
10985 @itemx ev45
10986 @itemx 21064
10987 Schedules as an EV4 and has no instruction set extensions.
10989 @item ev5
10990 @itemx 21164
10991 Schedules as an EV5 and has no instruction set extensions.
10993 @item ev56
10994 @itemx 21164a
10995 Schedules as an EV5 and supports the BWX extension.
10997 @item pca56
10998 @itemx 21164pc
10999 @itemx 21164PC
11000 Schedules as an EV5 and supports the BWX and MAX extensions.
11002 @item ev6
11003 @itemx 21264
11004 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
11006 @item ev67
11007 @itemx 21264a
11008 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
11009 @end table
11011 Native Linux/GNU toolchains also support the value @samp{native},
11012 which selects the best architecture option for the host processor.
11013 @option{-mcpu=native} has no effect if GCC does not recognize
11014 the processor.
11016 @item -mtune=@var{cpu_type}
11017 @opindex mtune
11018 Set only the instruction scheduling parameters for machine type
11019 @var{cpu_type}.  The instruction set is not changed.
11021 Native Linux/GNU toolchains also support the value @samp{native},
11022 which selects the best architecture option for the host processor.
11023 @option{-mtune=native} has no effect if GCC does not recognize
11024 the processor.
11026 @item -mmemory-latency=@var{time}
11027 @opindex mmemory-latency
11028 Sets the latency the scheduler should assume for typical memory
11029 references as seen by the application.  This number is highly
11030 dependent on the memory access patterns used by the application
11031 and the size of the external cache on the machine.
11033 Valid options for @var{time} are
11035 @table @samp
11036 @item @var{number}
11037 A decimal number representing clock cycles.
11039 @item L1
11040 @itemx L2
11041 @itemx L3
11042 @itemx main
11043 The compiler contains estimates of the number of clock cycles for
11044 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
11045 (also called Dcache, Scache, and Bcache), as well as to main memory.
11046 Note that L3 is only valid for EV5.
11048 @end table
11049 @end table
11051 @node DEC Alpha/VMS Options
11052 @subsection DEC Alpha/VMS Options
11054 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
11056 @table @gcctabopt
11057 @item -mvms-return-codes
11058 @opindex mvms-return-codes
11059 Return VMS condition codes from main.  The default is to return POSIX
11060 style condition (e.g.@: error) codes.
11062 @item -mdebug-main=@var{prefix}
11063 @opindex mdebug-main=@var{prefix}
11064 Flag the first routine whose name starts with @var{prefix} as the main
11065 routine for the debugger.
11067 @item -mmalloc64
11068 @opindex mmalloc64
11069 Default to 64bit memory allocation routines.
11070 @end table
11072 @node FR30 Options
11073 @subsection FR30 Options
11074 @cindex FR30 Options
11076 These options are defined specifically for the FR30 port.
11078 @table @gcctabopt
11080 @item -msmall-model
11081 @opindex msmall-model
11082 Use the small address space model.  This can produce smaller code, but
11083 it does assume that all symbolic values and addresses will fit into a
11084 20-bit range.
11086 @item -mno-lsim
11087 @opindex mno-lsim
11088 Assume that run-time support has been provided and so there is no need
11089 to include the simulator library (@file{libsim.a}) on the linker
11090 command line.
11092 @end table
11094 @node FRV Options
11095 @subsection FRV Options
11096 @cindex FRV Options
11098 @table @gcctabopt
11099 @item -mgpr-32
11100 @opindex mgpr-32
11102 Only use the first 32 general purpose registers.
11104 @item -mgpr-64
11105 @opindex mgpr-64
11107 Use all 64 general purpose registers.
11109 @item -mfpr-32
11110 @opindex mfpr-32
11112 Use only the first 32 floating point registers.
11114 @item -mfpr-64
11115 @opindex mfpr-64
11117 Use all 64 floating point registers
11119 @item -mhard-float
11120 @opindex mhard-float
11122 Use hardware instructions for floating point operations.
11124 @item -msoft-float
11125 @opindex msoft-float
11127 Use library routines for floating point operations.
11129 @item -malloc-cc
11130 @opindex malloc-cc
11132 Dynamically allocate condition code registers.
11134 @item -mfixed-cc
11135 @opindex mfixed-cc
11137 Do not try to dynamically allocate condition code registers, only
11138 use @code{icc0} and @code{fcc0}.
11140 @item -mdword
11141 @opindex mdword
11143 Change ABI to use double word insns.
11145 @item -mno-dword
11146 @opindex mno-dword
11148 Do not use double word instructions.
11150 @item -mdouble
11151 @opindex mdouble
11153 Use floating point double instructions.
11155 @item -mno-double
11156 @opindex mno-double
11158 Do not use floating point double instructions.
11160 @item -mmedia
11161 @opindex mmedia
11163 Use media instructions.
11165 @item -mno-media
11166 @opindex mno-media
11168 Do not use media instructions.
11170 @item -mmuladd
11171 @opindex mmuladd
11173 Use multiply and add/subtract instructions.
11175 @item -mno-muladd
11176 @opindex mno-muladd
11178 Do not use multiply and add/subtract instructions.
11180 @item -mfdpic
11181 @opindex mfdpic
11183 Select the FDPIC ABI, that uses function descriptors to represent
11184 pointers to functions.  Without any PIC/PIE-related options, it
11185 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
11186 assumes GOT entries and small data are within a 12-bit range from the
11187 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11188 are computed with 32 bits.
11189 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11191 @item -minline-plt
11192 @opindex minline-plt
11194 Enable inlining of PLT entries in function calls to functions that are
11195 not known to bind locally.  It has no effect without @option{-mfdpic}.
11196 It's enabled by default if optimizing for speed and compiling for
11197 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11198 optimization option such as @option{-O3} or above is present in the
11199 command line.
11201 @item -mTLS
11202 @opindex mTLS
11204 Assume a large TLS segment when generating thread-local code.
11206 @item -mtls
11207 @opindex mtls
11209 Do not assume a large TLS segment when generating thread-local code.
11211 @item -mgprel-ro
11212 @opindex mgprel-ro
11214 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11215 that is known to be in read-only sections.  It's enabled by default,
11216 except for @option{-fpic} or @option{-fpie}: even though it may help
11217 make the global offset table smaller, it trades 1 instruction for 4.
11218 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11219 one of which may be shared by multiple symbols, and it avoids the need
11220 for a GOT entry for the referenced symbol, so it's more likely to be a
11221 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
11223 @item -multilib-library-pic
11224 @opindex multilib-library-pic
11226 Link with the (library, not FD) pic libraries.  It's implied by
11227 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11228 @option{-fpic} without @option{-mfdpic}.  You should never have to use
11229 it explicitly.
11231 @item -mlinked-fp
11232 @opindex mlinked-fp
11234 Follow the EABI requirement of always creating a frame pointer whenever
11235 a stack frame is allocated.  This option is enabled by default and can
11236 be disabled with @option{-mno-linked-fp}.
11238 @item -mlong-calls
11239 @opindex mlong-calls
11241 Use indirect addressing to call functions outside the current
11242 compilation unit.  This allows the functions to be placed anywhere
11243 within the 32-bit address space.
11245 @item -malign-labels
11246 @opindex malign-labels
11248 Try to align labels to an 8-byte boundary by inserting nops into the
11249 previous packet.  This option only has an effect when VLIW packing
11250 is enabled.  It doesn't create new packets; it merely adds nops to
11251 existing ones.
11253 @item -mlibrary-pic
11254 @opindex mlibrary-pic
11256 Generate position-independent EABI code.
11258 @item -macc-4
11259 @opindex macc-4
11261 Use only the first four media accumulator registers.
11263 @item -macc-8
11264 @opindex macc-8
11266 Use all eight media accumulator registers.
11268 @item -mpack
11269 @opindex mpack
11271 Pack VLIW instructions.
11273 @item -mno-pack
11274 @opindex mno-pack
11276 Do not pack VLIW instructions.
11278 @item -mno-eflags
11279 @opindex mno-eflags
11281 Do not mark ABI switches in e_flags.
11283 @item -mcond-move
11284 @opindex mcond-move
11286 Enable the use of conditional-move instructions (default).
11288 This switch is mainly for debugging the compiler and will likely be removed
11289 in a future version.
11291 @item -mno-cond-move
11292 @opindex mno-cond-move
11294 Disable the use of conditional-move instructions.
11296 This switch is mainly for debugging the compiler and will likely be removed
11297 in a future version.
11299 @item -mscc
11300 @opindex mscc
11302 Enable the use of conditional set instructions (default).
11304 This switch is mainly for debugging the compiler and will likely be removed
11305 in a future version.
11307 @item -mno-scc
11308 @opindex mno-scc
11310 Disable the use of conditional set instructions.
11312 This switch is mainly for debugging the compiler and will likely be removed
11313 in a future version.
11315 @item -mcond-exec
11316 @opindex mcond-exec
11318 Enable the use of conditional execution (default).
11320 This switch is mainly for debugging the compiler and will likely be removed
11321 in a future version.
11323 @item -mno-cond-exec
11324 @opindex mno-cond-exec
11326 Disable the use of conditional execution.
11328 This switch is mainly for debugging the compiler and will likely be removed
11329 in a future version.
11331 @item -mvliw-branch
11332 @opindex mvliw-branch
11334 Run a pass to pack branches into VLIW instructions (default).
11336 This switch is mainly for debugging the compiler and will likely be removed
11337 in a future version.
11339 @item -mno-vliw-branch
11340 @opindex mno-vliw-branch
11342 Do not run a pass to pack branches into VLIW instructions.
11344 This switch is mainly for debugging the compiler and will likely be removed
11345 in a future version.
11347 @item -mmulti-cond-exec
11348 @opindex mmulti-cond-exec
11350 Enable optimization of @code{&&} and @code{||} in conditional execution
11351 (default).
11353 This switch is mainly for debugging the compiler and will likely be removed
11354 in a future version.
11356 @item -mno-multi-cond-exec
11357 @opindex mno-multi-cond-exec
11359 Disable optimization of @code{&&} and @code{||} in conditional execution.
11361 This switch is mainly for debugging the compiler and will likely be removed
11362 in a future version.
11364 @item -mnested-cond-exec
11365 @opindex mnested-cond-exec
11367 Enable nested conditional execution optimizations (default).
11369 This switch is mainly for debugging the compiler and will likely be removed
11370 in a future version.
11372 @item -mno-nested-cond-exec
11373 @opindex mno-nested-cond-exec
11375 Disable nested conditional execution optimizations.
11377 This switch is mainly for debugging the compiler and will likely be removed
11378 in a future version.
11380 @item -moptimize-membar
11381 @opindex moptimize-membar
11383 This switch removes redundant @code{membar} instructions from the
11384 compiler generated code.  It is enabled by default.
11386 @item -mno-optimize-membar
11387 @opindex mno-optimize-membar
11389 This switch disables the automatic removal of redundant @code{membar}
11390 instructions from the generated code.
11392 @item -mtomcat-stats
11393 @opindex mtomcat-stats
11395 Cause gas to print out tomcat statistics.
11397 @item -mcpu=@var{cpu}
11398 @opindex mcpu
11400 Select the processor type for which to generate code.  Possible values are
11401 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11402 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11404 @end table
11406 @node GNU/Linux Options
11407 @subsection GNU/Linux Options
11409 These @samp{-m} options are defined for GNU/Linux targets:
11411 @table @gcctabopt
11412 @item -mglibc
11413 @opindex mglibc
11414 Use the GNU C library instead of uClibc.  This is the default except
11415 on @samp{*-*-linux-*uclibc*} targets.
11417 @item -muclibc
11418 @opindex muclibc
11419 Use uClibc instead of the GNU C library.  This is the default on
11420 @samp{*-*-linux-*uclibc*} targets.
11421 @end table
11423 @node H8/300 Options
11424 @subsection H8/300 Options
11426 These @samp{-m} options are defined for the H8/300 implementations:
11428 @table @gcctabopt
11429 @item -mrelax
11430 @opindex mrelax
11431 Shorten some address references at link time, when possible; uses the
11432 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11433 ld, Using ld}, for a fuller description.
11435 @item -mh
11436 @opindex mh
11437 Generate code for the H8/300H@.
11439 @item -ms
11440 @opindex ms
11441 Generate code for the H8S@.
11443 @item -mn
11444 @opindex mn
11445 Generate code for the H8S and H8/300H in the normal mode.  This switch
11446 must be used either with @option{-mh} or @option{-ms}.
11448 @item -ms2600
11449 @opindex ms2600
11450 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11452 @item -mint32
11453 @opindex mint32
11454 Make @code{int} data 32 bits by default.
11456 @item -malign-300
11457 @opindex malign-300
11458 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11459 The default for the H8/300H and H8S is to align longs and floats on 4
11460 byte boundaries.
11461 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11462 This option has no effect on the H8/300.
11463 @end table
11465 @node HPPA Options
11466 @subsection HPPA Options
11467 @cindex HPPA Options
11469 These @samp{-m} options are defined for the HPPA family of computers:
11471 @table @gcctabopt
11472 @item -march=@var{architecture-type}
11473 @opindex march
11474 Generate code for the specified architecture.  The choices for
11475 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11476 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11477 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11478 architecture option for your machine.  Code compiled for lower numbered
11479 architectures will run on higher numbered architectures, but not the
11480 other way around.
11482 @item -mpa-risc-1-0
11483 @itemx -mpa-risc-1-1
11484 @itemx -mpa-risc-2-0
11485 @opindex mpa-risc-1-0
11486 @opindex mpa-risc-1-1
11487 @opindex mpa-risc-2-0
11488 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11490 @item -mbig-switch
11491 @opindex mbig-switch
11492 Generate code suitable for big switch tables.  Use this option only if
11493 the assembler/linker complain about out of range branches within a switch
11494 table.
11496 @item -mjump-in-delay
11497 @opindex mjump-in-delay
11498 Fill delay slots of function calls with unconditional jump instructions
11499 by modifying the return pointer for the function call to be the target
11500 of the conditional jump.
11502 @item -mdisable-fpregs
11503 @opindex mdisable-fpregs
11504 Prevent floating point registers from being used in any manner.  This is
11505 necessary for compiling kernels which perform lazy context switching of
11506 floating point registers.  If you use this option and attempt to perform
11507 floating point operations, the compiler will abort.
11509 @item -mdisable-indexing
11510 @opindex mdisable-indexing
11511 Prevent the compiler from using indexing address modes.  This avoids some
11512 rather obscure problems when compiling MIG generated code under MACH@.
11514 @item -mno-space-regs
11515 @opindex mno-space-regs
11516 Generate code that assumes the target has no space registers.  This allows
11517 GCC to generate faster indirect calls and use unscaled index address modes.
11519 Such code is suitable for level 0 PA systems and kernels.
11521 @item -mfast-indirect-calls
11522 @opindex mfast-indirect-calls
11523 Generate code that assumes calls never cross space boundaries.  This
11524 allows GCC to emit code which performs faster indirect calls.
11526 This option will not work in the presence of shared libraries or nested
11527 functions.
11529 @item -mfixed-range=@var{register-range}
11530 @opindex mfixed-range
11531 Generate code treating the given register range as fixed registers.
11532 A fixed register is one that the register allocator can not use.  This is
11533 useful when compiling kernel code.  A register range is specified as
11534 two registers separated by a dash.  Multiple register ranges can be
11535 specified separated by a comma.
11537 @item -mlong-load-store
11538 @opindex mlong-load-store
11539 Generate 3-instruction load and store sequences as sometimes required by
11540 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11541 the HP compilers.
11543 @item -mportable-runtime
11544 @opindex mportable-runtime
11545 Use the portable calling conventions proposed by HP for ELF systems.
11547 @item -mgas
11548 @opindex mgas
11549 Enable the use of assembler directives only GAS understands.
11551 @item -mschedule=@var{cpu-type}
11552 @opindex mschedule
11553 Schedule code according to the constraints for the machine type
11554 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11555 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11556 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11557 proper scheduling option for your machine.  The default scheduling is
11558 @samp{8000}.
11560 @item -mlinker-opt
11561 @opindex mlinker-opt
11562 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11563 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11564 linkers in which they give bogus error messages when linking some programs.
11566 @item -msoft-float
11567 @opindex msoft-float
11568 Generate output containing library calls for floating point.
11569 @strong{Warning:} the requisite libraries are not available for all HPPA
11570 targets.  Normally the facilities of the machine's usual C compiler are
11571 used, but this cannot be done directly in cross-compilation.  You must make
11572 your own arrangements to provide suitable library functions for
11573 cross-compilation.
11575 @option{-msoft-float} changes the calling convention in the output file;
11576 therefore, it is only useful if you compile @emph{all} of a program with
11577 this option.  In particular, you need to compile @file{libgcc.a}, the
11578 library that comes with GCC, with @option{-msoft-float} in order for
11579 this to work.
11581 @item -msio
11582 @opindex msio
11583 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11584 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11585 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11586 options are available under HP-UX and HI-UX@.
11588 @item -mgnu-ld
11589 @opindex mgnu-ld
11590 Use GNU ld specific options.  This passes @option{-shared} to ld when
11591 building a shared library.  It is the default when GCC is configured,
11592 explicitly or implicitly, with the GNU linker.  This option does not
11593 have any affect on which ld is called, it only changes what parameters
11594 are passed to that ld.  The ld that is called is determined by the
11595 @option{--with-ld} configure option, GCC's program search path, and
11596 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11597 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11598 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11600 @item -mhp-ld
11601 @opindex mhp-ld
11602 Use HP ld specific options.  This passes @option{-b} to ld when building
11603 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11604 links.  It is the default when GCC is configured, explicitly or
11605 implicitly, with the HP linker.  This option does not have any affect on
11606 which ld is called, it only changes what parameters are passed to that
11607 ld.  The ld that is called is determined by the @option{--with-ld}
11608 configure option, GCC's program search path, and finally by the user's
11609 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11610 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11611 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11613 @item -mlong-calls
11614 @opindex mno-long-calls
11615 Generate code that uses long call sequences.  This ensures that a call
11616 is always able to reach linker generated stubs.  The default is to generate
11617 long calls only when the distance from the call site to the beginning
11618 of the function or translation unit, as the case may be, exceeds a
11619 predefined limit set by the branch type being used.  The limits for
11620 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11621 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11622 240,000 bytes.
11624 Distances are measured from the beginning of functions when using the
11625 @option{-ffunction-sections} option, or when using the @option{-mgas}
11626 and @option{-mno-portable-runtime} options together under HP-UX with
11627 the SOM linker.
11629 It is normally not desirable to use this option as it will degrade
11630 performance.  However, it may be useful in large applications,
11631 particularly when partial linking is used to build the application.
11633 The types of long calls used depends on the capabilities of the
11634 assembler and linker, and the type of code being generated.  The
11635 impact on systems that support long absolute calls, and long pic
11636 symbol-difference or pc-relative calls should be relatively small.
11637 However, an indirect call is used on 32-bit ELF systems in pic code
11638 and it is quite long.
11640 @item -munix=@var{unix-std}
11641 @opindex march
11642 Generate compiler predefines and select a startfile for the specified
11643 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11644 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11645 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11646 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11647 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11648 and later.
11650 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11651 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11652 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11653 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11654 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11655 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11657 It is @emph{important} to note that this option changes the interfaces
11658 for various library routines.  It also affects the operational behavior
11659 of the C library.  Thus, @emph{extreme} care is needed in using this
11660 option.
11662 Library code that is intended to operate with more than one UNIX
11663 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11664 as appropriate.  Most GNU software doesn't provide this capability.
11666 @item -nolibdld
11667 @opindex nolibdld
11668 Suppress the generation of link options to search libdld.sl when the
11669 @option{-static} option is specified on HP-UX 10 and later.
11671 @item -static
11672 @opindex static
11673 The HP-UX implementation of setlocale in libc has a dependency on
11674 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11675 when the @option{-static} option is specified, special link options
11676 are needed to resolve this dependency.
11678 On HP-UX 10 and later, the GCC driver adds the necessary options to
11679 link with libdld.sl when the @option{-static} option is specified.
11680 This causes the resulting binary to be dynamic.  On the 64-bit port,
11681 the linkers generate dynamic binaries by default in any case.  The
11682 @option{-nolibdld} option can be used to prevent the GCC driver from
11683 adding these link options.
11685 @item -threads
11686 @opindex threads
11687 Add support for multithreading with the @dfn{dce thread} library
11688 under HP-UX@.  This option sets flags for both the preprocessor and
11689 linker.
11690 @end table
11692 @node i386 and x86-64 Options
11693 @subsection Intel 386 and AMD x86-64 Options
11694 @cindex i386 Options
11695 @cindex x86-64 Options
11696 @cindex Intel 386 Options
11697 @cindex AMD x86-64 Options
11699 These @samp{-m} options are defined for the i386 and x86-64 family of
11700 computers:
11702 @table @gcctabopt
11703 @item -mtune=@var{cpu-type}
11704 @opindex mtune
11705 Tune to @var{cpu-type} everything applicable about the generated code, except
11706 for the ABI and the set of available instructions.  The choices for
11707 @var{cpu-type} are:
11708 @table @emph
11709 @item generic
11710 Produce code optimized for the most common IA32/AMD64/EM64T processors.
11711 If you know the CPU on which your code will run, then you should use
11712 the corresponding @option{-mtune} option instead of
11713 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
11714 of your application will have, then you should use this option.
11716 As new processors are deployed in the marketplace, the behavior of this
11717 option will change.  Therefore, if you upgrade to a newer version of
11718 GCC, the code generated option will change to reflect the processors
11719 that were most common when that version of GCC was released.
11721 There is no @option{-march=generic} option because @option{-march}
11722 indicates the instruction set the compiler can use, and there is no
11723 generic instruction set applicable to all processors.  In contrast,
11724 @option{-mtune} indicates the processor (or, in this case, collection of
11725 processors) for which the code is optimized.
11726 @item native
11727 This selects the CPU to tune for at compilation time by determining
11728 the processor type of the compiling machine.  Using @option{-mtune=native}
11729 will produce code optimized for the local machine under the constraints
11730 of the selected instruction set.  Using @option{-march=native} will
11731 enable all instruction subsets supported by the local machine (hence
11732 the result might not run on different machines).
11733 @item i386
11734 Original Intel's i386 CPU@.
11735 @item i486
11736 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
11737 @item i586, pentium
11738 Intel Pentium CPU with no MMX support.
11739 @item pentium-mmx
11740 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
11741 @item pentiumpro
11742 Intel PentiumPro CPU@.
11743 @item i686
11744 Same as @code{generic}, but when used as @code{march} option, PentiumPro
11745 instruction set will be used, so the code will run on all i686 family chips.
11746 @item pentium2
11747 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
11748 @item pentium3, pentium3m
11749 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
11750 support.
11751 @item pentium-m
11752 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
11753 support.  Used by Centrino notebooks.
11754 @item pentium4, pentium4m
11755 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
11756 @item prescott
11757 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
11758 set support.
11759 @item nocona
11760 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
11761 SSE2 and SSE3 instruction set support.
11762 @item core2
11763 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11764 instruction set support.
11765 @item atom
11766 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11767 instruction set support.
11768 @item k6
11769 AMD K6 CPU with MMX instruction set support.
11770 @item k6-2, k6-3
11771 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
11772 @item athlon, athlon-tbird
11773 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
11774 support.
11775 @item athlon-4, athlon-xp, athlon-mp
11776 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
11777 instruction set support.
11778 @item k8, opteron, athlon64, athlon-fx
11779 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
11780 MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit instruction set extensions.)
11781 @item k8-sse3, opteron-sse3, athlon64-sse3
11782 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
11783 @item amdfam10, barcelona
11784 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
11785 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
11786 instruction set extensions.)
11787 @item winchip-c6
11788 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
11789 set support.
11790 @item winchip2
11791 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
11792 instruction set support.
11793 @item c3
11794 Via C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
11795 implemented for this chip.)
11796 @item c3-2
11797 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
11798 implemented for this chip.)
11799 @item geode
11800 Embedded AMD CPU with MMX and 3DNow!@: instruction set support.
11801 @end table
11803 While picking a specific @var{cpu-type} will schedule things appropriately
11804 for that particular chip, the compiler will not generate any code that
11805 does not run on the i386 without the @option{-march=@var{cpu-type}} option
11806 being used.
11808 @item -march=@var{cpu-type}
11809 @opindex march
11810 Generate instructions for the machine type @var{cpu-type}.  The choices
11811 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
11812 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
11814 @item -mcpu=@var{cpu-type}
11815 @opindex mcpu
11816 A deprecated synonym for @option{-mtune}.
11818 @item -mfpmath=@var{unit}
11819 @opindex mfpmath
11820 Generate floating point arithmetics for selected unit @var{unit}.  The choices
11821 for @var{unit} are:
11823 @table @samp
11824 @item 387
11825 Use the standard 387 floating point coprocessor present majority of chips and
11826 emulated otherwise.  Code compiled with this option will run almost everywhere.
11827 The temporary results are computed in 80bit precision instead of precision
11828 specified by the type resulting in slightly different results compared to most
11829 of other chips.  See @option{-ffloat-store} for more detailed description.
11831 This is the default choice for i386 compiler.
11833 @item sse
11834 Use scalar floating point instructions present in the SSE instruction set.
11835 This instruction set is supported by Pentium3 and newer chips, in the AMD line
11836 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
11837 instruction set supports only single precision arithmetics, thus the double and
11838 extended precision arithmetics is still done using 387.  Later version, present
11839 only in Pentium4 and the future AMD x86-64 chips supports double precision
11840 arithmetics too.
11842 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
11843 or @option{-msse2} switches to enable SSE extensions and make this option
11844 effective.  For the x86-64 compiler, these extensions are enabled by default.
11846 The resulting code should be considerably faster in the majority of cases and avoid
11847 the numerical instability problems of 387 code, but may break some existing
11848 code that expects temporaries to be 80bit.
11850 This is the default choice for the x86-64 compiler.
11852 @item sse,387
11853 @itemx sse+387
11854 @itemx both
11855 Attempt to utilize both instruction sets at once.  This effectively double the
11856 amount of available registers and on chips with separate execution units for
11857 387 and SSE the execution resources too.  Use this option with care, as it is
11858 still experimental, because the GCC register allocator does not model separate
11859 functional units well resulting in instable performance.
11860 @end table
11862 @item -masm=@var{dialect}
11863 @opindex masm=@var{dialect}
11864 Output asm instructions using selected @var{dialect}.  Supported
11865 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
11866 not support @samp{intel}.
11868 @item -mieee-fp
11869 @itemx -mno-ieee-fp
11870 @opindex mieee-fp
11871 @opindex mno-ieee-fp
11872 Control whether or not the compiler uses IEEE floating point
11873 comparisons.  These handle correctly the case where the result of a
11874 comparison is unordered.
11876 @item -msoft-float
11877 @opindex msoft-float
11878 Generate output containing library calls for floating point.
11879 @strong{Warning:} the requisite libraries are not part of GCC@.
11880 Normally the facilities of the machine's usual C compiler are used, but
11881 this can't be done directly in cross-compilation.  You must make your
11882 own arrangements to provide suitable library functions for
11883 cross-compilation.
11885 On machines where a function returns floating point results in the 80387
11886 register stack, some floating point opcodes may be emitted even if
11887 @option{-msoft-float} is used.
11889 @item -mno-fp-ret-in-387
11890 @opindex mno-fp-ret-in-387
11891 Do not use the FPU registers for return values of functions.
11893 The usual calling convention has functions return values of types
11894 @code{float} and @code{double} in an FPU register, even if there
11895 is no FPU@.  The idea is that the operating system should emulate
11896 an FPU@.
11898 The option @option{-mno-fp-ret-in-387} causes such values to be returned
11899 in ordinary CPU registers instead.
11901 @item -mno-fancy-math-387
11902 @opindex mno-fancy-math-387
11903 Some 387 emulators do not support the @code{sin}, @code{cos} and
11904 @code{sqrt} instructions for the 387.  Specify this option to avoid
11905 generating those instructions.  This option is the default on FreeBSD,
11906 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
11907 indicates that the target cpu will always have an FPU and so the
11908 instruction will not need emulation.  As of revision 2.6.1, these
11909 instructions are not generated unless you also use the
11910 @option{-funsafe-math-optimizations} switch.
11912 @item -malign-double
11913 @itemx -mno-align-double
11914 @opindex malign-double
11915 @opindex mno-align-double
11916 Control whether GCC aligns @code{double}, @code{long double}, and
11917 @code{long long} variables on a two word boundary or a one word
11918 boundary.  Aligning @code{double} variables on a two word boundary will
11919 produce code that runs somewhat faster on a @samp{Pentium} at the
11920 expense of more memory.
11922 On x86-64, @option{-malign-double} is enabled by default.
11924 @strong{Warning:} if you use the @option{-malign-double} switch,
11925 structures containing the above types will be aligned differently than
11926 the published application binary interface specifications for the 386
11927 and will not be binary compatible with structures in code compiled
11928 without that switch.
11930 @item -m96bit-long-double
11931 @itemx -m128bit-long-double
11932 @opindex m96bit-long-double
11933 @opindex m128bit-long-double
11934 These switches control the size of @code{long double} type.  The i386
11935 application binary interface specifies the size to be 96 bits,
11936 so @option{-m96bit-long-double} is the default in 32 bit mode.
11938 Modern architectures (Pentium and newer) would prefer @code{long double}
11939 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
11940 conforming to the ABI, this would not be possible.  So specifying a
11941 @option{-m128bit-long-double} will align @code{long double}
11942 to a 16 byte boundary by padding the @code{long double} with an additional
11943 32 bit zero.
11945 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
11946 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
11948 Notice that neither of these options enable any extra precision over the x87
11949 standard of 80 bits for a @code{long double}.
11951 @strong{Warning:} if you override the default value for your target ABI, the
11952 structures and arrays containing @code{long double} variables will change
11953 their size as well as function calling convention for function taking
11954 @code{long double} will be modified.  Hence they will not be binary
11955 compatible with arrays or structures in code compiled without that switch.
11957 @item -mlarge-data-threshold=@var{number}
11958 @opindex mlarge-data-threshold=@var{number}
11959 When @option{-mcmodel=medium} is specified, the data greater than
11960 @var{threshold} are placed in large data section.  This value must be the
11961 same across all object linked into the binary and defaults to 65535.
11963 @item -mrtd
11964 @opindex mrtd
11965 Use a different function-calling convention, in which functions that
11966 take a fixed number of arguments return with the @code{ret} @var{num}
11967 instruction, which pops their arguments while returning.  This saves one
11968 instruction in the caller since there is no need to pop the arguments
11969 there.
11971 You can specify that an individual function is called with this calling
11972 sequence with the function attribute @samp{stdcall}.  You can also
11973 override the @option{-mrtd} option by using the function attribute
11974 @samp{cdecl}.  @xref{Function Attributes}.
11976 @strong{Warning:} this calling convention is incompatible with the one
11977 normally used on Unix, so you cannot use it if you need to call
11978 libraries compiled with the Unix compiler.
11980 Also, you must provide function prototypes for all functions that
11981 take variable numbers of arguments (including @code{printf});
11982 otherwise incorrect code will be generated for calls to those
11983 functions.
11985 In addition, seriously incorrect code will result if you call a
11986 function with too many arguments.  (Normally, extra arguments are
11987 harmlessly ignored.)
11989 @item -mregparm=@var{num}
11990 @opindex mregparm
11991 Control how many registers are used to pass integer arguments.  By
11992 default, no registers are used to pass arguments, and at most 3
11993 registers can be used.  You can control this behavior for a specific
11994 function by using the function attribute @samp{regparm}.
11995 @xref{Function Attributes}.
11997 @strong{Warning:} if you use this switch, and
11998 @var{num} is nonzero, then you must build all modules with the same
11999 value, including any libraries.  This includes the system libraries and
12000 startup modules.
12002 @item -msseregparm
12003 @opindex msseregparm
12004 Use SSE register passing conventions for float and double arguments
12005 and return values.  You can control this behavior for a specific
12006 function by using the function attribute @samp{sseregparm}.
12007 @xref{Function Attributes}.
12009 @strong{Warning:} if you use this switch then you must build all
12010 modules with the same value, including any libraries.  This includes
12011 the system libraries and startup modules.
12013 @item -mpc32
12014 @itemx -mpc64
12015 @itemx -mpc80
12016 @opindex mpc32
12017 @opindex mpc64
12018 @opindex mpc80
12020 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
12021 is specified, the significands of results of floating-point operations are
12022 rounded to 24 bits (single precision); @option{-mpc64} rounds the
12023 significands of results of floating-point operations to 53 bits (double
12024 precision) and @option{-mpc80} rounds the significands of results of
12025 floating-point operations to 64 bits (extended double precision), which is
12026 the default.  When this option is used, floating-point operations in higher
12027 precisions are not available to the programmer without setting the FPU
12028 control word explicitly.
12030 Setting the rounding of floating-point operations to less than the default
12031 80 bits can speed some programs by 2% or more.  Note that some mathematical
12032 libraries assume that extended precision (80 bit) floating-point operations
12033 are enabled by default; routines in such libraries could suffer significant
12034 loss of accuracy, typically through so-called "catastrophic cancellation",
12035 when this option is used to set the precision to less than extended precision.
12037 @item -mstackrealign
12038 @opindex mstackrealign
12039 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
12040 option will generate an alternate prologue and epilogue that realigns the
12041 runtime stack if necessary.  This supports mixing legacy codes that keep
12042 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
12043 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
12044 applicable to individual functions.
12046 @item -mpreferred-stack-boundary=@var{num}
12047 @opindex mpreferred-stack-boundary
12048 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
12049 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
12050 the default is 4 (16 bytes or 128 bits).
12052 @item -mincoming-stack-boundary=@var{num}
12053 @opindex mincoming-stack-boundary
12054 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
12055 boundary.  If @option{-mincoming-stack-boundary} is not specified,
12056 the one specified by @option{-mpreferred-stack-boundary} will be used.
12058 On Pentium and PentiumPro, @code{double} and @code{long double} values
12059 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
12060 suffer significant run time performance penalties.  On Pentium III, the
12061 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
12062 properly if it is not 16 byte aligned.
12064 To ensure proper alignment of this values on the stack, the stack boundary
12065 must be as aligned as that required by any value stored on the stack.
12066 Further, every function must be generated such that it keeps the stack
12067 aligned.  Thus calling a function compiled with a higher preferred
12068 stack boundary from a function compiled with a lower preferred stack
12069 boundary will most likely misalign the stack.  It is recommended that
12070 libraries that use callbacks always use the default setting.
12072 This extra alignment does consume extra stack space, and generally
12073 increases code size.  Code that is sensitive to stack space usage, such
12074 as embedded systems and operating system kernels, may want to reduce the
12075 preferred alignment to @option{-mpreferred-stack-boundary=2}.
12077 @item -mmmx
12078 @itemx -mno-mmx
12079 @itemx -msse
12080 @itemx -mno-sse
12081 @itemx -msse2
12082 @itemx -mno-sse2
12083 @itemx -msse3
12084 @itemx -mno-sse3
12085 @itemx -mssse3
12086 @itemx -mno-ssse3
12087 @itemx -msse4.1
12088 @itemx -mno-sse4.1
12089 @itemx -msse4.2
12090 @itemx -mno-sse4.2
12091 @itemx -msse4
12092 @itemx -mno-sse4
12093 @itemx -mavx
12094 @itemx -mno-avx
12095 @itemx -maes
12096 @itemx -mno-aes
12097 @itemx -mpclmul
12098 @itemx -mno-pclmul
12099 @itemx -msse4a
12100 @itemx -mno-sse4a
12101 @itemx -mfma4
12102 @itemx -mno-fma4
12103 @itemx -mxop
12104 @itemx -mno-xop
12105 @itemx -mlwp
12106 @itemx -mno-lwp
12107 @itemx -m3dnow
12108 @itemx -mno-3dnow
12109 @itemx -mpopcnt
12110 @itemx -mno-popcnt
12111 @itemx -mabm
12112 @itemx -mno-abm
12113 @opindex mmmx
12114 @opindex mno-mmx
12115 @opindex msse
12116 @opindex mno-sse
12117 @opindex m3dnow
12118 @opindex mno-3dnow
12119 These switches enable or disable the use of instructions in the MMX,
12120 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, FMA4, XOP,
12121 LWP, ABM or 3DNow!@: extended instruction sets.
12122 These extensions are also available as built-in functions: see
12123 @ref{X86 Built-in Functions}, for details of the functions enabled and
12124 disabled by these switches.
12126 To have SSE/SSE2 instructions generated automatically from floating-point
12127 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12129 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12130 generates new AVX instructions or AVX equivalence for all SSEx instructions
12131 when needed.
12133 These options will enable GCC to use these extended instructions in
12134 generated code, even without @option{-mfpmath=sse}.  Applications which
12135 perform runtime CPU detection must compile separate files for each
12136 supported architecture, using the appropriate flags.  In particular,
12137 the file containing the CPU detection code should be compiled without
12138 these options.
12140 @item -mfused-madd
12141 @itemx -mno-fused-madd
12142 @opindex mfused-madd
12143 @opindex mno-fused-madd
12144 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12145 instructions.  The default is to use these instructions.
12147 @item -mcld
12148 @opindex mcld
12149 This option instructs GCC to emit a @code{cld} instruction in the prologue
12150 of functions that use string instructions.  String instructions depend on
12151 the DF flag to select between autoincrement or autodecrement mode.  While the
12152 ABI specifies the DF flag to be cleared on function entry, some operating
12153 systems violate this specification by not clearing the DF flag in their
12154 exception dispatchers.  The exception handler can be invoked with the DF flag
12155 set which leads to wrong direction mode, when string instructions are used.
12156 This option can be enabled by default on 32-bit x86 targets by configuring
12157 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
12158 instructions can be suppressed with the @option{-mno-cld} compiler option
12159 in this case.
12161 @item -mcx16
12162 @opindex mcx16
12163 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12164 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12165 data types.  This is useful for high resolution counters that could be updated
12166 by multiple processors (or cores).  This instruction is generated as part of
12167 atomic built-in functions: see @ref{Atomic Builtins} for details.
12169 @item -msahf
12170 @opindex msahf
12171 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12172 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12173 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
12174 SAHF are load and store instructions, respectively, for certain status flags.
12175 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12176 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12178 @item -mmovbe
12179 @opindex mmovbe
12180 This option will enable GCC to use movbe instruction to implement
12181 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12183 @item -mcrc32
12184 @opindex mcrc32
12185 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12186 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12187 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12189 @item -mrecip
12190 @opindex mrecip
12191 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12192 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12193 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12194 variants) for single precision floating point arguments.  These instructions
12195 are generated only when @option{-funsafe-math-optimizations} is enabled
12196 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12197 Note that while the throughput of the sequence is higher than the throughput
12198 of the non-reciprocal instruction, the precision of the sequence can be
12199 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12201 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12202 already with @option{-ffast-math} (or the above option combination), and
12203 doesn't need @option{-mrecip}.
12205 @item -mveclibabi=@var{type}
12206 @opindex mveclibabi
12207 Specifies the ABI type to use for vectorizing intrinsics using an
12208 external library.  Supported types are @code{svml} for the Intel short
12209 vector math library and @code{acml} for the AMD math core library style
12210 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
12211 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12212 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12213 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12214 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12215 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12216 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12217 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12218 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12219 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12220 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12221 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12222 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12223 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12224 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12225 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12226 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12227 compatible library will have to be specified at link time.
12229 @item -mabi=@var{name}
12230 @opindex mabi
12231 Generate code for the specified calling convention.  Permissible values
12232 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12233 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
12234 ABI when targeting Windows.  On all other systems, the default is the
12235 SYSV ABI.  You can control this behavior for a specific function by
12236 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12237 @xref{Function Attributes}.
12239 @item -mpush-args
12240 @itemx -mno-push-args
12241 @opindex mpush-args
12242 @opindex mno-push-args
12243 Use PUSH operations to store outgoing parameters.  This method is shorter
12244 and usually equally fast as method using SUB/MOV operations and is enabled
12245 by default.  In some cases disabling it may improve performance because of
12246 improved scheduling and reduced dependencies.
12248 @item -maccumulate-outgoing-args
12249 @opindex maccumulate-outgoing-args
12250 If enabled, the maximum amount of space required for outgoing arguments will be
12251 computed in the function prologue.  This is faster on most modern CPUs
12252 because of reduced dependencies, improved scheduling and reduced stack usage
12253 when preferred stack boundary is not equal to 2.  The drawback is a notable
12254 increase in code size.  This switch implies @option{-mno-push-args}.
12256 @item -mthreads
12257 @opindex mthreads
12258 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
12259 on thread-safe exception handling must compile and link all code with the
12260 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
12261 @option{-D_MT}; when linking, it links in a special thread helper library
12262 @option{-lmingwthrd} which cleans up per thread exception handling data.
12264 @item -mno-align-stringops
12265 @opindex mno-align-stringops
12266 Do not align destination of inlined string operations.  This switch reduces
12267 code size and improves performance in case the destination is already aligned,
12268 but GCC doesn't know about it.
12270 @item -minline-all-stringops
12271 @opindex minline-all-stringops
12272 By default GCC inlines string operations only when destination is known to be
12273 aligned at least to 4 byte boundary.  This enables more inlining, increase code
12274 size, but may improve performance of code that depends on fast memcpy, strlen
12275 and memset for short lengths.
12277 @item -minline-stringops-dynamically
12278 @opindex minline-stringops-dynamically
12279 For string operation of unknown size, inline runtime checks so for small
12280 blocks inline code is used, while for large blocks library call is used.
12282 @item -mstringop-strategy=@var{alg}
12283 @opindex mstringop-strategy=@var{alg}
12284 Overwrite internal decision heuristic about particular algorithm to inline
12285 string operation with.  The allowed values are @code{rep_byte},
12286 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12287 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12288 expanding inline loop, @code{libcall} for always expanding library call.
12290 @item -momit-leaf-frame-pointer
12291 @opindex momit-leaf-frame-pointer
12292 Don't keep the frame pointer in a register for leaf functions.  This
12293 avoids the instructions to save, set up and restore frame pointers and
12294 makes an extra register available in leaf functions.  The option
12295 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12296 which might make debugging harder.
12298 @item -mtls-direct-seg-refs
12299 @itemx -mno-tls-direct-seg-refs
12300 @opindex mtls-direct-seg-refs
12301 Controls whether TLS variables may be accessed with offsets from the
12302 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12303 or whether the thread base pointer must be added.  Whether or not this
12304 is legal depends on the operating system, and whether it maps the
12305 segment to cover the entire TLS area.
12307 For systems that use GNU libc, the default is on.
12309 @item -msse2avx
12310 @itemx -mno-sse2avx
12311 @opindex msse2avx
12312 Specify that the assembler should encode SSE instructions with VEX
12313 prefix.  The option @option{-mavx} turns this on by default.
12314 @end table
12316 These @samp{-m} switches are supported in addition to the above
12317 on AMD x86-64 processors in 64-bit environments.
12319 @table @gcctabopt
12320 @item -m32
12321 @itemx -m64
12322 @opindex m32
12323 @opindex m64
12324 Generate code for a 32-bit or 64-bit environment.
12325 The 32-bit environment sets int, long and pointer to 32 bits and
12326 generates code that runs on any i386 system.
12327 The 64-bit environment sets int to 32 bits and long and pointer
12328 to 64 bits and generates code for AMD's x86-64 architecture. For
12329 darwin only the -m64 option turns off the @option{-fno-pic} and
12330 @option{-mdynamic-no-pic} options.
12332 @item -mno-red-zone
12333 @opindex mno-red-zone
12334 Do not use a so called red zone for x86-64 code.  The red zone is mandated
12335 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12336 stack pointer that will not be modified by signal or interrupt handlers
12337 and therefore can be used for temporary data without adjusting the stack
12338 pointer.  The flag @option{-mno-red-zone} disables this red zone.
12340 @item -mcmodel=small
12341 @opindex mcmodel=small
12342 Generate code for the small code model: the program and its symbols must
12343 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
12344 Programs can be statically or dynamically linked.  This is the default
12345 code model.
12347 @item -mcmodel=kernel
12348 @opindex mcmodel=kernel
12349 Generate code for the kernel code model.  The kernel runs in the
12350 negative 2 GB of the address space.
12351 This model has to be used for Linux kernel code.
12353 @item -mcmodel=medium
12354 @opindex mcmodel=medium
12355 Generate code for the medium model: The program is linked in the lower 2
12356 GB of the address space.  Small symbols are also placed there.  Symbols
12357 with sizes larger than @option{-mlarge-data-threshold} are put into
12358 large data or bss sections and can be located above 2GB.  Programs can
12359 be statically or dynamically linked.
12361 @item -mcmodel=large
12362 @opindex mcmodel=large
12363 Generate code for the large model: This model makes no assumptions
12364 about addresses and sizes of sections.
12365 @end table
12367 @node IA-64 Options
12368 @subsection IA-64 Options
12369 @cindex IA-64 Options
12371 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12373 @table @gcctabopt
12374 @item -mbig-endian
12375 @opindex mbig-endian
12376 Generate code for a big endian target.  This is the default for HP-UX@.
12378 @item -mlittle-endian
12379 @opindex mlittle-endian
12380 Generate code for a little endian target.  This is the default for AIX5
12381 and GNU/Linux.
12383 @item -mgnu-as
12384 @itemx -mno-gnu-as
12385 @opindex mgnu-as
12386 @opindex mno-gnu-as
12387 Generate (or don't) code for the GNU assembler.  This is the default.
12388 @c Also, this is the default if the configure option @option{--with-gnu-as}
12389 @c is used.
12391 @item -mgnu-ld
12392 @itemx -mno-gnu-ld
12393 @opindex mgnu-ld
12394 @opindex mno-gnu-ld
12395 Generate (or don't) code for the GNU linker.  This is the default.
12396 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12397 @c is used.
12399 @item -mno-pic
12400 @opindex mno-pic
12401 Generate code that does not use a global pointer register.  The result
12402 is not position independent code, and violates the IA-64 ABI@.
12404 @item -mvolatile-asm-stop
12405 @itemx -mno-volatile-asm-stop
12406 @opindex mvolatile-asm-stop
12407 @opindex mno-volatile-asm-stop
12408 Generate (or don't) a stop bit immediately before and after volatile asm
12409 statements.
12411 @item -mregister-names
12412 @itemx -mno-register-names
12413 @opindex mregister-names
12414 @opindex mno-register-names
12415 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12416 the stacked registers.  This may make assembler output more readable.
12418 @item -mno-sdata
12419 @itemx -msdata
12420 @opindex mno-sdata
12421 @opindex msdata
12422 Disable (or enable) optimizations that use the small data section.  This may
12423 be useful for working around optimizer bugs.
12425 @item -mconstant-gp
12426 @opindex mconstant-gp
12427 Generate code that uses a single constant global pointer value.  This is
12428 useful when compiling kernel code.
12430 @item -mauto-pic
12431 @opindex mauto-pic
12432 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
12433 This is useful when compiling firmware code.
12435 @item -minline-float-divide-min-latency
12436 @opindex minline-float-divide-min-latency
12437 Generate code for inline divides of floating point values
12438 using the minimum latency algorithm.
12440 @item -minline-float-divide-max-throughput
12441 @opindex minline-float-divide-max-throughput
12442 Generate code for inline divides of floating point values
12443 using the maximum throughput algorithm.
12445 @item -mno-inline-float-divide
12446 @opindex mno-inline-float-divide
12447 Do not generate inline code for divides of floating point values.
12449 @item -minline-int-divide-min-latency
12450 @opindex minline-int-divide-min-latency
12451 Generate code for inline divides of integer values
12452 using the minimum latency algorithm.
12454 @item -minline-int-divide-max-throughput
12455 @opindex minline-int-divide-max-throughput
12456 Generate code for inline divides of integer values
12457 using the maximum throughput algorithm.
12459 @item -mno-inline-int-divide
12460 @opindex mno-inline-int-divide
12461 Do not generate inline code for divides of integer values.
12463 @item -minline-sqrt-min-latency
12464 @opindex minline-sqrt-min-latency
12465 Generate code for inline square roots
12466 using the minimum latency algorithm.
12468 @item -minline-sqrt-max-throughput
12469 @opindex minline-sqrt-max-throughput
12470 Generate code for inline square roots
12471 using the maximum throughput algorithm.
12473 @item -mno-inline-sqrt
12474 @opindex mno-inline-sqrt
12475 Do not generate inline code for sqrt.
12477 @item -mfused-madd
12478 @itemx -mno-fused-madd
12479 @opindex mfused-madd
12480 @opindex mno-fused-madd
12481 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12482 instructions.  The default is to use these instructions.
12484 @item -mno-dwarf2-asm
12485 @itemx -mdwarf2-asm
12486 @opindex mno-dwarf2-asm
12487 @opindex mdwarf2-asm
12488 Don't (or do) generate assembler code for the DWARF2 line number debugging
12489 info.  This may be useful when not using the GNU assembler.
12491 @item -mearly-stop-bits
12492 @itemx -mno-early-stop-bits
12493 @opindex mearly-stop-bits
12494 @opindex mno-early-stop-bits
12495 Allow stop bits to be placed earlier than immediately preceding the
12496 instruction that triggered the stop bit.  This can improve instruction
12497 scheduling, but does not always do so.
12499 @item -mfixed-range=@var{register-range}
12500 @opindex mfixed-range
12501 Generate code treating the given register range as fixed registers.
12502 A fixed register is one that the register allocator can not use.  This is
12503 useful when compiling kernel code.  A register range is specified as
12504 two registers separated by a dash.  Multiple register ranges can be
12505 specified separated by a comma.
12507 @item -mtls-size=@var{tls-size}
12508 @opindex mtls-size
12509 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12512 @item -mtune=@var{cpu-type}
12513 @opindex mtune
12514 Tune the instruction scheduling for a particular CPU, Valid values are
12515 itanium, itanium1, merced, itanium2, and mckinley.
12517 @item -milp32
12518 @itemx -mlp64
12519 @opindex milp32
12520 @opindex mlp64
12521 Generate code for a 32-bit or 64-bit environment.
12522 The 32-bit environment sets int, long and pointer to 32 bits.
12523 The 64-bit environment sets int to 32 bits and long and pointer
12524 to 64 bits.  These are HP-UX specific flags.
12526 @item -mno-sched-br-data-spec
12527 @itemx -msched-br-data-spec
12528 @opindex mno-sched-br-data-spec
12529 @opindex msched-br-data-spec
12530 (Dis/En)able data speculative scheduling before reload.
12531 This will result in generation of the ld.a instructions and
12532 the corresponding check instructions (ld.c / chk.a).
12533 The default is 'disable'.
12535 @item -msched-ar-data-spec
12536 @itemx -mno-sched-ar-data-spec
12537 @opindex msched-ar-data-spec
12538 @opindex mno-sched-ar-data-spec
12539 (En/Dis)able data speculative scheduling after reload.
12540 This will result in generation of the ld.a instructions and
12541 the corresponding check instructions (ld.c / chk.a).
12542 The default is 'enable'.
12544 @item -mno-sched-control-spec
12545 @itemx -msched-control-spec
12546 @opindex mno-sched-control-spec
12547 @opindex msched-control-spec
12548 (Dis/En)able control speculative scheduling.  This feature is
12549 available only during region scheduling (i.e.@: before reload).
12550 This will result in generation of the ld.s instructions and
12551 the corresponding check instructions chk.s .
12552 The default is 'disable'.
12554 @item -msched-br-in-data-spec
12555 @itemx -mno-sched-br-in-data-spec
12556 @opindex msched-br-in-data-spec
12557 @opindex mno-sched-br-in-data-spec
12558 (En/Dis)able speculative scheduling of the instructions that
12559 are dependent on the data speculative loads before reload.
12560 This is effective only with @option{-msched-br-data-spec} enabled.
12561 The default is 'enable'.
12563 @item -msched-ar-in-data-spec
12564 @itemx -mno-sched-ar-in-data-spec
12565 @opindex msched-ar-in-data-spec
12566 @opindex mno-sched-ar-in-data-spec
12567 (En/Dis)able speculative scheduling of the instructions that
12568 are dependent on the data speculative loads after reload.
12569 This is effective only with @option{-msched-ar-data-spec} enabled.
12570 The default is 'enable'.
12572 @item -msched-in-control-spec
12573 @itemx -mno-sched-in-control-spec
12574 @opindex msched-in-control-spec
12575 @opindex mno-sched-in-control-spec
12576 (En/Dis)able speculative scheduling of the instructions that
12577 are dependent on the control speculative loads.
12578 This is effective only with @option{-msched-control-spec} enabled.
12579 The default is 'enable'.
12581 @item -mno-sched-prefer-non-data-spec-insns
12582 @itemx -msched-prefer-non-data-spec-insns
12583 @opindex mno-sched-prefer-non-data-spec-insns
12584 @opindex msched-prefer-non-data-spec-insns
12585 If enabled, data speculative instructions will be chosen for schedule
12586 only if there are no other choices at the moment.  This will make
12587 the use of the data speculation much more conservative.
12588 The default is 'disable'.
12590 @item -mno-sched-prefer-non-control-spec-insns
12591 @itemx -msched-prefer-non-control-spec-insns
12592 @opindex mno-sched-prefer-non-control-spec-insns
12593 @opindex msched-prefer-non-control-spec-insns
12594 If enabled, control speculative instructions will be chosen for schedule
12595 only if there are no other choices at the moment.  This will make
12596 the use of the control speculation much more conservative.
12597 The default is 'disable'.
12599 @item -mno-sched-count-spec-in-critical-path
12600 @itemx -msched-count-spec-in-critical-path
12601 @opindex mno-sched-count-spec-in-critical-path
12602 @opindex msched-count-spec-in-critical-path
12603 If enabled, speculative dependencies will be considered during
12604 computation of the instructions priorities.  This will make the use of the
12605 speculation a bit more conservative.
12606 The default is 'disable'.
12608 @item -msched-spec-ldc
12609 @opindex msched-spec-ldc
12610 Use a simple data speculation check.  This option is on by default.
12612 @item -msched-control-spec-ldc
12613 @opindex msched-spec-ldc
12614 Use a simple check for control speculation.  This option is on by default.
12616 @item -msched-stop-bits-after-every-cycle
12617 @opindex msched-stop-bits-after-every-cycle
12618 Place a stop bit after every cycle when scheduling.  This option is on
12619 by default.
12621 @item -msched-fp-mem-deps-zero-cost
12622 @opindex msched-fp-mem-deps-zero-cost
12623 Assume that floating-point stores and loads are not likely to cause a conflict
12624 when placed into the same instruction group.  This option is disabled by
12625 default.
12627 @item -msel-sched-dont-check-control-spec
12628 @opindex msel-sched-dont-check-control-spec
12629 Generate checks for control speculation in selective scheduling.
12630 This flag is disabled by default.
12632 @item -msched-max-memory-insns=@var{max-insns}
12633 @opindex msched-max-memory-insns
12634 Limit on the number of memory insns per instruction group, giving lower
12635 priority to subsequent memory insns attempting to schedule in the same
12636 instruction group. Frequently useful to prevent cache bank conflicts.
12637 The default value is 1.
12639 @item -msched-max-memory-insns-hard-limit
12640 @opindex msched-max-memory-insns-hard-limit
12641 Disallow more than `msched-max-memory-insns' in instruction group.
12642 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12643 when limit is reached but may still schedule memory operations.
12645 @end table
12647 @node IA-64/VMS Options
12648 @subsection IA-64/VMS Options
12650 These @samp{-m} options are defined for the IA-64/VMS implementations:
12652 @table @gcctabopt
12653 @item -mvms-return-codes
12654 @opindex mvms-return-codes
12655 Return VMS condition codes from main. The default is to return POSIX
12656 style condition (e.g.@ error) codes.
12658 @item -mdebug-main=@var{prefix}
12659 @opindex mdebug-main=@var{prefix}
12660 Flag the first routine whose name starts with @var{prefix} as the main
12661 routine for the debugger.
12663 @item -mmalloc64
12664 @opindex mmalloc64
12665 Default to 64bit memory allocation routines.
12666 @end table
12668 @node LM32 Options
12669 @subsection LM32 Options
12670 @cindex LM32 options
12672 These @option{-m} options are defined for the Lattice Mico32 architecture:
12674 @table @gcctabopt
12675 @item -mbarrel-shift-enabled
12676 @opindex mbarrel-shift-enabled
12677 Enable barrel-shift instructions.
12679 @item -mdivide-enabled
12680 @opindex mdivide-enabled
12681 Enable divide and modulus instructions.
12683 @item -mmultiply-enabled
12684 @opindex multiply-enabled
12685 Enable multiply instructions.
12687 @item -msign-extend-enabled
12688 @opindex msign-extend-enabled
12689 Enable sign extend instructions.
12691 @item -muser-enabled
12692 @opindex muser-enabled
12693 Enable user-defined instructions.
12695 @end table
12697 @node M32C Options
12698 @subsection M32C Options
12699 @cindex M32C options
12701 @table @gcctabopt
12702 @item -mcpu=@var{name}
12703 @opindex mcpu=
12704 Select the CPU for which code is generated.  @var{name} may be one of
12705 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
12706 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
12707 the M32C/80 series.
12709 @item -msim
12710 @opindex msim
12711 Specifies that the program will be run on the simulator.  This causes
12712 an alternate runtime library to be linked in which supports, for
12713 example, file I/O@.  You must not use this option when generating
12714 programs that will run on real hardware; you must provide your own
12715 runtime library for whatever I/O functions are needed.
12717 @item -memregs=@var{number}
12718 @opindex memregs=
12719 Specifies the number of memory-based pseudo-registers GCC will use
12720 during code generation.  These pseudo-registers will be used like real
12721 registers, so there is a tradeoff between GCC's ability to fit the
12722 code into available registers, and the performance penalty of using
12723 memory instead of registers.  Note that all modules in a program must
12724 be compiled with the same value for this option.  Because of that, you
12725 must not use this option with the default runtime libraries gcc
12726 builds.
12728 @end table
12730 @node M32R/D Options
12731 @subsection M32R/D Options
12732 @cindex M32R/D options
12734 These @option{-m} options are defined for Renesas M32R/D architectures:
12736 @table @gcctabopt
12737 @item -m32r2
12738 @opindex m32r2
12739 Generate code for the M32R/2@.
12741 @item -m32rx
12742 @opindex m32rx
12743 Generate code for the M32R/X@.
12745 @item -m32r
12746 @opindex m32r
12747 Generate code for the M32R@.  This is the default.
12749 @item -mmodel=small
12750 @opindex mmodel=small
12751 Assume all objects live in the lower 16MB of memory (so that their addresses
12752 can be loaded with the @code{ld24} instruction), and assume all subroutines
12753 are reachable with the @code{bl} instruction.
12754 This is the default.
12756 The addressability of a particular object can be set with the
12757 @code{model} attribute.
12759 @item -mmodel=medium
12760 @opindex mmodel=medium
12761 Assume objects may be anywhere in the 32-bit address space (the compiler
12762 will generate @code{seth/add3} instructions to load their addresses), and
12763 assume all subroutines are reachable with the @code{bl} instruction.
12765 @item -mmodel=large
12766 @opindex mmodel=large
12767 Assume objects may be anywhere in the 32-bit address space (the compiler
12768 will generate @code{seth/add3} instructions to load their addresses), and
12769 assume subroutines may not be reachable with the @code{bl} instruction
12770 (the compiler will generate the much slower @code{seth/add3/jl}
12771 instruction sequence).
12773 @item -msdata=none
12774 @opindex msdata=none
12775 Disable use of the small data area.  Variables will be put into
12776 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
12777 @code{section} attribute has been specified).
12778 This is the default.
12780 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
12781 Objects may be explicitly put in the small data area with the
12782 @code{section} attribute using one of these sections.
12784 @item -msdata=sdata
12785 @opindex msdata=sdata
12786 Put small global and static data in the small data area, but do not
12787 generate special code to reference them.
12789 @item -msdata=use
12790 @opindex msdata=use
12791 Put small global and static data in the small data area, and generate
12792 special instructions to reference them.
12794 @item -G @var{num}
12795 @opindex G
12796 @cindex smaller data references
12797 Put global and static objects less than or equal to @var{num} bytes
12798 into the small data or bss sections instead of the normal data or bss
12799 sections.  The default value of @var{num} is 8.
12800 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
12801 for this option to have any effect.
12803 All modules should be compiled with the same @option{-G @var{num}} value.
12804 Compiling with different values of @var{num} may or may not work; if it
12805 doesn't the linker will give an error message---incorrect code will not be
12806 generated.
12808 @item -mdebug
12809 @opindex mdebug
12810 Makes the M32R specific code in the compiler display some statistics
12811 that might help in debugging programs.
12813 @item -malign-loops
12814 @opindex malign-loops
12815 Align all loops to a 32-byte boundary.
12817 @item -mno-align-loops
12818 @opindex mno-align-loops
12819 Do not enforce a 32-byte alignment for loops.  This is the default.
12821 @item -missue-rate=@var{number}
12822 @opindex missue-rate=@var{number}
12823 Issue @var{number} instructions per cycle.  @var{number} can only be 1
12824 or 2.
12826 @item -mbranch-cost=@var{number}
12827 @opindex mbranch-cost=@var{number}
12828 @var{number} can only be 1 or 2.  If it is 1 then branches will be
12829 preferred over conditional code, if it is 2, then the opposite will
12830 apply.
12832 @item -mflush-trap=@var{number}
12833 @opindex mflush-trap=@var{number}
12834 Specifies the trap number to use to flush the cache.  The default is
12835 12.  Valid numbers are between 0 and 15 inclusive.
12837 @item -mno-flush-trap
12838 @opindex mno-flush-trap
12839 Specifies that the cache cannot be flushed by using a trap.
12841 @item -mflush-func=@var{name}
12842 @opindex mflush-func=@var{name}
12843 Specifies the name of the operating system function to call to flush
12844 the cache.  The default is @emph{_flush_cache}, but a function call
12845 will only be used if a trap is not available.
12847 @item -mno-flush-func
12848 @opindex mno-flush-func
12849 Indicates that there is no OS function for flushing the cache.
12851 @end table
12853 @node M680x0 Options
12854 @subsection M680x0 Options
12855 @cindex M680x0 options
12857 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
12858 The default settings depend on which architecture was selected when
12859 the compiler was configured; the defaults for the most common choices
12860 are given below.
12862 @table @gcctabopt
12863 @item -march=@var{arch}
12864 @opindex march
12865 Generate code for a specific M680x0 or ColdFire instruction set
12866 architecture.  Permissible values of @var{arch} for M680x0
12867 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
12868 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
12869 architectures are selected according to Freescale's ISA classification
12870 and the permissible values are: @samp{isaa}, @samp{isaaplus},
12871 @samp{isab} and @samp{isac}.
12873 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
12874 code for a ColdFire target.  The @var{arch} in this macro is one of the
12875 @option{-march} arguments given above.
12877 When used together, @option{-march} and @option{-mtune} select code
12878 that runs on a family of similar processors but that is optimized
12879 for a particular microarchitecture.
12881 @item -mcpu=@var{cpu}
12882 @opindex mcpu
12883 Generate code for a specific M680x0 or ColdFire processor.
12884 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
12885 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
12886 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
12887 below, which also classifies the CPUs into families:
12889 @multitable @columnfractions 0.20 0.80
12890 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
12891 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
12892 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
12893 @item @samp{5206e} @tab @samp{5206e}
12894 @item @samp{5208} @tab @samp{5207} @samp{5208}
12895 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
12896 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
12897 @item @samp{5216} @tab @samp{5214} @samp{5216}
12898 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
12899 @item @samp{5225} @tab @samp{5224} @samp{5225}
12900 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
12901 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
12902 @item @samp{5249} @tab @samp{5249}
12903 @item @samp{5250} @tab @samp{5250}
12904 @item @samp{5271} @tab @samp{5270} @samp{5271}
12905 @item @samp{5272} @tab @samp{5272}
12906 @item @samp{5275} @tab @samp{5274} @samp{5275}
12907 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
12908 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
12909 @item @samp{5307} @tab @samp{5307}
12910 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
12911 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
12912 @item @samp{5407} @tab @samp{5407}
12913 @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}
12914 @end multitable
12916 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
12917 @var{arch} is compatible with @var{cpu}.  Other combinations of
12918 @option{-mcpu} and @option{-march} are rejected.
12920 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
12921 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
12922 where the value of @var{family} is given by the table above.
12924 @item -mtune=@var{tune}
12925 @opindex mtune
12926 Tune the code for a particular microarchitecture, within the
12927 constraints set by @option{-march} and @option{-mcpu}.
12928 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
12929 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
12930 and @samp{cpu32}.  The ColdFire microarchitectures
12931 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
12933 You can also use @option{-mtune=68020-40} for code that needs
12934 to run relatively well on 68020, 68030 and 68040 targets.
12935 @option{-mtune=68020-60} is similar but includes 68060 targets
12936 as well.  These two options select the same tuning decisions as
12937 @option{-m68020-40} and @option{-m68020-60} respectively.
12939 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
12940 when tuning for 680x0 architecture @var{arch}.  It also defines
12941 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
12942 option is used.  If gcc is tuning for a range of architectures,
12943 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
12944 it defines the macros for every architecture in the range.
12946 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
12947 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
12948 of the arguments given above.
12950 @item -m68000
12951 @itemx -mc68000
12952 @opindex m68000
12953 @opindex mc68000
12954 Generate output for a 68000.  This is the default
12955 when the compiler is configured for 68000-based systems.
12956 It is equivalent to @option{-march=68000}.
12958 Use this option for microcontrollers with a 68000 or EC000 core,
12959 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
12961 @item -m68010
12962 @opindex m68010
12963 Generate output for a 68010.  This is the default
12964 when the compiler is configured for 68010-based systems.
12965 It is equivalent to @option{-march=68010}.
12967 @item -m68020
12968 @itemx -mc68020
12969 @opindex m68020
12970 @opindex mc68020
12971 Generate output for a 68020.  This is the default
12972 when the compiler is configured for 68020-based systems.
12973 It is equivalent to @option{-march=68020}.
12975 @item -m68030
12976 @opindex m68030
12977 Generate output for a 68030.  This is the default when the compiler is
12978 configured for 68030-based systems.  It is equivalent to
12979 @option{-march=68030}.
12981 @item -m68040
12982 @opindex m68040
12983 Generate output for a 68040.  This is the default when the compiler is
12984 configured for 68040-based systems.  It is equivalent to
12985 @option{-march=68040}.
12987 This option inhibits the use of 68881/68882 instructions that have to be
12988 emulated by software on the 68040.  Use this option if your 68040 does not
12989 have code to emulate those instructions.
12991 @item -m68060
12992 @opindex m68060
12993 Generate output for a 68060.  This is the default when the compiler is
12994 configured for 68060-based systems.  It is equivalent to
12995 @option{-march=68060}.
12997 This option inhibits the use of 68020 and 68881/68882 instructions that
12998 have to be emulated by software on the 68060.  Use this option if your 68060
12999 does not have code to emulate those instructions.
13001 @item -mcpu32
13002 @opindex mcpu32
13003 Generate output for a CPU32.  This is the default
13004 when the compiler is configured for CPU32-based systems.
13005 It is equivalent to @option{-march=cpu32}.
13007 Use this option for microcontrollers with a
13008 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
13009 68336, 68340, 68341, 68349 and 68360.
13011 @item -m5200
13012 @opindex m5200
13013 Generate output for a 520X ColdFire CPU@.  This is the default
13014 when the compiler is configured for 520X-based systems.
13015 It is equivalent to @option{-mcpu=5206}, and is now deprecated
13016 in favor of that option.
13018 Use this option for microcontroller with a 5200 core, including
13019 the MCF5202, MCF5203, MCF5204 and MCF5206.
13021 @item -m5206e
13022 @opindex m5206e
13023 Generate output for a 5206e ColdFire CPU@.  The option is now
13024 deprecated in favor of the equivalent @option{-mcpu=5206e}.
13026 @item -m528x
13027 @opindex m528x
13028 Generate output for a member of the ColdFire 528X family.
13029 The option is now deprecated in favor of the equivalent
13030 @option{-mcpu=528x}.
13032 @item -m5307
13033 @opindex m5307
13034 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
13035 in favor of the equivalent @option{-mcpu=5307}.
13037 @item -m5407
13038 @opindex m5407
13039 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
13040 in favor of the equivalent @option{-mcpu=5407}.
13042 @item -mcfv4e
13043 @opindex mcfv4e
13044 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
13045 This includes use of hardware floating point instructions.
13046 The option is equivalent to @option{-mcpu=547x}, and is now
13047 deprecated in favor of that option.
13049 @item -m68020-40
13050 @opindex m68020-40
13051 Generate output for a 68040, without using any of the new instructions.
13052 This results in code which can run relatively efficiently on either a
13053 68020/68881 or a 68030 or a 68040.  The generated code does use the
13054 68881 instructions that are emulated on the 68040.
13056 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
13058 @item -m68020-60
13059 @opindex m68020-60
13060 Generate output for a 68060, without using any of the new instructions.
13061 This results in code which can run relatively efficiently on either a
13062 68020/68881 or a 68030 or a 68040.  The generated code does use the
13063 68881 instructions that are emulated on the 68060.
13065 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
13067 @item -mhard-float
13068 @itemx -m68881
13069 @opindex mhard-float
13070 @opindex m68881
13071 Generate floating-point instructions.  This is the default for 68020
13072 and above, and for ColdFire devices that have an FPU@.  It defines the
13073 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
13074 on ColdFire targets.
13076 @item -msoft-float
13077 @opindex msoft-float
13078 Do not generate floating-point instructions; use library calls instead.
13079 This is the default for 68000, 68010, and 68832 targets.  It is also
13080 the default for ColdFire devices that have no FPU.
13082 @item -mdiv
13083 @itemx -mno-div
13084 @opindex mdiv
13085 @opindex mno-div
13086 Generate (do not generate) ColdFire hardware divide and remainder
13087 instructions.  If @option{-march} is used without @option{-mcpu},
13088 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
13089 architectures.  Otherwise, the default is taken from the target CPU
13090 (either the default CPU, or the one specified by @option{-mcpu}).  For
13091 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
13092 @option{-mcpu=5206e}.
13094 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
13096 @item -mshort
13097 @opindex mshort
13098 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13099 Additionally, parameters passed on the stack are also aligned to a
13100 16-bit boundary even on targets whose API mandates promotion to 32-bit.
13102 @item -mno-short
13103 @opindex mno-short
13104 Do not consider type @code{int} to be 16 bits wide.  This is the default.
13106 @item -mnobitfield
13107 @itemx -mno-bitfield
13108 @opindex mnobitfield
13109 @opindex mno-bitfield
13110 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
13111 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
13113 @item -mbitfield
13114 @opindex mbitfield
13115 Do use the bit-field instructions.  The @option{-m68020} option implies
13116 @option{-mbitfield}.  This is the default if you use a configuration
13117 designed for a 68020.
13119 @item -mrtd
13120 @opindex mrtd
13121 Use a different function-calling convention, in which functions
13122 that take a fixed number of arguments return with the @code{rtd}
13123 instruction, which pops their arguments while returning.  This
13124 saves one instruction in the caller since there is no need to pop
13125 the arguments there.
13127 This calling convention is incompatible with the one normally
13128 used on Unix, so you cannot use it if you need to call libraries
13129 compiled with the Unix compiler.
13131 Also, you must provide function prototypes for all functions that
13132 take variable numbers of arguments (including @code{printf});
13133 otherwise incorrect code will be generated for calls to those
13134 functions.
13136 In addition, seriously incorrect code will result if you call a
13137 function with too many arguments.  (Normally, extra arguments are
13138 harmlessly ignored.)
13140 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13141 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13143 @item -mno-rtd
13144 @opindex mno-rtd
13145 Do not use the calling conventions selected by @option{-mrtd}.
13146 This is the default.
13148 @item -malign-int
13149 @itemx -mno-align-int
13150 @opindex malign-int
13151 @opindex mno-align-int
13152 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13153 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13154 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13155 Aligning variables on 32-bit boundaries produces code that runs somewhat
13156 faster on processors with 32-bit busses at the expense of more memory.
13158 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13159 align structures containing the above types  differently than
13160 most published application binary interface specifications for the m68k.
13162 @item -mpcrel
13163 @opindex mpcrel
13164 Use the pc-relative addressing mode of the 68000 directly, instead of
13165 using a global offset table.  At present, this option implies @option{-fpic},
13166 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
13167 not presently supported with @option{-mpcrel}, though this could be supported for
13168 68020 and higher processors.
13170 @item -mno-strict-align
13171 @itemx -mstrict-align
13172 @opindex mno-strict-align
13173 @opindex mstrict-align
13174 Do not (do) assume that unaligned memory references will be handled by
13175 the system.
13177 @item -msep-data
13178 Generate code that allows the data segment to be located in a different
13179 area of memory from the text segment.  This allows for execute in place in
13180 an environment without virtual memory management.  This option implies
13181 @option{-fPIC}.
13183 @item -mno-sep-data
13184 Generate code that assumes that the data segment follows the text segment.
13185 This is the default.
13187 @item -mid-shared-library
13188 Generate code that supports shared libraries via the library ID method.
13189 This allows for execute in place and shared libraries in an environment
13190 without virtual memory management.  This option implies @option{-fPIC}.
13192 @item -mno-id-shared-library
13193 Generate code that doesn't assume ID based shared libraries are being used.
13194 This is the default.
13196 @item -mshared-library-id=n
13197 Specified the identification number of the ID based shared library being
13198 compiled.  Specifying a value of 0 will generate more compact code, specifying
13199 other values will force the allocation of that number to the current
13200 library but is no more space or time efficient than omitting this option.
13202 @item -mxgot
13203 @itemx -mno-xgot
13204 @opindex mxgot
13205 @opindex mno-xgot
13206 When generating position-independent code for ColdFire, generate code
13207 that works if the GOT has more than 8192 entries.  This code is
13208 larger and slower than code generated without this option.  On M680x0
13209 processors, this option is not needed; @option{-fPIC} suffices.
13211 GCC normally uses a single instruction to load values from the GOT@.
13212 While this is relatively efficient, it only works if the GOT
13213 is smaller than about 64k.  Anything larger causes the linker
13214 to report an error such as:
13216 @cindex relocation truncated to fit (ColdFire)
13217 @smallexample
13218 relocation truncated to fit: R_68K_GOT16O foobar
13219 @end smallexample
13221 If this happens, you should recompile your code with @option{-mxgot}.
13222 It should then work with very large GOTs.  However, code generated with
13223 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13224 the value of a global symbol.
13226 Note that some linkers, including newer versions of the GNU linker,
13227 can create multiple GOTs and sort GOT entries.  If you have such a linker,
13228 you should only need to use @option{-mxgot} when compiling a single
13229 object file that accesses more than 8192 GOT entries.  Very few do.
13231 These options have no effect unless GCC is generating
13232 position-independent code.
13234 @end table
13236 @node M68hc1x Options
13237 @subsection M68hc1x Options
13238 @cindex M68hc1x options
13240 These are the @samp{-m} options defined for the 68hc11 and 68hc12
13241 microcontrollers.  The default values for these options depends on
13242 which style of microcontroller was selected when the compiler was configured;
13243 the defaults for the most common choices are given below.
13245 @table @gcctabopt
13246 @item -m6811
13247 @itemx -m68hc11
13248 @opindex m6811
13249 @opindex m68hc11
13250 Generate output for a 68HC11.  This is the default
13251 when the compiler is configured for 68HC11-based systems.
13253 @item -m6812
13254 @itemx -m68hc12
13255 @opindex m6812
13256 @opindex m68hc12
13257 Generate output for a 68HC12.  This is the default
13258 when the compiler is configured for 68HC12-based systems.
13260 @item -m68S12
13261 @itemx -m68hcs12
13262 @opindex m68S12
13263 @opindex m68hcs12
13264 Generate output for a 68HCS12.
13266 @item -mauto-incdec
13267 @opindex mauto-incdec
13268 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
13269 addressing modes.
13271 @item -minmax
13272 @itemx -mnominmax
13273 @opindex minmax
13274 @opindex mnominmax
13275 Enable the use of 68HC12 min and max instructions.
13277 @item -mlong-calls
13278 @itemx -mno-long-calls
13279 @opindex mlong-calls
13280 @opindex mno-long-calls
13281 Treat all calls as being far away (near).  If calls are assumed to be
13282 far away, the compiler will use the @code{call} instruction to
13283 call a function and the @code{rtc} instruction for returning.
13285 @item -mshort
13286 @opindex mshort
13287 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13289 @item -msoft-reg-count=@var{count}
13290 @opindex msoft-reg-count
13291 Specify the number of pseudo-soft registers which are used for the
13292 code generation.  The maximum number is 32.  Using more pseudo-soft
13293 register may or may not result in better code depending on the program.
13294 The default is 4 for 68HC11 and 2 for 68HC12.
13296 @end table
13298 @node MCore Options
13299 @subsection MCore Options
13300 @cindex MCore options
13302 These are the @samp{-m} options defined for the Motorola M*Core
13303 processors.
13305 @table @gcctabopt
13307 @item -mhardlit
13308 @itemx -mno-hardlit
13309 @opindex mhardlit
13310 @opindex mno-hardlit
13311 Inline constants into the code stream if it can be done in two
13312 instructions or less.
13314 @item -mdiv
13315 @itemx -mno-div
13316 @opindex mdiv
13317 @opindex mno-div
13318 Use the divide instruction.  (Enabled by default).
13320 @item -mrelax-immediate
13321 @itemx -mno-relax-immediate
13322 @opindex mrelax-immediate
13323 @opindex mno-relax-immediate
13324 Allow arbitrary sized immediates in bit operations.
13326 @item -mwide-bitfields
13327 @itemx -mno-wide-bitfields
13328 @opindex mwide-bitfields
13329 @opindex mno-wide-bitfields
13330 Always treat bit-fields as int-sized.
13332 @item -m4byte-functions
13333 @itemx -mno-4byte-functions
13334 @opindex m4byte-functions
13335 @opindex mno-4byte-functions
13336 Force all functions to be aligned to a four byte boundary.
13338 @item -mcallgraph-data
13339 @itemx -mno-callgraph-data
13340 @opindex mcallgraph-data
13341 @opindex mno-callgraph-data
13342 Emit callgraph information.
13344 @item -mslow-bytes
13345 @itemx -mno-slow-bytes
13346 @opindex mslow-bytes
13347 @opindex mno-slow-bytes
13348 Prefer word access when reading byte quantities.
13350 @item -mlittle-endian
13351 @itemx -mbig-endian
13352 @opindex mlittle-endian
13353 @opindex mbig-endian
13354 Generate code for a little endian target.
13356 @item -m210
13357 @itemx -m340
13358 @opindex m210
13359 @opindex m340
13360 Generate code for the 210 processor.
13362 @item -mno-lsim
13363 @opindex mno-lsim
13364 Assume that run-time support has been provided and so omit the
13365 simulator library (@file{libsim.a)} from the linker command line.
13367 @item -mstack-increment=@var{size}
13368 @opindex mstack-increment
13369 Set the maximum amount for a single stack increment operation.  Large
13370 values can increase the speed of programs which contain functions
13371 that need a large amount of stack space, but they can also trigger a
13372 segmentation fault if the stack is extended too much.  The default
13373 value is 0x1000.
13375 @end table
13377 @node MeP Options
13378 @subsection MeP Options
13379 @cindex MeP options
13381 @table @gcctabopt
13383 @item -mabsdiff
13384 @opindex mabsdiff
13385 Enables the @code{abs} instruction, which is the absolute difference
13386 between two registers.
13388 @item -mall-opts
13389 @opindex mall-opts
13390 Enables all the optional instructions - average, multiply, divide, bit
13391 operations, leading zero, absolute difference, min/max, clip, and
13392 saturation.
13395 @item -maverage
13396 @opindex maverage
13397 Enables the @code{ave} instruction, which computes the average of two
13398 registers.
13400 @item -mbased=@var{n}
13401 @opindex mbased=
13402 Variables of size @var{n} bytes or smaller will be placed in the
13403 @code{.based} section by default.  Based variables use the @code{$tp}
13404 register as a base register, and there is a 128 byte limit to the
13405 @code{.based} section.
13407 @item -mbitops
13408 @opindex mbitops
13409 Enables the bit operation instructions - bit test (@code{btstm}), set
13410 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13411 test-and-set (@code{tas}).
13413 @item -mc=@var{name}
13414 @opindex mc=
13415 Selects which section constant data will be placed in.  @var{name} may
13416 be @code{tiny}, @code{near}, or @code{far}.
13418 @item -mclip
13419 @opindex mclip
13420 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13421 useful unless you also provide @code{-mminmax}.
13423 @item -mconfig=@var{name}
13424 @opindex mconfig=
13425 Selects one of the build-in core configurations.  Each MeP chip has
13426 one or more modules in it; each module has a core CPU and a variety of
13427 coprocessors, optional instructions, and peripherals.  The
13428 @code{MeP-Integrator} tool, not part of GCC, provides these
13429 configurations through this option; using this option is the same as
13430 using all the corresponding command line options.  The default
13431 configuration is @code{default}.
13433 @item -mcop
13434 @opindex mcop
13435 Enables the coprocessor instructions.  By default, this is a 32-bit
13436 coprocessor.  Note that the coprocessor is normally enabled via the
13437 @code{-mconfig=} option.
13439 @item -mcop32
13440 @opindex mcop32
13441 Enables the 32-bit coprocessor's instructions.
13443 @item -mcop64
13444 @opindex mcop64
13445 Enables the 64-bit coprocessor's instructions.
13447 @item -mivc2
13448 @opindex mivc2
13449 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13451 @item -mdc
13452 @opindex mdc
13453 Causes constant variables to be placed in the @code{.near} section.
13455 @item -mdiv
13456 @opindex mdiv
13457 Enables the @code{div} and @code{divu} instructions.
13459 @item -meb
13460 @opindex meb
13461 Generate big-endian code.
13463 @item -mel
13464 @opindex mel
13465 Generate little-endian code.
13467 @item -mio-volatile
13468 @opindex mio-volatile
13469 Tells the compiler that any variable marked with the @code{io}
13470 attribute is to be considered volatile.
13472 @item -ml
13473 @opindex ml
13474 Causes variables to be assigned to the @code{.far} section by default.
13476 @item -mleadz
13477 @opindex mleadz
13478 Enables the @code{leadz} (leading zero) instruction.
13480 @item -mm
13481 @opindex mm
13482 Causes variables to be assigned to the @code{.near} section by default.
13484 @item -mminmax
13485 @opindex mminmax
13486 Enables the @code{min} and @code{max} instructions.
13488 @item -mmult
13489 @opindex mmult
13490 Enables the multiplication and multiply-accumulate instructions.
13492 @item -mno-opts
13493 @opindex mno-opts
13494 Disables all the optional instructions enabled by @code{-mall-opts}.
13496 @item -mrepeat
13497 @opindex mrepeat
13498 Enables the @code{repeat} and @code{erepeat} instructions, used for
13499 low-overhead looping.
13501 @item -ms
13502 @opindex ms
13503 Causes all variables to default to the @code{.tiny} section.  Note
13504 that there is a 65536 byte limit to this section.  Accesses to these
13505 variables use the @code{%gp} base register.
13507 @item -msatur
13508 @opindex msatur
13509 Enables the saturation instructions.  Note that the compiler does not
13510 currently generate these itself, but this option is included for
13511 compatibility with other tools, like @code{as}.
13513 @item -msdram
13514 @opindex msdram
13515 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13517 @item -msim
13518 @opindex msim
13519 Link the simulator runtime libraries.
13521 @item -msimnovec
13522 @opindex msimnovec
13523 Link the simulator runtime libraries, excluding built-in support
13524 for reset and exception vectors and tables.
13526 @item -mtf
13527 @opindex mtf
13528 Causes all functions to default to the @code{.far} section.  Without
13529 this option, functions default to the @code{.near} section.
13531 @item -mtiny=@var{n}
13532 @opindex mtiny=
13533 Variables that are @var{n} bytes or smaller will be allocated to the
13534 @code{.tiny} section.  These variables use the @code{$gp} base
13535 register.  The default for this option is 4, but note that there's a
13536 65536 byte limit to the @code{.tiny} section.
13538 @end table
13540 @node MIPS Options
13541 @subsection MIPS Options
13542 @cindex MIPS options
13544 @table @gcctabopt
13546 @item -EB
13547 @opindex EB
13548 Generate big-endian code.
13550 @item -EL
13551 @opindex EL
13552 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13553 configurations.
13555 @item -march=@var{arch}
13556 @opindex march
13557 Generate code that will run on @var{arch}, which can be the name of a
13558 generic MIPS ISA, or the name of a particular processor.
13559 The ISA names are:
13560 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13561 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13562 The processor names are:
13563 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13564 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13565 @samp{5kc}, @samp{5kf},
13566 @samp{20kc},
13567 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13568 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13569 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13570 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13571 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
13572 @samp{loongson2e}, @samp{loongson2f},
13573 @samp{m4k},
13574 @samp{octeon},
13575 @samp{orion},
13576 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
13577 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
13578 @samp{rm7000}, @samp{rm9000},
13579 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
13580 @samp{sb1},
13581 @samp{sr71000},
13582 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
13583 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
13584 and @samp{xlr}.
13585 The special value @samp{from-abi} selects the
13586 most compatible architecture for the selected ABI (that is,
13587 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
13589 Native Linux/GNU toolchains also support the value @samp{native},
13590 which selects the best architecture option for the host processor.
13591 @option{-march=native} has no effect if GCC does not recognize
13592 the processor.
13594 In processor names, a final @samp{000} can be abbreviated as @samp{k}
13595 (for example, @samp{-march=r2k}).  Prefixes are optional, and
13596 @samp{vr} may be written @samp{r}.
13598 Names of the form @samp{@var{n}f2_1} refer to processors with
13599 FPUs clocked at half the rate of the core, names of the form
13600 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
13601 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
13602 processors with FPUs clocked a ratio of 3:2 with respect to the core.
13603 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
13604 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
13605 accepted as synonyms for @samp{@var{n}f1_1}.
13607 GCC defines two macros based on the value of this option.  The first
13608 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
13609 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
13610 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
13611 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
13612 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
13614 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
13615 above.  In other words, it will have the full prefix and will not
13616 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
13617 the macro names the resolved architecture (either @samp{"mips1"} or
13618 @samp{"mips3"}).  It names the default architecture when no
13619 @option{-march} option is given.
13621 @item -mtune=@var{arch}
13622 @opindex mtune
13623 Optimize for @var{arch}.  Among other things, this option controls
13624 the way instructions are scheduled, and the perceived cost of arithmetic
13625 operations.  The list of @var{arch} values is the same as for
13626 @option{-march}.
13628 When this option is not used, GCC will optimize for the processor
13629 specified by @option{-march}.  By using @option{-march} and
13630 @option{-mtune} together, it is possible to generate code that will
13631 run on a family of processors, but optimize the code for one
13632 particular member of that family.
13634 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
13635 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
13636 @samp{-march} ones described above.
13638 @item -mips1
13639 @opindex mips1
13640 Equivalent to @samp{-march=mips1}.
13642 @item -mips2
13643 @opindex mips2
13644 Equivalent to @samp{-march=mips2}.
13646 @item -mips3
13647 @opindex mips3
13648 Equivalent to @samp{-march=mips3}.
13650 @item -mips4
13651 @opindex mips4
13652 Equivalent to @samp{-march=mips4}.
13654 @item -mips32
13655 @opindex mips32
13656 Equivalent to @samp{-march=mips32}.
13658 @item -mips32r2
13659 @opindex mips32r2
13660 Equivalent to @samp{-march=mips32r2}.
13662 @item -mips64
13663 @opindex mips64
13664 Equivalent to @samp{-march=mips64}.
13666 @item -mips64r2
13667 @opindex mips64r2
13668 Equivalent to @samp{-march=mips64r2}.
13670 @item -mips16
13671 @itemx -mno-mips16
13672 @opindex mips16
13673 @opindex mno-mips16
13674 Generate (do not generate) MIPS16 code.  If GCC is targetting a
13675 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
13677 MIPS16 code generation can also be controlled on a per-function basis
13678 by means of @code{mips16} and @code{nomips16} attributes.
13679 @xref{Function Attributes}, for more information.
13681 @item -mflip-mips16
13682 @opindex mflip-mips16
13683 Generate MIPS16 code on alternating functions.  This option is provided
13684 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
13685 not intended for ordinary use in compiling user code.
13687 @item -minterlink-mips16
13688 @itemx -mno-interlink-mips16
13689 @opindex minterlink-mips16
13690 @opindex mno-interlink-mips16
13691 Require (do not require) that non-MIPS16 code be link-compatible with
13692 MIPS16 code.
13694 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
13695 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
13696 therefore disables direct jumps unless GCC knows that the target of the
13697 jump is not MIPS16.
13699 @item -mabi=32
13700 @itemx -mabi=o64
13701 @itemx -mabi=n32
13702 @itemx -mabi=64
13703 @itemx -mabi=eabi
13704 @opindex mabi=32
13705 @opindex mabi=o64
13706 @opindex mabi=n32
13707 @opindex mabi=64
13708 @opindex mabi=eabi
13709 Generate code for the given ABI@.
13711 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
13712 generates 64-bit code when you select a 64-bit architecture, but you
13713 can use @option{-mgp32} to get 32-bit code instead.
13715 For information about the O64 ABI, see
13716 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
13718 GCC supports a variant of the o32 ABI in which floating-point registers
13719 are 64 rather than 32 bits wide.  You can select this combination with
13720 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
13721 and @samp{mfhc1} instructions and is therefore only supported for
13722 MIPS32R2 processors.
13724 The register assignments for arguments and return values remain the
13725 same, but each scalar value is passed in a single 64-bit register
13726 rather than a pair of 32-bit registers.  For example, scalar
13727 floating-point values are returned in @samp{$f0} only, not a
13728 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
13729 remains the same, but all 64 bits are saved.
13731 @item -mabicalls
13732 @itemx -mno-abicalls
13733 @opindex mabicalls
13734 @opindex mno-abicalls
13735 Generate (do not generate) code that is suitable for SVR4-style
13736 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
13737 systems.
13739 @item -mshared
13740 @itemx -mno-shared
13741 Generate (do not generate) code that is fully position-independent,
13742 and that can therefore be linked into shared libraries.  This option
13743 only affects @option{-mabicalls}.
13745 All @option{-mabicalls} code has traditionally been position-independent,
13746 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
13747 as an extension, the GNU toolchain allows executables to use absolute
13748 accesses for locally-binding symbols.  It can also use shorter GP
13749 initialization sequences and generate direct calls to locally-defined
13750 functions.  This mode is selected by @option{-mno-shared}.
13752 @option{-mno-shared} depends on binutils 2.16 or higher and generates
13753 objects that can only be linked by the GNU linker.  However, the option
13754 does not affect the ABI of the final executable; it only affects the ABI
13755 of relocatable objects.  Using @option{-mno-shared} will generally make
13756 executables both smaller and quicker.
13758 @option{-mshared} is the default.
13760 @item -mplt
13761 @itemx -mno-plt
13762 @opindex mplt
13763 @opindex mno-plt
13764 Assume (do not assume) that the static and dynamic linkers
13765 support PLTs and copy relocations.  This option only affects
13766 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
13767 has no effect without @samp{-msym32}.
13769 You can make @option{-mplt} the default by configuring
13770 GCC with @option{--with-mips-plt}.  The default is
13771 @option{-mno-plt} otherwise.
13773 @item -mxgot
13774 @itemx -mno-xgot
13775 @opindex mxgot
13776 @opindex mno-xgot
13777 Lift (do not lift) the usual restrictions on the size of the global
13778 offset table.
13780 GCC normally uses a single instruction to load values from the GOT@.
13781 While this is relatively efficient, it will only work if the GOT
13782 is smaller than about 64k.  Anything larger will cause the linker
13783 to report an error such as:
13785 @cindex relocation truncated to fit (MIPS)
13786 @smallexample
13787 relocation truncated to fit: R_MIPS_GOT16 foobar
13788 @end smallexample
13790 If this happens, you should recompile your code with @option{-mxgot}.
13791 It should then work with very large GOTs, although it will also be
13792 less efficient, since it will take three instructions to fetch the
13793 value of a global symbol.
13795 Note that some linkers can create multiple GOTs.  If you have such a
13796 linker, you should only need to use @option{-mxgot} when a single object
13797 file accesses more than 64k's worth of GOT entries.  Very few do.
13799 These options have no effect unless GCC is generating position
13800 independent code.
13802 @item -mgp32
13803 @opindex mgp32
13804 Assume that general-purpose registers are 32 bits wide.
13806 @item -mgp64
13807 @opindex mgp64
13808 Assume that general-purpose registers are 64 bits wide.
13810 @item -mfp32
13811 @opindex mfp32
13812 Assume that floating-point registers are 32 bits wide.
13814 @item -mfp64
13815 @opindex mfp64
13816 Assume that floating-point registers are 64 bits wide.
13818 @item -mhard-float
13819 @opindex mhard-float
13820 Use floating-point coprocessor instructions.
13822 @item -msoft-float
13823 @opindex msoft-float
13824 Do not use floating-point coprocessor instructions.  Implement
13825 floating-point calculations using library calls instead.
13827 @item -msingle-float
13828 @opindex msingle-float
13829 Assume that the floating-point coprocessor only supports single-precision
13830 operations.
13832 @item -mdouble-float
13833 @opindex mdouble-float
13834 Assume that the floating-point coprocessor supports double-precision
13835 operations.  This is the default.
13837 @item -mllsc
13838 @itemx -mno-llsc
13839 @opindex mllsc
13840 @opindex mno-llsc
13841 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
13842 implement atomic memory built-in functions.  When neither option is
13843 specified, GCC will use the instructions if the target architecture
13844 supports them.
13846 @option{-mllsc} is useful if the runtime environment can emulate the
13847 instructions and @option{-mno-llsc} can be useful when compiling for
13848 nonstandard ISAs.  You can make either option the default by
13849 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
13850 respectively.  @option{--with-llsc} is the default for some
13851 configurations; see the installation documentation for details.
13853 @item -mdsp
13854 @itemx -mno-dsp
13855 @opindex mdsp
13856 @opindex mno-dsp
13857 Use (do not use) revision 1 of the MIPS DSP ASE@.
13858 @xref{MIPS DSP Built-in Functions}.  This option defines the
13859 preprocessor macro @samp{__mips_dsp}.  It also defines
13860 @samp{__mips_dsp_rev} to 1.
13862 @item -mdspr2
13863 @itemx -mno-dspr2
13864 @opindex mdspr2
13865 @opindex mno-dspr2
13866 Use (do not use) revision 2 of the MIPS DSP ASE@.
13867 @xref{MIPS DSP Built-in Functions}.  This option defines the
13868 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
13869 It also defines @samp{__mips_dsp_rev} to 2.
13871 @item -msmartmips
13872 @itemx -mno-smartmips
13873 @opindex msmartmips
13874 @opindex mno-smartmips
13875 Use (do not use) the MIPS SmartMIPS ASE.
13877 @item -mpaired-single
13878 @itemx -mno-paired-single
13879 @opindex mpaired-single
13880 @opindex mno-paired-single
13881 Use (do not use) paired-single floating-point instructions.
13882 @xref{MIPS Paired-Single Support}.  This option requires
13883 hardware floating-point support to be enabled.
13885 @item -mdmx
13886 @itemx -mno-mdmx
13887 @opindex mdmx
13888 @opindex mno-mdmx
13889 Use (do not use) MIPS Digital Media Extension instructions.
13890 This option can only be used when generating 64-bit code and requires
13891 hardware floating-point support to be enabled.
13893 @item -mips3d
13894 @itemx -mno-mips3d
13895 @opindex mips3d
13896 @opindex mno-mips3d
13897 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
13898 The option @option{-mips3d} implies @option{-mpaired-single}.
13900 @item -mmt
13901 @itemx -mno-mt
13902 @opindex mmt
13903 @opindex mno-mt
13904 Use (do not use) MT Multithreading instructions.
13906 @item -mlong64
13907 @opindex mlong64
13908 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
13909 an explanation of the default and the way that the pointer size is
13910 determined.
13912 @item -mlong32
13913 @opindex mlong32
13914 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
13916 The default size of @code{int}s, @code{long}s and pointers depends on
13917 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
13918 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
13919 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
13920 or the same size as integer registers, whichever is smaller.
13922 @item -msym32
13923 @itemx -mno-sym32
13924 @opindex msym32
13925 @opindex mno-sym32
13926 Assume (do not assume) that all symbols have 32-bit values, regardless
13927 of the selected ABI@.  This option is useful in combination with
13928 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
13929 to generate shorter and faster references to symbolic addresses.
13931 @item -G @var{num}
13932 @opindex G
13933 Put definitions of externally-visible data in a small data section
13934 if that data is no bigger than @var{num} bytes.  GCC can then access
13935 the data more efficiently; see @option{-mgpopt} for details.
13937 The default @option{-G} option depends on the configuration.
13939 @item -mlocal-sdata
13940 @itemx -mno-local-sdata
13941 @opindex mlocal-sdata
13942 @opindex mno-local-sdata
13943 Extend (do not extend) the @option{-G} behavior to local data too,
13944 such as to static variables in C@.  @option{-mlocal-sdata} is the
13945 default for all configurations.
13947 If the linker complains that an application is using too much small data,
13948 you might want to try rebuilding the less performance-critical parts with
13949 @option{-mno-local-sdata}.  You might also want to build large
13950 libraries with @option{-mno-local-sdata}, so that the libraries leave
13951 more room for the main program.
13953 @item -mextern-sdata
13954 @itemx -mno-extern-sdata
13955 @opindex mextern-sdata
13956 @opindex mno-extern-sdata
13957 Assume (do not assume) that externally-defined data will be in
13958 a small data section if that data is within the @option{-G} limit.
13959 @option{-mextern-sdata} is the default for all configurations.
13961 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
13962 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
13963 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
13964 is placed in a small data section.  If @var{Var} is defined by another
13965 module, you must either compile that module with a high-enough
13966 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
13967 definition.  If @var{Var} is common, you must link the application
13968 with a high-enough @option{-G} setting.
13970 The easiest way of satisfying these restrictions is to compile
13971 and link every module with the same @option{-G} option.  However,
13972 you may wish to build a library that supports several different
13973 small data limits.  You can do this by compiling the library with
13974 the highest supported @option{-G} setting and additionally using
13975 @option{-mno-extern-sdata} to stop the library from making assumptions
13976 about externally-defined data.
13978 @item -mgpopt
13979 @itemx -mno-gpopt
13980 @opindex mgpopt
13981 @opindex mno-gpopt
13982 Use (do not use) GP-relative accesses for symbols that are known to be
13983 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
13984 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
13985 configurations.
13987 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
13988 might not hold the value of @code{_gp}.  For example, if the code is
13989 part of a library that might be used in a boot monitor, programs that
13990 call boot monitor routines will pass an unknown value in @code{$gp}.
13991 (In such situations, the boot monitor itself would usually be compiled
13992 with @option{-G0}.)
13994 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
13995 @option{-mno-extern-sdata}.
13997 @item -membedded-data
13998 @itemx -mno-embedded-data
13999 @opindex membedded-data
14000 @opindex mno-embedded-data
14001 Allocate variables to the read-only data section first if possible, then
14002 next in the small data section if possible, otherwise in data.  This gives
14003 slightly slower code than the default, but reduces the amount of RAM required
14004 when executing, and thus may be preferred for some embedded systems.
14006 @item -muninit-const-in-rodata
14007 @itemx -mno-uninit-const-in-rodata
14008 @opindex muninit-const-in-rodata
14009 @opindex mno-uninit-const-in-rodata
14010 Put uninitialized @code{const} variables in the read-only data section.
14011 This option is only meaningful in conjunction with @option{-membedded-data}.
14013 @item -mcode-readable=@var{setting}
14014 @opindex mcode-readable
14015 Specify whether GCC may generate code that reads from executable sections.
14016 There are three possible settings:
14018 @table @gcctabopt
14019 @item -mcode-readable=yes
14020 Instructions may freely access executable sections.  This is the
14021 default setting.
14023 @item -mcode-readable=pcrel
14024 MIPS16 PC-relative load instructions can access executable sections,
14025 but other instructions must not do so.  This option is useful on 4KSc
14026 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
14027 It is also useful on processors that can be configured to have a dual
14028 instruction/data SRAM interface and that, like the M4K, automatically
14029 redirect PC-relative loads to the instruction RAM.
14031 @item -mcode-readable=no
14032 Instructions must not access executable sections.  This option can be
14033 useful on targets that are configured to have a dual instruction/data
14034 SRAM interface but that (unlike the M4K) do not automatically redirect
14035 PC-relative loads to the instruction RAM.
14036 @end table
14038 @item -msplit-addresses
14039 @itemx -mno-split-addresses
14040 @opindex msplit-addresses
14041 @opindex mno-split-addresses
14042 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
14043 relocation operators.  This option has been superseded by
14044 @option{-mexplicit-relocs} but is retained for backwards compatibility.
14046 @item -mexplicit-relocs
14047 @itemx -mno-explicit-relocs
14048 @opindex mexplicit-relocs
14049 @opindex mno-explicit-relocs
14050 Use (do not use) assembler relocation operators when dealing with symbolic
14051 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
14052 is to use assembler macros instead.
14054 @option{-mexplicit-relocs} is the default if GCC was configured
14055 to use an assembler that supports relocation operators.
14057 @item -mcheck-zero-division
14058 @itemx -mno-check-zero-division
14059 @opindex mcheck-zero-division
14060 @opindex mno-check-zero-division
14061 Trap (do not trap) on integer division by zero.
14063 The default is @option{-mcheck-zero-division}.
14065 @item -mdivide-traps
14066 @itemx -mdivide-breaks
14067 @opindex mdivide-traps
14068 @opindex mdivide-breaks
14069 MIPS systems check for division by zero by generating either a
14070 conditional trap or a break instruction.  Using traps results in
14071 smaller code, but is only supported on MIPS II and later.  Also, some
14072 versions of the Linux kernel have a bug that prevents trap from
14073 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
14074 allow conditional traps on architectures that support them and
14075 @option{-mdivide-breaks} to force the use of breaks.
14077 The default is usually @option{-mdivide-traps}, but this can be
14078 overridden at configure time using @option{--with-divide=breaks}.
14079 Divide-by-zero checks can be completely disabled using
14080 @option{-mno-check-zero-division}.
14082 @item -mmemcpy
14083 @itemx -mno-memcpy
14084 @opindex mmemcpy
14085 @opindex mno-memcpy
14086 Force (do not force) the use of @code{memcpy()} for non-trivial block
14087 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
14088 most constant-sized copies.
14090 @item -mlong-calls
14091 @itemx -mno-long-calls
14092 @opindex mlong-calls
14093 @opindex mno-long-calls
14094 Disable (do not disable) use of the @code{jal} instruction.  Calling
14095 functions using @code{jal} is more efficient but requires the caller
14096 and callee to be in the same 256 megabyte segment.
14098 This option has no effect on abicalls code.  The default is
14099 @option{-mno-long-calls}.
14101 @item -mmad
14102 @itemx -mno-mad
14103 @opindex mmad
14104 @opindex mno-mad
14105 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
14106 instructions, as provided by the R4650 ISA@.
14108 @item -mfused-madd
14109 @itemx -mno-fused-madd
14110 @opindex mfused-madd
14111 @opindex mno-fused-madd
14112 Enable (disable) use of the floating point multiply-accumulate
14113 instructions, when they are available.  The default is
14114 @option{-mfused-madd}.
14116 When multiply-accumulate instructions are used, the intermediate
14117 product is calculated to infinite precision and is not subject to
14118 the FCSR Flush to Zero bit.  This may be undesirable in some
14119 circumstances.
14121 @item -nocpp
14122 @opindex nocpp
14123 Tell the MIPS assembler to not run its preprocessor over user
14124 assembler files (with a @samp{.s} suffix) when assembling them.
14126 @item -mfix-r4000
14127 @itemx -mno-fix-r4000
14128 @opindex mfix-r4000
14129 @opindex mno-fix-r4000
14130 Work around certain R4000 CPU errata:
14131 @itemize @minus
14132 @item
14133 A double-word or a variable shift may give an incorrect result if executed
14134 immediately after starting an integer division.
14135 @item
14136 A double-word or a variable shift may give an incorrect result if executed
14137 while an integer multiplication is in progress.
14138 @item
14139 An integer division may give an incorrect result if started in a delay slot
14140 of a taken branch or a jump.
14141 @end itemize
14143 @item -mfix-r4400
14144 @itemx -mno-fix-r4400
14145 @opindex mfix-r4400
14146 @opindex mno-fix-r4400
14147 Work around certain R4400 CPU errata:
14148 @itemize @minus
14149 @item
14150 A double-word or a variable shift may give an incorrect result if executed
14151 immediately after starting an integer division.
14152 @end itemize
14154 @item -mfix-r10000
14155 @itemx -mno-fix-r10000
14156 @opindex mfix-r10000
14157 @opindex mno-fix-r10000
14158 Work around certain R10000 errata:
14159 @itemize @minus
14160 @item
14161 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14162 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
14163 @end itemize
14165 This option can only be used if the target architecture supports
14166 branch-likely instructions.  @option{-mfix-r10000} is the default when
14167 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14168 otherwise.
14170 @item -mfix-vr4120
14171 @itemx -mno-fix-vr4120
14172 @opindex mfix-vr4120
14173 Work around certain VR4120 errata:
14174 @itemize @minus
14175 @item
14176 @code{dmultu} does not always produce the correct result.
14177 @item
14178 @code{div} and @code{ddiv} do not always produce the correct result if one
14179 of the operands is negative.
14180 @end itemize
14181 The workarounds for the division errata rely on special functions in
14182 @file{libgcc.a}.  At present, these functions are only provided by
14183 the @code{mips64vr*-elf} configurations.
14185 Other VR4120 errata require a nop to be inserted between certain pairs of
14186 instructions.  These errata are handled by the assembler, not by GCC itself.
14188 @item -mfix-vr4130
14189 @opindex mfix-vr4130
14190 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
14191 workarounds are implemented by the assembler rather than by GCC,
14192 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14193 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14194 instructions are available instead.
14196 @item -mfix-sb1
14197 @itemx -mno-fix-sb1
14198 @opindex mfix-sb1
14199 Work around certain SB-1 CPU core errata.
14200 (This flag currently works around the SB-1 revision 2
14201 ``F1'' and ``F2'' floating point errata.)
14203 @item -mr10k-cache-barrier=@var{setting}
14204 @opindex mr10k-cache-barrier
14205 Specify whether GCC should insert cache barriers to avoid the
14206 side-effects of speculation on R10K processors.
14208 In common with many processors, the R10K tries to predict the outcome
14209 of a conditional branch and speculatively executes instructions from
14210 the ``taken'' branch.  It later aborts these instructions if the
14211 predicted outcome was wrong.  However, on the R10K, even aborted
14212 instructions can have side effects.
14214 This problem only affects kernel stores and, depending on the system,
14215 kernel loads.  As an example, a speculatively-executed store may load
14216 the target memory into cache and mark the cache line as dirty, even if
14217 the store itself is later aborted.  If a DMA operation writes to the
14218 same area of memory before the ``dirty'' line is flushed, the cached
14219 data will overwrite the DMA-ed data.  See the R10K processor manual
14220 for a full description, including other potential problems.
14222 One workaround is to insert cache barrier instructions before every memory
14223 access that might be speculatively executed and that might have side
14224 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
14225 controls GCC's implementation of this workaround.  It assumes that
14226 aborted accesses to any byte in the following regions will not have
14227 side effects:
14229 @enumerate
14230 @item
14231 the memory occupied by the current function's stack frame;
14233 @item
14234 the memory occupied by an incoming stack argument;
14236 @item
14237 the memory occupied by an object with a link-time-constant address.
14238 @end enumerate
14240 It is the kernel's responsibility to ensure that speculative
14241 accesses to these regions are indeed safe.
14243 If the input program contains a function declaration such as:
14245 @smallexample
14246 void foo (void);
14247 @end smallexample
14249 then the implementation of @code{foo} must allow @code{j foo} and
14250 @code{jal foo} to be executed speculatively.  GCC honors this
14251 restriction for functions it compiles itself.  It expects non-GCC
14252 functions (such as hand-written assembly code) to do the same.
14254 The option has three forms:
14256 @table @gcctabopt
14257 @item -mr10k-cache-barrier=load-store
14258 Insert a cache barrier before a load or store that might be
14259 speculatively executed and that might have side effects even
14260 if aborted.
14262 @item -mr10k-cache-barrier=store
14263 Insert a cache barrier before a store that might be speculatively
14264 executed and that might have side effects even if aborted.
14266 @item -mr10k-cache-barrier=none
14267 Disable the insertion of cache barriers.  This is the default setting.
14268 @end table
14270 @item -mflush-func=@var{func}
14271 @itemx -mno-flush-func
14272 @opindex mflush-func
14273 Specifies the function to call to flush the I and D caches, or to not
14274 call any such function.  If called, the function must take the same
14275 arguments as the common @code{_flush_func()}, that is, the address of the
14276 memory range for which the cache is being flushed, the size of the
14277 memory range, and the number 3 (to flush both caches).  The default
14278 depends on the target GCC was configured for, but commonly is either
14279 @samp{_flush_func} or @samp{__cpu_flush}.
14281 @item mbranch-cost=@var{num}
14282 @opindex mbranch-cost
14283 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14284 This cost is only a heuristic and is not guaranteed to produce
14285 consistent results across releases.  A zero cost redundantly selects
14286 the default, which is based on the @option{-mtune} setting.
14288 @item -mbranch-likely
14289 @itemx -mno-branch-likely
14290 @opindex mbranch-likely
14291 @opindex mno-branch-likely
14292 Enable or disable use of Branch Likely instructions, regardless of the
14293 default for the selected architecture.  By default, Branch Likely
14294 instructions may be generated if they are supported by the selected
14295 architecture.  An exception is for the MIPS32 and MIPS64 architectures
14296 and processors which implement those architectures; for those, Branch
14297 Likely instructions will not be generated by default because the MIPS32
14298 and MIPS64 architectures specifically deprecate their use.
14300 @item -mfp-exceptions
14301 @itemx -mno-fp-exceptions
14302 @opindex mfp-exceptions
14303 Specifies whether FP exceptions are enabled.  This affects how we schedule
14304 FP instructions for some processors.  The default is that FP exceptions are
14305 enabled.
14307 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14308 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
14309 FP pipe.
14311 @item -mvr4130-align
14312 @itemx -mno-vr4130-align
14313 @opindex mvr4130-align
14314 The VR4130 pipeline is two-way superscalar, but can only issue two
14315 instructions together if the first one is 8-byte aligned.  When this
14316 option is enabled, GCC will align pairs of instructions that it
14317 thinks should execute in parallel.
14319 This option only has an effect when optimizing for the VR4130.
14320 It normally makes code faster, but at the expense of making it bigger.
14321 It is enabled by default at optimization level @option{-O3}.
14323 @item -msynci
14324 @itemx -mno-synci
14325 @opindex msynci
14326 Enable (disable) generation of @code{synci} instructions on
14327 architectures that support it.  The @code{synci} instructions (if
14328 enabled) will be generated when @code{__builtin___clear_cache()} is
14329 compiled.
14331 This option defaults to @code{-mno-synci}, but the default can be
14332 overridden by configuring with @code{--with-synci}.
14334 When compiling code for single processor systems, it is generally safe
14335 to use @code{synci}.  However, on many multi-core (SMP) systems, it
14336 will not invalidate the instruction caches on all cores and may lead
14337 to undefined behavior.
14339 @item -mrelax-pic-calls
14340 @itemx -mno-relax-pic-calls
14341 @opindex mrelax-pic-calls
14342 Try to turn PIC calls that are normally dispatched via register
14343 @code{$25} into direct calls.  This is only possible if the linker can
14344 resolve the destination at link-time and if the destination is within
14345 range for a direct call.
14347 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14348 an assembler and a linker that supports the @code{.reloc} assembly
14349 directive and @code{-mexplicit-relocs} is in effect.  With
14350 @code{-mno-explicit-relocs}, this optimization can be performed by the
14351 assembler and the linker alone without help from the compiler.
14353 @item -mmcount-ra-address
14354 @itemx -mno-mcount-ra-address
14355 @opindex mmcount-ra-address
14356 @opindex mno-mcount-ra-address
14357 Emit (do not emit) code that allows @code{_mcount} to modify the
14358 calling function's return address.  When enabled, this option extends
14359 the usual @code{_mcount} interface with a new @var{ra-address}
14360 parameter, which has type @code{intptr_t *} and is passed in register
14361 @code{$12}.  @code{_mcount} can then modify the return address by
14362 doing both of the following:
14363 @itemize
14364 @item
14365 Returning the new address in register @code{$31}.
14366 @item
14367 Storing the new address in @code{*@var{ra-address}},
14368 if @var{ra-address} is nonnull.
14369 @end itemize
14371 The default is @option{-mno-mcount-ra-address}.
14373 @end table
14375 @node MMIX Options
14376 @subsection MMIX Options
14377 @cindex MMIX Options
14379 These options are defined for the MMIX:
14381 @table @gcctabopt
14382 @item -mlibfuncs
14383 @itemx -mno-libfuncs
14384 @opindex mlibfuncs
14385 @opindex mno-libfuncs
14386 Specify that intrinsic library functions are being compiled, passing all
14387 values in registers, no matter the size.
14389 @item -mepsilon
14390 @itemx -mno-epsilon
14391 @opindex mepsilon
14392 @opindex mno-epsilon
14393 Generate floating-point comparison instructions that compare with respect
14394 to the @code{rE} epsilon register.
14396 @item -mabi=mmixware
14397 @itemx -mabi=gnu
14398 @opindex mabi=mmixware
14399 @opindex mabi=gnu
14400 Generate code that passes function parameters and return values that (in
14401 the called function) are seen as registers @code{$0} and up, as opposed to
14402 the GNU ABI which uses global registers @code{$231} and up.
14404 @item -mzero-extend
14405 @itemx -mno-zero-extend
14406 @opindex mzero-extend
14407 @opindex mno-zero-extend
14408 When reading data from memory in sizes shorter than 64 bits, use (do not
14409 use) zero-extending load instructions by default, rather than
14410 sign-extending ones.
14412 @item -mknuthdiv
14413 @itemx -mno-knuthdiv
14414 @opindex mknuthdiv
14415 @opindex mno-knuthdiv
14416 Make the result of a division yielding a remainder have the same sign as
14417 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
14418 remainder follows the sign of the dividend.  Both methods are
14419 arithmetically valid, the latter being almost exclusively used.
14421 @item -mtoplevel-symbols
14422 @itemx -mno-toplevel-symbols
14423 @opindex mtoplevel-symbols
14424 @opindex mno-toplevel-symbols
14425 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
14426 code can be used with the @code{PREFIX} assembly directive.
14428 @item -melf
14429 @opindex melf
14430 Generate an executable in the ELF format, rather than the default
14431 @samp{mmo} format used by the @command{mmix} simulator.
14433 @item -mbranch-predict
14434 @itemx -mno-branch-predict
14435 @opindex mbranch-predict
14436 @opindex mno-branch-predict
14437 Use (do not use) the probable-branch instructions, when static branch
14438 prediction indicates a probable branch.
14440 @item -mbase-addresses
14441 @itemx -mno-base-addresses
14442 @opindex mbase-addresses
14443 @opindex mno-base-addresses
14444 Generate (do not generate) code that uses @emph{base addresses}.  Using a
14445 base address automatically generates a request (handled by the assembler
14446 and the linker) for a constant to be set up in a global register.  The
14447 register is used for one or more base address requests within the range 0
14448 to 255 from the value held in the register.  The generally leads to short
14449 and fast code, but the number of different data items that can be
14450 addressed is limited.  This means that a program that uses lots of static
14451 data may require @option{-mno-base-addresses}.
14453 @item -msingle-exit
14454 @itemx -mno-single-exit
14455 @opindex msingle-exit
14456 @opindex mno-single-exit
14457 Force (do not force) generated code to have a single exit point in each
14458 function.
14459 @end table
14461 @node MN10300 Options
14462 @subsection MN10300 Options
14463 @cindex MN10300 options
14465 These @option{-m} options are defined for Matsushita MN10300 architectures:
14467 @table @gcctabopt
14468 @item -mmult-bug
14469 @opindex mmult-bug
14470 Generate code to avoid bugs in the multiply instructions for the MN10300
14471 processors.  This is the default.
14473 @item -mno-mult-bug
14474 @opindex mno-mult-bug
14475 Do not generate code to avoid bugs in the multiply instructions for the
14476 MN10300 processors.
14478 @item -mam33
14479 @opindex mam33
14480 Generate code which uses features specific to the AM33 processor.
14482 @item -mno-am33
14483 @opindex mno-am33
14484 Do not generate code which uses features specific to the AM33 processor.  This
14485 is the default.
14487 @item -mreturn-pointer-on-d0
14488 @opindex mreturn-pointer-on-d0
14489 When generating a function which returns a pointer, return the pointer
14490 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
14491 only in a0, and attempts to call such functions without a prototype
14492 would result in errors.  Note that this option is on by default; use
14493 @option{-mno-return-pointer-on-d0} to disable it.
14495 @item -mno-crt0
14496 @opindex mno-crt0
14497 Do not link in the C run-time initialization object file.
14499 @item -mrelax
14500 @opindex mrelax
14501 Indicate to the linker that it should perform a relaxation optimization pass
14502 to shorten branches, calls and absolute memory addresses.  This option only
14503 has an effect when used on the command line for the final link step.
14505 This option makes symbolic debugging impossible.
14506 @end table
14508 @node PDP-11 Options
14509 @subsection PDP-11 Options
14510 @cindex PDP-11 Options
14512 These options are defined for the PDP-11:
14514 @table @gcctabopt
14515 @item -mfpu
14516 @opindex mfpu
14517 Use hardware FPP floating point.  This is the default.  (FIS floating
14518 point on the PDP-11/40 is not supported.)
14520 @item -msoft-float
14521 @opindex msoft-float
14522 Do not use hardware floating point.
14524 @item -mac0
14525 @opindex mac0
14526 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
14528 @item -mno-ac0
14529 @opindex mno-ac0
14530 Return floating-point results in memory.  This is the default.
14532 @item -m40
14533 @opindex m40
14534 Generate code for a PDP-11/40.
14536 @item -m45
14537 @opindex m45
14538 Generate code for a PDP-11/45.  This is the default.
14540 @item -m10
14541 @opindex m10
14542 Generate code for a PDP-11/10.
14544 @item -mbcopy-builtin
14545 @opindex mbcopy-builtin
14546 Use inline @code{movmemhi} patterns for copying memory.  This is the
14547 default.
14549 @item -mbcopy
14550 @opindex mbcopy
14551 Do not use inline @code{movmemhi} patterns for copying memory.
14553 @item -mint16
14554 @itemx -mno-int32
14555 @opindex mint16
14556 @opindex mno-int32
14557 Use 16-bit @code{int}.  This is the default.
14559 @item -mint32
14560 @itemx -mno-int16
14561 @opindex mint32
14562 @opindex mno-int16
14563 Use 32-bit @code{int}.
14565 @item -mfloat64
14566 @itemx -mno-float32
14567 @opindex mfloat64
14568 @opindex mno-float32
14569 Use 64-bit @code{float}.  This is the default.
14571 @item -mfloat32
14572 @itemx -mno-float64
14573 @opindex mfloat32
14574 @opindex mno-float64
14575 Use 32-bit @code{float}.
14577 @item -mabshi
14578 @opindex mabshi
14579 Use @code{abshi2} pattern.  This is the default.
14581 @item -mno-abshi
14582 @opindex mno-abshi
14583 Do not use @code{abshi2} pattern.
14585 @item -mbranch-expensive
14586 @opindex mbranch-expensive
14587 Pretend that branches are expensive.  This is for experimenting with
14588 code generation only.
14590 @item -mbranch-cheap
14591 @opindex mbranch-cheap
14592 Do not pretend that branches are expensive.  This is the default.
14594 @item -msplit
14595 @opindex msplit
14596 Generate code for a system with split I&D@.
14598 @item -mno-split
14599 @opindex mno-split
14600 Generate code for a system without split I&D@.  This is the default.
14602 @item -munix-asm
14603 @opindex munix-asm
14604 Use Unix assembler syntax.  This is the default when configured for
14605 @samp{pdp11-*-bsd}.
14607 @item -mdec-asm
14608 @opindex mdec-asm
14609 Use DEC assembler syntax.  This is the default when configured for any
14610 PDP-11 target other than @samp{pdp11-*-bsd}.
14611 @end table
14613 @node picoChip Options
14614 @subsection picoChip Options
14615 @cindex picoChip options
14617 These @samp{-m} options are defined for picoChip implementations:
14619 @table @gcctabopt
14621 @item -mae=@var{ae_type}
14622 @opindex mcpu
14623 Set the instruction set, register set, and instruction scheduling
14624 parameters for array element type @var{ae_type}.  Supported values
14625 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
14627 @option{-mae=ANY} selects a completely generic AE type.  Code
14628 generated with this option will run on any of the other AE types.  The
14629 code will not be as efficient as it would be if compiled for a specific
14630 AE type, and some types of operation (e.g., multiplication) will not
14631 work properly on all types of AE.
14633 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
14634 for compiled code, and is the default.
14636 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
14637 option may suffer from poor performance of byte (char) manipulation,
14638 since the DSP AE does not provide hardware support for byte load/stores.
14640 @item -msymbol-as-address
14641 Enable the compiler to directly use a symbol name as an address in a
14642 load/store instruction, without first loading it into a
14643 register.  Typically, the use of this option will generate larger
14644 programs, which run faster than when the option isn't used.  However, the
14645 results vary from program to program, so it is left as a user option,
14646 rather than being permanently enabled.
14648 @item -mno-inefficient-warnings
14649 Disables warnings about the generation of inefficient code.  These
14650 warnings can be generated, for example, when compiling code which
14651 performs byte-level memory operations on the MAC AE type.  The MAC AE has
14652 no hardware support for byte-level memory operations, so all byte
14653 load/stores must be synthesized from word load/store operations.  This is
14654 inefficient and a warning will be generated indicating to the programmer
14655 that they should rewrite the code to avoid byte operations, or to target
14656 an AE type which has the necessary hardware support.  This option enables
14657 the warning to be turned off.
14659 @end table
14661 @node PowerPC Options
14662 @subsection PowerPC Options
14663 @cindex PowerPC options
14665 These are listed under @xref{RS/6000 and PowerPC Options}.
14667 @node RS/6000 and PowerPC Options
14668 @subsection IBM RS/6000 and PowerPC Options
14669 @cindex RS/6000 and PowerPC Options
14670 @cindex IBM RS/6000 and PowerPC Options
14672 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
14673 @table @gcctabopt
14674 @item -mpower
14675 @itemx -mno-power
14676 @itemx -mpower2
14677 @itemx -mno-power2
14678 @itemx -mpowerpc
14679 @itemx -mno-powerpc
14680 @itemx -mpowerpc-gpopt
14681 @itemx -mno-powerpc-gpopt
14682 @itemx -mpowerpc-gfxopt
14683 @itemx -mno-powerpc-gfxopt
14684 @itemx -mpowerpc64
14685 @itemx -mno-powerpc64
14686 @itemx -mmfcrf
14687 @itemx -mno-mfcrf
14688 @itemx -mpopcntb
14689 @itemx -mno-popcntb
14690 @itemx -mpopcntd
14691 @itemx -mno-popcntd
14692 @itemx -mfprnd
14693 @itemx -mno-fprnd
14694 @itemx -mcmpb
14695 @itemx -mno-cmpb
14696 @itemx -mmfpgpr
14697 @itemx -mno-mfpgpr
14698 @itemx -mhard-dfp
14699 @itemx -mno-hard-dfp
14700 @opindex mpower
14701 @opindex mno-power
14702 @opindex mpower2
14703 @opindex mno-power2
14704 @opindex mpowerpc
14705 @opindex mno-powerpc
14706 @opindex mpowerpc-gpopt
14707 @opindex mno-powerpc-gpopt
14708 @opindex mpowerpc-gfxopt
14709 @opindex mno-powerpc-gfxopt
14710 @opindex mpowerpc64
14711 @opindex mno-powerpc64
14712 @opindex mmfcrf
14713 @opindex mno-mfcrf
14714 @opindex mpopcntb
14715 @opindex mno-popcntb
14716 @opindex mpopcntd
14717 @opindex mno-popcntd
14718 @opindex mfprnd
14719 @opindex mno-fprnd
14720 @opindex mcmpb
14721 @opindex mno-cmpb
14722 @opindex mmfpgpr
14723 @opindex mno-mfpgpr
14724 @opindex mhard-dfp
14725 @opindex mno-hard-dfp
14726 GCC supports two related instruction set architectures for the
14727 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
14728 instructions supported by the @samp{rios} chip set used in the original
14729 RS/6000 systems and the @dfn{PowerPC} instruction set is the
14730 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
14731 the IBM 4xx, 6xx, and follow-on microprocessors.
14733 Neither architecture is a subset of the other.  However there is a
14734 large common subset of instructions supported by both.  An MQ
14735 register is included in processors supporting the POWER architecture.
14737 You use these options to specify which instructions are available on the
14738 processor you are using.  The default value of these options is
14739 determined when configuring GCC@.  Specifying the
14740 @option{-mcpu=@var{cpu_type}} overrides the specification of these
14741 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
14742 rather than the options listed above.
14744 The @option{-mpower} option allows GCC to generate instructions that
14745 are found only in the POWER architecture and to use the MQ register.
14746 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
14747 to generate instructions that are present in the POWER2 architecture but
14748 not the original POWER architecture.
14750 The @option{-mpowerpc} option allows GCC to generate instructions that
14751 are found only in the 32-bit subset of the PowerPC architecture.
14752 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
14753 GCC to use the optional PowerPC architecture instructions in the
14754 General Purpose group, including floating-point square root.  Specifying
14755 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
14756 use the optional PowerPC architecture instructions in the Graphics
14757 group, including floating-point select.
14759 The @option{-mmfcrf} option allows GCC to generate the move from
14760 condition register field instruction implemented on the POWER4
14761 processor and other processors that support the PowerPC V2.01
14762 architecture.
14763 The @option{-mpopcntb} option allows GCC to generate the popcount and
14764 double precision FP reciprocal estimate instruction implemented on the
14765 POWER5 processor and other processors that support the PowerPC V2.02
14766 architecture.
14767 The @option{-mpopcntd} option allows GCC to generate the popcount
14768 instruction implemented on the POWER7 processor and other processors
14769 that support the PowerPC V2.06 architecture.
14770 The @option{-mfprnd} option allows GCC to generate the FP round to
14771 integer instructions implemented on the POWER5+ processor and other
14772 processors that support the PowerPC V2.03 architecture.
14773 The @option{-mcmpb} option allows GCC to generate the compare bytes
14774 instruction implemented on the POWER6 processor and other processors
14775 that support the PowerPC V2.05 architecture.
14776 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
14777 general purpose register instructions implemented on the POWER6X
14778 processor and other processors that support the extended PowerPC V2.05
14779 architecture.
14780 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
14781 point instructions implemented on some POWER processors.
14783 The @option{-mpowerpc64} option allows GCC to generate the additional
14784 64-bit instructions that are found in the full PowerPC64 architecture
14785 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
14786 @option{-mno-powerpc64}.
14788 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
14789 will use only the instructions in the common subset of both
14790 architectures plus some special AIX common-mode calls, and will not use
14791 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
14792 permits GCC to use any instruction from either architecture and to
14793 allow use of the MQ register; specify this for the Motorola MPC601.
14795 @item -mnew-mnemonics
14796 @itemx -mold-mnemonics
14797 @opindex mnew-mnemonics
14798 @opindex mold-mnemonics
14799 Select which mnemonics to use in the generated assembler code.  With
14800 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
14801 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
14802 assembler mnemonics defined for the POWER architecture.  Instructions
14803 defined in only one architecture have only one mnemonic; GCC uses that
14804 mnemonic irrespective of which of these options is specified.
14806 GCC defaults to the mnemonics appropriate for the architecture in
14807 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
14808 value of these option.  Unless you are building a cross-compiler, you
14809 should normally not specify either @option{-mnew-mnemonics} or
14810 @option{-mold-mnemonics}, but should instead accept the default.
14812 @item -mcpu=@var{cpu_type}
14813 @opindex mcpu
14814 Set architecture type, register usage, choice of mnemonics, and
14815 instruction scheduling parameters for machine type @var{cpu_type}.
14816 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
14817 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
14818 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
14819 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
14820 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
14821 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
14822 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
14823 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
14824 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
14825 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
14826 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
14828 @option{-mcpu=common} selects a completely generic processor.  Code
14829 generated under this option will run on any POWER or PowerPC processor.
14830 GCC will use only the instructions in the common subset of both
14831 architectures, and will not use the MQ register.  GCC assumes a generic
14832 processor model for scheduling purposes.
14834 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
14835 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
14836 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
14837 types, with an appropriate, generic processor model assumed for
14838 scheduling purposes.
14840 The other options specify a specific processor.  Code generated under
14841 those options will run best on that processor, and may not run at all on
14842 others.
14844 The @option{-mcpu} options automatically enable or disable the
14845 following options:
14847 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
14848 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
14849 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
14850 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
14852 The particular options set for any particular CPU will vary between
14853 compiler versions, depending on what setting seems to produce optimal
14854 code for that CPU; it doesn't necessarily reflect the actual hardware's
14855 capabilities.  If you wish to set an individual option to a particular
14856 value, you may specify it after the @option{-mcpu} option, like
14857 @samp{-mcpu=970 -mno-altivec}.
14859 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
14860 not enabled or disabled by the @option{-mcpu} option at present because
14861 AIX does not have full support for these options.  You may still
14862 enable or disable them individually if you're sure it'll work in your
14863 environment.
14865 @item -mtune=@var{cpu_type}
14866 @opindex mtune
14867 Set the instruction scheduling parameters for machine type
14868 @var{cpu_type}, but do not set the architecture type, register usage, or
14869 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
14870 values for @var{cpu_type} are used for @option{-mtune} as for
14871 @option{-mcpu}.  If both are specified, the code generated will use the
14872 architecture, registers, and mnemonics set by @option{-mcpu}, but the
14873 scheduling parameters set by @option{-mtune}.
14875 @item -mswdiv
14876 @itemx -mno-swdiv
14877 @opindex mswdiv
14878 @opindex mno-swdiv
14879 Generate code to compute division as reciprocal estimate and iterative
14880 refinement, creating opportunities for increased throughput.  This
14881 feature requires: optional PowerPC Graphics instruction set for single
14882 precision and FRE instruction for double precision, assuming divides
14883 cannot generate user-visible traps, and the domain values not include
14884 Infinities, denormals or zero denominator.
14886 @item -maltivec
14887 @itemx -mno-altivec
14888 @opindex maltivec
14889 @opindex mno-altivec
14890 Generate code that uses (does not use) AltiVec instructions, and also
14891 enable the use of built-in functions that allow more direct access to
14892 the AltiVec instruction set.  You may also need to set
14893 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
14894 enhancements.
14896 @item -mvrsave
14897 @itemx -mno-vrsave
14898 @opindex mvrsave
14899 @opindex mno-vrsave
14900 Generate VRSAVE instructions when generating AltiVec code.
14902 @item -mgen-cell-microcode
14903 @opindex mgen-cell-microcode
14904 Generate Cell microcode instructions
14906 @item -mwarn-cell-microcode
14907 @opindex mwarn-cell-microcode
14908 Warning when a Cell microcode instruction is going to emitted.  An example
14909 of a Cell microcode instruction is a variable shift.
14911 @item -msecure-plt
14912 @opindex msecure-plt
14913 Generate code that allows ld and ld.so to build executables and shared
14914 libraries with non-exec .plt and .got sections.  This is a PowerPC
14915 32-bit SYSV ABI option.
14917 @item -mbss-plt
14918 @opindex mbss-plt
14919 Generate code that uses a BSS .plt section that ld.so fills in, and
14920 requires .plt and .got sections that are both writable and executable.
14921 This is a PowerPC 32-bit SYSV ABI option.
14923 @item -misel
14924 @itemx -mno-isel
14925 @opindex misel
14926 @opindex mno-isel
14927 This switch enables or disables the generation of ISEL instructions.
14929 @item -misel=@var{yes/no}
14930 This switch has been deprecated.  Use @option{-misel} and
14931 @option{-mno-isel} instead.
14933 @item -mspe
14934 @itemx -mno-spe
14935 @opindex mspe
14936 @opindex mno-spe
14937 This switch enables or disables the generation of SPE simd
14938 instructions.
14940 @item -mpaired
14941 @itemx -mno-paired
14942 @opindex mpaired
14943 @opindex mno-paired
14944 This switch enables or disables the generation of PAIRED simd
14945 instructions.
14947 @item -mspe=@var{yes/no}
14948 This option has been deprecated.  Use @option{-mspe} and
14949 @option{-mno-spe} instead.
14951 @item -mvsx
14952 @itemx -mno-vsx
14953 @opindex mvsx
14954 @opindex mno-vsx
14955 Generate code that uses (does not use) vector/scalar (VSX)
14956 instructions, and also enable the use of built-in functions that allow
14957 more direct access to the VSX instruction set.
14959 @item -mfloat-gprs=@var{yes/single/double/no}
14960 @itemx -mfloat-gprs
14961 @opindex mfloat-gprs
14962 This switch enables or disables the generation of floating point
14963 operations on the general purpose registers for architectures that
14964 support it.
14966 The argument @var{yes} or @var{single} enables the use of
14967 single-precision floating point operations.
14969 The argument @var{double} enables the use of single and
14970 double-precision floating point operations.
14972 The argument @var{no} disables floating point operations on the
14973 general purpose registers.
14975 This option is currently only available on the MPC854x.
14977 @item -m32
14978 @itemx -m64
14979 @opindex m32
14980 @opindex m64
14981 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
14982 targets (including GNU/Linux).  The 32-bit environment sets int, long
14983 and pointer to 32 bits and generates code that runs on any PowerPC
14984 variant.  The 64-bit environment sets int to 32 bits and long and
14985 pointer to 64 bits, and generates code for PowerPC64, as for
14986 @option{-mpowerpc64}.
14988 @item -mfull-toc
14989 @itemx -mno-fp-in-toc
14990 @itemx -mno-sum-in-toc
14991 @itemx -mminimal-toc
14992 @opindex mfull-toc
14993 @opindex mno-fp-in-toc
14994 @opindex mno-sum-in-toc
14995 @opindex mminimal-toc
14996 Modify generation of the TOC (Table Of Contents), which is created for
14997 every executable file.  The @option{-mfull-toc} option is selected by
14998 default.  In that case, GCC will allocate at least one TOC entry for
14999 each unique non-automatic variable reference in your program.  GCC
15000 will also place floating-point constants in the TOC@.  However, only
15001 16,384 entries are available in the TOC@.
15003 If you receive a linker error message that saying you have overflowed
15004 the available TOC space, you can reduce the amount of TOC space used
15005 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
15006 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
15007 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
15008 generate code to calculate the sum of an address and a constant at
15009 run-time instead of putting that sum into the TOC@.  You may specify one
15010 or both of these options.  Each causes GCC to produce very slightly
15011 slower and larger code at the expense of conserving TOC space.
15013 If you still run out of space in the TOC even when you specify both of
15014 these options, specify @option{-mminimal-toc} instead.  This option causes
15015 GCC to make only one TOC entry for every file.  When you specify this
15016 option, GCC will produce code that is slower and larger but which
15017 uses extremely little TOC space.  You may wish to use this option
15018 only on files that contain less frequently executed code.
15020 @item -maix64
15021 @itemx -maix32
15022 @opindex maix64
15023 @opindex maix32
15024 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
15025 @code{long} type, and the infrastructure needed to support them.
15026 Specifying @option{-maix64} implies @option{-mpowerpc64} and
15027 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
15028 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
15030 @item -mxl-compat
15031 @itemx -mno-xl-compat
15032 @opindex mxl-compat
15033 @opindex mno-xl-compat
15034 Produce code that conforms more closely to IBM XL compiler semantics
15035 when using AIX-compatible ABI@.  Pass floating-point arguments to
15036 prototyped functions beyond the register save area (RSA) on the stack
15037 in addition to argument FPRs.  Do not assume that most significant
15038 double in 128-bit long double value is properly rounded when comparing
15039 values and converting to double.  Use XL symbol names for long double
15040 support routines.
15042 The AIX calling convention was extended but not initially documented to
15043 handle an obscure K&R C case of calling a function that takes the
15044 address of its arguments with fewer arguments than declared.  IBM XL
15045 compilers access floating point arguments which do not fit in the
15046 RSA from the stack when a subroutine is compiled without
15047 optimization.  Because always storing floating-point arguments on the
15048 stack is inefficient and rarely needed, this option is not enabled by
15049 default and only is necessary when calling subroutines compiled by IBM
15050 XL compilers without optimization.
15052 @item -mpe
15053 @opindex mpe
15054 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
15055 application written to use message passing with special startup code to
15056 enable the application to run.  The system must have PE installed in the
15057 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
15058 must be overridden with the @option{-specs=} option to specify the
15059 appropriate directory location.  The Parallel Environment does not
15060 support threads, so the @option{-mpe} option and the @option{-pthread}
15061 option are incompatible.
15063 @item -malign-natural
15064 @itemx -malign-power
15065 @opindex malign-natural
15066 @opindex malign-power
15067 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
15068 @option{-malign-natural} overrides the ABI-defined alignment of larger
15069 types, such as floating-point doubles, on their natural size-based boundary.
15070 The option @option{-malign-power} instructs GCC to follow the ABI-specified
15071 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
15073 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
15074 is not supported.
15076 @item -msoft-float
15077 @itemx -mhard-float
15078 @opindex msoft-float
15079 @opindex mhard-float
15080 Generate code that does not use (uses) the floating-point register set.
15081 Software floating point emulation is provided if you use the
15082 @option{-msoft-float} option, and pass the option to GCC when linking.
15084 @item -msingle-float
15085 @itemx -mdouble-float
15086 @opindex msingle-float
15087 @opindex mdouble-float
15088 Generate code for single or double-precision floating point operations.
15089 @option{-mdouble-float} implies @option{-msingle-float}.
15091 @item -msimple-fpu
15092 @opindex msimple-fpu
15093 Do not generate sqrt and div instructions for hardware floating point unit.
15095 @item -mfpu
15096 @opindex mfpu
15097 Specify type of floating point unit.  Valid values are @var{sp_lite}
15098 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
15099 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
15100 and @var{dp_full} (equivalent to -mdouble-float).
15102 @item -mxilinx-fpu
15103 @opindex mxilinx-fpu
15104 Perform optimizations for floating point unit on Xilinx PPC 405/440.
15106 @item -mmultiple
15107 @itemx -mno-multiple
15108 @opindex mmultiple
15109 @opindex mno-multiple
15110 Generate code that uses (does not use) the load multiple word
15111 instructions and the store multiple word instructions.  These
15112 instructions are generated by default on POWER systems, and not
15113 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
15114 endian PowerPC systems, since those instructions do not work when the
15115 processor is in little endian mode.  The exceptions are PPC740 and
15116 PPC750 which permit the instructions usage in little endian mode.
15118 @item -mstring
15119 @itemx -mno-string
15120 @opindex mstring
15121 @opindex mno-string
15122 Generate code that uses (does not use) the load string instructions
15123 and the store string word instructions to save multiple registers and
15124 do small block moves.  These instructions are generated by default on
15125 POWER systems, and not generated on PowerPC systems.  Do not use
15126 @option{-mstring} on little endian PowerPC systems, since those
15127 instructions do not work when the processor is in little endian mode.
15128 The exceptions are PPC740 and PPC750 which permit the instructions
15129 usage in little endian mode.
15131 @item -mupdate
15132 @itemx -mno-update
15133 @opindex mupdate
15134 @opindex mno-update
15135 Generate code that uses (does not use) the load or store instructions
15136 that update the base register to the address of the calculated memory
15137 location.  These instructions are generated by default.  If you use
15138 @option{-mno-update}, there is a small window between the time that the
15139 stack pointer is updated and the address of the previous frame is
15140 stored, which means code that walks the stack frame across interrupts or
15141 signals may get corrupted data.
15143 @item -mavoid-indexed-addresses
15144 @itemx -mno-avoid-indexed-addresses
15145 @opindex mavoid-indexed-addresses
15146 @opindex mno-avoid-indexed-addresses
15147 Generate code that tries to avoid (not avoid) the use of indexed load
15148 or store instructions. These instructions can incur a performance
15149 penalty on Power6 processors in certain situations, such as when
15150 stepping through large arrays that cross a 16M boundary.  This option
15151 is enabled by default when targetting Power6 and disabled otherwise.
15153 @item -mfused-madd
15154 @itemx -mno-fused-madd
15155 @opindex mfused-madd
15156 @opindex mno-fused-madd
15157 Generate code that uses (does not use) the floating point multiply and
15158 accumulate instructions.  These instructions are generated by default if
15159 hardware floating is used.
15161 @item -mmulhw
15162 @itemx -mno-mulhw
15163 @opindex mmulhw
15164 @opindex mno-mulhw
15165 Generate code that uses (does not use) the half-word multiply and
15166 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15167 These instructions are generated by default when targetting those
15168 processors.
15170 @item -mdlmzb
15171 @itemx -mno-dlmzb
15172 @opindex mdlmzb
15173 @opindex mno-dlmzb
15174 Generate code that uses (does not use) the string-search @samp{dlmzb}
15175 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
15176 generated by default when targetting those processors.
15178 @item -mno-bit-align
15179 @itemx -mbit-align
15180 @opindex mno-bit-align
15181 @opindex mbit-align
15182 On System V.4 and embedded PowerPC systems do not (do) force structures
15183 and unions that contain bit-fields to be aligned to the base type of the
15184 bit-field.
15186 For example, by default a structure containing nothing but 8
15187 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15188 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
15189 the structure would be aligned to a 1 byte boundary and be one byte in
15190 size.
15192 @item -mno-strict-align
15193 @itemx -mstrict-align
15194 @opindex mno-strict-align
15195 @opindex mstrict-align
15196 On System V.4 and embedded PowerPC systems do not (do) assume that
15197 unaligned memory references will be handled by the system.
15199 @item -mrelocatable
15200 @itemx -mno-relocatable
15201 @opindex mrelocatable
15202 @opindex mno-relocatable
15203 On embedded PowerPC systems generate code that allows (does not allow)
15204 the program to be relocated to a different address at runtime.  If you
15205 use @option{-mrelocatable} on any module, all objects linked together must
15206 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
15208 @item -mrelocatable-lib
15209 @itemx -mno-relocatable-lib
15210 @opindex mrelocatable-lib
15211 @opindex mno-relocatable-lib
15212 On embedded PowerPC systems generate code that allows (does not allow)
15213 the program to be relocated to a different address at runtime.  Modules
15214 compiled with @option{-mrelocatable-lib} can be linked with either modules
15215 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
15216 with modules compiled with the @option{-mrelocatable} options.
15218 @item -mno-toc
15219 @itemx -mtoc
15220 @opindex mno-toc
15221 @opindex mtoc
15222 On System V.4 and embedded PowerPC systems do not (do) assume that
15223 register 2 contains a pointer to a global area pointing to the addresses
15224 used in the program.
15226 @item -mlittle
15227 @itemx -mlittle-endian
15228 @opindex mlittle
15229 @opindex mlittle-endian
15230 On System V.4 and embedded PowerPC systems compile code for the
15231 processor in little endian mode.  The @option{-mlittle-endian} option is
15232 the same as @option{-mlittle}.
15234 @item -mbig
15235 @itemx -mbig-endian
15236 @opindex mbig
15237 @opindex mbig-endian
15238 On System V.4 and embedded PowerPC systems compile code for the
15239 processor in big endian mode.  The @option{-mbig-endian} option is
15240 the same as @option{-mbig}.
15242 @item -mdynamic-no-pic
15243 @opindex mdynamic-no-pic
15244 On Darwin and Mac OS X systems, compile code so that it is not
15245 relocatable, but that its external references are relocatable.  The
15246 resulting code is suitable for applications, but not shared
15247 libraries.
15249 @item -mprioritize-restricted-insns=@var{priority}
15250 @opindex mprioritize-restricted-insns
15251 This option controls the priority that is assigned to
15252 dispatch-slot restricted instructions during the second scheduling
15253 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
15254 @var{no/highest/second-highest} priority to dispatch slot restricted
15255 instructions.
15257 @item -msched-costly-dep=@var{dependence_type}
15258 @opindex msched-costly-dep
15259 This option controls which dependences are considered costly
15260 by the target during instruction scheduling.  The argument
15261 @var{dependence_type} takes one of the following values:
15262 @var{no}: no dependence is costly,
15263 @var{all}: all dependences are costly,
15264 @var{true_store_to_load}: a true dependence from store to load is costly,
15265 @var{store_to_load}: any dependence from store to load is costly,
15266 @var{number}: any dependence which latency >= @var{number} is costly.
15268 @item -minsert-sched-nops=@var{scheme}
15269 @opindex minsert-sched-nops
15270 This option controls which nop insertion scheme will be used during
15271 the second scheduling pass.  The argument @var{scheme} takes one of the
15272 following values:
15273 @var{no}: Don't insert nops.
15274 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15275 according to the scheduler's grouping.
15276 @var{regroup_exact}: Insert nops to force costly dependent insns into
15277 separate groups.  Insert exactly as many nops as needed to force an insn
15278 to a new group, according to the estimated processor grouping.
15279 @var{number}: Insert nops to force costly dependent insns into
15280 separate groups.  Insert @var{number} nops to force an insn to a new group.
15282 @item -mcall-sysv
15283 @opindex mcall-sysv
15284 On System V.4 and embedded PowerPC systems compile code using calling
15285 conventions that adheres to the March 1995 draft of the System V
15286 Application Binary Interface, PowerPC processor supplement.  This is the
15287 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15289 @item -mcall-sysv-eabi
15290 @itemx -mcall-eabi
15291 @opindex mcall-sysv-eabi
15292 @opindex mcall-eabi
15293 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15295 @item -mcall-sysv-noeabi
15296 @opindex mcall-sysv-noeabi
15297 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15299 @item -mcall-aixdesc
15300 @opindex m
15301 On System V.4 and embedded PowerPC systems compile code for the AIX
15302 operating system.
15304 @item -mcall-linux
15305 @opindex mcall-linux
15306 On System V.4 and embedded PowerPC systems compile code for the
15307 Linux-based GNU system.
15309 @item -mcall-gnu
15310 @opindex mcall-gnu
15311 On System V.4 and embedded PowerPC systems compile code for the
15312 Hurd-based GNU system.
15314 @item -mcall-freebsd
15315 @opindex mcall-freebsd
15316 On System V.4 and embedded PowerPC systems compile code for the
15317 FreeBSD operating system.
15319 @item -mcall-netbsd
15320 @opindex mcall-netbsd
15321 On System V.4 and embedded PowerPC systems compile code for the
15322 NetBSD operating system.
15324 @item -mcall-openbsd
15325 @opindex mcall-netbsd
15326 On System V.4 and embedded PowerPC systems compile code for the
15327 OpenBSD operating system.
15329 @item -maix-struct-return
15330 @opindex maix-struct-return
15331 Return all structures in memory (as specified by the AIX ABI)@.
15333 @item -msvr4-struct-return
15334 @opindex msvr4-struct-return
15335 Return structures smaller than 8 bytes in registers (as specified by the
15336 SVR4 ABI)@.
15338 @item -mabi=@var{abi-type}
15339 @opindex mabi
15340 Extend the current ABI with a particular extension, or remove such extension.
15341 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
15342 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
15344 @item -mabi=spe
15345 @opindex mabi=spe
15346 Extend the current ABI with SPE ABI extensions.  This does not change
15347 the default ABI, instead it adds the SPE ABI extensions to the current
15348 ABI@.
15350 @item -mabi=no-spe
15351 @opindex mabi=no-spe
15352 Disable Booke SPE ABI extensions for the current ABI@.
15354 @item -mabi=ibmlongdouble
15355 @opindex mabi=ibmlongdouble
15356 Change the current ABI to use IBM extended precision long double.
15357 This is a PowerPC 32-bit SYSV ABI option.
15359 @item -mabi=ieeelongdouble
15360 @opindex mabi=ieeelongdouble
15361 Change the current ABI to use IEEE extended precision long double.
15362 This is a PowerPC 32-bit Linux ABI option.
15364 @item -mprototype
15365 @itemx -mno-prototype
15366 @opindex mprototype
15367 @opindex mno-prototype
15368 On System V.4 and embedded PowerPC systems assume that all calls to
15369 variable argument functions are properly prototyped.  Otherwise, the
15370 compiler must insert an instruction before every non prototyped call to
15371 set or clear bit 6 of the condition code register (@var{CR}) to
15372 indicate whether floating point values were passed in the floating point
15373 registers in case the function takes a variable arguments.  With
15374 @option{-mprototype}, only calls to prototyped variable argument functions
15375 will set or clear the bit.
15377 @item -msim
15378 @opindex msim
15379 On embedded PowerPC systems, assume that the startup module is called
15380 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
15381 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
15382 configurations.
15384 @item -mmvme
15385 @opindex mmvme
15386 On embedded PowerPC systems, assume that the startup module is called
15387 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
15388 @file{libc.a}.
15390 @item -mads
15391 @opindex mads
15392 On embedded PowerPC systems, assume that the startup module is called
15393 @file{crt0.o} and the standard C libraries are @file{libads.a} and
15394 @file{libc.a}.
15396 @item -myellowknife
15397 @opindex myellowknife
15398 On embedded PowerPC systems, assume that the startup module is called
15399 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
15400 @file{libc.a}.
15402 @item -mvxworks
15403 @opindex mvxworks
15404 On System V.4 and embedded PowerPC systems, specify that you are
15405 compiling for a VxWorks system.
15407 @item -memb
15408 @opindex memb
15409 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
15410 header to indicate that @samp{eabi} extended relocations are used.
15412 @item -meabi
15413 @itemx -mno-eabi
15414 @opindex meabi
15415 @opindex mno-eabi
15416 On System V.4 and embedded PowerPC systems do (do not) adhere to the
15417 Embedded Applications Binary Interface (eabi) which is a set of
15418 modifications to the System V.4 specifications.  Selecting @option{-meabi}
15419 means that the stack is aligned to an 8 byte boundary, a function
15420 @code{__eabi} is called to from @code{main} to set up the eabi
15421 environment, and the @option{-msdata} option can use both @code{r2} and
15422 @code{r13} to point to two separate small data areas.  Selecting
15423 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
15424 do not call an initialization function from @code{main}, and the
15425 @option{-msdata} option will only use @code{r13} to point to a single
15426 small data area.  The @option{-meabi} option is on by default if you
15427 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
15429 @item -msdata=eabi
15430 @opindex msdata=eabi
15431 On System V.4 and embedded PowerPC systems, put small initialized
15432 @code{const} global and static data in the @samp{.sdata2} section, which
15433 is pointed to by register @code{r2}.  Put small initialized
15434 non-@code{const} global and static data in the @samp{.sdata} section,
15435 which is pointed to by register @code{r13}.  Put small uninitialized
15436 global and static data in the @samp{.sbss} section, which is adjacent to
15437 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
15438 incompatible with the @option{-mrelocatable} option.  The
15439 @option{-msdata=eabi} option also sets the @option{-memb} option.
15441 @item -msdata=sysv
15442 @opindex msdata=sysv
15443 On System V.4 and embedded PowerPC systems, put small global and static
15444 data in the @samp{.sdata} section, which is pointed to by register
15445 @code{r13}.  Put small uninitialized global and static data in the
15446 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15447 The @option{-msdata=sysv} option is incompatible with the
15448 @option{-mrelocatable} option.
15450 @item -msdata=default
15451 @itemx -msdata
15452 @opindex msdata=default
15453 @opindex msdata
15454 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15455 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15456 same as @option{-msdata=sysv}.
15458 @item -msdata=data
15459 @opindex msdata=data
15460 On System V.4 and embedded PowerPC systems, put small global
15461 data in the @samp{.sdata} section.  Put small uninitialized global
15462 data in the @samp{.sbss} section.  Do not use register @code{r13}
15463 to address small data however.  This is the default behavior unless
15464 other @option{-msdata} options are used.
15466 @item -msdata=none
15467 @itemx -mno-sdata
15468 @opindex msdata=none
15469 @opindex mno-sdata
15470 On embedded PowerPC systems, put all initialized global and static data
15471 in the @samp{.data} section, and all uninitialized data in the
15472 @samp{.bss} section.
15474 @item -G @var{num}
15475 @opindex G
15476 @cindex smaller data references (PowerPC)
15477 @cindex .sdata/.sdata2 references (PowerPC)
15478 On embedded PowerPC systems, put global and static items less than or
15479 equal to @var{num} bytes into the small data or bss sections instead of
15480 the normal data or bss section.  By default, @var{num} is 8.  The
15481 @option{-G @var{num}} switch is also passed to the linker.
15482 All modules should be compiled with the same @option{-G @var{num}} value.
15484 @item -mregnames
15485 @itemx -mno-regnames
15486 @opindex mregnames
15487 @opindex mno-regnames
15488 On System V.4 and embedded PowerPC systems do (do not) emit register
15489 names in the assembly language output using symbolic forms.
15491 @item -mlongcall
15492 @itemx -mno-longcall
15493 @opindex mlongcall
15494 @opindex mno-longcall
15495 By default assume that all calls are far away so that a longer more
15496 expensive calling sequence is required.  This is required for calls
15497 further than 32 megabytes (33,554,432 bytes) from the current location.
15498 A short call will be generated if the compiler knows
15499 the call cannot be that far away.  This setting can be overridden by
15500 the @code{shortcall} function attribute, or by @code{#pragma
15501 longcall(0)}.
15503 Some linkers are capable of detecting out-of-range calls and generating
15504 glue code on the fly.  On these systems, long calls are unnecessary and
15505 generate slower code.  As of this writing, the AIX linker can do this,
15506 as can the GNU linker for PowerPC/64.  It is planned to add this feature
15507 to the GNU linker for 32-bit PowerPC systems as well.
15509 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
15510 callee, L42'', plus a ``branch island'' (glue code).  The two target
15511 addresses represent the callee and the ``branch island''.  The
15512 Darwin/PPC linker will prefer the first address and generate a ``bl
15513 callee'' if the PPC ``bl'' instruction will reach the callee directly;
15514 otherwise, the linker will generate ``bl L42'' to call the ``branch
15515 island''.  The ``branch island'' is appended to the body of the
15516 calling function; it computes the full 32-bit address of the callee
15517 and jumps to it.
15519 On Mach-O (Darwin) systems, this option directs the compiler emit to
15520 the glue for every direct call, and the Darwin linker decides whether
15521 to use or discard it.
15523 In the future, we may cause GCC to ignore all longcall specifications
15524 when the linker is known to generate glue.
15526 @item -mtls-markers
15527 @itemx -mno-tls-markers
15528 @opindex mtls-markers
15529 @opindex mno-tls-markers
15530 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
15531 specifying the function argument.  The relocation allows ld to
15532 reliably associate function call with argument setup instructions for
15533 TLS optimization, which in turn allows gcc to better schedule the
15534 sequence.
15536 @item -pthread
15537 @opindex pthread
15538 Adds support for multithreading with the @dfn{pthreads} library.
15539 This option sets flags for both the preprocessor and linker.
15541 @end table
15543 @node RX Options
15544 @subsection RX Options
15545 @cindex RX Options
15547 These command line options are defined for RX targets:
15549 @table @gcctabopt
15550 @item -m64bit-doubles
15551 @itemx -m32bit-doubles
15552 @opindex m64bit-doubles
15553 @opindex m32bit-doubles
15554 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
15555 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
15556 @option{-m32bit-doubles}.  @emph{Note} RX floating point hardware only
15557 works on 32-bit values, which is why the default is
15558 @option{-m32bit-doubles}.
15560 @item -fpu
15561 @itemx -nofpu
15562 @opindex fpu
15563 @opindex nofpu
15564 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
15565 floating point hardware.  The default is enabled for the @var{RX600}
15566 series and disabled for the @var{RX200} series.
15568 Floating point instructions will only be generated for 32-bit floating
15569 point values however, so if the @option{-m64bit-doubles} option is in
15570 use then the FPU hardware will not be used for doubles.
15572 @emph{Note} If the @option{-fpu} option is enabled then
15573 @option{-funsafe-math-optimizations} is also enabled automatically.
15574 This is because the RX FPU instructions are themselves unsafe.
15576 @item -mcpu=@var{name}
15577 @itemx -patch=@var{name}
15578 @opindex -mcpu
15579 @opindex -patch
15580 Selects the type of RX CPU to be targeted.  Currently three types are
15581 supported, the generic @var{RX600} and @var{RX200} series hardware and
15582 the specific @var{RX610} cpu.  The default is @var{RX600}.
15584 The only difference between @var{RX600} and @var{RX610} is that the
15585 @var{RX610} does not support the @code{MVTIPL} instruction.
15587 The @var{RX200} series does not have a hardware floating point unit
15588 and so @option{-nofpu} is enabled by default when this type is
15589 selected.
15591 @item -mbig-endian-data
15592 @itemx -mlittle-endian-data
15593 @opindex mbig-endian-data
15594 @opindex mlittle-endian-data
15595 Store data (but not code) in the big-endian format.  The default is
15596 @option{-mlittle-endian-data}, ie to store data in the little endian
15597 format.
15599 @item -msmall-data-limit=@var{N}
15600 @opindex msmall-data-limit
15601 Specifies the maximum size in bytes of global and static variables
15602 which can be placed into the small data area.  Using the small data
15603 area can lead to smaller and faster code, but the size of area is
15604 limited and it is up to the programmer to ensure that the area does
15605 not overflow.  Also when the small data area is used one of the RX's
15606 registers (@code{r13}) is reserved for use pointing to this area, so
15607 it is no longer available for use by the compiler.  This could result
15608 in slower and/or larger code if variables which once could have been
15609 held in @code{r13} are now pushed onto the stack.
15611 Note, common variables (variables which have not been initialised) and
15612 constants are not placed into the small data area as they are assigned
15613 to other sections in the output executable.
15615 The default value is zero, which disables this feature.  Note, this
15616 feature is not enabled by default with higher optimization levels
15617 (@option{-O2} etc) because of the potentially detrimental effects of
15618 reserving register @code{r13}.  It is up to the programmer to
15619 experiment and discover whether this feature is of benefit to their
15620 program.
15622 @item -msim
15623 @itemx -mno-sim
15624 @opindex msim
15625 @opindex mno-sim
15626 Use the simulator runtime.  The default is to use the libgloss board
15627 specific runtime.
15629 @item -mas100-syntax
15630 @itemx -mno-as100-syntax
15631 @opindex mas100-syntax
15632 @opindex mno-as100-syntax
15633 When generating assembler output use a syntax that is compatible with
15634 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
15635 assembler but it has some restrictions so generating it is not the
15636 default option.
15638 @item -mmax-constant-size=@var{N}
15639 @opindex mmax-constant-size
15640 Specifies the maximum size, in bytes, of a constant that can be used as
15641 an operand in a RX instruction.  Although the RX instruction set does
15642 allow constants of up to 4 bytes in length to be used in instructions,
15643 a longer value equates to a longer instruction.  Thus in some
15644 circumstances it can be beneficial to restrict the size of constants
15645 that are used in instructions.  Constants that are too big are instead
15646 placed into a constant pool and referenced via register indirection.
15648 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
15649 or 4 means that constants of any size are allowed.
15651 @item -mrelax
15652 @opindex mrelax
15653 Enable linker relaxation.  Linker relaxation is a process whereby the
15654 linker will attempt to reduce the size of a program by finding shorter
15655 versions of various instructions.  Disabled by default.
15657 @item -mint-register=@var{N}
15658 @opindex mint-register
15659 Specify the number of registers to reserve for fast interrupt handler
15660 functions.  The value @var{N} can be between 0 and 4.  A value of 1
15661 means that register @code{r13} will be reserved for the exclusive use
15662 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
15663 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
15664 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
15665 A value of 0, the default, does not reserve any registers.
15667 @item -msave-acc-in-interrupts
15668 @opindex msave-acc-in-interrupts
15669 Specifies that interrupt handler functions should preserve the
15670 accumulator register.  This is only necessary if normal code might use
15671 the accumulator register, for example because it performs 64-bit
15672 multiplications.  The default is to ignore the accumulator as this
15673 makes the interrupt handlers faster.
15675 @end table
15677 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
15678 has special significance to the RX port when used with the
15679 @code{interrupt} function attribute.  This attribute indicates a
15680 function intended to process fast interrupts.  GCC will will ensure
15681 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
15682 and/or @code{r13} and only provided that the normal use of the
15683 corresponding registers have been restricted via the
15684 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
15685 options.
15687 @node S/390 and zSeries Options
15688 @subsection S/390 and zSeries Options
15689 @cindex S/390 and zSeries Options
15691 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
15693 @table @gcctabopt
15694 @item -mhard-float
15695 @itemx -msoft-float
15696 @opindex mhard-float
15697 @opindex msoft-float
15698 Use (do not use) the hardware floating-point instructions and registers
15699 for floating-point operations.  When @option{-msoft-float} is specified,
15700 functions in @file{libgcc.a} will be used to perform floating-point
15701 operations.  When @option{-mhard-float} is specified, the compiler
15702 generates IEEE floating-point instructions.  This is the default.
15704 @item -mhard-dfp
15705 @itemx -mno-hard-dfp
15706 @opindex mhard-dfp
15707 @opindex mno-hard-dfp
15708 Use (do not use) the hardware decimal-floating-point instructions for
15709 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
15710 specified, functions in @file{libgcc.a} will be used to perform
15711 decimal-floating-point operations.  When @option{-mhard-dfp} is
15712 specified, the compiler generates decimal-floating-point hardware
15713 instructions.  This is the default for @option{-march=z9-ec} or higher.
15715 @item -mlong-double-64
15716 @itemx -mlong-double-128
15717 @opindex mlong-double-64
15718 @opindex mlong-double-128
15719 These switches control the size of @code{long double} type. A size
15720 of 64bit makes the @code{long double} type equivalent to the @code{double}
15721 type. This is the default.
15723 @item -mbackchain
15724 @itemx -mno-backchain
15725 @opindex mbackchain
15726 @opindex mno-backchain
15727 Store (do not store) the address of the caller's frame as backchain pointer
15728 into the callee's stack frame.
15729 A backchain may be needed to allow debugging using tools that do not understand
15730 DWARF-2 call frame information.
15731 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
15732 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
15733 the backchain is placed into the topmost word of the 96/160 byte register
15734 save area.
15736 In general, code compiled with @option{-mbackchain} is call-compatible with
15737 code compiled with @option{-mmo-backchain}; however, use of the backchain
15738 for debugging purposes usually requires that the whole binary is built with
15739 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
15740 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15741 to build a linux kernel use @option{-msoft-float}.
15743 The default is to not maintain the backchain.
15745 @item -mpacked-stack
15746 @itemx -mno-packed-stack
15747 @opindex mpacked-stack
15748 @opindex mno-packed-stack
15749 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
15750 specified, the compiler uses the all fields of the 96/160 byte register save
15751 area only for their default purpose; unused fields still take up stack space.
15752 When @option{-mpacked-stack} is specified, register save slots are densely
15753 packed at the top of the register save area; unused space is reused for other
15754 purposes, allowing for more efficient use of the available stack space.
15755 However, when @option{-mbackchain} is also in effect, the topmost word of
15756 the save area is always used to store the backchain, and the return address
15757 register is always saved two words below the backchain.
15759 As long as the stack frame backchain is not used, code generated with
15760 @option{-mpacked-stack} is call-compatible with code generated with
15761 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
15762 S/390 or zSeries generated code that uses the stack frame backchain at run
15763 time, not just for debugging purposes.  Such code is not call-compatible
15764 with code compiled with @option{-mpacked-stack}.  Also, note that the
15765 combination of @option{-mbackchain},
15766 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15767 to build a linux kernel use @option{-msoft-float}.
15769 The default is to not use the packed stack layout.
15771 @item -msmall-exec
15772 @itemx -mno-small-exec
15773 @opindex msmall-exec
15774 @opindex mno-small-exec
15775 Generate (or do not generate) code using the @code{bras} instruction
15776 to do subroutine calls.
15777 This only works reliably if the total executable size does not
15778 exceed 64k.  The default is to use the @code{basr} instruction instead,
15779 which does not have this limitation.
15781 @item -m64
15782 @itemx -m31
15783 @opindex m64
15784 @opindex m31
15785 When @option{-m31} is specified, generate code compliant to the
15786 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
15787 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
15788 particular to generate 64-bit instructions.  For the @samp{s390}
15789 targets, the default is @option{-m31}, while the @samp{s390x}
15790 targets default to @option{-m64}.
15792 @item -mzarch
15793 @itemx -mesa
15794 @opindex mzarch
15795 @opindex mesa
15796 When @option{-mzarch} is specified, generate code using the
15797 instructions available on z/Architecture.
15798 When @option{-mesa} is specified, generate code using the
15799 instructions available on ESA/390.  Note that @option{-mesa} is
15800 not possible with @option{-m64}.
15801 When generating code compliant to the GNU/Linux for S/390 ABI,
15802 the default is @option{-mesa}.  When generating code compliant
15803 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
15805 @item -mmvcle
15806 @itemx -mno-mvcle
15807 @opindex mmvcle
15808 @opindex mno-mvcle
15809 Generate (or do not generate) code using the @code{mvcle} instruction
15810 to perform block moves.  When @option{-mno-mvcle} is specified,
15811 use a @code{mvc} loop instead.  This is the default unless optimizing for
15812 size.
15814 @item -mdebug
15815 @itemx -mno-debug
15816 @opindex mdebug
15817 @opindex mno-debug
15818 Print (or do not print) additional debug information when compiling.
15819 The default is to not print debug information.
15821 @item -march=@var{cpu-type}
15822 @opindex march
15823 Generate code that will run on @var{cpu-type}, which is the name of a system
15824 representing a certain processor type.  Possible values for
15825 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
15826 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
15827 When generating code using the instructions available on z/Architecture,
15828 the default is @option{-march=z900}.  Otherwise, the default is
15829 @option{-march=g5}.
15831 @item -mtune=@var{cpu-type}
15832 @opindex mtune
15833 Tune to @var{cpu-type} everything applicable about the generated code,
15834 except for the ABI and the set of available instructions.
15835 The list of @var{cpu-type} values is the same as for @option{-march}.
15836 The default is the value used for @option{-march}.
15838 @item -mtpf-trace
15839 @itemx -mno-tpf-trace
15840 @opindex mtpf-trace
15841 @opindex mno-tpf-trace
15842 Generate code that adds (does not add) in TPF OS specific branches to trace
15843 routines in the operating system.  This option is off by default, even
15844 when compiling for the TPF OS@.
15846 @item -mfused-madd
15847 @itemx -mno-fused-madd
15848 @opindex mfused-madd
15849 @opindex mno-fused-madd
15850 Generate code that uses (does not use) the floating point multiply and
15851 accumulate instructions.  These instructions are generated by default if
15852 hardware floating point is used.
15854 @item -mwarn-framesize=@var{framesize}
15855 @opindex mwarn-framesize
15856 Emit a warning if the current function exceeds the given frame size.  Because
15857 this is a compile time check it doesn't need to be a real problem when the program
15858 runs.  It is intended to identify functions which most probably cause
15859 a stack overflow.  It is useful to be used in an environment with limited stack
15860 size e.g.@: the linux kernel.
15862 @item -mwarn-dynamicstack
15863 @opindex mwarn-dynamicstack
15864 Emit a warning if the function calls alloca or uses dynamically
15865 sized arrays.  This is generally a bad idea with a limited stack size.
15867 @item -mstack-guard=@var{stack-guard}
15868 @itemx -mstack-size=@var{stack-size}
15869 @opindex mstack-guard
15870 @opindex mstack-size
15871 If these options are provided the s390 back end emits additional instructions in
15872 the function prologue which trigger a trap if the stack size is @var{stack-guard}
15873 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
15874 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
15875 the frame size of the compiled function is chosen.
15876 These options are intended to be used to help debugging stack overflow problems.
15877 The additionally emitted code causes only little overhead and hence can also be
15878 used in production like systems without greater performance degradation.  The given
15879 values have to be exact powers of 2 and @var{stack-size} has to be greater than
15880 @var{stack-guard} without exceeding 64k.
15881 In order to be efficient the extra code makes the assumption that the stack starts
15882 at an address aligned to the value given by @var{stack-size}.
15883 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
15884 @end table
15886 @node Score Options
15887 @subsection Score Options
15888 @cindex Score Options
15890 These options are defined for Score implementations:
15892 @table @gcctabopt
15893 @item -meb
15894 @opindex meb
15895 Compile code for big endian mode.  This is the default.
15897 @item -mel
15898 @opindex mel
15899 Compile code for little endian mode.
15901 @item -mnhwloop
15902 @opindex mnhwloop
15903 Disable generate bcnz instruction.
15905 @item -muls
15906 @opindex muls
15907 Enable generate unaligned load and store instruction.
15909 @item -mmac
15910 @opindex mmac
15911 Enable the use of multiply-accumulate instructions. Disabled by default.
15913 @item -mscore5
15914 @opindex mscore5
15915 Specify the SCORE5 as the target architecture.
15917 @item -mscore5u
15918 @opindex mscore5u
15919 Specify the SCORE5U of the target architecture.
15921 @item -mscore7
15922 @opindex mscore7
15923 Specify the SCORE7 as the target architecture. This is the default.
15925 @item -mscore7d
15926 @opindex mscore7d
15927 Specify the SCORE7D as the target architecture.
15928 @end table
15930 @node SH Options
15931 @subsection SH Options
15933 These @samp{-m} options are defined for the SH implementations:
15935 @table @gcctabopt
15936 @item -m1
15937 @opindex m1
15938 Generate code for the SH1.
15940 @item -m2
15941 @opindex m2
15942 Generate code for the SH2.
15944 @item -m2e
15945 Generate code for the SH2e.
15947 @item -m2a-nofpu
15948 @opindex m2a-nofpu
15949 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
15950 that the floating-point unit is not used.
15952 @item -m2a-single-only
15953 @opindex m2a-single-only
15954 Generate code for the SH2a-FPU, in such a way that no double-precision
15955 floating point operations are used.
15957 @item -m2a-single
15958 @opindex m2a-single
15959 Generate code for the SH2a-FPU assuming the floating-point unit is in
15960 single-precision mode by default.
15962 @item -m2a
15963 @opindex m2a
15964 Generate code for the SH2a-FPU assuming the floating-point unit is in
15965 double-precision mode by default.
15967 @item -m3
15968 @opindex m3
15969 Generate code for the SH3.
15971 @item -m3e
15972 @opindex m3e
15973 Generate code for the SH3e.
15975 @item -m4-nofpu
15976 @opindex m4-nofpu
15977 Generate code for the SH4 without a floating-point unit.
15979 @item -m4-single-only
15980 @opindex m4-single-only
15981 Generate code for the SH4 with a floating-point unit that only
15982 supports single-precision arithmetic.
15984 @item -m4-single
15985 @opindex m4-single
15986 Generate code for the SH4 assuming the floating-point unit is in
15987 single-precision mode by default.
15989 @item -m4
15990 @opindex m4
15991 Generate code for the SH4.
15993 @item -m4a-nofpu
15994 @opindex m4a-nofpu
15995 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
15996 floating-point unit is not used.
15998 @item -m4a-single-only
15999 @opindex m4a-single-only
16000 Generate code for the SH4a, in such a way that no double-precision
16001 floating point operations are used.
16003 @item -m4a-single
16004 @opindex m4a-single
16005 Generate code for the SH4a assuming the floating-point unit is in
16006 single-precision mode by default.
16008 @item -m4a
16009 @opindex m4a
16010 Generate code for the SH4a.
16012 @item -m4al
16013 @opindex m4al
16014 Same as @option{-m4a-nofpu}, except that it implicitly passes
16015 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
16016 instructions at the moment.
16018 @item -mb
16019 @opindex mb
16020 Compile code for the processor in big endian mode.
16022 @item -ml
16023 @opindex ml
16024 Compile code for the processor in little endian mode.
16026 @item -mdalign
16027 @opindex mdalign
16028 Align doubles at 64-bit boundaries.  Note that this changes the calling
16029 conventions, and thus some functions from the standard C library will
16030 not work unless you recompile it first with @option{-mdalign}.
16032 @item -mrelax
16033 @opindex mrelax
16034 Shorten some address references at link time, when possible; uses the
16035 linker option @option{-relax}.
16037 @item -mbigtable
16038 @opindex mbigtable
16039 Use 32-bit offsets in @code{switch} tables.  The default is to use
16040 16-bit offsets.
16042 @item -mbitops
16043 @opindex mbitops
16044 Enable the use of bit manipulation instructions on SH2A.
16046 @item -mfmovd
16047 @opindex mfmovd
16048 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
16049 alignment constraints.
16051 @item -mhitachi
16052 @opindex mhitachi
16053 Comply with the calling conventions defined by Renesas.
16055 @item -mrenesas
16056 @opindex mhitachi
16057 Comply with the calling conventions defined by Renesas.
16059 @item -mno-renesas
16060 @opindex mhitachi
16061 Comply with the calling conventions defined for GCC before the Renesas
16062 conventions were available.  This option is the default for all
16063 targets of the SH toolchain except for @samp{sh-symbianelf}.
16065 @item -mnomacsave
16066 @opindex mnomacsave
16067 Mark the @code{MAC} register as call-clobbered, even if
16068 @option{-mhitachi} is given.
16070 @item -mieee
16071 @opindex mieee
16072 Increase IEEE-compliance of floating-point code.
16073 At the moment, this is equivalent to @option{-fno-finite-math-only}.
16074 When generating 16 bit SH opcodes, getting IEEE-conforming results for
16075 comparisons of NANs / infinities incurs extra overhead in every
16076 floating point comparison, therefore the default is set to
16077 @option{-ffinite-math-only}.
16079 @item -minline-ic_invalidate
16080 @opindex minline-ic_invalidate
16081 Inline code to invalidate instruction cache entries after setting up
16082 nested function trampolines.
16083 This option has no effect if -musermode is in effect and the selected
16084 code generation option (e.g. -m4) does not allow the use of the icbi
16085 instruction.
16086 If the selected code generation option does not allow the use of the icbi
16087 instruction, and -musermode is not in effect, the inlined code will
16088 manipulate the instruction cache address array directly with an associative
16089 write.  This not only requires privileged mode, but it will also
16090 fail if the cache line had been mapped via the TLB and has become unmapped.
16092 @item -misize
16093 @opindex misize
16094 Dump instruction size and location in the assembly code.
16096 @item -mpadstruct
16097 @opindex mpadstruct
16098 This option is deprecated.  It pads structures to multiple of 4 bytes,
16099 which is incompatible with the SH ABI@.
16101 @item -mspace
16102 @opindex mspace
16103 Optimize for space instead of speed.  Implied by @option{-Os}.
16105 @item -mprefergot
16106 @opindex mprefergot
16107 When generating position-independent code, emit function calls using
16108 the Global Offset Table instead of the Procedure Linkage Table.
16110 @item -musermode
16111 @opindex musermode
16112 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
16113 if the inlined code would not work in user mode.
16114 This is the default when the target is @code{sh-*-linux*}.
16116 @item -multcost=@var{number}
16117 @opindex multcost=@var{number}
16118 Set the cost to assume for a multiply insn.
16120 @item -mdiv=@var{strategy}
16121 @opindex mdiv=@var{strategy}
16122 Set the division strategy to use for SHmedia code.  @var{strategy} must be
16123 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
16124 inv:call2, inv:fp .
16125 "fp" performs the operation in floating point.  This has a very high latency,
16126 but needs only a few instructions, so it might be a good choice if
16127 your code has enough easily exploitable ILP to allow the compiler to
16128 schedule the floating point instructions together with other instructions.
16129 Division by zero causes a floating point exception.
16130 "inv" uses integer operations to calculate the inverse of the divisor,
16131 and then multiplies the dividend with the inverse.  This strategy allows
16132 cse and hoisting of the inverse calculation.  Division by zero calculates
16133 an unspecified result, but does not trap.
16134 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
16135 have been found, or if the entire operation has been hoisted to the same
16136 place, the last stages of the inverse calculation are intertwined with the
16137 final multiply to reduce the overall latency, at the expense of using a few
16138 more instructions, and thus offering fewer scheduling opportunities with
16139 other code.
16140 "call" calls a library function that usually implements the inv:minlat
16141 strategy.
16142 This gives high code density for m5-*media-nofpu compilations.
16143 "call2" uses a different entry point of the same library function, where it
16144 assumes that a pointer to a lookup table has already been set up, which
16145 exposes the pointer load to cse / code hoisting optimizations.
16146 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16147 code generation, but if the code stays unoptimized, revert to the "call",
16148 "call2", or "fp" strategies, respectively.  Note that the
16149 potentially-trapping side effect of division by zero is carried by a
16150 separate instruction, so it is possible that all the integer instructions
16151 are hoisted out, but the marker for the side effect stays where it is.
16152 A recombination to fp operations or a call is not possible in that case.
16153 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
16154 that the inverse calculation was nor separated from the multiply, they speed
16155 up division where the dividend fits into 20 bits (plus sign where applicable),
16156 by inserting a test to skip a number of operations in this case; this test
16157 slows down the case of larger dividends.  inv20u assumes the case of a such
16158 a small dividend to be unlikely, and inv20l assumes it to be likely.
16160 @item -maccumulate-outgoing-args
16161 @opindex maccumulate-outgoing-args
16162 Reserve space once for outgoing arguments in the function prologue rather 
16163 than around each call.  Generally beneficial for performance and size.  Also
16164 needed for unwinding to avoid changing the stack frame around conditional code.
16166 @item -mdivsi3_libfunc=@var{name}
16167 @opindex mdivsi3_libfunc=@var{name}
16168 Set the name of the library function used for 32 bit signed division to
16169 @var{name}.  This only affect the name used in the call and inv:call
16170 division strategies, and the compiler will still expect the same
16171 sets of input/output/clobbered registers as if this option was not present.
16173 @item -mfixed-range=@var{register-range}
16174 @opindex mfixed-range
16175 Generate code treating the given register range as fixed registers.
16176 A fixed register is one that the register allocator can not use.  This is
16177 useful when compiling kernel code.  A register range is specified as
16178 two registers separated by a dash.  Multiple register ranges can be
16179 specified separated by a comma.
16181 @item -madjust-unroll
16182 @opindex madjust-unroll
16183 Throttle unrolling to avoid thrashing target registers.
16184 This option only has an effect if the gcc code base supports the
16185 TARGET_ADJUST_UNROLL_MAX target hook.
16187 @item -mindexed-addressing
16188 @opindex mindexed-addressing
16189 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16190 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16191 semantics for the indexed addressing mode.  The architecture allows the
16192 implementation of processors with 64 bit MMU, which the OS could use to
16193 get 32 bit addressing, but since no current hardware implementation supports
16194 this or any other way to make the indexed addressing mode safe to use in
16195 the 32 bit ABI, the default is -mno-indexed-addressing.
16197 @item -mgettrcost=@var{number}
16198 @opindex mgettrcost=@var{number}
16199 Set the cost assumed for the gettr instruction to @var{number}.
16200 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16202 @item -mpt-fixed
16203 @opindex mpt-fixed
16204 Assume pt* instructions won't trap.  This will generally generate better
16205 scheduled code, but is unsafe on current hardware.  The current architecture
16206 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16207 This has the unintentional effect of making it unsafe to schedule ptabs /
16208 ptrel before a branch, or hoist it out of a loop.  For example,
16209 __do_global_ctors, a part of libgcc that runs constructors at program
16210 startup, calls functions in a list which is delimited by @minus{}1.  With the
16211 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16212 That means that all the constructors will be run a bit quicker, but when
16213 the loop comes to the end of the list, the program crashes because ptabs
16214 loads @minus{}1 into a target register.  Since this option is unsafe for any
16215 hardware implementing the current architecture specification, the default
16216 is -mno-pt-fixed.  Unless the user specifies a specific cost with
16217 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16218 this deters register allocation using target registers for storing
16219 ordinary integers.
16221 @item -minvalid-symbols
16222 @opindex minvalid-symbols
16223 Assume symbols might be invalid.  Ordinary function symbols generated by
16224 the compiler will always be valid to load with movi/shori/ptabs or
16225 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16226 to generate symbols that will cause ptabs / ptrel to trap.
16227 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16228 It will then prevent cross-basic-block cse, hoisting and most scheduling
16229 of symbol loads.  The default is @option{-mno-invalid-symbols}.
16230 @end table
16232 @node SPARC Options
16233 @subsection SPARC Options
16234 @cindex SPARC options
16236 These @samp{-m} options are supported on the SPARC:
16238 @table @gcctabopt
16239 @item -mno-app-regs
16240 @itemx -mapp-regs
16241 @opindex mno-app-regs
16242 @opindex mapp-regs
16243 Specify @option{-mapp-regs} to generate output using the global registers
16244 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
16245 is the default.
16247 To be fully SVR4 ABI compliant at the cost of some performance loss,
16248 specify @option{-mno-app-regs}.  You should compile libraries and system
16249 software with this option.
16251 @item -mfpu
16252 @itemx -mhard-float
16253 @opindex mfpu
16254 @opindex mhard-float
16255 Generate output containing floating point instructions.  This is the
16256 default.
16258 @item -mno-fpu
16259 @itemx -msoft-float
16260 @opindex mno-fpu
16261 @opindex msoft-float
16262 Generate output containing library calls for floating point.
16263 @strong{Warning:} the requisite libraries are not available for all SPARC
16264 targets.  Normally the facilities of the machine's usual C compiler are
16265 used, but this cannot be done directly in cross-compilation.  You must make
16266 your own arrangements to provide suitable library functions for
16267 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
16268 @samp{sparclite-*-*} do provide software floating point support.
16270 @option{-msoft-float} changes the calling convention in the output file;
16271 therefore, it is only useful if you compile @emph{all} of a program with
16272 this option.  In particular, you need to compile @file{libgcc.a}, the
16273 library that comes with GCC, with @option{-msoft-float} in order for
16274 this to work.
16276 @item -mhard-quad-float
16277 @opindex mhard-quad-float
16278 Generate output containing quad-word (long double) floating point
16279 instructions.
16281 @item -msoft-quad-float
16282 @opindex msoft-quad-float
16283 Generate output containing library calls for quad-word (long double)
16284 floating point instructions.  The functions called are those specified
16285 in the SPARC ABI@.  This is the default.
16287 As of this writing, there are no SPARC implementations that have hardware
16288 support for the quad-word floating point instructions.  They all invoke
16289 a trap handler for one of these instructions, and then the trap handler
16290 emulates the effect of the instruction.  Because of the trap handler overhead,
16291 this is much slower than calling the ABI library routines.  Thus the
16292 @option{-msoft-quad-float} option is the default.
16294 @item -mno-unaligned-doubles
16295 @itemx -munaligned-doubles
16296 @opindex mno-unaligned-doubles
16297 @opindex munaligned-doubles
16298 Assume that doubles have 8 byte alignment.  This is the default.
16300 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
16301 alignment only if they are contained in another type, or if they have an
16302 absolute address.  Otherwise, it assumes they have 4 byte alignment.
16303 Specifying this option avoids some rare compatibility problems with code
16304 generated by other compilers.  It is not the default because it results
16305 in a performance loss, especially for floating point code.
16307 @item -mno-faster-structs
16308 @itemx -mfaster-structs
16309 @opindex mno-faster-structs
16310 @opindex mfaster-structs
16311 With @option{-mfaster-structs}, the compiler assumes that structures
16312 should have 8 byte alignment.  This enables the use of pairs of
16313 @code{ldd} and @code{std} instructions for copies in structure
16314 assignment, in place of twice as many @code{ld} and @code{st} pairs.
16315 However, the use of this changed alignment directly violates the SPARC
16316 ABI@.  Thus, it's intended only for use on targets where the developer
16317 acknowledges that their resulting code will not be directly in line with
16318 the rules of the ABI@.
16320 @item -mimpure-text
16321 @opindex mimpure-text
16322 @option{-mimpure-text}, used in addition to @option{-shared}, tells
16323 the compiler to not pass @option{-z text} to the linker when linking a
16324 shared object.  Using this option, you can link position-dependent
16325 code into a shared object.
16327 @option{-mimpure-text} suppresses the ``relocations remain against
16328 allocatable but non-writable sections'' linker error message.
16329 However, the necessary relocations will trigger copy-on-write, and the
16330 shared object is not actually shared across processes.  Instead of
16331 using @option{-mimpure-text}, you should compile all source code with
16332 @option{-fpic} or @option{-fPIC}.
16334 This option is only available on SunOS and Solaris.
16336 @item -mcpu=@var{cpu_type}
16337 @opindex mcpu
16338 Set the instruction set, register set, and instruction scheduling parameters
16339 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
16340 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
16341 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
16342 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
16343 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
16345 Default instruction scheduling parameters are used for values that select
16346 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
16347 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
16349 Here is a list of each supported architecture and their supported
16350 implementations.
16352 @smallexample
16353     v7:             cypress
16354     v8:             supersparc, hypersparc
16355     sparclite:      f930, f934, sparclite86x
16356     sparclet:       tsc701
16357     v9:             ultrasparc, ultrasparc3, niagara, niagara2
16358 @end smallexample
16360 By default (unless configured otherwise), GCC generates code for the V7
16361 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
16362 additionally optimizes it for the Cypress CY7C602 chip, as used in the
16363 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
16364 SPARCStation 1, 2, IPX etc.
16366 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
16367 architecture.  The only difference from V7 code is that the compiler emits
16368 the integer multiply and integer divide instructions which exist in SPARC-V8
16369 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
16370 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
16371 2000 series.
16373 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
16374 the SPARC architecture.  This adds the integer multiply, integer divide step
16375 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
16376 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
16377 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
16378 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
16379 MB86934 chip, which is the more recent SPARClite with FPU@.
16381 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
16382 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
16383 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
16384 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
16385 optimizes it for the TEMIC SPARClet chip.
16387 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
16388 architecture.  This adds 64-bit integer and floating-point move instructions,
16389 3 additional floating-point condition code registers and conditional move
16390 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
16391 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
16392 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
16393 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
16394 @option{-mcpu=niagara}, the compiler additionally optimizes it for
16395 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
16396 additionally optimizes it for Sun UltraSPARC T2 chips.
16398 @item -mtune=@var{cpu_type}
16399 @opindex mtune
16400 Set the instruction scheduling parameters for machine type
16401 @var{cpu_type}, but do not set the instruction set or register set that the
16402 option @option{-mcpu=@var{cpu_type}} would.
16404 The same values for @option{-mcpu=@var{cpu_type}} can be used for
16405 @option{-mtune=@var{cpu_type}}, but the only useful values are those
16406 that select a particular cpu implementation.  Those are @samp{cypress},
16407 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
16408 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
16409 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
16411 @item -mv8plus
16412 @itemx -mno-v8plus
16413 @opindex mv8plus
16414 @opindex mno-v8plus
16415 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
16416 difference from the V8 ABI is that the global and out registers are
16417 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
16418 mode for all SPARC-V9 processors.
16420 @item -mvis
16421 @itemx -mno-vis
16422 @opindex mvis
16423 @opindex mno-vis
16424 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
16425 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
16426 @end table
16428 These @samp{-m} options are supported in addition to the above
16429 on SPARC-V9 processors in 64-bit environments:
16431 @table @gcctabopt
16432 @item -mlittle-endian
16433 @opindex mlittle-endian
16434 Generate code for a processor running in little-endian mode.  It is only
16435 available for a few configurations and most notably not on Solaris and Linux.
16437 @item -m32
16438 @itemx -m64
16439 @opindex m32
16440 @opindex m64
16441 Generate code for a 32-bit or 64-bit environment.
16442 The 32-bit environment sets int, long and pointer to 32 bits.
16443 The 64-bit environment sets int to 32 bits and long and pointer
16444 to 64 bits.
16446 @item -mcmodel=medlow
16447 @opindex mcmodel=medlow
16448 Generate code for the Medium/Low code model: 64-bit addresses, programs
16449 must be linked in the low 32 bits of memory.  Programs can be statically
16450 or dynamically linked.
16452 @item -mcmodel=medmid
16453 @opindex mcmodel=medmid
16454 Generate code for the Medium/Middle code model: 64-bit addresses, programs
16455 must be linked in the low 44 bits of memory, the text and data segments must
16456 be less than 2GB in size and the data segment must be located within 2GB of
16457 the text segment.
16459 @item -mcmodel=medany
16460 @opindex mcmodel=medany
16461 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
16462 may be linked anywhere in memory, the text and data segments must be less
16463 than 2GB in size and the data segment must be located within 2GB of the
16464 text segment.
16466 @item -mcmodel=embmedany
16467 @opindex mcmodel=embmedany
16468 Generate code for the Medium/Anywhere code model for embedded systems:
16469 64-bit addresses, the text and data segments must be less than 2GB in
16470 size, both starting anywhere in memory (determined at link time).  The
16471 global register %g4 points to the base of the data segment.  Programs
16472 are statically linked and PIC is not supported.
16474 @item -mstack-bias
16475 @itemx -mno-stack-bias
16476 @opindex mstack-bias
16477 @opindex mno-stack-bias
16478 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
16479 frame pointer if present, are offset by @minus{}2047 which must be added back
16480 when making stack frame references.  This is the default in 64-bit mode.
16481 Otherwise, assume no such offset is present.
16482 @end table
16484 These switches are supported in addition to the above on Solaris:
16486 @table @gcctabopt
16487 @item -threads
16488 @opindex threads
16489 Add support for multithreading using the Solaris threads library.  This
16490 option sets flags for both the preprocessor and linker.  This option does
16491 not affect the thread safety of object code produced by the compiler or
16492 that of libraries supplied with it.
16494 @item -pthreads
16495 @opindex pthreads
16496 Add support for multithreading using the POSIX threads library.  This
16497 option sets flags for both the preprocessor and linker.  This option does
16498 not affect the thread safety of object code produced  by the compiler or
16499 that of libraries supplied with it.
16501 @item -pthread
16502 @opindex pthread
16503 This is a synonym for @option{-pthreads}.
16504 @end table
16506 @node SPU Options
16507 @subsection SPU Options
16508 @cindex SPU options
16510 These @samp{-m} options are supported on the SPU:
16512 @table @gcctabopt
16513 @item -mwarn-reloc
16514 @itemx -merror-reloc
16515 @opindex mwarn-reloc
16516 @opindex merror-reloc
16518 The loader for SPU does not handle dynamic relocations.  By default, GCC
16519 will give an error when it generates code that requires a dynamic
16520 relocation.  @option{-mno-error-reloc} disables the error,
16521 @option{-mwarn-reloc} will generate a warning instead.
16523 @item -msafe-dma
16524 @itemx -munsafe-dma
16525 @opindex msafe-dma
16526 @opindex munsafe-dma
16528 Instructions which initiate or test completion of DMA must not be
16529 reordered with respect to loads and stores of the memory which is being
16530 accessed.  Users typically address this problem using the volatile
16531 keyword, but that can lead to inefficient code in places where the
16532 memory is known to not change.  Rather than mark the memory as volatile
16533 we treat the DMA instructions as potentially effecting all memory.  With
16534 @option{-munsafe-dma} users must use the volatile keyword to protect
16535 memory accesses.
16537 @item -mbranch-hints
16538 @opindex mbranch-hints
16540 By default, GCC will generate a branch hint instruction to avoid
16541 pipeline stalls for always taken or probably taken branches.  A hint
16542 will not be generated closer than 8 instructions away from its branch.
16543 There is little reason to disable them, except for debugging purposes,
16544 or to make an object a little bit smaller.
16546 @item -msmall-mem
16547 @itemx -mlarge-mem
16548 @opindex msmall-mem
16549 @opindex mlarge-mem
16551 By default, GCC generates code assuming that addresses are never larger
16552 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
16553 a full 32 bit address.
16555 @item -mstdmain
16556 @opindex mstdmain
16558 By default, GCC links against startup code that assumes the SPU-style
16559 main function interface (which has an unconventional parameter list).
16560 With @option{-mstdmain}, GCC will link your program against startup
16561 code that assumes a C99-style interface to @code{main}, including a
16562 local copy of @code{argv} strings.
16564 @item -mfixed-range=@var{register-range}
16565 @opindex mfixed-range
16566 Generate code treating the given register range as fixed registers.
16567 A fixed register is one that the register allocator can not use.  This is
16568 useful when compiling kernel code.  A register range is specified as
16569 two registers separated by a dash.  Multiple register ranges can be
16570 specified separated by a comma.
16572 @item -mea32
16573 @itemx -mea64
16574 @opindex mea32
16575 @opindex mea64
16576 Compile code assuming that pointers to the PPU address space accessed
16577 via the @code{__ea} named address space qualifier are either 32 or 64
16578 bits wide.  The default is 32 bits.  As this is an ABI changing option,
16579 all object code in an executable must be compiled with the same setting.
16581 @item -maddress-space-conversion
16582 @itemx -mno-address-space-conversion
16583 @opindex maddress-space-conversion
16584 @opindex mno-address-space-conversion
16585 Allow/disallow treating the @code{__ea} address space as superset
16586 of the generic address space.  This enables explicit type casts
16587 between @code{__ea} and generic pointer as well as implicit
16588 conversions of generic pointers to @code{__ea} pointers.  The
16589 default is to allow address space pointer conversions.
16591 @item -mcache-size=@var{cache-size}
16592 @opindex mcache-size
16593 This option controls the version of libgcc that the compiler links to an
16594 executable and selects a software-managed cache for accessing variables
16595 in the @code{__ea} address space with a particular cache size.  Possible
16596 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
16597 and @samp{128}.  The default cache size is 64KB.
16599 @item -matomic-updates
16600 @itemx -mno-atomic-updates
16601 @opindex matomic-updates
16602 @opindex mno-atomic-updates
16603 This option controls the version of libgcc that the compiler links to an
16604 executable and selects whether atomic updates to the software-managed
16605 cache of PPU-side variables are used.  If you use atomic updates, changes
16606 to a PPU variable from SPU code using the @code{__ea} named address space
16607 qualifier will not interfere with changes to other PPU variables residing
16608 in the same cache line from PPU code.  If you do not use atomic updates,
16609 such interference may occur; however, writing back cache lines will be
16610 more efficient.  The default behavior is to use atomic updates.
16612 @item -mdual-nops
16613 @itemx -mdual-nops=@var{n}
16614 @opindex mdual-nops
16615 By default, GCC will insert nops to increase dual issue when it expects
16616 it to increase performance.  @var{n} can be a value from 0 to 10.  A
16617 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
16618 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
16620 @item -mhint-max-nops=@var{n}
16621 @opindex mhint-max-nops
16622 Maximum number of nops to insert for a branch hint.  A branch hint must
16623 be at least 8 instructions away from the branch it is effecting.  GCC
16624 will insert up to @var{n} nops to enforce this, otherwise it will not
16625 generate the branch hint.
16627 @item -mhint-max-distance=@var{n}
16628 @opindex mhint-max-distance
16629 The encoding of the branch hint instruction limits the hint to be within
16630 256 instructions of the branch it is effecting.  By default, GCC makes
16631 sure it is within 125.
16633 @item -msafe-hints
16634 @opindex msafe-hints
16635 Work around a hardware bug which causes the SPU to stall indefinitely.
16636 By default, GCC will insert the @code{hbrp} instruction to make sure
16637 this stall won't happen.
16639 @end table
16641 @node System V Options
16642 @subsection Options for System V
16644 These additional options are available on System V Release 4 for
16645 compatibility with other compilers on those systems:
16647 @table @gcctabopt
16648 @item -G
16649 @opindex G
16650 Create a shared object.
16651 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
16653 @item -Qy
16654 @opindex Qy
16655 Identify the versions of each tool used by the compiler, in a
16656 @code{.ident} assembler directive in the output.
16658 @item -Qn
16659 @opindex Qn
16660 Refrain from adding @code{.ident} directives to the output file (this is
16661 the default).
16663 @item -YP,@var{dirs}
16664 @opindex YP
16665 Search the directories @var{dirs}, and no others, for libraries
16666 specified with @option{-l}.
16668 @item -Ym,@var{dir}
16669 @opindex Ym
16670 Look in the directory @var{dir} to find the M4 preprocessor.
16671 The assembler uses this option.
16672 @c This is supposed to go with a -Yd for predefined M4 macro files, but
16673 @c the generic assembler that comes with Solaris takes just -Ym.
16674 @end table
16676 @node V850 Options
16677 @subsection V850 Options
16678 @cindex V850 Options
16680 These @samp{-m} options are defined for V850 implementations:
16682 @table @gcctabopt
16683 @item -mlong-calls
16684 @itemx -mno-long-calls
16685 @opindex mlong-calls
16686 @opindex mno-long-calls
16687 Treat all calls as being far away (near).  If calls are assumed to be
16688 far away, the compiler will always load the functions address up into a
16689 register, and call indirect through the pointer.
16691 @item -mno-ep
16692 @itemx -mep
16693 @opindex mno-ep
16694 @opindex mep
16695 Do not optimize (do optimize) basic blocks that use the same index
16696 pointer 4 or more times to copy pointer into the @code{ep} register, and
16697 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
16698 option is on by default if you optimize.
16700 @item -mno-prolog-function
16701 @itemx -mprolog-function
16702 @opindex mno-prolog-function
16703 @opindex mprolog-function
16704 Do not use (do use) external functions to save and restore registers
16705 at the prologue and epilogue of a function.  The external functions
16706 are slower, but use less code space if more than one function saves
16707 the same number of registers.  The @option{-mprolog-function} option
16708 is on by default if you optimize.
16710 @item -mspace
16711 @opindex mspace
16712 Try to make the code as small as possible.  At present, this just turns
16713 on the @option{-mep} and @option{-mprolog-function} options.
16715 @item -mtda=@var{n}
16716 @opindex mtda
16717 Put static or global variables whose size is @var{n} bytes or less into
16718 the tiny data area that register @code{ep} points to.  The tiny data
16719 area can hold up to 256 bytes in total (128 bytes for byte references).
16721 @item -msda=@var{n}
16722 @opindex msda
16723 Put static or global variables whose size is @var{n} bytes or less into
16724 the small data area that register @code{gp} points to.  The small data
16725 area can hold up to 64 kilobytes.
16727 @item -mzda=@var{n}
16728 @opindex mzda
16729 Put static or global variables whose size is @var{n} bytes or less into
16730 the first 32 kilobytes of memory.
16732 @item -mv850
16733 @opindex mv850
16734 Specify that the target processor is the V850.
16736 @item -mbig-switch
16737 @opindex mbig-switch
16738 Generate code suitable for big switch tables.  Use this option only if
16739 the assembler/linker complain about out of range branches within a switch
16740 table.
16742 @item -mapp-regs
16743 @opindex mapp-regs
16744 This option will cause r2 and r5 to be used in the code generated by
16745 the compiler.  This setting is the default.
16747 @item -mno-app-regs
16748 @opindex mno-app-regs
16749 This option will cause r2 and r5 to be treated as fixed registers.
16751 @item -mv850e1
16752 @opindex mv850e1
16753 Specify that the target processor is the V850E1.  The preprocessor
16754 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
16755 this option is used.
16757 @item -mv850e
16758 @opindex mv850e
16759 Specify that the target processor is the V850E@.  The preprocessor
16760 constant @samp{__v850e__} will be defined if this option is used.
16762 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
16763 are defined then a default target processor will be chosen and the
16764 relevant @samp{__v850*__} preprocessor constant will be defined.
16766 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
16767 defined, regardless of which processor variant is the target.
16769 @item -mdisable-callt
16770 @opindex mdisable-callt
16771 This option will suppress generation of the CALLT instruction for the
16772 v850e and v850e1 flavors of the v850 architecture.  The default is
16773 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
16775 @end table
16777 @node VAX Options
16778 @subsection VAX Options
16779 @cindex VAX options
16781 These @samp{-m} options are defined for the VAX:
16783 @table @gcctabopt
16784 @item -munix
16785 @opindex munix
16786 Do not output certain jump instructions (@code{aobleq} and so on)
16787 that the Unix assembler for the VAX cannot handle across long
16788 ranges.
16790 @item -mgnu
16791 @opindex mgnu
16792 Do output those jump instructions, on the assumption that you
16793 will assemble with the GNU assembler.
16795 @item -mg
16796 @opindex mg
16797 Output code for g-format floating point numbers instead of d-format.
16798 @end table
16800 @node VxWorks Options
16801 @subsection VxWorks Options
16802 @cindex VxWorks Options
16804 The options in this section are defined for all VxWorks targets.
16805 Options specific to the target hardware are listed with the other
16806 options for that target.
16808 @table @gcctabopt
16809 @item -mrtp
16810 @opindex mrtp
16811 GCC can generate code for both VxWorks kernels and real time processes
16812 (RTPs).  This option switches from the former to the latter.  It also
16813 defines the preprocessor macro @code{__RTP__}.
16815 @item -non-static
16816 @opindex non-static
16817 Link an RTP executable against shared libraries rather than static
16818 libraries.  The options @option{-static} and @option{-shared} can
16819 also be used for RTPs (@pxref{Link Options}); @option{-static}
16820 is the default.
16822 @item -Bstatic
16823 @itemx -Bdynamic
16824 @opindex Bstatic
16825 @opindex Bdynamic
16826 These options are passed down to the linker.  They are defined for
16827 compatibility with Diab.
16829 @item -Xbind-lazy
16830 @opindex Xbind-lazy
16831 Enable lazy binding of function calls.  This option is equivalent to
16832 @option{-Wl,-z,now} and is defined for compatibility with Diab.
16834 @item -Xbind-now
16835 @opindex Xbind-now
16836 Disable lazy binding of function calls.  This option is the default and
16837 is defined for compatibility with Diab.
16838 @end table
16840 @node x86-64 Options
16841 @subsection x86-64 Options
16842 @cindex x86-64 options
16844 These are listed under @xref{i386 and x86-64 Options}.
16846 @node i386 and x86-64 Windows Options
16847 @subsection i386 and x86-64 Windows Options
16848 @cindex i386 and x86-64 Windows Options
16850 These additional options are available for Windows targets:
16852 @table @gcctabopt
16853 @item -mconsole
16854 @opindex mconsole
16855 This option is available for Cygwin and MinGW targets.  It
16856 specifies that a console application is to be generated, by
16857 instructing the linker to set the PE header subsystem type
16858 required for console applications.
16859 This is the default behavior for Cygwin and MinGW targets.
16861 @item -mcygwin
16862 @opindex mcygwin
16863 This option is available for Cygwin targets.  It specifies that
16864 the Cygwin internal interface is to be used for predefined
16865 preprocessor macros, C runtime libraries and related linker
16866 paths and options.  For Cygwin targets this is the default behavior.
16867 This option is deprecated and will be removed in a future release.
16869 @item -mno-cygwin
16870 @opindex mno-cygwin
16871 This option is available for Cygwin targets.  It specifies that
16872 the MinGW internal interface is to be used instead of Cygwin's, by
16873 setting MinGW-related predefined macros and linker paths and default
16874 library options.
16875 This option is deprecated and will be removed in a future release.
16877 @item -mdll
16878 @opindex mdll
16879 This option is available for Cygwin and MinGW targets.  It
16880 specifies that a DLL - a dynamic link library - is to be
16881 generated, enabling the selection of the required runtime
16882 startup object and entry point.
16884 @item -mnop-fun-dllimport
16885 @opindex mnop-fun-dllimport
16886 This option is available for Cygwin and MinGW targets.  It
16887 specifies that the dllimport attribute should be ignored.
16889 @item -mthread
16890 @opindex mthread
16891 This option is available for MinGW targets. It specifies
16892 that MinGW-specific thread support is to be used.
16894 @item -municode
16895 @opindex municode
16896 This option is available for mingw-w64 targets.  It specifies
16897 that the UNICODE macro is getting pre-defined and that the
16898 unicode capable runtime startup code is chosen.
16900 @item -mwin32
16901 @opindex mwin32
16902 This option is available for Cygwin and MinGW targets.  It
16903 specifies that the typical Windows pre-defined macros are to
16904 be set in the pre-processor, but does not influence the choice
16905 of runtime library/startup code.
16907 @item -mwindows
16908 @opindex mwindows
16909 This option is available for Cygwin and MinGW targets.  It
16910 specifies that a GUI application is to be generated by
16911 instructing the linker to set the PE header subsystem type
16912 appropriately.
16914 @item -fno-set-stack-executable
16915 @opindex fno-set-stack-executable
16916 This option is available for MinGW targets. It specifies that
16917 the executable flag for stack used by nested functions isn't
16918 set. This is necessary for binaries running in kernel mode of
16919 Windows, as there the user32 API, which is used to set executable
16920 privileges, isn't available.
16922 @item -mpe-aligned-commons
16923 @opindex mpe-aligned-commons
16924 This option is available for Cygwin and MinGW targets.  It
16925 specifies that the GNU extension to the PE file format that
16926 permits the correct alignment of COMMON variables should be
16927 used when generating code.  It will be enabled by default if
16928 GCC detects that the target assembler found during configuration
16929 supports the feature.
16930 @end table
16932 See also under @ref{i386 and x86-64 Options} for standard options.
16934 @node Xstormy16 Options
16935 @subsection Xstormy16 Options
16936 @cindex Xstormy16 Options
16938 These options are defined for Xstormy16:
16940 @table @gcctabopt
16941 @item -msim
16942 @opindex msim
16943 Choose startup files and linker script suitable for the simulator.
16944 @end table
16946 @node Xtensa Options
16947 @subsection Xtensa Options
16948 @cindex Xtensa Options
16950 These options are supported for Xtensa targets:
16952 @table @gcctabopt
16953 @item -mconst16
16954 @itemx -mno-const16
16955 @opindex mconst16
16956 @opindex mno-const16
16957 Enable or disable use of @code{CONST16} instructions for loading
16958 constant values.  The @code{CONST16} instruction is currently not a
16959 standard option from Tensilica.  When enabled, @code{CONST16}
16960 instructions are always used in place of the standard @code{L32R}
16961 instructions.  The use of @code{CONST16} is enabled by default only if
16962 the @code{L32R} instruction is not available.
16964 @item -mfused-madd
16965 @itemx -mno-fused-madd
16966 @opindex mfused-madd
16967 @opindex mno-fused-madd
16968 Enable or disable use of fused multiply/add and multiply/subtract
16969 instructions in the floating-point option.  This has no effect if the
16970 floating-point option is not also enabled.  Disabling fused multiply/add
16971 and multiply/subtract instructions forces the compiler to use separate
16972 instructions for the multiply and add/subtract operations.  This may be
16973 desirable in some cases where strict IEEE 754-compliant results are
16974 required: the fused multiply add/subtract instructions do not round the
16975 intermediate result, thereby producing results with @emph{more} bits of
16976 precision than specified by the IEEE standard.  Disabling fused multiply
16977 add/subtract instructions also ensures that the program output is not
16978 sensitive to the compiler's ability to combine multiply and add/subtract
16979 operations.
16981 @item -mserialize-volatile
16982 @itemx -mno-serialize-volatile
16983 @opindex mserialize-volatile
16984 @opindex mno-serialize-volatile
16985 When this option is enabled, GCC inserts @code{MEMW} instructions before
16986 @code{volatile} memory references to guarantee sequential consistency.
16987 The default is @option{-mserialize-volatile}.  Use
16988 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
16990 @item -mtext-section-literals
16991 @itemx -mno-text-section-literals
16992 @opindex mtext-section-literals
16993 @opindex mno-text-section-literals
16994 Control the treatment of literal pools.  The default is
16995 @option{-mno-text-section-literals}, which places literals in a separate
16996 section in the output file.  This allows the literal pool to be placed
16997 in a data RAM/ROM, and it also allows the linker to combine literal
16998 pools from separate object files to remove redundant literals and
16999 improve code size.  With @option{-mtext-section-literals}, the literals
17000 are interspersed in the text section in order to keep them as close as
17001 possible to their references.  This may be necessary for large assembly
17002 files.
17004 @item -mtarget-align
17005 @itemx -mno-target-align
17006 @opindex mtarget-align
17007 @opindex mno-target-align
17008 When this option is enabled, GCC instructs the assembler to
17009 automatically align instructions to reduce branch penalties at the
17010 expense of some code density.  The assembler attempts to widen density
17011 instructions to align branch targets and the instructions following call
17012 instructions.  If there are not enough preceding safe density
17013 instructions to align a target, no widening will be performed.  The
17014 default is @option{-mtarget-align}.  These options do not affect the
17015 treatment of auto-aligned instructions like @code{LOOP}, which the
17016 assembler will always align, either by widening density instructions or
17017 by inserting no-op instructions.
17019 @item -mlongcalls
17020 @itemx -mno-longcalls
17021 @opindex mlongcalls
17022 @opindex mno-longcalls
17023 When this option is enabled, GCC instructs the assembler to translate
17024 direct calls to indirect calls unless it can determine that the target
17025 of a direct call is in the range allowed by the call instruction.  This
17026 translation typically occurs for calls to functions in other source
17027 files.  Specifically, the assembler translates a direct @code{CALL}
17028 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
17029 The default is @option{-mno-longcalls}.  This option should be used in
17030 programs where the call target can potentially be out of range.  This
17031 option is implemented in the assembler, not the compiler, so the
17032 assembly code generated by GCC will still show direct call
17033 instructions---look at the disassembled object code to see the actual
17034 instructions.  Note that the assembler will use an indirect call for
17035 every cross-file call, not just those that really will be out of range.
17036 @end table
17038 @node zSeries Options
17039 @subsection zSeries Options
17040 @cindex zSeries options
17042 These are listed under @xref{S/390 and zSeries Options}.
17044 @node Code Gen Options
17045 @section Options for Code Generation Conventions
17046 @cindex code generation conventions
17047 @cindex options, code generation
17048 @cindex run-time options
17050 These machine-independent options control the interface conventions
17051 used in code generation.
17053 Most of them have both positive and negative forms; the negative form
17054 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
17055 one of the forms is listed---the one which is not the default.  You
17056 can figure out the other form by either removing @samp{no-} or adding
17059 @table @gcctabopt
17060 @item -fbounds-check
17061 @opindex fbounds-check
17062 For front-ends that support it, generate additional code to check that
17063 indices used to access arrays are within the declared range.  This is
17064 currently only supported by the Java and Fortran front-ends, where
17065 this option defaults to true and false respectively.
17067 @item -ftrapv
17068 @opindex ftrapv
17069 This option generates traps for signed overflow on addition, subtraction,
17070 multiplication operations.
17072 @item -fwrapv
17073 @opindex fwrapv
17074 This option instructs the compiler to assume that signed arithmetic
17075 overflow of addition, subtraction and multiplication wraps around
17076 using twos-complement representation.  This flag enables some optimizations
17077 and disables others.  This option is enabled by default for the Java
17078 front-end, as required by the Java language specification.
17080 @item -fexceptions
17081 @opindex fexceptions
17082 Enable exception handling.  Generates extra code needed to propagate
17083 exceptions.  For some targets, this implies GCC will generate frame
17084 unwind information for all functions, which can produce significant data
17085 size overhead, although it does not affect execution.  If you do not
17086 specify this option, GCC will enable it by default for languages like
17087 C++ which normally require exception handling, and disable it for
17088 languages like C that do not normally require it.  However, you may need
17089 to enable this option when compiling C code that needs to interoperate
17090 properly with exception handlers written in C++.  You may also wish to
17091 disable this option if you are compiling older C++ programs that don't
17092 use exception handling.
17094 @item -fnon-call-exceptions
17095 @opindex fnon-call-exceptions
17096 Generate code that allows trapping instructions to throw exceptions.
17097 Note that this requires platform-specific runtime support that does
17098 not exist everywhere.  Moreover, it only allows @emph{trapping}
17099 instructions to throw exceptions, i.e.@: memory references or floating
17100 point instructions.  It does not allow exceptions to be thrown from
17101 arbitrary signal handlers such as @code{SIGALRM}.
17103 @item -funwind-tables
17104 @opindex funwind-tables
17105 Similar to @option{-fexceptions}, except that it will just generate any needed
17106 static data, but will not affect the generated code in any other way.
17107 You will normally not enable this option; instead, a language processor
17108 that needs this handling would enable it on your behalf.
17110 @item -fasynchronous-unwind-tables
17111 @opindex fasynchronous-unwind-tables
17112 Generate unwind table in dwarf2 format, if supported by target machine.  The
17113 table is exact at each instruction boundary, so it can be used for stack
17114 unwinding from asynchronous events (such as debugger or garbage collector).
17116 @item -fpcc-struct-return
17117 @opindex fpcc-struct-return
17118 Return ``short'' @code{struct} and @code{union} values in memory like
17119 longer ones, rather than in registers.  This convention is less
17120 efficient, but it has the advantage of allowing intercallability between
17121 GCC-compiled files and files compiled with other compilers, particularly
17122 the Portable C Compiler (pcc).
17124 The precise convention for returning structures in memory depends
17125 on the target configuration macros.
17127 Short structures and unions are those whose size and alignment match
17128 that of some integer type.
17130 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
17131 switch is not binary compatible with code compiled with the
17132 @option{-freg-struct-return} switch.
17133 Use it to conform to a non-default application binary interface.
17135 @item -freg-struct-return
17136 @opindex freg-struct-return
17137 Return @code{struct} and @code{union} values in registers when possible.
17138 This is more efficient for small structures than
17139 @option{-fpcc-struct-return}.
17141 If you specify neither @option{-fpcc-struct-return} nor
17142 @option{-freg-struct-return}, GCC defaults to whichever convention is
17143 standard for the target.  If there is no standard convention, GCC
17144 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17145 the principal compiler.  In those cases, we can choose the standard, and
17146 we chose the more efficient register return alternative.
17148 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17149 switch is not binary compatible with code compiled with the
17150 @option{-fpcc-struct-return} switch.
17151 Use it to conform to a non-default application binary interface.
17153 @item -fshort-enums
17154 @opindex fshort-enums
17155 Allocate to an @code{enum} type only as many bytes as it needs for the
17156 declared range of possible values.  Specifically, the @code{enum} type
17157 will be equivalent to the smallest integer type which has enough room.
17159 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17160 code that is not binary compatible with code generated without that switch.
17161 Use it to conform to a non-default application binary interface.
17163 @item -fshort-double
17164 @opindex fshort-double
17165 Use the same size for @code{double} as for @code{float}.
17167 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17168 code that is not binary compatible with code generated without that switch.
17169 Use it to conform to a non-default application binary interface.
17171 @item -fshort-wchar
17172 @opindex fshort-wchar
17173 Override the underlying type for @samp{wchar_t} to be @samp{short
17174 unsigned int} instead of the default for the target.  This option is
17175 useful for building programs to run under WINE@.
17177 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17178 code that is not binary compatible with code generated without that switch.
17179 Use it to conform to a non-default application binary interface.
17181 @item -fno-common
17182 @opindex fno-common
17183 In C code, controls the placement of uninitialized global variables.
17184 Unix C compilers have traditionally permitted multiple definitions of
17185 such variables in different compilation units by placing the variables
17186 in a common block.
17187 This is the behavior specified by @option{-fcommon}, and is the default
17188 for GCC on most targets.
17189 On the other hand, this behavior is not required by ISO C, and on some
17190 targets may carry a speed or code size penalty on variable references.
17191 The @option{-fno-common} option specifies that the compiler should place
17192 uninitialized global variables in the data section of the object file,
17193 rather than generating them as common blocks.
17194 This has the effect that if the same variable is declared
17195 (without @code{extern}) in two different compilations,
17196 you will get a multiple-definition error when you link them.
17197 In this case, you must compile with @option{-fcommon} instead.
17198 Compiling with @option{-fno-common} is useful on targets for which
17199 it provides better performance, or if you wish to verify that the
17200 program will work on other systems which always treat uninitialized
17201 variable declarations this way.
17203 @item -fno-ident
17204 @opindex fno-ident
17205 Ignore the @samp{#ident} directive.
17207 @item -finhibit-size-directive
17208 @opindex finhibit-size-directive
17209 Don't output a @code{.size} assembler directive, or anything else that
17210 would cause trouble if the function is split in the middle, and the
17211 two halves are placed at locations far apart in memory.  This option is
17212 used when compiling @file{crtstuff.c}; you should not need to use it
17213 for anything else.
17215 @item -fverbose-asm
17216 @opindex fverbose-asm
17217 Put extra commentary information in the generated assembly code to
17218 make it more readable.  This option is generally only of use to those
17219 who actually need to read the generated assembly code (perhaps while
17220 debugging the compiler itself).
17222 @option{-fno-verbose-asm}, the default, causes the
17223 extra information to be omitted and is useful when comparing two assembler
17224 files.
17226 @item -frecord-gcc-switches
17227 @opindex frecord-gcc-switches
17228 This switch causes the command line that was used to invoke the
17229 compiler to be recorded into the object file that is being created.
17230 This switch is only implemented on some targets and the exact format
17231 of the recording is target and binary file format dependent, but it
17232 usually takes the form of a section containing ASCII text.  This
17233 switch is related to the @option{-fverbose-asm} switch, but that
17234 switch only records information in the assembler output file as
17235 comments, so it never reaches the object file.
17237 @item -fpic
17238 @opindex fpic
17239 @cindex global offset table
17240 @cindex PIC
17241 Generate position-independent code (PIC) suitable for use in a shared
17242 library, if supported for the target machine.  Such code accesses all
17243 constant addresses through a global offset table (GOT)@.  The dynamic
17244 loader resolves the GOT entries when the program starts (the dynamic
17245 loader is not part of GCC; it is part of the operating system).  If
17246 the GOT size for the linked executable exceeds a machine-specific
17247 maximum size, you get an error message from the linker indicating that
17248 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17249 instead.  (These maximums are 8k on the SPARC and 32k
17250 on the m68k and RS/6000.  The 386 has no such limit.)
17252 Position-independent code requires special support, and therefore works
17253 only on certain machines.  For the 386, GCC supports PIC for System V
17254 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
17255 position-independent.
17257 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17258 are defined to 1.
17260 @item -fPIC
17261 @opindex fPIC
17262 If supported for the target machine, emit position-independent code,
17263 suitable for dynamic linking and avoiding any limit on the size of the
17264 global offset table.  This option makes a difference on the m68k,
17265 PowerPC and SPARC@.
17267 Position-independent code requires special support, and therefore works
17268 only on certain machines.
17270 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17271 are defined to 2.
17273 @item -fpie
17274 @itemx -fPIE
17275 @opindex fpie
17276 @opindex fPIE
17277 These options are similar to @option{-fpic} and @option{-fPIC}, but
17278 generated position independent code can be only linked into executables.
17279 Usually these options are used when @option{-pie} GCC option will be
17280 used during linking.
17282 @option{-fpie} and @option{-fPIE} both define the macros
17283 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
17284 for @option{-fpie} and 2 for @option{-fPIE}.
17286 @item -fno-jump-tables
17287 @opindex fno-jump-tables
17288 Do not use jump tables for switch statements even where it would be
17289 more efficient than other code generation strategies.  This option is
17290 of use in conjunction with @option{-fpic} or @option{-fPIC} for
17291 building code which forms part of a dynamic linker and cannot
17292 reference the address of a jump table.  On some targets, jump tables
17293 do not require a GOT and this option is not needed.
17295 @item -ffixed-@var{reg}
17296 @opindex ffixed
17297 Treat the register named @var{reg} as a fixed register; generated code
17298 should never refer to it (except perhaps as a stack pointer, frame
17299 pointer or in some other fixed role).
17301 @var{reg} must be the name of a register.  The register names accepted
17302 are machine-specific and are defined in the @code{REGISTER_NAMES}
17303 macro in the machine description macro file.
17305 This flag does not have a negative form, because it specifies a
17306 three-way choice.
17308 @item -fcall-used-@var{reg}
17309 @opindex fcall-used
17310 Treat the register named @var{reg} as an allocable register that is
17311 clobbered by function calls.  It may be allocated for temporaries or
17312 variables that do not live across a call.  Functions compiled this way
17313 will not save and restore the register @var{reg}.
17315 It is an error to used this flag with the frame pointer or stack pointer.
17316 Use of this flag for other registers that have fixed pervasive roles in
17317 the machine's execution model will produce disastrous results.
17319 This flag does not have a negative form, because it specifies a
17320 three-way choice.
17322 @item -fcall-saved-@var{reg}
17323 @opindex fcall-saved
17324 Treat the register named @var{reg} as an allocable register saved by
17325 functions.  It may be allocated even for temporaries or variables that
17326 live across a call.  Functions compiled this way will save and restore
17327 the register @var{reg} if they use it.
17329 It is an error to used this flag with the frame pointer or stack pointer.
17330 Use of this flag for other registers that have fixed pervasive roles in
17331 the machine's execution model will produce disastrous results.
17333 A different sort of disaster will result from the use of this flag for
17334 a register in which function values may be returned.
17336 This flag does not have a negative form, because it specifies a
17337 three-way choice.
17339 @item -fpack-struct[=@var{n}]
17340 @opindex fpack-struct
17341 Without a value specified, pack all structure members together without
17342 holes.  When a value is specified (which must be a small power of two), pack
17343 structure members according to this value, representing the maximum
17344 alignment (that is, objects with default alignment requirements larger than
17345 this will be output potentially unaligned at the next fitting location.
17347 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
17348 code that is not binary compatible with code generated without that switch.
17349 Additionally, it makes the code suboptimal.
17350 Use it to conform to a non-default application binary interface.
17352 @item -finstrument-functions
17353 @opindex finstrument-functions
17354 Generate instrumentation calls for entry and exit to functions.  Just
17355 after function entry and just before function exit, the following
17356 profiling functions will be called with the address of the current
17357 function and its call site.  (On some platforms,
17358 @code{__builtin_return_address} does not work beyond the current
17359 function, so the call site information may not be available to the
17360 profiling functions otherwise.)
17362 @smallexample
17363 void __cyg_profile_func_enter (void *this_fn,
17364                                void *call_site);
17365 void __cyg_profile_func_exit  (void *this_fn,
17366                                void *call_site);
17367 @end smallexample
17369 The first argument is the address of the start of the current function,
17370 which may be looked up exactly in the symbol table.
17372 This instrumentation is also done for functions expanded inline in other
17373 functions.  The profiling calls will indicate where, conceptually, the
17374 inline function is entered and exited.  This means that addressable
17375 versions of such functions must be available.  If all your uses of a
17376 function are expanded inline, this may mean an additional expansion of
17377 code size.  If you use @samp{extern inline} in your C code, an
17378 addressable version of such functions must be provided.  (This is
17379 normally the case anyways, but if you get lucky and the optimizer always
17380 expands the functions inline, you might have gotten away without
17381 providing static copies.)
17383 A function may be given the attribute @code{no_instrument_function}, in
17384 which case this instrumentation will not be done.  This can be used, for
17385 example, for the profiling functions listed above, high-priority
17386 interrupt routines, and any functions from which the profiling functions
17387 cannot safely be called (perhaps signal handlers, if the profiling
17388 routines generate output or allocate memory).
17390 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
17391 @opindex finstrument-functions-exclude-file-list
17393 Set the list of functions that are excluded from instrumentation (see
17394 the description of @code{-finstrument-functions}).  If the file that
17395 contains a function definition matches with one of @var{file}, then
17396 that function is not instrumented.  The match is done on substrings:
17397 if the @var{file} parameter is a substring of the file name, it is
17398 considered to be a match.
17400 For example,
17401 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
17402 will exclude any inline function defined in files whose pathnames
17403 contain @code{/bits/stl} or @code{include/sys}.
17405 If, for some reason, you want to include letter @code{','} in one of
17406 @var{sym}, write @code{'\,'}. For example,
17407 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
17408 (note the single quote surrounding the option).
17410 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
17411 @opindex finstrument-functions-exclude-function-list
17413 This is similar to @code{-finstrument-functions-exclude-file-list},
17414 but this option sets the list of function names to be excluded from
17415 instrumentation.  The function name to be matched is its user-visible
17416 name, such as @code{vector<int> blah(const vector<int> &)}, not the
17417 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
17418 match is done on substrings: if the @var{sym} parameter is a substring
17419 of the function name, it is considered to be a match.  For C99 and C++
17420 extended identifiers, the function name must be given in UTF-8, not
17421 using universal character names.
17423 @item -fstack-check
17424 @opindex fstack-check
17425 Generate code to verify that you do not go beyond the boundary of the
17426 stack.  You should specify this flag if you are running in an
17427 environment with multiple threads, but only rarely need to specify it in
17428 a single-threaded environment since stack overflow is automatically
17429 detected on nearly all systems if there is only one stack.
17431 Note that this switch does not actually cause checking to be done; the
17432 operating system or the language runtime must do that.  The switch causes
17433 generation of code to ensure that they see the stack being extended.
17435 You can additionally specify a string parameter: @code{no} means no
17436 checking, @code{generic} means force the use of old-style checking,
17437 @code{specific} means use the best checking method and is equivalent
17438 to bare @option{-fstack-check}.
17440 Old-style checking is a generic mechanism that requires no specific
17441 target support in the compiler but comes with the following drawbacks:
17443 @enumerate
17444 @item
17445 Modified allocation strategy for large objects: they will always be
17446 allocated dynamically if their size exceeds a fixed threshold.
17448 @item
17449 Fixed limit on the size of the static frame of functions: when it is
17450 topped by a particular function, stack checking is not reliable and
17451 a warning is issued by the compiler.
17453 @item
17454 Inefficiency: because of both the modified allocation strategy and the
17455 generic implementation, the performances of the code are hampered.
17456 @end enumerate
17458 Note that old-style stack checking is also the fallback method for
17459 @code{specific} if no target support has been added in the compiler.
17461 @item -fstack-limit-register=@var{reg}
17462 @itemx -fstack-limit-symbol=@var{sym}
17463 @itemx -fno-stack-limit
17464 @opindex fstack-limit-register
17465 @opindex fstack-limit-symbol
17466 @opindex fno-stack-limit
17467 Generate code to ensure that the stack does not grow beyond a certain value,
17468 either the value of a register or the address of a symbol.  If the stack
17469 would grow beyond the value, a signal is raised.  For most targets,
17470 the signal is raised before the stack overruns the boundary, so
17471 it is possible to catch the signal without taking special precautions.
17473 For instance, if the stack starts at absolute address @samp{0x80000000}
17474 and grows downwards, you can use the flags
17475 @option{-fstack-limit-symbol=__stack_limit} and
17476 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
17477 of 128KB@.  Note that this may only work with the GNU linker.
17479 @item -fleading-underscore
17480 @opindex fleading-underscore
17481 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
17482 change the way C symbols are represented in the object file.  One use
17483 is to help link with legacy assembly code.
17485 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
17486 generate code that is not binary compatible with code generated without that
17487 switch.  Use it to conform to a non-default application binary interface.
17488 Not all targets provide complete support for this switch.
17490 @item -ftls-model=@var{model}
17491 @opindex ftls-model
17492 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
17493 The @var{model} argument should be one of @code{global-dynamic},
17494 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
17496 The default without @option{-fpic} is @code{initial-exec}; with
17497 @option{-fpic} the default is @code{global-dynamic}.
17499 @item -fvisibility=@var{default|internal|hidden|protected}
17500 @opindex fvisibility
17501 Set the default ELF image symbol visibility to the specified option---all
17502 symbols will be marked with this unless overridden within the code.
17503 Using this feature can very substantially improve linking and
17504 load times of shared object libraries, produce more optimized
17505 code, provide near-perfect API export and prevent symbol clashes.
17506 It is @strong{strongly} recommended that you use this in any shared objects
17507 you distribute.
17509 Despite the nomenclature, @code{default} always means public ie;
17510 available to be linked against from outside the shared object.
17511 @code{protected} and @code{internal} are pretty useless in real-world
17512 usage so the only other commonly used option will be @code{hidden}.
17513 The default if @option{-fvisibility} isn't specified is
17514 @code{default}, i.e., make every
17515 symbol public---this causes the same behavior as previous versions of
17516 GCC@.
17518 A good explanation of the benefits offered by ensuring ELF
17519 symbols have the correct visibility is given by ``How To Write
17520 Shared Libraries'' by Ulrich Drepper (which can be found at
17521 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
17522 solution made possible by this option to marking things hidden when
17523 the default is public is to make the default hidden and mark things
17524 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
17525 and @code{__attribute__ ((visibility("default")))} instead of
17526 @code{__declspec(dllexport)} you get almost identical semantics with
17527 identical syntax.  This is a great boon to those working with
17528 cross-platform projects.
17530 For those adding visibility support to existing code, you may find
17531 @samp{#pragma GCC visibility} of use.  This works by you enclosing
17532 the declarations you wish to set visibility for with (for example)
17533 @samp{#pragma GCC visibility push(hidden)} and
17534 @samp{#pragma GCC visibility pop}.
17535 Bear in mind that symbol visibility should be viewed @strong{as
17536 part of the API interface contract} and thus all new code should
17537 always specify visibility when it is not the default ie; declarations
17538 only for use within the local DSO should @strong{always} be marked explicitly
17539 as hidden as so to avoid PLT indirection overheads---making this
17540 abundantly clear also aids readability and self-documentation of the code.
17541 Note that due to ISO C++ specification requirements, operator new and
17542 operator delete must always be of default visibility.
17544 Be aware that headers from outside your project, in particular system
17545 headers and headers from any other library you use, may not be
17546 expecting to be compiled with visibility other than the default.  You
17547 may need to explicitly say @samp{#pragma GCC visibility push(default)}
17548 before including any such headers.
17550 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
17551 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
17552 no modifications.  However, this means that calls to @samp{extern}
17553 functions with no explicit visibility will use the PLT, so it is more
17554 effective to use @samp{__attribute ((visibility))} and/or
17555 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
17556 declarations should be treated as hidden.
17558 Note that @samp{-fvisibility} does affect C++ vague linkage
17559 entities. This means that, for instance, an exception class that will
17560 be thrown between DSOs must be explicitly marked with default
17561 visibility so that the @samp{type_info} nodes will be unified between
17562 the DSOs.
17564 An overview of these techniques, their benefits and how to use them
17565 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
17567 @end table
17569 @c man end
17571 @node Environment Variables
17572 @section Environment Variables Affecting GCC
17573 @cindex environment variables
17575 @c man begin ENVIRONMENT
17576 This section describes several environment variables that affect how GCC
17577 operates.  Some of them work by specifying directories or prefixes to use
17578 when searching for various kinds of files.  Some are used to specify other
17579 aspects of the compilation environment.
17581 Note that you can also specify places to search using options such as
17582 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
17583 take precedence over places specified using environment variables, which
17584 in turn take precedence over those specified by the configuration of GCC@.
17585 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
17586 GNU Compiler Collection (GCC) Internals}.
17588 @table @env
17589 @item LANG
17590 @itemx LC_CTYPE
17591 @c @itemx LC_COLLATE
17592 @itemx LC_MESSAGES
17593 @c @itemx LC_MONETARY
17594 @c @itemx LC_NUMERIC
17595 @c @itemx LC_TIME
17596 @itemx LC_ALL
17597 @findex LANG
17598 @findex LC_CTYPE
17599 @c @findex LC_COLLATE
17600 @findex LC_MESSAGES
17601 @c @findex LC_MONETARY
17602 @c @findex LC_NUMERIC
17603 @c @findex LC_TIME
17604 @findex LC_ALL
17605 @cindex locale
17606 These environment variables control the way that GCC uses
17607 localization information that allow GCC to work with different
17608 national conventions.  GCC inspects the locale categories
17609 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
17610 so.  These locale categories can be set to any value supported by your
17611 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
17612 Kingdom encoded in UTF-8.
17614 The @env{LC_CTYPE} environment variable specifies character
17615 classification.  GCC uses it to determine the character boundaries in
17616 a string; this is needed for some multibyte encodings that contain quote
17617 and escape characters that would otherwise be interpreted as a string
17618 end or escape.
17620 The @env{LC_MESSAGES} environment variable specifies the language to
17621 use in diagnostic messages.
17623 If the @env{LC_ALL} environment variable is set, it overrides the value
17624 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
17625 and @env{LC_MESSAGES} default to the value of the @env{LANG}
17626 environment variable.  If none of these variables are set, GCC
17627 defaults to traditional C English behavior.
17629 @item TMPDIR
17630 @findex TMPDIR
17631 If @env{TMPDIR} is set, it specifies the directory to use for temporary
17632 files.  GCC uses temporary files to hold the output of one stage of
17633 compilation which is to be used as input to the next stage: for example,
17634 the output of the preprocessor, which is the input to the compiler
17635 proper.
17637 @item GCC_EXEC_PREFIX
17638 @findex GCC_EXEC_PREFIX
17639 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
17640 names of the subprograms executed by the compiler.  No slash is added
17641 when this prefix is combined with the name of a subprogram, but you can
17642 specify a prefix that ends with a slash if you wish.
17644 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
17645 an appropriate prefix to use based on the pathname it was invoked with.
17647 If GCC cannot find the subprogram using the specified prefix, it
17648 tries looking in the usual places for the subprogram.
17650 The default value of @env{GCC_EXEC_PREFIX} is
17651 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
17652 the installed compiler. In many cases @var{prefix} is the value
17653 of @code{prefix} when you ran the @file{configure} script.
17655 Other prefixes specified with @option{-B} take precedence over this prefix.
17657 This prefix is also used for finding files such as @file{crt0.o} that are
17658 used for linking.
17660 In addition, the prefix is used in an unusual way in finding the
17661 directories to search for header files.  For each of the standard
17662 directories whose name normally begins with @samp{/usr/local/lib/gcc}
17663 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
17664 replacing that beginning with the specified prefix to produce an
17665 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
17666 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
17667 These alternate directories are searched first; the standard directories
17668 come next. If a standard directory begins with the configured
17669 @var{prefix} then the value of @var{prefix} is replaced by
17670 @env{GCC_EXEC_PREFIX} when looking for header files.
17672 @item COMPILER_PATH
17673 @findex COMPILER_PATH
17674 The value of @env{COMPILER_PATH} is a colon-separated list of
17675 directories, much like @env{PATH}.  GCC tries the directories thus
17676 specified when searching for subprograms, if it can't find the
17677 subprograms using @env{GCC_EXEC_PREFIX}.
17679 @item LIBRARY_PATH
17680 @findex LIBRARY_PATH
17681 The value of @env{LIBRARY_PATH} is a colon-separated list of
17682 directories, much like @env{PATH}.  When configured as a native compiler,
17683 GCC tries the directories thus specified when searching for special
17684 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
17685 using GCC also uses these directories when searching for ordinary
17686 libraries for the @option{-l} option (but directories specified with
17687 @option{-L} come first).
17689 @item LANG
17690 @findex LANG
17691 @cindex locale definition
17692 This variable is used to pass locale information to the compiler.  One way in
17693 which this information is used is to determine the character set to be used
17694 when character literals, string literals and comments are parsed in C and C++.
17695 When the compiler is configured to allow multibyte characters,
17696 the following values for @env{LANG} are recognized:
17698 @table @samp
17699 @item C-JIS
17700 Recognize JIS characters.
17701 @item C-SJIS
17702 Recognize SJIS characters.
17703 @item C-EUCJP
17704 Recognize EUCJP characters.
17705 @end table
17707 If @env{LANG} is not defined, or if it has some other value, then the
17708 compiler will use mblen and mbtowc as defined by the default locale to
17709 recognize and translate multibyte characters.
17710 @end table
17712 @noindent
17713 Some additional environments variables affect the behavior of the
17714 preprocessor.
17716 @include cppenv.texi
17718 @c man end
17720 @node Precompiled Headers
17721 @section Using Precompiled Headers
17722 @cindex precompiled headers
17723 @cindex speed of compilation
17725 Often large projects have many header files that are included in every
17726 source file.  The time the compiler takes to process these header files
17727 over and over again can account for nearly all of the time required to
17728 build the project.  To make builds faster, GCC allows users to
17729 `precompile' a header file; then, if builds can use the precompiled
17730 header file they will be much faster.
17732 To create a precompiled header file, simply compile it as you would any
17733 other file, if necessary using the @option{-x} option to make the driver
17734 treat it as a C or C++ header file.  You will probably want to use a
17735 tool like @command{make} to keep the precompiled header up-to-date when
17736 the headers it contains change.
17738 A precompiled header file will be searched for when @code{#include} is
17739 seen in the compilation.  As it searches for the included file
17740 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
17741 compiler looks for a precompiled header in each directory just before it
17742 looks for the include file in that directory.  The name searched for is
17743 the name specified in the @code{#include} with @samp{.gch} appended.  If
17744 the precompiled header file can't be used, it is ignored.
17746 For instance, if you have @code{#include "all.h"}, and you have
17747 @file{all.h.gch} in the same directory as @file{all.h}, then the
17748 precompiled header file will be used if possible, and the original
17749 header will be used otherwise.
17751 Alternatively, you might decide to put the precompiled header file in a
17752 directory and use @option{-I} to ensure that directory is searched
17753 before (or instead of) the directory containing the original header.
17754 Then, if you want to check that the precompiled header file is always
17755 used, you can put a file of the same name as the original header in this
17756 directory containing an @code{#error} command.
17758 This also works with @option{-include}.  So yet another way to use
17759 precompiled headers, good for projects not designed with precompiled
17760 header files in mind, is to simply take most of the header files used by
17761 a project, include them from another header file, precompile that header
17762 file, and @option{-include} the precompiled header.  If the header files
17763 have guards against multiple inclusion, they will be skipped because
17764 they've already been included (in the precompiled header).
17766 If you need to precompile the same header file for different
17767 languages, targets, or compiler options, you can instead make a
17768 @emph{directory} named like @file{all.h.gch}, and put each precompiled
17769 header in the directory, perhaps using @option{-o}.  It doesn't matter
17770 what you call the files in the directory, every precompiled header in
17771 the directory will be considered.  The first precompiled header
17772 encountered in the directory that is valid for this compilation will
17773 be used; they're searched in no particular order.
17775 There are many other possibilities, limited only by your imagination,
17776 good sense, and the constraints of your build system.
17778 A precompiled header file can be used only when these conditions apply:
17780 @itemize
17781 @item
17782 Only one precompiled header can be used in a particular compilation.
17784 @item
17785 A precompiled header can't be used once the first C token is seen.  You
17786 can have preprocessor directives before a precompiled header; you can
17787 even include a precompiled header from inside another header, so long as
17788 there are no C tokens before the @code{#include}.
17790 @item
17791 The precompiled header file must be produced for the same language as
17792 the current compilation.  You can't use a C precompiled header for a C++
17793 compilation.
17795 @item
17796 The precompiled header file must have been produced by the same compiler
17797 binary as the current compilation is using.
17799 @item
17800 Any macros defined before the precompiled header is included must
17801 either be defined in the same way as when the precompiled header was
17802 generated, or must not affect the precompiled header, which usually
17803 means that they don't appear in the precompiled header at all.
17805 The @option{-D} option is one way to define a macro before a
17806 precompiled header is included; using a @code{#define} can also do it.
17807 There are also some options that define macros implicitly, like
17808 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
17809 defined this way.
17811 @item If debugging information is output when using the precompiled
17812 header, using @option{-g} or similar, the same kind of debugging information
17813 must have been output when building the precompiled header.  However,
17814 a precompiled header built using @option{-g} can be used in a compilation
17815 when no debugging information is being output.
17817 @item The same @option{-m} options must generally be used when building
17818 and using the precompiled header.  @xref{Submodel Options},
17819 for any cases where this rule is relaxed.
17821 @item Each of the following options must be the same when building and using
17822 the precompiled header:
17824 @gccoptlist{-fexceptions}
17826 @item
17827 Some other command-line options starting with @option{-f},
17828 @option{-p}, or @option{-O} must be defined in the same way as when
17829 the precompiled header was generated.  At present, it's not clear
17830 which options are safe to change and which are not; the safest choice
17831 is to use exactly the same options when generating and using the
17832 precompiled header.  The following are known to be safe:
17834 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
17835 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
17836 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
17837 -pedantic-errors}
17839 @end itemize
17841 For all of these except the last, the compiler will automatically
17842 ignore the precompiled header if the conditions aren't met.  If you
17843 find an option combination that doesn't work and doesn't cause the
17844 precompiled header to be ignored, please consider filing a bug report,
17845 see @ref{Bugs}.
17847 If you do use differing options when generating and using the
17848 precompiled header, the actual behavior will be a mixture of the
17849 behavior for the options.  For instance, if you use @option{-g} to
17850 generate the precompiled header but not when using it, you may or may
17851 not get debugging information for routines in the precompiled header.