Merge from mainline (160224:163495).
[official-gcc/graphite-test-results.git] / gcc / doc / invoke.texi
blob47e4db389ec0f342b3388ec96af2b0372b552a73
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.3 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}  @gol
168 -fdump-ada-spec@r{[}-slim@r{]}}
170 @item C Language Options
171 @xref{C Dialect Options,,Options Controlling C Dialect}.
172 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
173 -aux-info @var{filename} @gol
174 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
175 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
176 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
177 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
178 -fsigned-bitfields  -fsigned-char @gol
179 -funsigned-bitfields  -funsigned-char}
181 @item C++ Language Options
182 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
183 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
184 -fconserve-space  -ffriend-injection @gol
185 -fno-elide-constructors @gol
186 -fno-enforce-eh-specs @gol
187 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
188 -fno-implicit-templates @gol
189 -fno-implicit-inline-templates @gol
190 -fno-implement-inlines  -fms-extensions @gol
191 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
192 -fno-optional-diags  -fpermissive @gol
193 -fno-pretty-templates @gol
194 -frepo  -fno-rtti  -fstats  -ftemplate-depth=@var{n} @gol
195 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
196 -fno-default-inline  -fvisibility-inlines-hidden @gol
197 -fvisibility-ms-compat @gol
198 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
199 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
200 -Weffc++  -Wstrict-null-sentinel @gol
201 -Wno-non-template-friend  -Wold-style-cast @gol
202 -Woverloaded-virtual  -Wno-pmf-conversions @gol
203 -Wsign-promo}
205 @item Objective-C and Objective-C++ Language Options
206 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
207 Objective-C and Objective-C++ Dialects}.
208 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
209 -fgnu-runtime  -fnext-runtime @gol
210 -fno-nil-receivers @gol
211 -fobjc-call-cxx-cdtors @gol
212 -fobjc-direct-dispatch @gol
213 -fobjc-exceptions @gol
214 -fobjc-gc @gol
215 -freplace-objc-classes @gol
216 -fzero-link @gol
217 -gen-decls @gol
218 -Wassign-intercept @gol
219 -Wno-protocol  -Wselector @gol
220 -Wstrict-selector-match @gol
221 -Wundeclared-selector}
223 @item Language Independent Options
224 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
225 @gccoptlist{-fmessage-length=@var{n}  @gol
226 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
227 -fdiagnostics-show-option}
229 @item Warning Options
230 @xref{Warning Options,,Options to Request or Suppress Warnings}.
231 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
232 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
233 -Wno-attributes -Wno-builtin-macro-redefined @gol
234 -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
235 -Wchar-subscripts -Wclobbered  -Wcomment @gol
236 -Wconversion  -Wcoverage-mismatch  -Wcpp  -Wno-deprecated  @gol
237 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
238 -Wno-div-by-zero -Wempty-body  -Wenum-compare -Wno-endif-labels @gol
239 -Werror  -Werror=* @gol
240 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
241 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
242 -Wformat-security  -Wformat-y2k @gol
243 -Wframe-larger-than=@var{len} -Wjump-misses-init -Wignored-qualifiers @gol
244 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
245 -Winit-self  -Winline @gol
246 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
247 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
248 -Wlogical-op -Wlong-long @gol
249 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
250 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
251 -Wno-mudflap @gol
252 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
253 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
254 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
255 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
256 -Wredundant-decls @gol
257 -Wreturn-type  -Wsequence-point  -Wshadow @gol
258 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
259 -Wstrict-aliasing -Wstrict-aliasing=n @gol
260 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
261 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]} @gol
262 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
263 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
264 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
265 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
266 -Wunused-label  -Wunused-parameter -Wno-unused-result -Wunused-value  -Wunused-variable @gol
267 -Wunused-but-set-parameter -Wunused-but-set-variable -Wvariadic-macros -Wvla @gol
268 -Wvolatile-register-var  -Wwrite-strings}
270 @item C and Objective-C-only Warning Options
271 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
272 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
273 -Wold-style-declaration  -Wold-style-definition @gol
274 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
275 -Wdeclaration-after-statement -Wpointer-sign}
277 @item Debugging Options
278 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
279 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
280 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
281 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
282 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
283 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
284 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
285 -fdump-statistics @gol
286 -fdump-tree-all @gol
287 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
288 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
289 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
290 -fdump-tree-ch @gol
291 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
299 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
300 -fdump-tree-nrv -fdump-tree-vect @gol
301 -fdump-tree-sink @gol
302 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
303 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
304 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
305 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
306 -ftree-vectorizer-verbose=@var{n} @gol
307 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
308 -fdump-final-insns=@var{file} @gol
309 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
310 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
311 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
312 -fenable-icf-debug @gol
313 -fgraphite-read -fgraphite-write @gol
314 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
315 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
316 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
317 -ftest-coverage  -ftime-report -fvar-tracking @gol
318 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
319 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
320 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
321 -gvms  -gxcoff  -gxcoff+ @gol
322 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
323 -fdebug-prefix-map=@var{old}=@var{new} @gol
324 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
325 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
326 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
327 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
328 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
329 -print-sysroot -print-sysroot-headers-suffix @gol
330 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
332 @item Optimization Options
333 @xref{Optimize Options,,Options that Control Optimization}.
334 @gccoptlist{
335 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
336 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
337 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
338 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
339 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
340 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
341 -fdata-sections -fdce -fdce @gol
342 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
343 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
344 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
345 -fforward-propagate -ffunction-sections @gol
346 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
347 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
348 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
349 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol
350 -fipa-profile -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
351 -fira-algorithm=@var{algorithm} @gol
352 -fira-region=@var{region} -fira-coalesce @gol
353 -fira-loop-pressure -fno-ira-share-save-slots @gol
354 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
355 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
356 -floop-block -floop-interchange -floop-strip-mine @gol
357 -floop-parallelize-all -flto -flto-compression-level -flto-report -fltrans @gol
358 -fltrans-output-list -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
359 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
360 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
361 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
362 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
363 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
364 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
365 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
366 -fpartial-inlining -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
367 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
368 -fprofile-generate=@var{path} @gol
369 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
370 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
371 -freorder-blocks-and-partition -freorder-functions @gol
372 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
373 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
374 -fsched-spec-load -fsched-spec-load-dangerous @gol
375 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
376 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
377 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
378 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
379 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
380 -fselective-scheduling -fselective-scheduling2 @gol
381 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
382 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
383 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
384 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
385 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
386 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
387 -ftree-forwprop -ftree-fre -ftree-loop-if-convert -ftree-loop-im @gol
388 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
389 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
390 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
391 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
392 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
393 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
394 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
395 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
396 -fwhole-program -fwhopr[=@var{n}] -fwpa -fuse-linker-plugin @gol
397 --param @var{name}=@var{value}
398 -O  -O0  -O1  -O2  -O3  -Os -Ofast}
400 @item Preprocessor Options
401 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
402 @gccoptlist{-A@var{question}=@var{answer} @gol
403 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
404 -C  -dD  -dI  -dM  -dN @gol
405 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
406 -idirafter @var{dir} @gol
407 -include @var{file}  -imacros @var{file} @gol
408 -iprefix @var{file}  -iwithprefix @var{dir} @gol
409 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
410 -imultilib @var{dir} -isysroot @var{dir} @gol
411 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
412 -P  -fworking-directory  -remap @gol
413 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
414 -Xpreprocessor @var{option}}
416 @item Assembler Option
417 @xref{Assembler Options,,Passing Options to the Assembler}.
418 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
420 @item Linker Options
421 @xref{Link Options,,Options for Linking}.
422 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
423 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
424 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
425 -shared-libgcc  -symbolic @gol
426 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
427 -u @var{symbol}}
429 @item Directory Options
430 @xref{Directory Options,,Options for Directory Search}.
431 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir}}
432 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I-
433 --sysroot=@var{dir}
435 @item Machine Dependent Options
436 @xref{Submodel Options,,Hardware Models and Configurations}.
437 @c This list is ordered alphanumerically by subsection name.
438 @c Try and put the significant identifier (CPU or system) first,
439 @c so users have a clue at guessing where the ones they want will be.
441 @emph{ARC Options}
442 @gccoptlist{-EB  -EL @gol
443 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
444 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
446 @emph{ARM Options}
447 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
448 -mabi=@var{name} @gol
449 -mapcs-stack-check  -mno-apcs-stack-check @gol
450 -mapcs-float  -mno-apcs-float @gol
451 -mapcs-reentrant  -mno-apcs-reentrant @gol
452 -msched-prolog  -mno-sched-prolog @gol
453 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
454 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
455 -mfp16-format=@var{name}
456 -mthumb-interwork  -mno-thumb-interwork @gol
457 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
458 -mstructure-size-boundary=@var{n} @gol
459 -mabort-on-noreturn @gol
460 -mlong-calls  -mno-long-calls @gol
461 -msingle-pic-base  -mno-single-pic-base @gol
462 -mpic-register=@var{reg} @gol
463 -mnop-fun-dllimport @gol
464 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
465 -mpoke-function-name @gol
466 -mthumb  -marm @gol
467 -mtpcs-frame  -mtpcs-leaf-frame @gol
468 -mcaller-super-interworking  -mcallee-super-interworking @gol
469 -mtp=@var{name} @gol
470 -mword-relocations @gol
471 -mfix-cortex-m3-ldrd}
473 @emph{AVR Options}
474 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
475 -mcall-prologues  -mtiny-stack  -mint8}
477 @emph{Blackfin Options}
478 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
479 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
480 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
481 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
482 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
483 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
484 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
485 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
486 -micplb}
488 @emph{CRIS Options}
489 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
490 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
491 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
492 -mstack-align  -mdata-align  -mconst-align @gol
493 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
494 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
495 -mmul-bug-workaround  -mno-mul-bug-workaround}
497 @emph{CRX Options}
498 @gccoptlist{-mmac -mpush-args}
500 @emph{Darwin Options}
501 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
502 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
503 -client_name  -compatibility_version  -current_version @gol
504 -dead_strip @gol
505 -dependency-file  -dylib_file  -dylinker_install_name @gol
506 -dynamic  -dynamiclib  -exported_symbols_list @gol
507 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
508 -force_flat_namespace  -headerpad_max_install_names @gol
509 -iframework @gol
510 -image_base  -init  -install_name  -keep_private_externs @gol
511 -multi_module  -multiply_defined  -multiply_defined_unused @gol
512 -noall_load   -no_dead_strip_inits_and_terms @gol
513 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
514 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
515 -private_bundle  -read_only_relocs  -sectalign @gol
516 -sectobjectsymbols  -whyload  -seg1addr @gol
517 -sectcreate  -sectobjectsymbols  -sectorder @gol
518 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
519 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
520 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
521 -single_module  -static  -sub_library  -sub_umbrella @gol
522 -twolevel_namespace  -umbrella  -undefined @gol
523 -unexported_symbols_list  -weak_reference_mismatches @gol
524 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
525 -mkernel -mone-byte-bool}
527 @emph{DEC Alpha Options}
528 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
529 -mieee  -mieee-with-inexact  -mieee-conformant @gol
530 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
531 -mtrap-precision=@var{mode}  -mbuild-constants @gol
532 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
533 -mbwx  -mmax  -mfix  -mcix @gol
534 -mfloat-vax  -mfloat-ieee @gol
535 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
536 -msmall-text  -mlarge-text @gol
537 -mmemory-latency=@var{time}}
539 @emph{DEC Alpha/VMS Options}
540 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
542 @emph{FR30 Options}
543 @gccoptlist{-msmall-model -mno-lsim}
545 @emph{FRV Options}
546 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
547 -mhard-float  -msoft-float @gol
548 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
549 -mdouble  -mno-double @gol
550 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
551 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
552 -mlinked-fp  -mlong-calls  -malign-labels @gol
553 -mlibrary-pic  -macc-4  -macc-8 @gol
554 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
555 -moptimize-membar -mno-optimize-membar @gol
556 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
557 -mvliw-branch  -mno-vliw-branch @gol
558 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
559 -mno-nested-cond-exec  -mtomcat-stats @gol
560 -mTLS -mtls @gol
561 -mcpu=@var{cpu}}
563 @emph{GNU/Linux Options}
564 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
565 -tno-android-cc -tno-android-ld}
567 @emph{H8/300 Options}
568 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
570 @emph{HPPA Options}
571 @gccoptlist{-march=@var{architecture-type} @gol
572 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
573 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
574 -mfixed-range=@var{register-range} @gol
575 -mjump-in-delay -mlinker-opt -mlong-calls @gol
576 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
577 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
578 -mno-jump-in-delay  -mno-long-load-store @gol
579 -mno-portable-runtime  -mno-soft-float @gol
580 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
581 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
582 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
583 -munix=@var{unix-std}  -nolibdld  -static  -threads}
585 @emph{i386 and x86-64 Options}
586 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
587 -mfpmath=@var{unit} @gol
588 -masm=@var{dialect}  -mno-fancy-math-387 @gol
589 -mno-fp-ret-in-387  -msoft-float @gol
590 -mno-wide-multiply  -mrtd  -malign-double @gol
591 -mpreferred-stack-boundary=@var{num}
592 -mincoming-stack-boundary=@var{num}
593 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
594 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
595 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfused-madd @gol
596 -msse4a -m3dnow -mpopcnt -mabm -mfma4 -mxop -mlwp @gol
597 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
598 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
599 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
600 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
601 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
602 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
603 -mcmodel=@var{code-model} -mabi=@var{name} @gol
604 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
605 -msse2avx -mfentry}
607 @emph{IA-64 Options}
608 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
609 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
610 -mconstant-gp  -mauto-pic  -mfused-madd @gol
611 -minline-float-divide-min-latency @gol
612 -minline-float-divide-max-throughput @gol
613 -mno-inline-float-divide @gol
614 -minline-int-divide-min-latency @gol
615 -minline-int-divide-max-throughput  @gol
616 -mno-inline-int-divide @gol
617 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
618 -mno-inline-sqrt @gol
619 -mdwarf2-asm -mearly-stop-bits @gol
620 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
621 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
622 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
623 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
624 -msched-spec-ldc -msched-spec-control-ldc @gol
625 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
626 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
627 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
628 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
630 @emph{IA-64/VMS Options}
631 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
633 @emph{LM32 Options}
634 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
635 -msign-extend-enabled -muser-enabled}
637 @emph{M32R/D Options}
638 @gccoptlist{-m32r2 -m32rx -m32r @gol
639 -mdebug @gol
640 -malign-loops -mno-align-loops @gol
641 -missue-rate=@var{number} @gol
642 -mbranch-cost=@var{number} @gol
643 -mmodel=@var{code-size-model-type} @gol
644 -msdata=@var{sdata-type} @gol
645 -mno-flush-func -mflush-func=@var{name} @gol
646 -mno-flush-trap -mflush-trap=@var{number} @gol
647 -G @var{num}}
649 @emph{M32C Options}
650 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
652 @emph{M680x0 Options}
653 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
654 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
655 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
656 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
657 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
658 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
659 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
660 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
661 -mxgot -mno-xgot}
663 @emph{M68hc1x Options}
664 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
665 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
666 -msoft-reg-count=@var{count}}
668 @emph{MCore Options}
669 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
670 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
671 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
672 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
673 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
675 @emph{MeP Options}
676 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
677 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
678 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
679 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
680 -mtiny=@var{n}}
682 @emph{MIPS Options}
683 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
684 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
685 -mips64  -mips64r2 @gol
686 -mips16  -mno-mips16  -mflip-mips16 @gol
687 -minterlink-mips16  -mno-interlink-mips16 @gol
688 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
689 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
690 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
691 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
692 -mfpu=@var{fpu-type} @gol
693 -msmartmips  -mno-smartmips @gol
694 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
695 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
696 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
697 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
698 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
699 -membedded-data  -mno-embedded-data @gol
700 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
701 -mcode-readable=@var{setting} @gol
702 -msplit-addresses  -mno-split-addresses @gol
703 -mexplicit-relocs  -mno-explicit-relocs @gol
704 -mcheck-zero-division  -mno-check-zero-division @gol
705 -mdivide-traps  -mdivide-breaks @gol
706 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
707 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
708 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
709 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
710 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
711 -mflush-func=@var{func}  -mno-flush-func @gol
712 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
713 -mfp-exceptions -mno-fp-exceptions @gol
714 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
715 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
717 @emph{MMIX Options}
718 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
719 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
720 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
721 -mno-base-addresses  -msingle-exit  -mno-single-exit}
723 @emph{MN10300 Options}
724 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
725 -mam33  -mno-am33 @gol
726 -mam33-2  -mno-am33-2 @gol
727 -mreturn-pointer-on-d0 @gol
728 -mno-crt0  -mrelax}
730 @emph{PDP-11 Options}
731 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
732 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
733 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
734 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
735 -mbranch-expensive  -mbranch-cheap @gol
736 -msplit  -mno-split  -munix-asm  -mdec-asm}
738 @emph{picoChip Options}
739 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
740 -msymbol-as-address -mno-inefficient-warnings}
742 @emph{PowerPC Options}
743 See RS/6000 and PowerPC Options.
745 @emph{RS/6000 and PowerPC Options}
746 @gccoptlist{-mcpu=@var{cpu-type} @gol
747 -mtune=@var{cpu-type} @gol
748 -mcmodel=@var{code-model} @gol
749 -mpower  -mno-power  -mpower2  -mno-power2 @gol
750 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
751 -maltivec  -mno-altivec @gol
752 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
753 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
754 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
755 -mfprnd  -mno-fprnd @gol
756 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
757 -mnew-mnemonics  -mold-mnemonics @gol
758 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
759 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
760 -malign-power  -malign-natural @gol
761 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
762 -msingle-float -mdouble-float -msimple-fpu @gol
763 -mstring  -mno-string  -mupdate  -mno-update @gol
764 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
765 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
766 -mstrict-align  -mno-strict-align  -mrelocatable @gol
767 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
768 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
769 -mdynamic-no-pic  -maltivec -mswdiv @gol
770 -mprioritize-restricted-insns=@var{priority} @gol
771 -msched-costly-dep=@var{dependence_type} @gol
772 -minsert-sched-nops=@var{scheme} @gol
773 -mcall-sysv  -mcall-netbsd @gol
774 -maix-struct-return  -msvr4-struct-return @gol
775 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
776 -mblock-move-inline-limit=@var{num} @gol
777 -misel -mno-isel @gol
778 -misel=yes  -misel=no @gol
779 -mspe -mno-spe @gol
780 -mspe=yes  -mspe=no @gol
781 -mpaired @gol
782 -mgen-cell-microcode -mwarn-cell-microcode @gol
783 -mvrsave -mno-vrsave @gol
784 -mmulhw -mno-mulhw @gol
785 -mdlmzb -mno-dlmzb @gol
786 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
787 -mprototype  -mno-prototype @gol
788 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
789 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
790 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision
791 -mno-recip-precision @gol
792 -mveclibabi=@var{type}}
794 @emph{RX Options}
795 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
796 -mcpu=@gol
797 -mbig-endian-data -mlittle-endian-data @gol
798 -msmall-data @gol
799 -msim  -mno-sim@gol
800 -mas100-syntax -mno-as100-syntax@gol
801 -mrelax@gol
802 -mmax-constant-size=@gol
803 -mint-register=@gol
804 -msave-acc-in-interrupts}
806 @emph{S/390 and zSeries Options}
807 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
808 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
809 -mlong-double-64 -mlong-double-128 @gol
810 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
811 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
812 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
813 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
814 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
816 @emph{Score Options}
817 @gccoptlist{-meb -mel @gol
818 -mnhwloop @gol
819 -muls @gol
820 -mmac @gol
821 -mscore5 -mscore5u -mscore7 -mscore7d}
823 @emph{SH Options}
824 @gccoptlist{-m1  -m2  -m2e @gol
825 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
826 -m3  -m3e @gol
827 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
828 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
829 -m5-64media  -m5-64media-nofpu @gol
830 -m5-32media  -m5-32media-nofpu @gol
831 -m5-compact  -m5-compact-nofpu @gol
832 -mb  -ml  -mdalign  -mrelax @gol
833 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
834 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
835 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
836 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
837 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
838 -maccumulate-outgoing-args -minvalid-symbols}
840 @emph{SPARC Options}
841 @gccoptlist{-mcpu=@var{cpu-type} @gol
842 -mtune=@var{cpu-type} @gol
843 -mcmodel=@var{code-model} @gol
844 -m32  -m64  -mapp-regs  -mno-app-regs @gol
845 -mfaster-structs  -mno-faster-structs @gol
846 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
847 -mhard-quad-float  -msoft-quad-float @gol
848 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
849 -mstack-bias  -mno-stack-bias @gol
850 -munaligned-doubles  -mno-unaligned-doubles @gol
851 -mv8plus  -mno-v8plus  -mvis  -mno-vis
852 -threads -pthreads -pthread}
854 @emph{SPU Options}
855 @gccoptlist{-mwarn-reloc -merror-reloc @gol
856 -msafe-dma -munsafe-dma @gol
857 -mbranch-hints @gol
858 -msmall-mem -mlarge-mem -mstdmain @gol
859 -mfixed-range=@var{register-range} @gol
860 -mea32 -mea64 @gol
861 -maddress-space-conversion -mno-address-space-conversion @gol
862 -mcache-size=@var{cache-size} @gol
863 -matomic-updates -mno-atomic-updates}
865 @emph{System V Options}
866 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
868 @emph{V850 Options}
869 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
870 -mprolog-function  -mno-prolog-function  -mspace @gol
871 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
872 -mapp-regs  -mno-app-regs @gol
873 -mdisable-callt  -mno-disable-callt @gol
874 -mv850e2v3 @gol
875 -mv850e2 @gol
876 -mv850e1 @gol
877 -mv850e @gol
878 -mv850  -mbig-switch}
880 @emph{VAX Options}
881 @gccoptlist{-mg  -mgnu  -munix}
883 @emph{VxWorks Options}
884 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
885 -Xbind-lazy  -Xbind-now}
887 @emph{x86-64 Options}
888 See i386 and x86-64 Options.
890 @emph{i386 and x86-64 Windows Options}
891 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
892 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows
893 -fno-set-stack-executable}
895 @emph{Xstormy16 Options}
896 @gccoptlist{-msim}
898 @emph{Xtensa Options}
899 @gccoptlist{-mconst16 -mno-const16 @gol
900 -mfused-madd  -mno-fused-madd @gol
901 -mforce-no-pic @gol
902 -mserialize-volatile  -mno-serialize-volatile @gol
903 -mtext-section-literals  -mno-text-section-literals @gol
904 -mtarget-align  -mno-target-align @gol
905 -mlongcalls  -mno-longcalls}
907 @emph{zSeries Options}
908 See S/390 and zSeries Options.
910 @item Code Generation Options
911 @xref{Code Gen Options,,Options for Code Generation Conventions}.
912 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
913 -ffixed-@var{reg}  -fexceptions @gol
914 -fnon-call-exceptions  -funwind-tables @gol
915 -fasynchronous-unwind-tables @gol
916 -finhibit-size-directive  -finstrument-functions @gol
917 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
918 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
919 -fno-common  -fno-ident @gol
920 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
921 -fno-jump-tables @gol
922 -frecord-gcc-switches @gol
923 -freg-struct-return  -fshort-enums @gol
924 -fshort-double  -fshort-wchar @gol
925 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
926 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
927 -fno-stack-limit @gol
928 -fleading-underscore  -ftls-model=@var{model} @gol
929 -ftrapv  -fwrapv  -fbounds-check @gol
930 -fvisibility}
931 @end table
933 @menu
934 * Overall Options::     Controlling the kind of output:
935                         an executable, object files, assembler files,
936                         or preprocessed source.
937 * C Dialect Options::   Controlling the variant of C language compiled.
938 * C++ Dialect Options:: Variations on C++.
939 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
940                         and Objective-C++.
941 * Language Independent Options:: Controlling how diagnostics should be
942                         formatted.
943 * Warning Options::     How picky should the compiler be?
944 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
945 * Optimize Options::    How much optimization?
946 * Preprocessor Options:: Controlling header files and macro definitions.
947                          Also, getting dependency information for Make.
948 * Assembler Options::   Passing options to the assembler.
949 * Link Options::        Specifying libraries and so on.
950 * Directory Options::   Where to find header files and libraries.
951                         Where to find the compiler executable files.
952 * Spec Files::          How to pass switches to sub-processes.
953 * Target Options::      Running a cross-compiler, or an old version of GCC.
954 @end menu
956 @node Overall Options
957 @section Options Controlling the Kind of Output
959 Compilation can involve up to four stages: preprocessing, compilation
960 proper, assembly and linking, always in that order.  GCC is capable of
961 preprocessing and compiling several files either into several
962 assembler input files, or into one assembler input file; then each
963 assembler input file produces an object file, and linking combines all
964 the object files (those newly compiled, and those specified as input)
965 into an executable file.
967 @cindex file name suffix
968 For any given input file, the file name suffix determines what kind of
969 compilation is done:
971 @table @gcctabopt
972 @item @var{file}.c
973 C source code which must be preprocessed.
975 @item @var{file}.i
976 C source code which should not be preprocessed.
978 @item @var{file}.ii
979 C++ source code which should not be preprocessed.
981 @item @var{file}.m
982 Objective-C source code.  Note that you must link with the @file{libobjc}
983 library to make an Objective-C program work.
985 @item @var{file}.mi
986 Objective-C source code which should not be preprocessed.
988 @item @var{file}.mm
989 @itemx @var{file}.M
990 Objective-C++ source code.  Note that you must link with the @file{libobjc}
991 library to make an Objective-C++ program work.  Note that @samp{.M} refers
992 to a literal capital M@.
994 @item @var{file}.mii
995 Objective-C++ source code which should not be preprocessed.
997 @item @var{file}.h
998 C, C++, Objective-C or Objective-C++ header file to be turned into a
999 precompiled header (default), or C, C++ header file to be turned into an
1000 Ada spec (via the @option{-fdump-ada-spec} switch).
1002 @item @var{file}.cc
1003 @itemx @var{file}.cp
1004 @itemx @var{file}.cxx
1005 @itemx @var{file}.cpp
1006 @itemx @var{file}.CPP
1007 @itemx @var{file}.c++
1008 @itemx @var{file}.C
1009 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
1010 the last two letters must both be literally @samp{x}.  Likewise,
1011 @samp{.C} refers to a literal capital C@.
1013 @item @var{file}.mm
1014 @itemx @var{file}.M
1015 Objective-C++ source code which must be preprocessed.
1017 @item @var{file}.mii
1018 Objective-C++ source code which should not be preprocessed.
1020 @item @var{file}.hh
1021 @itemx @var{file}.H
1022 @itemx @var{file}.hp
1023 @itemx @var{file}.hxx
1024 @itemx @var{file}.hpp
1025 @itemx @var{file}.HPP
1026 @itemx @var{file}.h++
1027 @itemx @var{file}.tcc
1028 C++ header file to be turned into a precompiled header or Ada spec.
1030 @item @var{file}.f
1031 @itemx @var{file}.for
1032 @itemx @var{file}.ftn
1033 Fixed form Fortran source code which should not be preprocessed.
1035 @item @var{file}.F
1036 @itemx @var{file}.FOR
1037 @itemx @var{file}.fpp
1038 @itemx @var{file}.FPP
1039 @itemx @var{file}.FTN
1040 Fixed form Fortran source code which must be preprocessed (with the traditional
1041 preprocessor).
1043 @item @var{file}.f90
1044 @itemx @var{file}.f95
1045 @itemx @var{file}.f03
1046 @itemx @var{file}.f08
1047 Free form Fortran source code which should not be preprocessed.
1049 @item @var{file}.F90
1050 @itemx @var{file}.F95
1051 @itemx @var{file}.F03
1052 @itemx @var{file}.F08
1053 Free form Fortran source code which must be preprocessed (with the
1054 traditional preprocessor).
1056 @c FIXME: Descriptions of Java file types.
1057 @c @var{file}.java
1058 @c @var{file}.class
1059 @c @var{file}.zip
1060 @c @var{file}.jar
1062 @item @var{file}.ads
1063 Ada source code file which contains a library unit declaration (a
1064 declaration of a package, subprogram, or generic, or a generic
1065 instantiation), or a library unit renaming declaration (a package,
1066 generic, or subprogram renaming declaration).  Such files are also
1067 called @dfn{specs}.
1069 @item @var{file}.adb
1070 Ada source code file containing a library unit body (a subprogram or
1071 package body).  Such files are also called @dfn{bodies}.
1073 @c GCC also knows about some suffixes for languages not yet included:
1074 @c Pascal:
1075 @c @var{file}.p
1076 @c @var{file}.pas
1077 @c Ratfor:
1078 @c @var{file}.r
1080 @item @var{file}.s
1081 Assembler code.
1083 @item @var{file}.S
1084 @itemx @var{file}.sx
1085 Assembler code which must be preprocessed.
1087 @item @var{other}
1088 An object file to be fed straight into linking.
1089 Any file name with no recognized suffix is treated this way.
1090 @end table
1092 @opindex x
1093 You can specify the input language explicitly with the @option{-x} option:
1095 @table @gcctabopt
1096 @item -x @var{language}
1097 Specify explicitly the @var{language} for the following input files
1098 (rather than letting the compiler choose a default based on the file
1099 name suffix).  This option applies to all following input files until
1100 the next @option{-x} option.  Possible values for @var{language} are:
1101 @smallexample
1102 c  c-header  c-cpp-output
1103 c++  c++-header  c++-cpp-output
1104 objective-c  objective-c-header  objective-c-cpp-output
1105 objective-c++ objective-c++-header objective-c++-cpp-output
1106 assembler  assembler-with-cpp
1108 f77  f77-cpp-input f95  f95-cpp-input
1109 java
1110 @end smallexample
1112 @item -x none
1113 Turn off any specification of a language, so that subsequent files are
1114 handled according to their file name suffixes (as they are if @option{-x}
1115 has not been used at all).
1117 @item -pass-exit-codes
1118 @opindex pass-exit-codes
1119 Normally the @command{gcc} program will exit with the code of 1 if any
1120 phase of the compiler returns a non-success return code.  If you specify
1121 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1122 numerically highest error produced by any phase that returned an error
1123 indication.  The C, C++, and Fortran frontends return 4, if an internal
1124 compiler error is encountered.
1125 @end table
1127 If you only want some of the stages of compilation, you can use
1128 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1129 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1130 @command{gcc} is to stop.  Note that some combinations (for example,
1131 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1133 @table @gcctabopt
1134 @item -c
1135 @opindex c
1136 Compile or assemble the source files, but do not link.  The linking
1137 stage simply is not done.  The ultimate output is in the form of an
1138 object file for each source file.
1140 By default, the object file name for a source file is made by replacing
1141 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1143 Unrecognized input files, not requiring compilation or assembly, are
1144 ignored.
1146 @item -S
1147 @opindex S
1148 Stop after the stage of compilation proper; do not assemble.  The output
1149 is in the form of an assembler code file for each non-assembler input
1150 file specified.
1152 By default, the assembler file name for a source file is made by
1153 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1155 Input files that don't require compilation are ignored.
1157 @item -E
1158 @opindex E
1159 Stop after the preprocessing stage; do not run the compiler proper.  The
1160 output is in the form of preprocessed source code, which is sent to the
1161 standard output.
1163 Input files which don't require preprocessing are ignored.
1165 @cindex output file option
1166 @item -o @var{file}
1167 @opindex o
1168 Place output in file @var{file}.  This applies regardless to whatever
1169 sort of output is being produced, whether it be an executable file,
1170 an object file, an assembler file or preprocessed C code.
1172 If @option{-o} is not specified, the default is to put an executable
1173 file in @file{a.out}, the object file for
1174 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1175 assembler file in @file{@var{source}.s}, a precompiled header file in
1176 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1177 standard output.
1179 @item -v
1180 @opindex v
1181 Print (on standard error output) the commands executed to run the stages
1182 of compilation.  Also print the version number of the compiler driver
1183 program and of the preprocessor and the compiler proper.
1185 @item -###
1186 @opindex ###
1187 Like @option{-v} except the commands are not executed and arguments
1188 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1189 This is useful for shell scripts to capture the driver-generated command lines.
1191 @item -pipe
1192 @opindex pipe
1193 Use pipes rather than temporary files for communication between the
1194 various stages of compilation.  This fails to work on some systems where
1195 the assembler is unable to read from a pipe; but the GNU assembler has
1196 no trouble.
1198 @item -combine
1199 @opindex combine
1200 If you are compiling multiple source files, this option tells the driver
1201 to pass all the source files to the compiler at once (for those
1202 languages for which the compiler can handle this).  This will allow
1203 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1204 language for which this is supported is C@.  If you pass source files for
1205 multiple languages to the driver, using this option, the driver will invoke
1206 the compiler(s) that support IMA once each, passing each compiler all the
1207 source files appropriate for it.  For those languages that do not support
1208 IMA this option will be ignored, and the compiler will be invoked once for
1209 each source file in that language.  If you use this option in conjunction
1210 with @option{-save-temps}, the compiler will generate multiple
1211 pre-processed files
1212 (one for each source file), but only one (combined) @file{.o} or
1213 @file{.s} file.
1215 @item --help
1216 @opindex help
1217 Print (on the standard output) a description of the command line options
1218 understood by @command{gcc}.  If the @option{-v} option is also specified
1219 then @option{--help} will also be passed on to the various processes
1220 invoked by @command{gcc}, so that they can display the command line options
1221 they accept.  If the @option{-Wextra} option has also been specified
1222 (prior to the @option{--help} option), then command line options which
1223 have no documentation associated with them will also be displayed.
1225 @item --target-help
1226 @opindex target-help
1227 Print (on the standard output) a description of target-specific command
1228 line options for each tool.  For some targets extra target-specific
1229 information may also be printed.
1231 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1232 Print (on the standard output) a description of the command line
1233 options understood by the compiler that fit into all specified classes
1234 and qualifiers.  These are the supported classes:
1236 @table @asis
1237 @item @samp{optimizers}
1238 This will display all of the optimization options supported by the
1239 compiler.
1241 @item @samp{warnings}
1242 This will display all of the options controlling warning messages
1243 produced by the compiler.
1245 @item @samp{target}
1246 This will display target-specific options.  Unlike the
1247 @option{--target-help} option however, target-specific options of the
1248 linker and assembler will not be displayed.  This is because those
1249 tools do not currently support the extended @option{--help=} syntax.
1251 @item @samp{params}
1252 This will display the values recognized by the @option{--param}
1253 option.
1255 @item @var{language}
1256 This will display the options supported for @var{language}, where
1257 @var{language} is the name of one of the languages supported in this
1258 version of GCC.
1260 @item @samp{common}
1261 This will display the options that are common to all languages.
1262 @end table
1264 These are the supported qualifiers:
1266 @table @asis
1267 @item @samp{undocumented}
1268 Display only those options which are undocumented.
1270 @item @samp{joined}
1271 Display options which take an argument that appears after an equal
1272 sign in the same continuous piece of text, such as:
1273 @samp{--help=target}.
1275 @item @samp{separate}
1276 Display options which take an argument that appears as a separate word
1277 following the original option, such as: @samp{-o output-file}.
1278 @end table
1280 Thus for example to display all the undocumented target-specific
1281 switches supported by the compiler the following can be used:
1283 @smallexample
1284 --help=target,undocumented
1285 @end smallexample
1287 The sense of a qualifier can be inverted by prefixing it with the
1288 @samp{^} character, so for example to display all binary warning
1289 options (i.e., ones that are either on or off and that do not take an
1290 argument), which have a description the following can be used:
1292 @smallexample
1293 --help=warnings,^joined,^undocumented
1294 @end smallexample
1296 The argument to @option{--help=} should not consist solely of inverted
1297 qualifiers.
1299 Combining several classes is possible, although this usually
1300 restricts the output by so much that there is nothing to display.  One
1301 case where it does work however is when one of the classes is
1302 @var{target}.  So for example to display all the target-specific
1303 optimization options the following can be used:
1305 @smallexample
1306 --help=target,optimizers
1307 @end smallexample
1309 The @option{--help=} option can be repeated on the command line.  Each
1310 successive use will display its requested class of options, skipping
1311 those that have already been displayed.
1313 If the @option{-Q} option appears on the command line before the
1314 @option{--help=} option, then the descriptive text displayed by
1315 @option{--help=} is changed.  Instead of describing the displayed
1316 options, an indication is given as to whether the option is enabled,
1317 disabled or set to a specific value (assuming that the compiler
1318 knows this at the point where the @option{--help=} option is used).
1320 Here is a truncated example from the ARM port of @command{gcc}:
1322 @smallexample
1323   % gcc -Q -mabi=2 --help=target -c
1324   The following options are target specific:
1325   -mabi=                                2
1326   -mabort-on-noreturn                   [disabled]
1327   -mapcs                                [disabled]
1328 @end smallexample
1330 The output is sensitive to the effects of previous command line
1331 options, so for example it is possible to find out which optimizations
1332 are enabled at @option{-O2} by using:
1334 @smallexample
1335 -Q -O2 --help=optimizers
1336 @end smallexample
1338 Alternatively you can discover which binary optimizations are enabled
1339 by @option{-O3} by using:
1341 @smallexample
1342 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1343 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1344 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1345 @end smallexample
1347 @item -no-canonical-prefixes
1348 @opindex no-canonical-prefixes
1349 Do not expand any symbolic links, resolve references to @samp{/../}
1350 or @samp{/./}, or make the path absolute when generating a relative
1351 prefix.
1353 @item --version
1354 @opindex version
1355 Display the version number and copyrights of the invoked GCC@.
1357 @item -wrapper
1358 @opindex wrapper
1359 Invoke all subcommands under a wrapper program. It takes a single
1360 comma separated list as an argument, which will be used to invoke
1361 the wrapper:
1363 @smallexample
1364 gcc -c t.c -wrapper gdb,--args
1365 @end smallexample
1367 This will invoke all subprograms of gcc under "gdb --args",
1368 thus cc1 invocation will be "gdb --args cc1 ...".
1370 @item -fplugin=@var{name}.so
1371 Load the plugin code in file @var{name}.so, assumed to be a
1372 shared object to be dlopen'd by the compiler.  The base name of
1373 the shared object file is used to identify the plugin for the
1374 purposes of argument parsing (See
1375 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1376 Each plugin should define the callback functions specified in the
1377 Plugins API.
1379 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1380 Define an argument called @var{key} with a value of @var{value}
1381 for the plugin called @var{name}.
1383 @item -fdump-ada-spec@r{[}-slim@r{]}
1384 For C and C++ source and include files, generate corresponding Ada
1385 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1386 GNAT User's Guide}, which provides detailed documentation on this feature.
1388 @include @value{srcdir}/../libiberty/at-file.texi
1389 @end table
1391 @node Invoking G++
1392 @section Compiling C++ Programs
1394 @cindex suffixes for C++ source
1395 @cindex C++ source file suffixes
1396 C++ source files conventionally use one of the suffixes @samp{.C},
1397 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1398 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1399 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1400 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1401 files with these names and compiles them as C++ programs even if you
1402 call the compiler the same way as for compiling C programs (usually
1403 with the name @command{gcc}).
1405 @findex g++
1406 @findex c++
1407 However, the use of @command{gcc} does not add the C++ library.
1408 @command{g++} is a program that calls GCC and treats @samp{.c},
1409 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1410 files unless @option{-x} is used, and automatically specifies linking
1411 against the C++ library.  This program is also useful when
1412 precompiling a C header file with a @samp{.h} extension for use in C++
1413 compilations.  On many systems, @command{g++} is also installed with
1414 the name @command{c++}.
1416 @cindex invoking @command{g++}
1417 When you compile C++ programs, you may specify many of the same
1418 command-line options that you use for compiling programs in any
1419 language; or command-line options meaningful for C and related
1420 languages; or options that are meaningful only for C++ programs.
1421 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1422 explanations of options for languages related to C@.
1423 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1424 explanations of options that are meaningful only for C++ programs.
1426 @node C Dialect Options
1427 @section Options Controlling C Dialect
1428 @cindex dialect options
1429 @cindex language dialect options
1430 @cindex options, dialect
1432 The following options control the dialect of C (or languages derived
1433 from C, such as C++, Objective-C and Objective-C++) that the compiler
1434 accepts:
1436 @table @gcctabopt
1437 @cindex ANSI support
1438 @cindex ISO support
1439 @item -ansi
1440 @opindex ansi
1441 In C mode, this is equivalent to @samp{-std=c90}. In C++ mode, it is
1442 equivalent to @samp{-std=c++98}.
1444 This turns off certain features of GCC that are incompatible with ISO
1445 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1446 such as the @code{asm} and @code{typeof} keywords, and
1447 predefined macros such as @code{unix} and @code{vax} that identify the
1448 type of system you are using.  It also enables the undesirable and
1449 rarely used ISO trigraph feature.  For the C compiler,
1450 it disables recognition of C++ style @samp{//} comments as well as
1451 the @code{inline} keyword.
1453 The alternate keywords @code{__asm__}, @code{__extension__},
1454 @code{__inline__} and @code{__typeof__} continue to work despite
1455 @option{-ansi}.  You would not want to use them in an ISO C program, of
1456 course, but it is useful to put them in header files that might be included
1457 in compilations done with @option{-ansi}.  Alternate predefined macros
1458 such as @code{__unix__} and @code{__vax__} are also available, with or
1459 without @option{-ansi}.
1461 The @option{-ansi} option does not cause non-ISO programs to be
1462 rejected gratuitously.  For that, @option{-pedantic} is required in
1463 addition to @option{-ansi}.  @xref{Warning Options}.
1465 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1466 option is used.  Some header files may notice this macro and refrain
1467 from declaring certain functions or defining certain macros that the
1468 ISO standard doesn't call for; this is to avoid interfering with any
1469 programs that might use these names for other things.
1471 Functions that would normally be built in but do not have semantics
1472 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1473 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1474 built-in functions provided by GCC}, for details of the functions
1475 affected.
1477 @item -std=
1478 @opindex std
1479 Determine the language standard. @xref{Standards,,Language Standards
1480 Supported by GCC}, for details of these standard versions.  This option
1481 is currently only supported when compiling C or C++.
1483 The compiler can accept several base standards, such as @samp{c90} or
1484 @samp{c++98}, and GNU dialects of those standards, such as
1485 @samp{gnu90} or @samp{gnu++98}.  By specifying a base standard, the
1486 compiler will accept all programs following that standard and those
1487 using GNU extensions that do not contradict it.  For example,
1488 @samp{-std=c90} turns off certain features of GCC that are
1489 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1490 keywords, but not other GNU extensions that do not have a meaning in
1491 ISO C90, such as omitting the middle term of a @code{?:}
1492 expression. On the other hand, by specifying a GNU dialect of a
1493 standard, all features the compiler support are enabled, even when
1494 those features change the meaning of the base standard and some
1495 strict-conforming programs may be rejected.  The particular standard
1496 is used by @option{-pedantic} to identify which features are GNU
1497 extensions given that version of the standard. For example
1498 @samp{-std=gnu90 -pedantic} would warn about C++ style @samp{//}
1499 comments, while @samp{-std=gnu99 -pedantic} would not.
1501 A value for this option must be provided; possible values are
1503 @table @samp
1504 @item c90
1505 @itemx c89
1506 @itemx iso9899:1990
1507 Support all ISO C90 programs (certain GNU extensions that conflict
1508 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1510 @item iso9899:199409
1511 ISO C90 as modified in amendment 1.
1513 @item c99
1514 @itemx c9x
1515 @itemx iso9899:1999
1516 @itemx iso9899:199x
1517 ISO C99.  Note that this standard is not yet fully supported; see
1518 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1519 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1521 @item c1x
1522 ISO C1X, the draft of the next revision of the ISO C standard.
1523 Support is limited and experimental and features enabled by this
1524 option may be changed or removed if changed in or removed from the
1525 standard draft.
1527 @item gnu90
1528 @itemx gnu89
1529 GNU dialect of ISO C90 (including some C99 features). This
1530 is the default for C code.
1532 @item gnu99
1533 @itemx gnu9x
1534 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1535 this will become the default.  The name @samp{gnu9x} is deprecated.
1537 @item gnu1x
1538 GNU dialect of ISO C1X.  Support is limited and experimental and
1539 features enabled by this option may be changed or removed if changed
1540 in or removed from the standard draft.
1542 @item c++98
1543 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1544 C++ code.
1546 @item gnu++98
1547 GNU dialect of @option{-std=c++98}.  This is the default for
1548 C++ code.
1550 @item c++0x
1551 The working draft of the upcoming ISO C++0x standard. This option
1552 enables experimental features that are likely to be included in
1553 C++0x. The working draft is constantly changing, and any feature that is
1554 enabled by this flag may be removed from future versions of GCC if it is
1555 not part of the C++0x standard.
1557 @item gnu++0x
1558 GNU dialect of @option{-std=c++0x}. This option enables
1559 experimental features that may be removed in future versions of GCC.
1560 @end table
1562 @item -fgnu89-inline
1563 @opindex fgnu89-inline
1564 The option @option{-fgnu89-inline} tells GCC to use the traditional
1565 GNU semantics for @code{inline} functions when in C99 mode.
1566 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1567 is accepted and ignored by GCC versions 4.1.3 up to but not including
1568 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1569 C99 mode.  Using this option is roughly equivalent to adding the
1570 @code{gnu_inline} function attribute to all inline functions
1571 (@pxref{Function Attributes}).
1573 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1574 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1575 specifies the default behavior).  This option was first supported in
1576 GCC 4.3.  This option is not supported in @option{-std=c90} or
1577 @option{-std=gnu90} mode.
1579 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1580 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1581 in effect for @code{inline} functions.  @xref{Common Predefined
1582 Macros,,,cpp,The C Preprocessor}.
1584 @item -aux-info @var{filename}
1585 @opindex aux-info
1586 Output to the given filename prototyped declarations for all functions
1587 declared and/or defined in a translation unit, including those in header
1588 files.  This option is silently ignored in any language other than C@.
1590 Besides declarations, the file indicates, in comments, the origin of
1591 each declaration (source file and line), whether the declaration was
1592 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1593 @samp{O} for old, respectively, in the first character after the line
1594 number and the colon), and whether it came from a declaration or a
1595 definition (@samp{C} or @samp{F}, respectively, in the following
1596 character).  In the case of function definitions, a K&R-style list of
1597 arguments followed by their declarations is also provided, inside
1598 comments, after the declaration.
1600 @item -fno-asm
1601 @opindex fno-asm
1602 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1603 keyword, so that code can use these words as identifiers.  You can use
1604 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1605 instead.  @option{-ansi} implies @option{-fno-asm}.
1607 In C++, this switch only affects the @code{typeof} keyword, since
1608 @code{asm} and @code{inline} are standard keywords.  You may want to
1609 use the @option{-fno-gnu-keywords} flag instead, which has the same
1610 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1611 switch only affects the @code{asm} and @code{typeof} keywords, since
1612 @code{inline} is a standard keyword in ISO C99.
1614 @item -fno-builtin
1615 @itemx -fno-builtin-@var{function}
1616 @opindex fno-builtin
1617 @cindex built-in functions
1618 Don't recognize built-in functions that do not begin with
1619 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1620 functions provided by GCC}, for details of the functions affected,
1621 including those which are not built-in functions when @option{-ansi} or
1622 @option{-std} options for strict ISO C conformance are used because they
1623 do not have an ISO standard meaning.
1625 GCC normally generates special code to handle certain built-in functions
1626 more efficiently; for instance, calls to @code{alloca} may become single
1627 instructions that adjust the stack directly, and calls to @code{memcpy}
1628 may become inline copy loops.  The resulting code is often both smaller
1629 and faster, but since the function calls no longer appear as such, you
1630 cannot set a breakpoint on those calls, nor can you change the behavior
1631 of the functions by linking with a different library.  In addition,
1632 when a function is recognized as a built-in function, GCC may use
1633 information about that function to warn about problems with calls to
1634 that function, or to generate more efficient code, even if the
1635 resulting code still contains calls to that function.  For example,
1636 warnings are given with @option{-Wformat} for bad calls to
1637 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1638 known not to modify global memory.
1640 With the @option{-fno-builtin-@var{function}} option
1641 only the built-in function @var{function} is
1642 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1643 function is named that is not built-in in this version of GCC, this
1644 option is ignored.  There is no corresponding
1645 @option{-fbuiltin-@var{function}} option; if you wish to enable
1646 built-in functions selectively when using @option{-fno-builtin} or
1647 @option{-ffreestanding}, you may define macros such as:
1649 @smallexample
1650 #define abs(n)          __builtin_abs ((n))
1651 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1652 @end smallexample
1654 @item -fhosted
1655 @opindex fhosted
1656 @cindex hosted environment
1658 Assert that compilation takes place in a hosted environment.  This implies
1659 @option{-fbuiltin}.  A hosted environment is one in which the
1660 entire standard library is available, and in which @code{main} has a return
1661 type of @code{int}.  Examples are nearly everything except a kernel.
1662 This is equivalent to @option{-fno-freestanding}.
1664 @item -ffreestanding
1665 @opindex ffreestanding
1666 @cindex hosted environment
1668 Assert that compilation takes place in a freestanding environment.  This
1669 implies @option{-fno-builtin}.  A freestanding environment
1670 is one in which the standard library may not exist, and program startup may
1671 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1672 This is equivalent to @option{-fno-hosted}.
1674 @xref{Standards,,Language Standards Supported by GCC}, for details of
1675 freestanding and hosted environments.
1677 @item -fopenmp
1678 @opindex fopenmp
1679 @cindex openmp parallel
1680 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1681 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1682 compiler generates parallel code according to the OpenMP Application
1683 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1684 implies @option{-pthread}, and thus is only supported on targets that
1685 have support for @option{-pthread}.
1687 @item -fms-extensions
1688 @opindex fms-extensions
1689 Accept some non-standard constructs used in Microsoft header files.
1691 It allows for c++ that member-names in structures can be similiar
1692 to previous types declarations.
1694 @smallexample
1695 typedef int UOW;
1696 struct ABC @{
1697   UOW UOW;
1699 @end smallexample
1701 Some cases of unnamed fields in structures and unions are only
1702 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1703 fields within structs/unions}, for details.
1705 @item -trigraphs
1706 @opindex trigraphs
1707 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1708 options for strict ISO C conformance) implies @option{-trigraphs}.
1710 @item -no-integrated-cpp
1711 @opindex no-integrated-cpp
1712 Performs a compilation in two passes: preprocessing and compiling.  This
1713 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1714 @option{-B} option.  The user supplied compilation step can then add in
1715 an additional preprocessing step after normal preprocessing but before
1716 compiling.  The default is to use the integrated cpp (internal cpp)
1718 The semantics of this option will change if "cc1", "cc1plus", and
1719 "cc1obj" are merged.
1721 @cindex traditional C language
1722 @cindex C language, traditional
1723 @item -traditional
1724 @itemx -traditional-cpp
1725 @opindex traditional-cpp
1726 @opindex traditional
1727 Formerly, these options caused GCC to attempt to emulate a pre-standard
1728 C compiler.  They are now only supported with the @option{-E} switch.
1729 The preprocessor continues to support a pre-standard mode.  See the GNU
1730 CPP manual for details.
1732 @item -fcond-mismatch
1733 @opindex fcond-mismatch
1734 Allow conditional expressions with mismatched types in the second and
1735 third arguments.  The value of such an expression is void.  This option
1736 is not supported for C++.
1738 @item -flax-vector-conversions
1739 @opindex flax-vector-conversions
1740 Allow implicit conversions between vectors with differing numbers of
1741 elements and/or incompatible element types.  This option should not be
1742 used for new code.
1744 @item -funsigned-char
1745 @opindex funsigned-char
1746 Let the type @code{char} be unsigned, like @code{unsigned char}.
1748 Each kind of machine has a default for what @code{char} should
1749 be.  It is either like @code{unsigned char} by default or like
1750 @code{signed char} by default.
1752 Ideally, a portable program should always use @code{signed char} or
1753 @code{unsigned char} when it depends on the signedness of an object.
1754 But many programs have been written to use plain @code{char} and
1755 expect it to be signed, or expect it to be unsigned, depending on the
1756 machines they were written for.  This option, and its inverse, let you
1757 make such a program work with the opposite default.
1759 The type @code{char} is always a distinct type from each of
1760 @code{signed char} or @code{unsigned char}, even though its behavior
1761 is always just like one of those two.
1763 @item -fsigned-char
1764 @opindex fsigned-char
1765 Let the type @code{char} be signed, like @code{signed char}.
1767 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1768 the negative form of @option{-funsigned-char}.  Likewise, the option
1769 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1771 @item -fsigned-bitfields
1772 @itemx -funsigned-bitfields
1773 @itemx -fno-signed-bitfields
1774 @itemx -fno-unsigned-bitfields
1775 @opindex fsigned-bitfields
1776 @opindex funsigned-bitfields
1777 @opindex fno-signed-bitfields
1778 @opindex fno-unsigned-bitfields
1779 These options control whether a bit-field is signed or unsigned, when the
1780 declaration does not use either @code{signed} or @code{unsigned}.  By
1781 default, such a bit-field is signed, because this is consistent: the
1782 basic integer types such as @code{int} are signed types.
1783 @end table
1785 @node C++ Dialect Options
1786 @section Options Controlling C++ Dialect
1788 @cindex compiler options, C++
1789 @cindex C++ options, command line
1790 @cindex options, C++
1791 This section describes the command-line options that are only meaningful
1792 for C++ programs; but you can also use most of the GNU compiler options
1793 regardless of what language your program is in.  For example, you
1794 might compile a file @code{firstClass.C} like this:
1796 @smallexample
1797 g++ -g -frepo -O -c firstClass.C
1798 @end smallexample
1800 @noindent
1801 In this example, only @option{-frepo} is an option meant
1802 only for C++ programs; you can use the other options with any
1803 language supported by GCC@.
1805 Here is a list of options that are @emph{only} for compiling C++ programs:
1807 @table @gcctabopt
1809 @item -fabi-version=@var{n}
1810 @opindex fabi-version
1811 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1812 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1813 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1814 the version that conforms most closely to the C++ ABI specification.
1815 Therefore, the ABI obtained using version 0 will change as ABI bugs
1816 are fixed.
1818 The default is version 2.
1820 Version 3 corrects an error in mangling a constant address as a
1821 template argument.
1823 Version 4 implements a standard mangling for vector types.
1825 See also @option{-Wabi}.
1827 @item -fno-access-control
1828 @opindex fno-access-control
1829 Turn off all access checking.  This switch is mainly useful for working
1830 around bugs in the access control code.
1832 @item -fcheck-new
1833 @opindex fcheck-new
1834 Check that the pointer returned by @code{operator new} is non-null
1835 before attempting to modify the storage allocated.  This check is
1836 normally unnecessary because the C++ standard specifies that
1837 @code{operator new} will only return @code{0} if it is declared
1838 @samp{throw()}, in which case the compiler will always check the
1839 return value even without this option.  In all other cases, when
1840 @code{operator new} has a non-empty exception specification, memory
1841 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1842 @samp{new (nothrow)}.
1844 @item -fconserve-space
1845 @opindex fconserve-space
1846 Put uninitialized or runtime-initialized global variables into the
1847 common segment, as C does.  This saves space in the executable at the
1848 cost of not diagnosing duplicate definitions.  If you compile with this
1849 flag and your program mysteriously crashes after @code{main()} has
1850 completed, you may have an object that is being destroyed twice because
1851 two definitions were merged.
1853 This option is no longer useful on most targets, now that support has
1854 been added for putting variables into BSS without making them common.
1856 @item -fno-deduce-init-list
1857 @opindex fno-deduce-init-list
1858 Disable deduction of a template type parameter as
1859 std::initializer_list from a brace-enclosed initializer list, i.e.
1861 @smallexample
1862 template <class T> auto forward(T t) -> decltype (realfn (t))
1864   return realfn (t);
1867 void f()
1869   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1871 @end smallexample
1873 This option is present because this deduction is an extension to the
1874 current specification in the C++0x working draft, and there was
1875 some concern about potential overload resolution problems.
1877 @item -ffriend-injection
1878 @opindex ffriend-injection
1879 Inject friend functions into the enclosing namespace, so that they are
1880 visible outside the scope of the class in which they are declared.
1881 Friend functions were documented to work this way in the old Annotated
1882 C++ Reference Manual, and versions of G++ before 4.1 always worked
1883 that way.  However, in ISO C++ a friend function which is not declared
1884 in an enclosing scope can only be found using argument dependent
1885 lookup.  This option causes friends to be injected as they were in
1886 earlier releases.
1888 This option is for compatibility, and may be removed in a future
1889 release of G++.
1891 @item -fno-elide-constructors
1892 @opindex fno-elide-constructors
1893 The C++ standard allows an implementation to omit creating a temporary
1894 which is only used to initialize another object of the same type.
1895 Specifying this option disables that optimization, and forces G++ to
1896 call the copy constructor in all cases.
1898 @item -fno-enforce-eh-specs
1899 @opindex fno-enforce-eh-specs
1900 Don't generate code to check for violation of exception specifications
1901 at runtime.  This option violates the C++ standard, but may be useful
1902 for reducing code size in production builds, much like defining
1903 @samp{NDEBUG}.  This does not give user code permission to throw
1904 exceptions in violation of the exception specifications; the compiler
1905 will still optimize based on the specifications, so throwing an
1906 unexpected exception will result in undefined behavior.
1908 @item -ffor-scope
1909 @itemx -fno-for-scope
1910 @opindex ffor-scope
1911 @opindex fno-for-scope
1912 If @option{-ffor-scope} is specified, the scope of variables declared in
1913 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1914 as specified by the C++ standard.
1915 If @option{-fno-for-scope} is specified, the scope of variables declared in
1916 a @i{for-init-statement} extends to the end of the enclosing scope,
1917 as was the case in old versions of G++, and other (traditional)
1918 implementations of C++.
1920 The default if neither flag is given to follow the standard,
1921 but to allow and give a warning for old-style code that would
1922 otherwise be invalid, or have different behavior.
1924 @item -fno-gnu-keywords
1925 @opindex fno-gnu-keywords
1926 Do not recognize @code{typeof} as a keyword, so that code can use this
1927 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1928 @option{-ansi} implies @option{-fno-gnu-keywords}.
1930 @item -fno-implicit-templates
1931 @opindex fno-implicit-templates
1932 Never emit code for non-inline templates which are instantiated
1933 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1934 @xref{Template Instantiation}, for more information.
1936 @item -fno-implicit-inline-templates
1937 @opindex fno-implicit-inline-templates
1938 Don't emit code for implicit instantiations of inline templates, either.
1939 The default is to handle inlines differently so that compiles with and
1940 without optimization will need the same set of explicit instantiations.
1942 @item -fno-implement-inlines
1943 @opindex fno-implement-inlines
1944 To save space, do not emit out-of-line copies of inline functions
1945 controlled by @samp{#pragma implementation}.  This will cause linker
1946 errors if these functions are not inlined everywhere they are called.
1948 @item -fms-extensions
1949 @opindex fms-extensions
1950 Disable pedantic warnings about constructs used in MFC, such as implicit
1951 int and getting a pointer to member function via non-standard syntax.
1953 @item -fno-nonansi-builtins
1954 @opindex fno-nonansi-builtins
1955 Disable built-in declarations of functions that are not mandated by
1956 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1957 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1959 @item -fnothrow-opt
1960 @opindex fnothrow-opt
1961 Treat a @code{throw()} exception specification as though it were a
1962 @code{noexcept} specification to reduce or eliminate the text size
1963 overhead relative to a function with no exception specification.  If
1964 the function has local variables of types with non-trivial
1965 destructors, the exception specification will actually make the
1966 function smaller because the EH cleanups for those variables can be
1967 optimized away.  The semantic effect is that an exception thrown out of
1968 a function with such an exception specification will result in a call
1969 to @code{terminate} rather than @code{unexpected}.
1971 @item -fno-operator-names
1972 @opindex fno-operator-names
1973 Do not treat the operator name keywords @code{and}, @code{bitand},
1974 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1975 synonyms as keywords.
1977 @item -fno-optional-diags
1978 @opindex fno-optional-diags
1979 Disable diagnostics that the standard says a compiler does not need to
1980 issue.  Currently, the only such diagnostic issued by G++ is the one for
1981 a name having multiple meanings within a class.
1983 @item -fpermissive
1984 @opindex fpermissive
1985 Downgrade some diagnostics about nonconformant code from errors to
1986 warnings.  Thus, using @option{-fpermissive} will allow some
1987 nonconforming code to compile.
1989 @item -fno-pretty-templates
1990 @opindex fno-pretty-templates
1991 When an error message refers to a specialization of a function
1992 template, the compiler will normally print the signature of the
1993 template followed by the template arguments and any typedefs or
1994 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1995 rather than @code{void f(int)}) so that it's clear which template is
1996 involved.  When an error message refers to a specialization of a class
1997 template, the compiler will omit any template arguments which match
1998 the default template arguments for that template.  If either of these
1999 behaviors make it harder to understand the error message rather than
2000 easier, using @option{-fno-pretty-templates} will disable them.
2002 @item -frepo
2003 @opindex frepo
2004 Enable automatic template instantiation at link time.  This option also
2005 implies @option{-fno-implicit-templates}.  @xref{Template
2006 Instantiation}, for more information.
2008 @item -fno-rtti
2009 @opindex fno-rtti
2010 Disable generation of information about every class with virtual
2011 functions for use by the C++ runtime type identification features
2012 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2013 of the language, you can save some space by using this flag.  Note that
2014 exception handling uses the same information, but it will generate it as
2015 needed. The @samp{dynamic_cast} operator can still be used for casts that
2016 do not require runtime type information, i.e.@: casts to @code{void *} or to
2017 unambiguous base classes.
2019 @item -fstats
2020 @opindex fstats
2021 Emit statistics about front-end processing at the end of the compilation.
2022 This information is generally only useful to the G++ development team.
2024 @item -fstrict-enums
2025 @opindex fstrict-enums
2026 Allow the compiler to optimize using the assumption that a value of
2027 enumeration type can only be one of the values of the enumeration (as
2028 defined in the C++ standard; basically, a value which can be
2029 represented in the minimum number of bits needed to represent all the
2030 enumerators).  This assumption may not be valid if the program uses a
2031 cast to convert an arbitrary integer value to the enumeration type.
2033 @item -ftemplate-depth=@var{n}
2034 @opindex ftemplate-depth
2035 Set the maximum instantiation depth for template classes to @var{n}.
2036 A limit on the template instantiation depth is needed to detect
2037 endless recursions during template class instantiation.  ANSI/ISO C++
2038 conforming programs must not rely on a maximum depth greater than 17
2039 (changed to 1024 in C++0x).
2041 @item -fno-threadsafe-statics
2042 @opindex fno-threadsafe-statics
2043 Do not emit the extra code to use the routines specified in the C++
2044 ABI for thread-safe initialization of local statics.  You can use this
2045 option to reduce code size slightly in code that doesn't need to be
2046 thread-safe.
2048 @item -fuse-cxa-atexit
2049 @opindex fuse-cxa-atexit
2050 Register destructors for objects with static storage duration with the
2051 @code{__cxa_atexit} function rather than the @code{atexit} function.
2052 This option is required for fully standards-compliant handling of static
2053 destructors, but will only work if your C library supports
2054 @code{__cxa_atexit}.
2056 @item -fno-use-cxa-get-exception-ptr
2057 @opindex fno-use-cxa-get-exception-ptr
2058 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2059 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2060 if the runtime routine is not available.
2062 @item -fvisibility-inlines-hidden
2063 @opindex fvisibility-inlines-hidden
2064 This switch declares that the user does not attempt to compare
2065 pointers to inline methods where the addresses of the two functions
2066 were taken in different shared objects.
2068 The effect of this is that GCC may, effectively, mark inline methods with
2069 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2070 appear in the export table of a DSO and do not require a PLT indirection
2071 when used within the DSO@.  Enabling this option can have a dramatic effect
2072 on load and link times of a DSO as it massively reduces the size of the
2073 dynamic export table when the library makes heavy use of templates.
2075 The behavior of this switch is not quite the same as marking the
2076 methods as hidden directly, because it does not affect static variables
2077 local to the function or cause the compiler to deduce that
2078 the function is defined in only one shared object.
2080 You may mark a method as having a visibility explicitly to negate the
2081 effect of the switch for that method.  For example, if you do want to
2082 compare pointers to a particular inline method, you might mark it as
2083 having default visibility.  Marking the enclosing class with explicit
2084 visibility will have no effect.
2086 Explicitly instantiated inline methods are unaffected by this option
2087 as their linkage might otherwise cross a shared library boundary.
2088 @xref{Template Instantiation}.
2090 @item -fvisibility-ms-compat
2091 @opindex fvisibility-ms-compat
2092 This flag attempts to use visibility settings to make GCC's C++
2093 linkage model compatible with that of Microsoft Visual Studio.
2095 The flag makes these changes to GCC's linkage model:
2097 @enumerate
2098 @item
2099 It sets the default visibility to @code{hidden}, like
2100 @option{-fvisibility=hidden}.
2102 @item
2103 Types, but not their members, are not hidden by default.
2105 @item
2106 The One Definition Rule is relaxed for types without explicit
2107 visibility specifications which are defined in more than one different
2108 shared object: those declarations are permitted if they would have
2109 been permitted when this option was not used.
2110 @end enumerate
2112 In new code it is better to use @option{-fvisibility=hidden} and
2113 export those classes which are intended to be externally visible.
2114 Unfortunately it is possible for code to rely, perhaps accidentally,
2115 on the Visual Studio behavior.
2117 Among the consequences of these changes are that static data members
2118 of the same type with the same name but defined in different shared
2119 objects will be different, so changing one will not change the other;
2120 and that pointers to function members defined in different shared
2121 objects may not compare equal.  When this flag is given, it is a
2122 violation of the ODR to define types with the same name differently.
2124 @item -fno-weak
2125 @opindex fno-weak
2126 Do not use weak symbol support, even if it is provided by the linker.
2127 By default, G++ will use weak symbols if they are available.  This
2128 option exists only for testing, and should not be used by end-users;
2129 it will result in inferior code and has no benefits.  This option may
2130 be removed in a future release of G++.
2132 @item -nostdinc++
2133 @opindex nostdinc++
2134 Do not search for header files in the standard directories specific to
2135 C++, but do still search the other standard directories.  (This option
2136 is used when building the C++ library.)
2137 @end table
2139 In addition, these optimization, warning, and code generation options
2140 have meanings only for C++ programs:
2142 @table @gcctabopt
2143 @item -fno-default-inline
2144 @opindex fno-default-inline
2145 Do not assume @samp{inline} for functions defined inside a class scope.
2146 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2147 functions will have linkage like inline functions; they just won't be
2148 inlined by default.
2150 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2151 @opindex Wabi
2152 @opindex Wno-abi
2153 Warn when G++ generates code that is probably not compatible with the
2154 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2155 all such cases, there are probably some cases that are not warned about,
2156 even though G++ is generating incompatible code.  There may also be
2157 cases where warnings are emitted even though the code that is generated
2158 will be compatible.
2160 You should rewrite your code to avoid these warnings if you are
2161 concerned about the fact that code generated by G++ may not be binary
2162 compatible with code generated by other compilers.
2164 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2166 @itemize @bullet
2168 @item
2169 A template with a non-type template parameter of reference type is
2170 mangled incorrectly:
2171 @smallexample
2172 extern int N;
2173 template <int &> struct S @{@};
2174 void n (S<N>) @{2@}
2175 @end smallexample
2177 This is fixed in @option{-fabi-version=3}.
2179 @item
2180 SIMD vector types declared using @code{__attribute ((vector_size))} are
2181 mangled in a non-standard way that does not allow for overloading of
2182 functions taking vectors of different sizes.
2184 The mangling is changed in @option{-fabi-version=4}.
2185 @end itemize
2187 The known incompatibilities in @option{-fabi-version=1} include:
2189 @itemize @bullet
2191 @item
2192 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2193 pack data into the same byte as a base class.  For example:
2195 @smallexample
2196 struct A @{ virtual void f(); int f1 : 1; @};
2197 struct B : public A @{ int f2 : 1; @};
2198 @end smallexample
2200 @noindent
2201 In this case, G++ will place @code{B::f2} into the same byte
2202 as@code{A::f1}; other compilers will not.  You can avoid this problem
2203 by explicitly padding @code{A} so that its size is a multiple of the
2204 byte size on your platform; that will cause G++ and other compilers to
2205 layout @code{B} identically.
2207 @item
2208 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2209 tail padding when laying out virtual bases.  For example:
2211 @smallexample
2212 struct A @{ virtual void f(); char c1; @};
2213 struct B @{ B(); char c2; @};
2214 struct C : public A, public virtual B @{@};
2215 @end smallexample
2217 @noindent
2218 In this case, G++ will not place @code{B} into the tail-padding for
2219 @code{A}; other compilers will.  You can avoid this problem by
2220 explicitly padding @code{A} so that its size is a multiple of its
2221 alignment (ignoring virtual base classes); that will cause G++ and other
2222 compilers to layout @code{C} identically.
2224 @item
2225 Incorrect handling of bit-fields with declared widths greater than that
2226 of their underlying types, when the bit-fields appear in a union.  For
2227 example:
2229 @smallexample
2230 union U @{ int i : 4096; @};
2231 @end smallexample
2233 @noindent
2234 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2235 union too small by the number of bits in an @code{int}.
2237 @item
2238 Empty classes can be placed at incorrect offsets.  For example:
2240 @smallexample
2241 struct A @{@};
2243 struct B @{
2244   A a;
2245   virtual void f ();
2248 struct C : public B, public A @{@};
2249 @end smallexample
2251 @noindent
2252 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2253 it should be placed at offset zero.  G++ mistakenly believes that the
2254 @code{A} data member of @code{B} is already at offset zero.
2256 @item
2257 Names of template functions whose types involve @code{typename} or
2258 template template parameters can be mangled incorrectly.
2260 @smallexample
2261 template <typename Q>
2262 void f(typename Q::X) @{@}
2264 template <template <typename> class Q>
2265 void f(typename Q<int>::X) @{@}
2266 @end smallexample
2268 @noindent
2269 Instantiations of these templates may be mangled incorrectly.
2271 @end itemize
2273 It also warns psABI related changes.  The known psABI changes at this
2274 point include:
2276 @itemize @bullet
2278 @item
2279 For SYSV/x86-64, when passing union with long double, it is changed to
2280 pass in memory as specified in psABI.  For example:
2282 @smallexample
2283 union U @{
2284   long double ld;
2285   int i;
2287 @end smallexample
2289 @noindent
2290 @code{union U} will always be passed in memory.
2292 @end itemize
2294 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2295 @opindex Wctor-dtor-privacy
2296 @opindex Wno-ctor-dtor-privacy
2297 Warn when a class seems unusable because all the constructors or
2298 destructors in that class are private, and it has neither friends nor
2299 public static member functions.
2301 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2302 @opindex Wnoexcept
2303 @opindex Wno-noexcept
2304 Warn when a noexcept-expression evaluates to false because of a call
2305 to a function that does not have a non-throwing exception
2306 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2307 the compiler to never throw an exception.
2309 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2310 @opindex Wnon-virtual-dtor
2311 @opindex Wno-non-virtual-dtor
2312 Warn when a class has virtual functions and accessible non-virtual
2313 destructor, in which case it would be possible but unsafe to delete
2314 an instance of a derived class through a pointer to the base class.
2315 This warning is also enabled if -Weffc++ is specified.
2317 @item -Wreorder @r{(C++ and Objective-C++ only)}
2318 @opindex Wreorder
2319 @opindex Wno-reorder
2320 @cindex reordering, warning
2321 @cindex warning for reordering of member initializers
2322 Warn when the order of member initializers given in the code does not
2323 match the order in which they must be executed.  For instance:
2325 @smallexample
2326 struct A @{
2327   int i;
2328   int j;
2329   A(): j (0), i (1) @{ @}
2331 @end smallexample
2333 The compiler will rearrange the member initializers for @samp{i}
2334 and @samp{j} to match the declaration order of the members, emitting
2335 a warning to that effect.  This warning is enabled by @option{-Wall}.
2336 @end table
2338 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2340 @table @gcctabopt
2341 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2342 @opindex Weffc++
2343 @opindex Wno-effc++
2344 Warn about violations of the following style guidelines from Scott Meyers'
2345 @cite{Effective C++} book:
2347 @itemize @bullet
2348 @item
2349 Item 11:  Define a copy constructor and an assignment operator for classes
2350 with dynamically allocated memory.
2352 @item
2353 Item 12:  Prefer initialization to assignment in constructors.
2355 @item
2356 Item 14:  Make destructors virtual in base classes.
2358 @item
2359 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2361 @item
2362 Item 23:  Don't try to return a reference when you must return an object.
2364 @end itemize
2366 Also warn about violations of the following style guidelines from
2367 Scott Meyers' @cite{More Effective C++} book:
2369 @itemize @bullet
2370 @item
2371 Item 6:  Distinguish between prefix and postfix forms of increment and
2372 decrement operators.
2374 @item
2375 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2377 @end itemize
2379 When selecting this option, be aware that the standard library
2380 headers do not obey all of these guidelines; use @samp{grep -v}
2381 to filter out those warnings.
2383 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2384 @opindex Wstrict-null-sentinel
2385 @opindex Wno-strict-null-sentinel
2386 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2387 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2388 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2389 it is guaranteed to be of the same size as a pointer.  But this use is
2390 not portable across different compilers.
2392 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2393 @opindex Wno-non-template-friend
2394 @opindex Wnon-template-friend
2395 Disable warnings when non-templatized friend functions are declared
2396 within a template.  Since the advent of explicit template specification
2397 support in G++, if the name of the friend is an unqualified-id (i.e.,
2398 @samp{friend foo(int)}), the C++ language specification demands that the
2399 friend declare or define an ordinary, nontemplate function.  (Section
2400 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2401 could be interpreted as a particular specialization of a templatized
2402 function.  Because this non-conforming behavior is no longer the default
2403 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2404 check existing code for potential trouble spots and is on by default.
2405 This new compiler behavior can be turned off with
2406 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2407 but disables the helpful warning.
2409 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2410 @opindex Wold-style-cast
2411 @opindex Wno-old-style-cast
2412 Warn if an old-style (C-style) cast to a non-void type is used within
2413 a C++ program.  The new-style casts (@samp{dynamic_cast},
2414 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2415 less vulnerable to unintended effects and much easier to search for.
2417 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2418 @opindex Woverloaded-virtual
2419 @opindex Wno-overloaded-virtual
2420 @cindex overloaded virtual fn, warning
2421 @cindex warning for overloaded virtual fn
2422 Warn when a function declaration hides virtual functions from a
2423 base class.  For example, in:
2425 @smallexample
2426 struct A @{
2427   virtual void f();
2430 struct B: public A @{
2431   void f(int);
2433 @end smallexample
2435 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2436 like:
2438 @smallexample
2439 B* b;
2440 b->f();
2441 @end smallexample
2443 will fail to compile.
2445 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2446 @opindex Wno-pmf-conversions
2447 @opindex Wpmf-conversions
2448 Disable the diagnostic for converting a bound pointer to member function
2449 to a plain pointer.
2451 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2452 @opindex Wsign-promo
2453 @opindex Wno-sign-promo
2454 Warn when overload resolution chooses a promotion from unsigned or
2455 enumerated type to a signed type, over a conversion to an unsigned type of
2456 the same size.  Previous versions of G++ would try to preserve
2457 unsignedness, but the standard mandates the current behavior.
2459 @smallexample
2460 struct A @{
2461   operator int ();
2462   A& operator = (int);
2465 main ()
2467   A a,b;
2468   a = b;
2470 @end smallexample
2472 In this example, G++ will synthesize a default @samp{A& operator =
2473 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2474 @end table
2476 @node Objective-C and Objective-C++ Dialect Options
2477 @section Options Controlling Objective-C and Objective-C++ Dialects
2479 @cindex compiler options, Objective-C and Objective-C++
2480 @cindex Objective-C and Objective-C++ options, command line
2481 @cindex options, Objective-C and Objective-C++
2482 (NOTE: This manual does not describe the Objective-C and Objective-C++
2483 languages themselves.  See @xref{Standards,,Language Standards
2484 Supported by GCC}, for references.)
2486 This section describes the command-line options that are only meaningful
2487 for Objective-C and Objective-C++ programs, but you can also use most of
2488 the language-independent GNU compiler options.
2489 For example, you might compile a file @code{some_class.m} like this:
2491 @smallexample
2492 gcc -g -fgnu-runtime -O -c some_class.m
2493 @end smallexample
2495 @noindent
2496 In this example, @option{-fgnu-runtime} is an option meant only for
2497 Objective-C and Objective-C++ programs; you can use the other options with
2498 any language supported by GCC@.
2500 Note that since Objective-C is an extension of the C language, Objective-C
2501 compilations may also use options specific to the C front-end (e.g.,
2502 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2503 C++-specific options (e.g., @option{-Wabi}).
2505 Here is a list of options that are @emph{only} for compiling Objective-C
2506 and Objective-C++ programs:
2508 @table @gcctabopt
2509 @item -fconstant-string-class=@var{class-name}
2510 @opindex fconstant-string-class
2511 Use @var{class-name} as the name of the class to instantiate for each
2512 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2513 class name is @code{NXConstantString} if the GNU runtime is being used, and
2514 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2515 @option{-fconstant-cfstrings} option, if also present, will override the
2516 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2517 to be laid out as constant CoreFoundation strings.
2519 @item -fgnu-runtime
2520 @opindex fgnu-runtime
2521 Generate object code compatible with the standard GNU Objective-C
2522 runtime.  This is the default for most types of systems.
2524 @item -fnext-runtime
2525 @opindex fnext-runtime
2526 Generate output compatible with the NeXT runtime.  This is the default
2527 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2528 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2529 used.
2531 @item -fno-nil-receivers
2532 @opindex fno-nil-receivers
2533 Assume that all Objective-C message dispatches (e.g.,
2534 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2535 is not @code{nil}.  This allows for more efficient entry points in the runtime
2536 to be used.  Currently, this option is only available in conjunction with
2537 the NeXT runtime on Mac OS X 10.3 and later.
2539 @item -fobjc-call-cxx-cdtors
2540 @opindex fobjc-call-cxx-cdtors
2541 For each Objective-C class, check if any of its instance variables is a
2542 C++ object with a non-trivial default constructor.  If so, synthesize a
2543 special @code{- (id) .cxx_construct} instance method that will run
2544 non-trivial default constructors on any such instance variables, in order,
2545 and then return @code{self}.  Similarly, check if any instance variable
2546 is a C++ object with a non-trivial destructor, and if so, synthesize a
2547 special @code{- (void) .cxx_destruct} method that will run
2548 all such default destructors, in reverse order.
2550 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2551 thusly generated will only operate on instance variables declared in the
2552 current Objective-C class, and not those inherited from superclasses.  It
2553 is the responsibility of the Objective-C runtime to invoke all such methods
2554 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2555 will be invoked by the runtime immediately after a new object
2556 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2557 be invoked immediately before the runtime deallocates an object instance.
2559 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2560 support for invoking the @code{- (id) .cxx_construct} and
2561 @code{- (void) .cxx_destruct} methods.
2563 @item -fobjc-direct-dispatch
2564 @opindex fobjc-direct-dispatch
2565 Allow fast jumps to the message dispatcher.  On Darwin this is
2566 accomplished via the comm page.
2568 @item -fobjc-exceptions
2569 @opindex fobjc-exceptions
2570 Enable syntactic support for structured exception handling in Objective-C,
2571 similar to what is offered by C++ and Java.  This option is
2572 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2573 earlier.
2575 @smallexample
2576   @@try @{
2577     @dots{}
2578        @@throw expr;
2579     @dots{}
2580   @}
2581   @@catch (AnObjCClass *exc) @{
2582     @dots{}
2583       @@throw expr;
2584     @dots{}
2585       @@throw;
2586     @dots{}
2587   @}
2588   @@catch (AnotherClass *exc) @{
2589     @dots{}
2590   @}
2591   @@catch (id allOthers) @{
2592     @dots{}
2593   @}
2594   @@finally @{
2595     @dots{}
2596       @@throw expr;
2597     @dots{}
2598   @}
2599 @end smallexample
2601 The @code{@@throw} statement may appear anywhere in an Objective-C or
2602 Objective-C++ program; when used inside of a @code{@@catch} block, the
2603 @code{@@throw} may appear without an argument (as shown above), in which case
2604 the object caught by the @code{@@catch} will be rethrown.
2606 Note that only (pointers to) Objective-C objects may be thrown and
2607 caught using this scheme.  When an object is thrown, it will be caught
2608 by the nearest @code{@@catch} clause capable of handling objects of that type,
2609 analogously to how @code{catch} blocks work in C++ and Java.  A
2610 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2611 any and all Objective-C exceptions not caught by previous @code{@@catch}
2612 clauses (if any).
2614 The @code{@@finally} clause, if present, will be executed upon exit from the
2615 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2616 regardless of whether any exceptions are thrown, caught or rethrown
2617 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2618 of the @code{finally} clause in Java.
2620 There are several caveats to using the new exception mechanism:
2622 @itemize @bullet
2623 @item
2624 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2625 idioms provided by the @code{NSException} class, the new
2626 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2627 systems, due to additional functionality needed in the (NeXT) Objective-C
2628 runtime.
2630 @item
2631 As mentioned above, the new exceptions do not support handling
2632 types other than Objective-C objects.   Furthermore, when used from
2633 Objective-C++, the Objective-C exception model does not interoperate with C++
2634 exceptions at this time.  This means you cannot @code{@@throw} an exception
2635 from Objective-C and @code{catch} it in C++, or vice versa
2636 (i.e., @code{throw @dots{} @@catch}).
2637 @end itemize
2639 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2640 blocks for thread-safe execution:
2642 @smallexample
2643   @@synchronized (ObjCClass *guard) @{
2644     @dots{}
2645   @}
2646 @end smallexample
2648 Upon entering the @code{@@synchronized} block, a thread of execution shall
2649 first check whether a lock has been placed on the corresponding @code{guard}
2650 object by another thread.  If it has, the current thread shall wait until
2651 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2652 the current thread will place its own lock on it, execute the code contained in
2653 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2654 making @code{guard} available to other threads).
2656 Unlike Java, Objective-C does not allow for entire methods to be marked
2657 @code{@@synchronized}.  Note that throwing exceptions out of
2658 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2659 to be unlocked properly.
2661 @item -fobjc-gc
2662 @opindex fobjc-gc
2663 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2665 @item -freplace-objc-classes
2666 @opindex freplace-objc-classes
2667 Emit a special marker instructing @command{ld(1)} not to statically link in
2668 the resulting object file, and allow @command{dyld(1)} to load it in at
2669 run time instead.  This is used in conjunction with the Fix-and-Continue
2670 debugging mode, where the object file in question may be recompiled and
2671 dynamically reloaded in the course of program execution, without the need
2672 to restart the program itself.  Currently, Fix-and-Continue functionality
2673 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2674 and later.
2676 @item -fzero-link
2677 @opindex fzero-link
2678 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2679 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2680 compile time) with static class references that get initialized at load time,
2681 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2682 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2683 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2684 for individual class implementations to be modified during program execution.
2686 @item -gen-decls
2687 @opindex gen-decls
2688 Dump interface declarations for all classes seen in the source file to a
2689 file named @file{@var{sourcename}.decl}.
2691 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2692 @opindex Wassign-intercept
2693 @opindex Wno-assign-intercept
2694 Warn whenever an Objective-C assignment is being intercepted by the
2695 garbage collector.
2697 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2698 @opindex Wno-protocol
2699 @opindex Wprotocol
2700 If a class is declared to implement a protocol, a warning is issued for
2701 every method in the protocol that is not implemented by the class.  The
2702 default behavior is to issue a warning for every method not explicitly
2703 implemented in the class, even if a method implementation is inherited
2704 from the superclass.  If you use the @option{-Wno-protocol} option, then
2705 methods inherited from the superclass are considered to be implemented,
2706 and no warning is issued for them.
2708 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2709 @opindex Wselector
2710 @opindex Wno-selector
2711 Warn if multiple methods of different types for the same selector are
2712 found during compilation.  The check is performed on the list of methods
2713 in the final stage of compilation.  Additionally, a check is performed
2714 for each selector appearing in a @code{@@selector(@dots{})}
2715 expression, and a corresponding method for that selector has been found
2716 during compilation.  Because these checks scan the method table only at
2717 the end of compilation, these warnings are not produced if the final
2718 stage of compilation is not reached, for example because an error is
2719 found during compilation, or because the @option{-fsyntax-only} option is
2720 being used.
2722 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2723 @opindex Wstrict-selector-match
2724 @opindex Wno-strict-selector-match
2725 Warn if multiple methods with differing argument and/or return types are
2726 found for a given selector when attempting to send a message using this
2727 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2728 is off (which is the default behavior), the compiler will omit such warnings
2729 if any differences found are confined to types which share the same size
2730 and alignment.
2732 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2733 @opindex Wundeclared-selector
2734 @opindex Wno-undeclared-selector
2735 Warn if a @code{@@selector(@dots{})} expression referring to an
2736 undeclared selector is found.  A selector is considered undeclared if no
2737 method with that name has been declared before the
2738 @code{@@selector(@dots{})} expression, either explicitly in an
2739 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2740 an @code{@@implementation} section.  This option always performs its
2741 checks as soon as a @code{@@selector(@dots{})} expression is found,
2742 while @option{-Wselector} only performs its checks in the final stage of
2743 compilation.  This also enforces the coding style convention
2744 that methods and selectors must be declared before being used.
2746 @item -print-objc-runtime-info
2747 @opindex print-objc-runtime-info
2748 Generate C header describing the largest structure that is passed by
2749 value, if any.
2751 @end table
2753 @node Language Independent Options
2754 @section Options to Control Diagnostic Messages Formatting
2755 @cindex options to control diagnostics formatting
2756 @cindex diagnostic messages
2757 @cindex message formatting
2759 Traditionally, diagnostic messages have been formatted irrespective of
2760 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2761 below can be used to control the diagnostic messages formatting
2762 algorithm, e.g.@: how many characters per line, how often source location
2763 information should be reported.  Right now, only the C++ front end can
2764 honor these options.  However it is expected, in the near future, that
2765 the remaining front ends would be able to digest them correctly.
2767 @table @gcctabopt
2768 @item -fmessage-length=@var{n}
2769 @opindex fmessage-length
2770 Try to format error messages so that they fit on lines of about @var{n}
2771 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2772 the front ends supported by GCC@.  If @var{n} is zero, then no
2773 line-wrapping will be done; each error message will appear on a single
2774 line.
2776 @opindex fdiagnostics-show-location
2777 @item -fdiagnostics-show-location=once
2778 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2779 reporter to emit @emph{once} source location information; that is, in
2780 case the message is too long to fit on a single physical line and has to
2781 be wrapped, the source location won't be emitted (as prefix) again,
2782 over and over, in subsequent continuation lines.  This is the default
2783 behavior.
2785 @item -fdiagnostics-show-location=every-line
2786 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2787 messages reporter to emit the same source location information (as
2788 prefix) for physical lines that result from the process of breaking
2789 a message which is too long to fit on a single line.
2791 @item -fdiagnostics-show-option
2792 @opindex fdiagnostics-show-option
2793 This option instructs the diagnostic machinery to add text to each
2794 diagnostic emitted, which indicates which command line option directly
2795 controls that diagnostic, when such an option is known to the
2796 diagnostic machinery.
2798 @item -Wcoverage-mismatch
2799 @opindex Wcoverage-mismatch
2800 Warn if feedback profiles do not match when using the
2801 @option{-fprofile-use} option.
2802 If a source file was changed between @option{-fprofile-gen} and
2803 @option{-fprofile-use}, the files with the profile feedback can fail
2804 to match the source file and GCC can not use the profile feedback
2805 information.  By default, this warning is enabled and is treated as an
2806 error.  @option{-Wno-coverage-mismatch} can be used to disable the
2807 warning or @option{-Wno-error=coverage-mismatch} can be used to
2808 disable the error.  Disable the error for this warning can result in
2809 poorly optimized code, so disabling the error is useful only in the
2810 case of very minor changes such as bug fixes to an existing code-base.
2811 Completely disabling the warning is not recommended.
2813 @end table
2815 @node Warning Options
2816 @section Options to Request or Suppress Warnings
2817 @cindex options to control warnings
2818 @cindex warning messages
2819 @cindex messages, warning
2820 @cindex suppressing warnings
2822 Warnings are diagnostic messages that report constructions which
2823 are not inherently erroneous but which are risky or suggest there
2824 may have been an error.
2826 The following language-independent options do not enable specific
2827 warnings but control the kinds of diagnostics produced by GCC.
2829 @table @gcctabopt
2830 @cindex syntax checking
2831 @item -fsyntax-only
2832 @opindex fsyntax-only
2833 Check the code for syntax errors, but don't do anything beyond that.
2835 @item -w
2836 @opindex w
2837 Inhibit all warning messages.
2839 @item -Werror
2840 @opindex Werror
2841 @opindex Wno-error
2842 Make all warnings into errors.
2844 @item -Werror=
2845 @opindex Werror=
2846 @opindex Wno-error=
2847 Make the specified warning into an error.  The specifier for a warning
2848 is appended, for example @option{-Werror=switch} turns the warnings
2849 controlled by @option{-Wswitch} into errors.  This switch takes a
2850 negative form, to be used to negate @option{-Werror} for specific
2851 warnings, for example @option{-Wno-error=switch} makes
2852 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2853 is in effect.  You can use the @option{-fdiagnostics-show-option}
2854 option to have each controllable warning amended with the option which
2855 controls it, to determine what to use with this option.
2857 Note that specifying @option{-Werror=}@var{foo} automatically implies
2858 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2859 imply anything.
2861 @item -Wfatal-errors
2862 @opindex Wfatal-errors
2863 @opindex Wno-fatal-errors
2864 This option causes the compiler to abort compilation on the first error
2865 occurred rather than trying to keep going and printing further error
2866 messages.
2868 @end table
2870 You can request many specific warnings with options beginning
2871 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2872 implicit declarations.  Each of these specific warning options also
2873 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2874 example, @option{-Wno-implicit}.  This manual lists only one of the
2875 two forms, whichever is not the default.  For further,
2876 language-specific options also refer to @ref{C++ Dialect Options} and
2877 @ref{Objective-C and Objective-C++ Dialect Options}.
2879 When an unrecognized warning option is requested (e.g.,
2880 @option{-Wunknown-warning}), GCC will emit a diagnostic stating
2881 that the option is not recognized.  However, if the @option{-Wno-} form
2882 is used, the behavior is slightly different: No diagnostic will be
2883 produced for @option{-Wno-unknown-warning} unless other diagnostics
2884 are being produced.  This allows the use of new @option{-Wno-} options
2885 with old compilers, but if something goes wrong, the compiler will
2886 warn that an unrecognized option was used.
2888 @table @gcctabopt
2889 @item -pedantic
2890 @opindex pedantic
2891 Issue all the warnings demanded by strict ISO C and ISO C++;
2892 reject all programs that use forbidden extensions, and some other
2893 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2894 version of the ISO C standard specified by any @option{-std} option used.
2896 Valid ISO C and ISO C++ programs should compile properly with or without
2897 this option (though a rare few will require @option{-ansi} or a
2898 @option{-std} option specifying the required version of ISO C)@.  However,
2899 without this option, certain GNU extensions and traditional C and C++
2900 features are supported as well.  With this option, they are rejected.
2902 @option{-pedantic} does not cause warning messages for use of the
2903 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2904 warnings are also disabled in the expression that follows
2905 @code{__extension__}.  However, only system header files should use
2906 these escape routes; application programs should avoid them.
2907 @xref{Alternate Keywords}.
2909 Some users try to use @option{-pedantic} to check programs for strict ISO
2910 C conformance.  They soon find that it does not do quite what they want:
2911 it finds some non-ISO practices, but not all---only those for which
2912 ISO C @emph{requires} a diagnostic, and some others for which
2913 diagnostics have been added.
2915 A feature to report any failure to conform to ISO C might be useful in
2916 some instances, but would require considerable additional work and would
2917 be quite different from @option{-pedantic}.  We don't have plans to
2918 support such a feature in the near future.
2920 Where the standard specified with @option{-std} represents a GNU
2921 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
2922 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2923 extended dialect is based.  Warnings from @option{-pedantic} are given
2924 where they are required by the base standard.  (It would not make sense
2925 for such warnings to be given only for features not in the specified GNU
2926 C dialect, since by definition the GNU dialects of C include all
2927 features the compiler supports with the given option, and there would be
2928 nothing to warn about.)
2930 @item -pedantic-errors
2931 @opindex pedantic-errors
2932 Like @option{-pedantic}, except that errors are produced rather than
2933 warnings.
2935 @item -Wall
2936 @opindex Wall
2937 @opindex Wno-all
2938 This enables all the warnings about constructions that some users
2939 consider questionable, and that are easy to avoid (or modify to
2940 prevent the warning), even in conjunction with macros.  This also
2941 enables some language-specific warnings described in @ref{C++ Dialect
2942 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2944 @option{-Wall} turns on the following warning flags:
2946 @gccoptlist{-Waddress   @gol
2947 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2948 -Wc++0x-compat  @gol
2949 -Wchar-subscripts  @gol
2950 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2951 -Wimplicit-int @r{(C and Objective-C only)} @gol
2952 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
2953 -Wcomment  @gol
2954 -Wformat   @gol
2955 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2956 -Wmissing-braces  @gol
2957 -Wnonnull  @gol
2958 -Wparentheses  @gol
2959 -Wpointer-sign  @gol
2960 -Wreorder   @gol
2961 -Wreturn-type  @gol
2962 -Wsequence-point  @gol
2963 -Wsign-compare @r{(only in C++)}  @gol
2964 -Wstrict-aliasing  @gol
2965 -Wstrict-overflow=1  @gol
2966 -Wswitch  @gol
2967 -Wtrigraphs  @gol
2968 -Wuninitialized  @gol
2969 -Wunknown-pragmas  @gol
2970 -Wunused-function  @gol
2971 -Wunused-label     @gol
2972 -Wunused-value     @gol
2973 -Wunused-variable  @gol
2974 -Wvolatile-register-var @gol
2977 Note that some warning flags are not implied by @option{-Wall}.  Some of
2978 them warn about constructions that users generally do not consider
2979 questionable, but which occasionally you might wish to check for;
2980 others warn about constructions that are necessary or hard to avoid in
2981 some cases, and there is no simple way to modify the code to suppress
2982 the warning. Some of them are enabled by @option{-Wextra} but many of
2983 them must be enabled individually.
2985 @item -Wextra
2986 @opindex W
2987 @opindex Wextra
2988 @opindex Wno-extra
2989 This enables some extra warning flags that are not enabled by
2990 @option{-Wall}. (This option used to be called @option{-W}.  The older
2991 name is still supported, but the newer name is more descriptive.)
2993 @gccoptlist{-Wclobbered  @gol
2994 -Wempty-body  @gol
2995 -Wignored-qualifiers @gol
2996 -Wmissing-field-initializers  @gol
2997 -Wmissing-parameter-type @r{(C only)}  @gol
2998 -Wold-style-declaration @r{(C only)}  @gol
2999 -Woverride-init  @gol
3000 -Wsign-compare  @gol
3001 -Wtype-limits  @gol
3002 -Wuninitialized  @gol
3003 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3004 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3007 The option @option{-Wextra} also prints warning messages for the
3008 following cases:
3010 @itemize @bullet
3012 @item
3013 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3014 @samp{>}, or @samp{>=}.
3016 @item
3017 (C++ only) An enumerator and a non-enumerator both appear in a
3018 conditional expression.
3020 @item
3021 (C++ only) Ambiguous virtual bases.
3023 @item
3024 (C++ only) Subscripting an array which has been declared @samp{register}.
3026 @item
3027 (C++ only) Taking the address of a variable which has been declared
3028 @samp{register}.
3030 @item
3031 (C++ only) A base class is not initialized in a derived class' copy
3032 constructor.
3034 @end itemize
3036 @item -Wchar-subscripts
3037 @opindex Wchar-subscripts
3038 @opindex Wno-char-subscripts
3039 Warn if an array subscript has type @code{char}.  This is a common cause
3040 of error, as programmers often forget that this type is signed on some
3041 machines.
3042 This warning is enabled by @option{-Wall}.
3044 @item -Wcomment
3045 @opindex Wcomment
3046 @opindex Wno-comment
3047 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3048 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3049 This warning is enabled by @option{-Wall}.
3051 @item -Wno-cpp \
3052 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3054 Suppress warning messages emitted by @code{#warning} directives.
3056 @item -Wformat
3057 @opindex Wformat
3058 @opindex Wno-format
3059 @opindex ffreestanding
3060 @opindex fno-builtin
3061 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3062 the arguments supplied have types appropriate to the format string
3063 specified, and that the conversions specified in the format string make
3064 sense.  This includes standard functions, and others specified by format
3065 attributes (@pxref{Function Attributes}), in the @code{printf},
3066 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3067 not in the C standard) families (or other target-specific families).
3068 Which functions are checked without format attributes having been
3069 specified depends on the standard version selected, and such checks of
3070 functions without the attribute specified are disabled by
3071 @option{-ffreestanding} or @option{-fno-builtin}.
3073 The formats are checked against the format features supported by GNU
3074 libc version 2.2.  These include all ISO C90 and C99 features, as well
3075 as features from the Single Unix Specification and some BSD and GNU
3076 extensions.  Other library implementations may not support all these
3077 features; GCC does not support warning about features that go beyond a
3078 particular library's limitations.  However, if @option{-pedantic} is used
3079 with @option{-Wformat}, warnings will be given about format features not
3080 in the selected standard version (but not for @code{strfmon} formats,
3081 since those are not in any version of the C standard).  @xref{C Dialect
3082 Options,,Options Controlling C Dialect}.
3084 Since @option{-Wformat} also checks for null format arguments for
3085 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3087 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3088 aspects of format checking, the options @option{-Wformat-y2k},
3089 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3090 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3091 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3093 @item -Wformat-y2k
3094 @opindex Wformat-y2k
3095 @opindex Wno-format-y2k
3096 If @option{-Wformat} is specified, also warn about @code{strftime}
3097 formats which may yield only a two-digit year.
3099 @item -Wno-format-contains-nul
3100 @opindex Wno-format-contains-nul
3101 @opindex Wformat-contains-nul
3102 If @option{-Wformat} is specified, do not warn about format strings that
3103 contain NUL bytes.
3105 @item -Wno-format-extra-args
3106 @opindex Wno-format-extra-args
3107 @opindex Wformat-extra-args
3108 If @option{-Wformat} is specified, do not warn about excess arguments to a
3109 @code{printf} or @code{scanf} format function.  The C standard specifies
3110 that such arguments are ignored.
3112 Where the unused arguments lie between used arguments that are
3113 specified with @samp{$} operand number specifications, normally
3114 warnings are still given, since the implementation could not know what
3115 type to pass to @code{va_arg} to skip the unused arguments.  However,
3116 in the case of @code{scanf} formats, this option will suppress the
3117 warning if the unused arguments are all pointers, since the Single
3118 Unix Specification says that such unused arguments are allowed.
3120 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3121 @opindex Wno-format-zero-length
3122 @opindex Wformat-zero-length
3123 If @option{-Wformat} is specified, do not warn about zero-length formats.
3124 The C standard specifies that zero-length formats are allowed.
3126 @item -Wformat-nonliteral
3127 @opindex Wformat-nonliteral
3128 @opindex Wno-format-nonliteral
3129 If @option{-Wformat} is specified, also warn if the format string is not a
3130 string literal and so cannot be checked, unless the format function
3131 takes its format arguments as a @code{va_list}.
3133 @item -Wformat-security
3134 @opindex Wformat-security
3135 @opindex Wno-format-security
3136 If @option{-Wformat} is specified, also warn about uses of format
3137 functions that represent possible security problems.  At present, this
3138 warns about calls to @code{printf} and @code{scanf} functions where the
3139 format string is not a string literal and there are no format arguments,
3140 as in @code{printf (foo);}.  This may be a security hole if the format
3141 string came from untrusted input and contains @samp{%n}.  (This is
3142 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3143 in future warnings may be added to @option{-Wformat-security} that are not
3144 included in @option{-Wformat-nonliteral}.)
3146 @item -Wformat=2
3147 @opindex Wformat=2
3148 @opindex Wno-format=2
3149 Enable @option{-Wformat} plus format checks not included in
3150 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3151 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3153 @item -Wnonnull @r{(C and Objective-C only)}
3154 @opindex Wnonnull
3155 @opindex Wno-nonnull
3156 Warn about passing a null pointer for arguments marked as
3157 requiring a non-null value by the @code{nonnull} function attribute.
3159 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3160 can be disabled with the @option{-Wno-nonnull} option.
3162 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3163 @opindex Winit-self
3164 @opindex Wno-init-self
3165 Warn about uninitialized variables which are initialized with themselves.
3166 Note this option can only be used with the @option{-Wuninitialized} option.
3168 For example, GCC will warn about @code{i} being uninitialized in the
3169 following snippet only when @option{-Winit-self} has been specified:
3170 @smallexample
3171 @group
3172 int f()
3174   int i = i;
3175   return i;
3177 @end group
3178 @end smallexample
3180 @item -Wimplicit-int @r{(C and Objective-C only)}
3181 @opindex Wimplicit-int
3182 @opindex Wno-implicit-int
3183 Warn when a declaration does not specify a type.
3184 This warning is enabled by @option{-Wall}.
3186 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3187 @opindex Wimplicit-function-declaration
3188 @opindex Wno-implicit-function-declaration
3189 Give a warning whenever a function is used before being declared. In
3190 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3191 enabled by default and it is made into an error by
3192 @option{-pedantic-errors}. This warning is also enabled by
3193 @option{-Wall}.
3195 @item -Wimplicit @r{(C and Objective-C only)}
3196 @opindex Wimplicit
3197 @opindex Wno-implicit
3198 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3199 This warning is enabled by @option{-Wall}.
3201 @item -Wignored-qualifiers @r{(C and C++ only)}
3202 @opindex Wignored-qualifiers
3203 @opindex Wno-ignored-qualifiers
3204 Warn if the return type of a function has a type qualifier
3205 such as @code{const}.  For ISO C such a type qualifier has no effect,
3206 since the value returned by a function is not an lvalue.
3207 For C++, the warning is only emitted for scalar types or @code{void}.
3208 ISO C prohibits qualified @code{void} return types on function
3209 definitions, so such return types always receive a warning
3210 even without this option.
3212 This warning is also enabled by @option{-Wextra}.
3214 @item -Wmain
3215 @opindex Wmain
3216 @opindex Wno-main
3217 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3218 a function with external linkage, returning int, taking either zero
3219 arguments, two, or three arguments of appropriate types.  This warning
3220 is enabled by default in C++ and is enabled by either @option{-Wall}
3221 or @option{-pedantic}.
3223 @item -Wmissing-braces
3224 @opindex Wmissing-braces
3225 @opindex Wno-missing-braces
3226 Warn if an aggregate or union initializer is not fully bracketed.  In
3227 the following example, the initializer for @samp{a} is not fully
3228 bracketed, but that for @samp{b} is fully bracketed.
3230 @smallexample
3231 int a[2][2] = @{ 0, 1, 2, 3 @};
3232 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3233 @end smallexample
3235 This warning is enabled by @option{-Wall}.
3237 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3238 @opindex Wmissing-include-dirs
3239 @opindex Wno-missing-include-dirs
3240 Warn if a user-supplied include directory does not exist.
3242 @item -Wparentheses
3243 @opindex Wparentheses
3244 @opindex Wno-parentheses
3245 Warn if parentheses are omitted in certain contexts, such
3246 as when there is an assignment in a context where a truth value
3247 is expected, or when operators are nested whose precedence people
3248 often get confused about.
3250 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3251 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3252 interpretation from that of ordinary mathematical notation.
3254 Also warn about constructions where there may be confusion to which
3255 @code{if} statement an @code{else} branch belongs.  Here is an example of
3256 such a case:
3258 @smallexample
3259 @group
3261   if (a)
3262     if (b)
3263       foo ();
3264   else
3265     bar ();
3267 @end group
3268 @end smallexample
3270 In C/C++, every @code{else} branch belongs to the innermost possible
3271 @code{if} statement, which in this example is @code{if (b)}.  This is
3272 often not what the programmer expected, as illustrated in the above
3273 example by indentation the programmer chose.  When there is the
3274 potential for this confusion, GCC will issue a warning when this flag
3275 is specified.  To eliminate the warning, add explicit braces around
3276 the innermost @code{if} statement so there is no way the @code{else}
3277 could belong to the enclosing @code{if}.  The resulting code would
3278 look like this:
3280 @smallexample
3281 @group
3283   if (a)
3284     @{
3285       if (b)
3286         foo ();
3287       else
3288         bar ();
3289     @}
3291 @end group
3292 @end smallexample
3294 Also warn for dangerous uses of the 
3295 ?: with omitted middle operand GNU extension. When the condition
3296 in the ?: operator is a boolean expression the omitted value will
3297 be always 1. Often the user expects it to be a value computed
3298 inside the conditional expression instead. 
3300 This warning is enabled by @option{-Wall}.
3302 @item -Wsequence-point
3303 @opindex Wsequence-point
3304 @opindex Wno-sequence-point
3305 Warn about code that may have undefined semantics because of violations
3306 of sequence point rules in the C and C++ standards.
3308 The C and C++ standards defines the order in which expressions in a C/C++
3309 program are evaluated in terms of @dfn{sequence points}, which represent
3310 a partial ordering between the execution of parts of the program: those
3311 executed before the sequence point, and those executed after it.  These
3312 occur after the evaluation of a full expression (one which is not part
3313 of a larger expression), after the evaluation of the first operand of a
3314 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3315 function is called (but after the evaluation of its arguments and the
3316 expression denoting the called function), and in certain other places.
3317 Other than as expressed by the sequence point rules, the order of
3318 evaluation of subexpressions of an expression is not specified.  All
3319 these rules describe only a partial order rather than a total order,
3320 since, for example, if two functions are called within one expression
3321 with no sequence point between them, the order in which the functions
3322 are called is not specified.  However, the standards committee have
3323 ruled that function calls do not overlap.
3325 It is not specified when between sequence points modifications to the
3326 values of objects take effect.  Programs whose behavior depends on this
3327 have undefined behavior; the C and C++ standards specify that ``Between
3328 the previous and next sequence point an object shall have its stored
3329 value modified at most once by the evaluation of an expression.
3330 Furthermore, the prior value shall be read only to determine the value
3331 to be stored.''.  If a program breaks these rules, the results on any
3332 particular implementation are entirely unpredictable.
3334 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3335 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3336 diagnosed by this option, and it may give an occasional false positive
3337 result, but in general it has been found fairly effective at detecting
3338 this sort of problem in programs.
3340 The standard is worded confusingly, therefore there is some debate
3341 over the precise meaning of the sequence point rules in subtle cases.
3342 Links to discussions of the problem, including proposed formal
3343 definitions, may be found on the GCC readings page, at
3344 @w{@uref{http://gcc.gnu.org/readings.html}}.
3346 This warning is enabled by @option{-Wall} for C and C++.
3348 @item -Wreturn-type
3349 @opindex Wreturn-type
3350 @opindex Wno-return-type
3351 Warn whenever a function is defined with a return-type that defaults
3352 to @code{int}.  Also warn about any @code{return} statement with no
3353 return-value in a function whose return-type is not @code{void}
3354 (falling off the end of the function body is considered returning
3355 without a value), and about a @code{return} statement with an
3356 expression in a function whose return-type is @code{void}.
3358 For C++, a function without return type always produces a diagnostic
3359 message, even when @option{-Wno-return-type} is specified.  The only
3360 exceptions are @samp{main} and functions defined in system headers.
3362 This warning is enabled by @option{-Wall}.
3364 @item -Wswitch
3365 @opindex Wswitch
3366 @opindex Wno-switch
3367 Warn whenever a @code{switch} statement has an index of enumerated type
3368 and lacks a @code{case} for one or more of the named codes of that
3369 enumeration.  (The presence of a @code{default} label prevents this
3370 warning.)  @code{case} labels outside the enumeration range also
3371 provoke warnings when this option is used (even if there is a
3372 @code{default} label).
3373 This warning is enabled by @option{-Wall}.
3375 @item -Wswitch-default
3376 @opindex Wswitch-default
3377 @opindex Wno-switch-default
3378 Warn whenever a @code{switch} statement does not have a @code{default}
3379 case.
3381 @item -Wswitch-enum
3382 @opindex Wswitch-enum
3383 @opindex Wno-switch-enum
3384 Warn whenever a @code{switch} statement has an index of enumerated type
3385 and lacks a @code{case} for one or more of the named codes of that
3386 enumeration.  @code{case} labels outside the enumeration range also
3387 provoke warnings when this option is used.  The only difference
3388 between @option{-Wswitch} and this option is that this option gives a
3389 warning about an omitted enumeration code even if there is a
3390 @code{default} label.
3392 @item -Wsync-nand @r{(C and C++ only)}
3393 @opindex Wsync-nand
3394 @opindex Wno-sync-nand
3395 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3396 built-in functions are used.  These functions changed semantics in GCC 4.4.
3398 @item -Wtrigraphs
3399 @opindex Wtrigraphs
3400 @opindex Wno-trigraphs
3401 Warn if any trigraphs are encountered that might change the meaning of
3402 the program (trigraphs within comments are not warned about).
3403 This warning is enabled by @option{-Wall}.
3405 @item -Wunused-but-set-parameter
3406 @opindex Wunused-but-set-parameter
3407 @opindex Wno-unused-but-set-parameter
3408 Warn whenever a function parameter is assigned to, but otherwise unused
3409 (aside from its declaration).
3411 To suppress this warning use the @samp{unused} attribute
3412 (@pxref{Variable Attributes}).
3414 This warning is also enabled by @option{-Wunused} together with
3415 @option{-Wextra}.
3417 @item -Wunused-but-set-variable
3418 @opindex Wunused-but-set-variable
3419 @opindex Wno-unused-but-set-variable
3420 Warn whenever a local variable is assigned to, but otherwise unused
3421 (aside from its declaration).
3422 This warning is enabled by @option{-Wall}.
3424 To suppress this warning use the @samp{unused} attribute
3425 (@pxref{Variable Attributes}).
3427 This warning is also enabled by @option{-Wunused}, which is enabled
3428 by @option{-Wall}.
3430 @item -Wunused-function
3431 @opindex Wunused-function
3432 @opindex Wno-unused-function
3433 Warn whenever a static function is declared but not defined or a
3434 non-inline static function is unused.
3435 This warning is enabled by @option{-Wall}.
3437 @item -Wunused-label
3438 @opindex Wunused-label
3439 @opindex Wno-unused-label
3440 Warn whenever a label is declared but not used.
3441 This warning is enabled by @option{-Wall}.
3443 To suppress this warning use the @samp{unused} attribute
3444 (@pxref{Variable Attributes}).
3446 @item -Wunused-parameter
3447 @opindex Wunused-parameter
3448 @opindex Wno-unused-parameter
3449 Warn whenever a function parameter is unused aside from its declaration.
3451 To suppress this warning use the @samp{unused} attribute
3452 (@pxref{Variable Attributes}).
3454 @item -Wno-unused-result
3455 @opindex Wunused-result
3456 @opindex Wno-unused-result
3457 Do not warn if a caller of a function marked with attribute
3458 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3459 its return value. The default is @option{-Wunused-result}.
3461 @item -Wunused-variable
3462 @opindex Wunused-variable
3463 @opindex Wno-unused-variable
3464 Warn whenever a local variable or non-constant static variable is unused
3465 aside from its declaration.
3466 This warning is enabled by @option{-Wall}.
3468 To suppress this warning use the @samp{unused} attribute
3469 (@pxref{Variable Attributes}).
3471 @item -Wunused-value
3472 @opindex Wunused-value
3473 @opindex Wno-unused-value
3474 Warn whenever a statement computes a result that is explicitly not
3475 used. To suppress this warning cast the unused expression to
3476 @samp{void}. This includes an expression-statement or the left-hand
3477 side of a comma expression that contains no side effects. For example,
3478 an expression such as @samp{x[i,j]} will cause a warning, while
3479 @samp{x[(void)i,j]} will not.
3481 This warning is enabled by @option{-Wall}.
3483 @item -Wunused
3484 @opindex Wunused
3485 @opindex Wno-unused
3486 All the above @option{-Wunused} options combined.
3488 In order to get a warning about an unused function parameter, you must
3489 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3490 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3492 @item -Wuninitialized
3493 @opindex Wuninitialized
3494 @opindex Wno-uninitialized
3495 Warn if an automatic variable is used without first being initialized
3496 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3497 warn if a non-static reference or non-static @samp{const} member
3498 appears in a class without constructors.
3500 If you want to warn about code which uses the uninitialized value of the
3501 variable in its own initializer, use the @option{-Winit-self} option.
3503 These warnings occur for individual uninitialized or clobbered
3504 elements of structure, union or array variables as well as for
3505 variables which are uninitialized or clobbered as a whole.  They do
3506 not occur for variables or elements declared @code{volatile}.  Because
3507 these warnings depend on optimization, the exact variables or elements
3508 for which there are warnings will depend on the precise optimization
3509 options and version of GCC used.
3511 Note that there may be no warning about a variable that is used only
3512 to compute a value that itself is never used, because such
3513 computations may be deleted by data flow analysis before the warnings
3514 are printed.
3516 These warnings are made optional because GCC is not smart
3517 enough to see all the reasons why the code might be correct
3518 despite appearing to have an error.  Here is one example of how
3519 this can happen:
3521 @smallexample
3522 @group
3524   int x;
3525   switch (y)
3526     @{
3527     case 1: x = 1;
3528       break;
3529     case 2: x = 4;
3530       break;
3531     case 3: x = 5;
3532     @}
3533   foo (x);
3535 @end group
3536 @end smallexample
3538 @noindent
3539 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3540 always initialized, but GCC doesn't know this.  Here is
3541 another common case:
3543 @smallexample
3545   int save_y;
3546   if (change_y) save_y = y, y = new_y;
3547   @dots{}
3548   if (change_y) y = save_y;
3550 @end smallexample
3552 @noindent
3553 This has no bug because @code{save_y} is used only if it is set.
3555 @cindex @code{longjmp} warnings
3556 This option also warns when a non-volatile automatic variable might be
3557 changed by a call to @code{longjmp}.  These warnings as well are possible
3558 only in optimizing compilation.
3560 The compiler sees only the calls to @code{setjmp}.  It cannot know
3561 where @code{longjmp} will be called; in fact, a signal handler could
3562 call it at any point in the code.  As a result, you may get a warning
3563 even when there is in fact no problem because @code{longjmp} cannot
3564 in fact be called at the place which would cause a problem.
3566 Some spurious warnings can be avoided if you declare all the functions
3567 you use that never return as @code{noreturn}.  @xref{Function
3568 Attributes}.
3570 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3572 @item -Wunknown-pragmas
3573 @opindex Wunknown-pragmas
3574 @opindex Wno-unknown-pragmas
3575 @cindex warning for unknown pragmas
3576 @cindex unknown pragmas, warning
3577 @cindex pragmas, warning of unknown
3578 Warn when a #pragma directive is encountered which is not understood by
3579 GCC@.  If this command line option is used, warnings will even be issued
3580 for unknown pragmas in system header files.  This is not the case if
3581 the warnings were only enabled by the @option{-Wall} command line option.
3583 @item -Wno-pragmas
3584 @opindex Wno-pragmas
3585 @opindex Wpragmas
3586 Do not warn about misuses of pragmas, such as incorrect parameters,
3587 invalid syntax, or conflicts between pragmas.  See also
3588 @samp{-Wunknown-pragmas}.
3590 @item -Wstrict-aliasing
3591 @opindex Wstrict-aliasing
3592 @opindex Wno-strict-aliasing
3593 This option is only active when @option{-fstrict-aliasing} is active.
3594 It warns about code which might break the strict aliasing rules that the
3595 compiler is using for optimization.  The warning does not catch all
3596 cases, but does attempt to catch the more common pitfalls.  It is
3597 included in @option{-Wall}.
3598 It is equivalent to @option{-Wstrict-aliasing=3}
3600 @item -Wstrict-aliasing=n
3601 @opindex Wstrict-aliasing=n
3602 @opindex Wno-strict-aliasing=n
3603 This option is only active when @option{-fstrict-aliasing} is active.
3604 It warns about code which might break the strict aliasing rules that the
3605 compiler is using for optimization.
3606 Higher levels correspond to higher accuracy (fewer false positives).
3607 Higher levels also correspond to more effort, similar to the way -O works.
3608 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3609 with n=3.
3611 Level 1: Most aggressive, quick, least accurate.
3612 Possibly useful when higher levels
3613 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3614 false negatives.  However, it has many false positives.
3615 Warns for all pointer conversions between possibly incompatible types,
3616 even if never dereferenced.  Runs in the frontend only.
3618 Level 2: Aggressive, quick, not too precise.
3619 May still have many false positives (not as many as level 1 though),
3620 and few false negatives (but possibly more than level 1).
3621 Unlike level 1, it only warns when an address is taken.  Warns about
3622 incomplete types.  Runs in the frontend only.
3624 Level 3 (default for @option{-Wstrict-aliasing}):
3625 Should have very few false positives and few false
3626 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3627 Takes care of the common pun+dereference pattern in the frontend:
3628 @code{*(int*)&some_float}.
3629 If optimization is enabled, it also runs in the backend, where it deals
3630 with multiple statement cases using flow-sensitive points-to information.
3631 Only warns when the converted pointer is dereferenced.
3632 Does not warn about incomplete types.
3634 @item -Wstrict-overflow
3635 @itemx -Wstrict-overflow=@var{n}
3636 @opindex Wstrict-overflow
3637 @opindex Wno-strict-overflow
3638 This option is only active when @option{-fstrict-overflow} is active.
3639 It warns about cases where the compiler optimizes based on the
3640 assumption that signed overflow does not occur.  Note that it does not
3641 warn about all cases where the code might overflow: it only warns
3642 about cases where the compiler implements some optimization.  Thus
3643 this warning depends on the optimization level.
3645 An optimization which assumes that signed overflow does not occur is
3646 perfectly safe if the values of the variables involved are such that
3647 overflow never does, in fact, occur.  Therefore this warning can
3648 easily give a false positive: a warning about code which is not
3649 actually a problem.  To help focus on important issues, several
3650 warning levels are defined.  No warnings are issued for the use of
3651 undefined signed overflow when estimating how many iterations a loop
3652 will require, in particular when determining whether a loop will be
3653 executed at all.
3655 @table @gcctabopt
3656 @item -Wstrict-overflow=1
3657 Warn about cases which are both questionable and easy to avoid.  For
3658 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3659 compiler will simplify this to @code{1}.  This level of
3660 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3661 are not, and must be explicitly requested.
3663 @item -Wstrict-overflow=2
3664 Also warn about other cases where a comparison is simplified to a
3665 constant.  For example: @code{abs (x) >= 0}.  This can only be
3666 simplified when @option{-fstrict-overflow} is in effect, because
3667 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3668 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3669 @option{-Wstrict-overflow=2}.
3671 @item -Wstrict-overflow=3
3672 Also warn about other cases where a comparison is simplified.  For
3673 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3675 @item -Wstrict-overflow=4
3676 Also warn about other simplifications not covered by the above cases.
3677 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3679 @item -Wstrict-overflow=5
3680 Also warn about cases where the compiler reduces the magnitude of a
3681 constant involved in a comparison.  For example: @code{x + 2 > y} will
3682 be simplified to @code{x + 1 >= y}.  This is reported only at the
3683 highest warning level because this simplification applies to many
3684 comparisons, so this warning level will give a very large number of
3685 false positives.
3686 @end table
3688 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]}
3689 @opindex Wsuggest-attribute=
3690 @opindex Wno-suggest-attribute=
3691 Warn for cases where adding an attribute may be beneficial. The
3692 attributes currently supported are listed below.
3694 @table @gcctabopt
3695 @item -Wsuggest-attribute=pure
3696 @itemx -Wsuggest-attribute=const
3697 @itemx -Wsuggest-attribute=noreturn
3698 @opindex Wsuggest-attribute=pure
3699 @opindex Wno-suggest-attribute=pure
3700 @opindex Wsuggest-attribute=const
3701 @opindex Wno-suggest-attribute=const
3702 @opindex Wsuggest-attribute=noreturn
3703 @opindex Wno-suggest-attribute=noreturn
3705 Warn about functions which might be candidates for attributes
3706 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3707 functions visible in other compilation units or (in the case of @code{pure} and
3708 @code{const}) if it cannot prove that the function returns normally. A function
3709 returns normally if it doesn't contain an infinite loop nor returns abnormally
3710 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3711 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3712 higher.  Higher optimization levels improve the accuracy of the analysis.
3713 @end table
3715 @item -Warray-bounds
3716 @opindex Wno-array-bounds
3717 @opindex Warray-bounds
3718 This option is only active when @option{-ftree-vrp} is active
3719 (default for @option{-O2} and above). It warns about subscripts to arrays
3720 that are always out of bounds. This warning is enabled by @option{-Wall}.
3722 @item -Wno-div-by-zero
3723 @opindex Wno-div-by-zero
3724 @opindex Wdiv-by-zero
3725 Do not warn about compile-time integer division by zero.  Floating point
3726 division by zero is not warned about, as it can be a legitimate way of
3727 obtaining infinities and NaNs.
3729 @item -Wsystem-headers
3730 @opindex Wsystem-headers
3731 @opindex Wno-system-headers
3732 @cindex warnings from system headers
3733 @cindex system headers, warnings from
3734 Print warning messages for constructs found in system header files.
3735 Warnings from system headers are normally suppressed, on the assumption
3736 that they usually do not indicate real problems and would only make the
3737 compiler output harder to read.  Using this command line option tells
3738 GCC to emit warnings from system headers as if they occurred in user
3739 code.  However, note that using @option{-Wall} in conjunction with this
3740 option will @emph{not} warn about unknown pragmas in system
3741 headers---for that, @option{-Wunknown-pragmas} must also be used.
3743 @item -Wtrampolines
3744 @opindex Wtrampolines
3745 @opindex Wno-trampolines
3746  Warn about trampolines generated for pointers to nested functions.
3748  A trampoline is a small piece of data or code that is created at run
3749  time on the stack when the address of a nested function is taken, and
3750  is used to call the nested function indirectly.  For some targets, it
3751  is made up of data only and thus requires no special treatment.  But,
3752  for most targets, it is made up of code and thus requires the stack
3753  to be made executable in order for the program to work properly.
3755 @item -Wfloat-equal
3756 @opindex Wfloat-equal
3757 @opindex Wno-float-equal
3758 Warn if floating point values are used in equality comparisons.
3760 The idea behind this is that sometimes it is convenient (for the
3761 programmer) to consider floating-point values as approximations to
3762 infinitely precise real numbers.  If you are doing this, then you need
3763 to compute (by analyzing the code, or in some other way) the maximum or
3764 likely maximum error that the computation introduces, and allow for it
3765 when performing comparisons (and when producing output, but that's a
3766 different problem).  In particular, instead of testing for equality, you
3767 would check to see whether the two values have ranges that overlap; and
3768 this is done with the relational operators, so equality comparisons are
3769 probably mistaken.
3771 @item -Wtraditional @r{(C and Objective-C only)}
3772 @opindex Wtraditional
3773 @opindex Wno-traditional
3774 Warn about certain constructs that behave differently in traditional and
3775 ISO C@.  Also warn about ISO C constructs that have no traditional C
3776 equivalent, and/or problematic constructs which should be avoided.
3778 @itemize @bullet
3779 @item
3780 Macro parameters that appear within string literals in the macro body.
3781 In traditional C macro replacement takes place within string literals,
3782 but does not in ISO C@.
3784 @item
3785 In traditional C, some preprocessor directives did not exist.
3786 Traditional preprocessors would only consider a line to be a directive
3787 if the @samp{#} appeared in column 1 on the line.  Therefore
3788 @option{-Wtraditional} warns about directives that traditional C
3789 understands but would ignore because the @samp{#} does not appear as the
3790 first character on the line.  It also suggests you hide directives like
3791 @samp{#pragma} not understood by traditional C by indenting them.  Some
3792 traditional implementations would not recognize @samp{#elif}, so it
3793 suggests avoiding it altogether.
3795 @item
3796 A function-like macro that appears without arguments.
3798 @item
3799 The unary plus operator.
3801 @item
3802 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3803 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3804 constants.)  Note, these suffixes appear in macros defined in the system
3805 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3806 Use of these macros in user code might normally lead to spurious
3807 warnings, however GCC's integrated preprocessor has enough context to
3808 avoid warning in these cases.
3810 @item
3811 A function declared external in one block and then used after the end of
3812 the block.
3814 @item
3815 A @code{switch} statement has an operand of type @code{long}.
3817 @item
3818 A non-@code{static} function declaration follows a @code{static} one.
3819 This construct is not accepted by some traditional C compilers.
3821 @item
3822 The ISO type of an integer constant has a different width or
3823 signedness from its traditional type.  This warning is only issued if
3824 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3825 typically represent bit patterns, are not warned about.
3827 @item
3828 Usage of ISO string concatenation is detected.
3830 @item
3831 Initialization of automatic aggregates.
3833 @item
3834 Identifier conflicts with labels.  Traditional C lacks a separate
3835 namespace for labels.
3837 @item
3838 Initialization of unions.  If the initializer is zero, the warning is
3839 omitted.  This is done under the assumption that the zero initializer in
3840 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3841 initializer warnings and relies on default initialization to zero in the
3842 traditional C case.
3844 @item
3845 Conversions by prototypes between fixed/floating point values and vice
3846 versa.  The absence of these prototypes when compiling with traditional
3847 C would cause serious problems.  This is a subset of the possible
3848 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3850 @item
3851 Use of ISO C style function definitions.  This warning intentionally is
3852 @emph{not} issued for prototype declarations or variadic functions
3853 because these ISO C features will appear in your code when using
3854 libiberty's traditional C compatibility macros, @code{PARAMS} and
3855 @code{VPARAMS}.  This warning is also bypassed for nested functions
3856 because that feature is already a GCC extension and thus not relevant to
3857 traditional C compatibility.
3858 @end itemize
3860 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3861 @opindex Wtraditional-conversion
3862 @opindex Wno-traditional-conversion
3863 Warn if a prototype causes a type conversion that is different from what
3864 would happen to the same argument in the absence of a prototype.  This
3865 includes conversions of fixed point to floating and vice versa, and
3866 conversions changing the width or signedness of a fixed point argument
3867 except when the same as the default promotion.
3869 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3870 @opindex Wdeclaration-after-statement
3871 @opindex Wno-declaration-after-statement
3872 Warn when a declaration is found after a statement in a block.  This
3873 construct, known from C++, was introduced with ISO C99 and is by default
3874 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3875 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3877 @item -Wundef
3878 @opindex Wundef
3879 @opindex Wno-undef
3880 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3882 @item -Wno-endif-labels
3883 @opindex Wno-endif-labels
3884 @opindex Wendif-labels
3885 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3887 @item -Wshadow
3888 @opindex Wshadow
3889 @opindex Wno-shadow
3890 Warn whenever a local variable or type declaration shadows another variable,
3891 parameter, type, or class member (in C++), or whenever a built-in function
3892 is shadowed. Note that in C++, the compiler will not warn if a local variable
3893 shadows a struct/class/enum, but will warn if it shadows an explicit typedef.
3895 @item -Wlarger-than=@var{len}
3896 @opindex Wlarger-than=@var{len}
3897 @opindex Wlarger-than-@var{len}
3898 Warn whenever an object of larger than @var{len} bytes is defined.
3900 @item -Wframe-larger-than=@var{len}
3901 @opindex Wframe-larger-than
3902 Warn if the size of a function frame is larger than @var{len} bytes.
3903 The computation done to determine the stack frame size is approximate
3904 and not conservative.
3905 The actual requirements may be somewhat greater than @var{len}
3906 even if you do not get a warning.  In addition, any space allocated
3907 via @code{alloca}, variable-length arrays, or related constructs
3908 is not included by the compiler when determining
3909 whether or not to issue a warning.
3911 @item -Wunsafe-loop-optimizations
3912 @opindex Wunsafe-loop-optimizations
3913 @opindex Wno-unsafe-loop-optimizations
3914 Warn if the loop cannot be optimized because the compiler could not
3915 assume anything on the bounds of the loop indices.  With
3916 @option{-funsafe-loop-optimizations} warn if the compiler made
3917 such assumptions.
3919 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3920 @opindex Wno-pedantic-ms-format
3921 @opindex Wpedantic-ms-format
3922 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3923 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3924 depending on the MS runtime, when you are using the options @option{-Wformat}
3925 and @option{-pedantic} without gnu-extensions.
3927 @item -Wpointer-arith
3928 @opindex Wpointer-arith
3929 @opindex Wno-pointer-arith
3930 Warn about anything that depends on the ``size of'' a function type or
3931 of @code{void}.  GNU C assigns these types a size of 1, for
3932 convenience in calculations with @code{void *} pointers and pointers
3933 to functions.  In C++, warn also when an arithmetic operation involves
3934 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3936 @item -Wtype-limits
3937 @opindex Wtype-limits
3938 @opindex Wno-type-limits
3939 Warn if a comparison is always true or always false due to the limited
3940 range of the data type, but do not warn for constant expressions.  For
3941 example, warn if an unsigned variable is compared against zero with
3942 @samp{<} or @samp{>=}.  This warning is also enabled by
3943 @option{-Wextra}.
3945 @item -Wbad-function-cast @r{(C and Objective-C only)}
3946 @opindex Wbad-function-cast
3947 @opindex Wno-bad-function-cast
3948 Warn whenever a function call is cast to a non-matching type.
3949 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3951 @item -Wc++-compat @r{(C and Objective-C only)}
3952 Warn about ISO C constructs that are outside of the common subset of
3953 ISO C and ISO C++, e.g.@: request for implicit conversion from
3954 @code{void *} to a pointer to non-@code{void} type.
3956 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3957 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3958 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3959 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3961 @item -Wcast-qual
3962 @opindex Wcast-qual
3963 @opindex Wno-cast-qual
3964 Warn whenever a pointer is cast so as to remove a type qualifier from
3965 the target type.  For example, warn if a @code{const char *} is cast
3966 to an ordinary @code{char *}.
3968 Also warn when making a cast which introduces a type qualifier in an
3969 unsafe way.  For example, casting @code{char **} to @code{const char **}
3970 is unsafe, as in this example:
3972 @smallexample
3973   /* p is char ** value.  */
3974   const char **q = (const char **) p;
3975   /* Assignment of readonly string to const char * is OK.  */
3976   *q = "string";
3977   /* Now char** pointer points to read-only memory.  */
3978   **p = 'b';
3979 @end smallexample
3981 @item -Wcast-align
3982 @opindex Wcast-align
3983 @opindex Wno-cast-align
3984 Warn whenever a pointer is cast such that the required alignment of the
3985 target is increased.  For example, warn if a @code{char *} is cast to
3986 an @code{int *} on machines where integers can only be accessed at
3987 two- or four-byte boundaries.
3989 @item -Wwrite-strings
3990 @opindex Wwrite-strings
3991 @opindex Wno-write-strings
3992 When compiling C, give string constants the type @code{const
3993 char[@var{length}]} so that copying the address of one into a
3994 non-@code{const} @code{char *} pointer will get a warning.  These
3995 warnings will help you find at compile time code that can try to write
3996 into a string constant, but only if you have been very careful about
3997 using @code{const} in declarations and prototypes.  Otherwise, it will
3998 just be a nuisance. This is why we did not make @option{-Wall} request
3999 these warnings.
4001 When compiling C++, warn about the deprecated conversion from string
4002 literals to @code{char *}.  This warning is enabled by default for C++
4003 programs.
4005 @item -Wclobbered
4006 @opindex Wclobbered
4007 @opindex Wno-clobbered
4008 Warn for variables that might be changed by @samp{longjmp} or
4009 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4011 @item -Wconversion
4012 @opindex Wconversion
4013 @opindex Wno-conversion
4014 Warn for implicit conversions that may alter a value. This includes
4015 conversions between real and integer, like @code{abs (x)} when
4016 @code{x} is @code{double}; conversions between signed and unsigned,
4017 like @code{unsigned ui = -1}; and conversions to smaller types, like
4018 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4019 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4020 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4021 conversions between signed and unsigned integers can be disabled by
4022 using @option{-Wno-sign-conversion}.
4024 For C++, also warn for confusing overload resolution for user-defined
4025 conversions; and conversions that will never use a type conversion
4026 operator: conversions to @code{void}, the same type, a base class or a
4027 reference to them. Warnings about conversions between signed and
4028 unsigned integers are disabled by default in C++ unless
4029 @option{-Wsign-conversion} is explicitly enabled.
4031 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4032 @opindex Wconversion-null
4033 @opindex Wno-conversion-null
4034 Do not warn for conversions between @code{NULL} and non-pointer
4035 types. @option{-Wconversion-null} is enabled by default.
4037 @item -Wempty-body
4038 @opindex Wempty-body
4039 @opindex Wno-empty-body
4040 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4041 while} statement.  This warning is also enabled by @option{-Wextra}.
4043 @item -Wenum-compare
4044 @opindex Wenum-compare
4045 @opindex Wno-enum-compare
4046 Warn about a comparison between values of different enum types. In C++
4047 this warning is enabled by default.  In C this warning is enabled by
4048 @option{-Wall}.
4050 @item -Wjump-misses-init @r{(C, Objective-C only)}
4051 @opindex Wjump-misses-init
4052 @opindex Wno-jump-misses-init
4053 Warn if a @code{goto} statement or a @code{switch} statement jumps
4054 forward across the initialization of a variable, or jumps backward to a
4055 label after the variable has been initialized.  This only warns about
4056 variables which are initialized when they are declared.  This warning is
4057 only supported for C and Objective C; in C++ this sort of branch is an
4058 error in any case.
4060 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4061 can be disabled with the @option{-Wno-jump-misses-init} option.
4063 @item -Wsign-compare
4064 @opindex Wsign-compare
4065 @opindex Wno-sign-compare
4066 @cindex warning for comparison of signed and unsigned values
4067 @cindex comparison of signed and unsigned values, warning
4068 @cindex signed and unsigned values, comparison warning
4069 Warn when a comparison between signed and unsigned values could produce
4070 an incorrect result when the signed value is converted to unsigned.
4071 This warning is also enabled by @option{-Wextra}; to get the other warnings
4072 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
4074 @item -Wsign-conversion
4075 @opindex Wsign-conversion
4076 @opindex Wno-sign-conversion
4077 Warn for implicit conversions that may change the sign of an integer
4078 value, like assigning a signed integer expression to an unsigned
4079 integer variable. An explicit cast silences the warning. In C, this
4080 option is enabled also by @option{-Wconversion}.
4082 @item -Waddress
4083 @opindex Waddress
4084 @opindex Wno-address
4085 Warn about suspicious uses of memory addresses. These include using
4086 the address of a function in a conditional expression, such as
4087 @code{void func(void); if (func)}, and comparisons against the memory
4088 address of a string literal, such as @code{if (x == "abc")}.  Such
4089 uses typically indicate a programmer error: the address of a function
4090 always evaluates to true, so their use in a conditional usually
4091 indicate that the programmer forgot the parentheses in a function
4092 call; and comparisons against string literals result in unspecified
4093 behavior and are not portable in C, so they usually indicate that the
4094 programmer intended to use @code{strcmp}.  This warning is enabled by
4095 @option{-Wall}.
4097 @item -Wlogical-op
4098 @opindex Wlogical-op
4099 @opindex Wno-logical-op
4100 Warn about suspicious uses of logical operators in expressions.
4101 This includes using logical operators in contexts where a
4102 bit-wise operator is likely to be expected.
4104 @item -Waggregate-return
4105 @opindex Waggregate-return
4106 @opindex Wno-aggregate-return
4107 Warn if any functions that return structures or unions are defined or
4108 called.  (In languages where you can return an array, this also elicits
4109 a warning.)
4111 @item -Wno-attributes
4112 @opindex Wno-attributes
4113 @opindex Wattributes
4114 Do not warn if an unexpected @code{__attribute__} is used, such as
4115 unrecognized attributes, function attributes applied to variables,
4116 etc.  This will not stop errors for incorrect use of supported
4117 attributes.
4119 @item -Wno-builtin-macro-redefined
4120 @opindex Wno-builtin-macro-redefined
4121 @opindex Wbuiltin-macro-redefined
4122 Do not warn if certain built-in macros are redefined.  This suppresses
4123 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4124 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4126 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4127 @opindex Wstrict-prototypes
4128 @opindex Wno-strict-prototypes
4129 Warn if a function is declared or defined without specifying the
4130 argument types.  (An old-style function definition is permitted without
4131 a warning if preceded by a declaration which specifies the argument
4132 types.)
4134 @item -Wold-style-declaration @r{(C and Objective-C only)}
4135 @opindex Wold-style-declaration
4136 @opindex Wno-old-style-declaration
4137 Warn for obsolescent usages, according to the C Standard, in a
4138 declaration. For example, warn if storage-class specifiers like
4139 @code{static} are not the first things in a declaration.  This warning
4140 is also enabled by @option{-Wextra}.
4142 @item -Wold-style-definition @r{(C and Objective-C only)}
4143 @opindex Wold-style-definition
4144 @opindex Wno-old-style-definition
4145 Warn if an old-style function definition is used.  A warning is given
4146 even if there is a previous prototype.
4148 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4149 @opindex Wmissing-parameter-type
4150 @opindex Wno-missing-parameter-type
4151 A function parameter is declared without a type specifier in K&R-style
4152 functions:
4154 @smallexample
4155 void foo(bar) @{ @}
4156 @end smallexample
4158 This warning is also enabled by @option{-Wextra}.
4160 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4161 @opindex Wmissing-prototypes
4162 @opindex Wno-missing-prototypes
4163 Warn if a global function is defined without a previous prototype
4164 declaration.  This warning is issued even if the definition itself
4165 provides a prototype.  The aim is to detect global functions that fail
4166 to be declared in header files.
4168 @item -Wmissing-declarations
4169 @opindex Wmissing-declarations
4170 @opindex Wno-missing-declarations
4171 Warn if a global function is defined without a previous declaration.
4172 Do so even if the definition itself provides a prototype.
4173 Use this option to detect global functions that are not declared in
4174 header files.  In C++, no warnings are issued for function templates,
4175 or for inline functions, or for functions in anonymous namespaces.
4177 @item -Wmissing-field-initializers
4178 @opindex Wmissing-field-initializers
4179 @opindex Wno-missing-field-initializers
4180 @opindex W
4181 @opindex Wextra
4182 @opindex Wno-extra
4183 Warn if a structure's initializer has some fields missing.  For
4184 example, the following code would cause such a warning, because
4185 @code{x.h} is implicitly zero:
4187 @smallexample
4188 struct s @{ int f, g, h; @};
4189 struct s x = @{ 3, 4 @};
4190 @end smallexample
4192 This option does not warn about designated initializers, so the following
4193 modification would not trigger a warning:
4195 @smallexample
4196 struct s @{ int f, g, h; @};
4197 struct s x = @{ .f = 3, .g = 4 @};
4198 @end smallexample
4200 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4201 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4203 @item -Wmissing-format-attribute
4204 @opindex Wmissing-format-attribute
4205 @opindex Wno-missing-format-attribute
4206 @opindex Wformat
4207 @opindex Wno-format
4208 Warn about function pointers which might be candidates for @code{format}
4209 attributes.  Note these are only possible candidates, not absolute ones.
4210 GCC will guess that function pointers with @code{format} attributes that
4211 are used in assignment, initialization, parameter passing or return
4212 statements should have a corresponding @code{format} attribute in the
4213 resulting type.  I.e.@: the left-hand side of the assignment or
4214 initialization, the type of the parameter variable, or the return type
4215 of the containing function respectively should also have a @code{format}
4216 attribute to avoid the warning.
4218 GCC will also warn about function definitions which might be
4219 candidates for @code{format} attributes.  Again, these are only
4220 possible candidates.  GCC will guess that @code{format} attributes
4221 might be appropriate for any function that calls a function like
4222 @code{vprintf} or @code{vscanf}, but this might not always be the
4223 case, and some functions for which @code{format} attributes are
4224 appropriate may not be detected.
4226 @item -Wno-multichar
4227 @opindex Wno-multichar
4228 @opindex Wmultichar
4229 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4230 Usually they indicate a typo in the user's code, as they have
4231 implementation-defined values, and should not be used in portable code.
4233 @item -Wnormalized=<none|id|nfc|nfkc>
4234 @opindex Wnormalized=
4235 @cindex NFC
4236 @cindex NFKC
4237 @cindex character set, input normalization
4238 In ISO C and ISO C++, two identifiers are different if they are
4239 different sequences of characters.  However, sometimes when characters
4240 outside the basic ASCII character set are used, you can have two
4241 different character sequences that look the same.  To avoid confusion,
4242 the ISO 10646 standard sets out some @dfn{normalization rules} which
4243 when applied ensure that two sequences that look the same are turned into
4244 the same sequence.  GCC can warn you if you are using identifiers which
4245 have not been normalized; this option controls that warning.
4247 There are four levels of warning that GCC supports.  The default is
4248 @option{-Wnormalized=nfc}, which warns about any identifier which is
4249 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4250 recommended form for most uses.
4252 Unfortunately, there are some characters which ISO C and ISO C++ allow
4253 in identifiers that when turned into NFC aren't allowable as
4254 identifiers.  That is, there's no way to use these symbols in portable
4255 ISO C or C++ and have all your identifiers in NFC@.
4256 @option{-Wnormalized=id} suppresses the warning for these characters.
4257 It is hoped that future versions of the standards involved will correct
4258 this, which is why this option is not the default.
4260 You can switch the warning off for all characters by writing
4261 @option{-Wnormalized=none}.  You would only want to do this if you
4262 were using some other normalization scheme (like ``D''), because
4263 otherwise you can easily create bugs that are literally impossible to see.
4265 Some characters in ISO 10646 have distinct meanings but look identical
4266 in some fonts or display methodologies, especially once formatting has
4267 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4268 LETTER N'', will display just like a regular @code{n} which has been
4269 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4270 normalization scheme to convert all these into a standard form as
4271 well, and GCC will warn if your code is not in NFKC if you use
4272 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4273 about every identifier that contains the letter O because it might be
4274 confused with the digit 0, and so is not the default, but may be
4275 useful as a local coding convention if the programming environment is
4276 unable to be fixed to display these characters distinctly.
4278 @item -Wno-deprecated
4279 @opindex Wno-deprecated
4280 @opindex Wdeprecated
4281 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4283 @item -Wno-deprecated-declarations
4284 @opindex Wno-deprecated-declarations
4285 @opindex Wdeprecated-declarations
4286 Do not warn about uses of functions (@pxref{Function Attributes}),
4287 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4288 Attributes}) marked as deprecated by using the @code{deprecated}
4289 attribute.
4291 @item -Wno-overflow
4292 @opindex Wno-overflow
4293 @opindex Woverflow
4294 Do not warn about compile-time overflow in constant expressions.
4296 @item -Woverride-init @r{(C and Objective-C only)}
4297 @opindex Woverride-init
4298 @opindex Wno-override-init
4299 @opindex W
4300 @opindex Wextra
4301 @opindex Wno-extra
4302 Warn if an initialized field without side effects is overridden when
4303 using designated initializers (@pxref{Designated Inits, , Designated
4304 Initializers}).
4306 This warning is included in @option{-Wextra}.  To get other
4307 @option{-Wextra} warnings without this one, use @samp{-Wextra
4308 -Wno-override-init}.
4310 @item -Wpacked
4311 @opindex Wpacked
4312 @opindex Wno-packed
4313 Warn if a structure is given the packed attribute, but the packed
4314 attribute has no effect on the layout or size of the structure.
4315 Such structures may be mis-aligned for little benefit.  For
4316 instance, in this code, the variable @code{f.x} in @code{struct bar}
4317 will be misaligned even though @code{struct bar} does not itself
4318 have the packed attribute:
4320 @smallexample
4321 @group
4322 struct foo @{
4323   int x;
4324   char a, b, c, d;
4325 @} __attribute__((packed));
4326 struct bar @{
4327   char z;
4328   struct foo f;
4330 @end group
4331 @end smallexample
4333 @item -Wpacked-bitfield-compat
4334 @opindex Wpacked-bitfield-compat
4335 @opindex Wno-packed-bitfield-compat
4336 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4337 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4338 the change can lead to differences in the structure layout.  GCC
4339 informs you when the offset of such a field has changed in GCC 4.4.
4340 For example there is no longer a 4-bit padding between field @code{a}
4341 and @code{b} in this structure:
4343 @smallexample
4344 struct foo
4346   char a:4;
4347   char b:8;
4348 @} __attribute__ ((packed));
4349 @end smallexample
4351 This warning is enabled by default.  Use
4352 @option{-Wno-packed-bitfield-compat} to disable this warning.
4354 @item -Wpadded
4355 @opindex Wpadded
4356 @opindex Wno-padded
4357 Warn if padding is included in a structure, either to align an element
4358 of the structure or to align the whole structure.  Sometimes when this
4359 happens it is possible to rearrange the fields of the structure to
4360 reduce the padding and so make the structure smaller.
4362 @item -Wredundant-decls
4363 @opindex Wredundant-decls
4364 @opindex Wno-redundant-decls
4365 Warn if anything is declared more than once in the same scope, even in
4366 cases where multiple declaration is valid and changes nothing.
4368 @item -Wnested-externs @r{(C and Objective-C only)}
4369 @opindex Wnested-externs
4370 @opindex Wno-nested-externs
4371 Warn if an @code{extern} declaration is encountered within a function.
4373 @item -Winline
4374 @opindex Winline
4375 @opindex Wno-inline
4376 Warn if a function can not be inlined and it was declared as inline.
4377 Even with this option, the compiler will not warn about failures to
4378 inline functions declared in system headers.
4380 The compiler uses a variety of heuristics to determine whether or not
4381 to inline a function.  For example, the compiler takes into account
4382 the size of the function being inlined and the amount of inlining
4383 that has already been done in the current function.  Therefore,
4384 seemingly insignificant changes in the source program can cause the
4385 warnings produced by @option{-Winline} to appear or disappear.
4387 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4388 @opindex Wno-invalid-offsetof
4389 @opindex Winvalid-offsetof
4390 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4391 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4392 to a non-POD type is undefined.  In existing C++ implementations,
4393 however, @samp{offsetof} typically gives meaningful results even when
4394 applied to certain kinds of non-POD types. (Such as a simple
4395 @samp{struct} that fails to be a POD type only by virtue of having a
4396 constructor.)  This flag is for users who are aware that they are
4397 writing nonportable code and who have deliberately chosen to ignore the
4398 warning about it.
4400 The restrictions on @samp{offsetof} may be relaxed in a future version
4401 of the C++ standard.
4403 @item -Wno-int-to-pointer-cast
4404 @opindex Wno-int-to-pointer-cast
4405 @opindex Wint-to-pointer-cast
4406 Suppress warnings from casts to pointer type of an integer of a
4407 different size. In C++, casting to a pointer type of smaller size is
4408 an error. @option{Wint-to-pointer-cast} is enabled by default.
4411 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4412 @opindex Wno-pointer-to-int-cast
4413 @opindex Wpointer-to-int-cast
4414 Suppress warnings from casts from a pointer to an integer type of a
4415 different size.
4417 @item -Winvalid-pch
4418 @opindex Winvalid-pch
4419 @opindex Wno-invalid-pch
4420 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4421 the search path but can't be used.
4423 @item -Wlong-long
4424 @opindex Wlong-long
4425 @opindex Wno-long-long
4426 Warn if @samp{long long} type is used.  This is enabled by either
4427 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4428 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4430 @item -Wvariadic-macros
4431 @opindex Wvariadic-macros
4432 @opindex Wno-variadic-macros
4433 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4434 alternate syntax when in pedantic ISO C99 mode.  This is default.
4435 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4437 @item -Wvla
4438 @opindex Wvla
4439 @opindex Wno-vla
4440 Warn if variable length array is used in the code.
4441 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4442 the variable length array.
4444 @item -Wvolatile-register-var
4445 @opindex Wvolatile-register-var
4446 @opindex Wno-volatile-register-var
4447 Warn if a register variable is declared volatile.  The volatile
4448 modifier does not inhibit all optimizations that may eliminate reads
4449 and/or writes to register variables.  This warning is enabled by
4450 @option{-Wall}.
4452 @item -Wdisabled-optimization
4453 @opindex Wdisabled-optimization
4454 @opindex Wno-disabled-optimization
4455 Warn if a requested optimization pass is disabled.  This warning does
4456 not generally indicate that there is anything wrong with your code; it
4457 merely indicates that GCC's optimizers were unable to handle the code
4458 effectively.  Often, the problem is that your code is too big or too
4459 complex; GCC will refuse to optimize programs when the optimization
4460 itself is likely to take inordinate amounts of time.
4462 @item -Wpointer-sign @r{(C and Objective-C only)}
4463 @opindex Wpointer-sign
4464 @opindex Wno-pointer-sign
4465 Warn for pointer argument passing or assignment with different signedness.
4466 This option is only supported for C and Objective-C@.  It is implied by
4467 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4468 @option{-Wno-pointer-sign}.
4470 @item -Wstack-protector
4471 @opindex Wstack-protector
4472 @opindex Wno-stack-protector
4473 This option is only active when @option{-fstack-protector} is active.  It
4474 warns about functions that will not be protected against stack smashing.
4476 @item -Wno-mudflap
4477 @opindex Wno-mudflap
4478 Suppress warnings about constructs that cannot be instrumented by
4479 @option{-fmudflap}.
4481 @item -Woverlength-strings
4482 @opindex Woverlength-strings
4483 @opindex Wno-overlength-strings
4484 Warn about string constants which are longer than the ``minimum
4485 maximum'' length specified in the C standard.  Modern compilers
4486 generally allow string constants which are much longer than the
4487 standard's minimum limit, but very portable programs should avoid
4488 using longer strings.
4490 The limit applies @emph{after} string constant concatenation, and does
4491 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4492 C99, it was raised to 4095.  C++98 does not specify a normative
4493 minimum maximum, so we do not diagnose overlength strings in C++@.
4495 This option is implied by @option{-pedantic}, and can be disabled with
4496 @option{-Wno-overlength-strings}.
4498 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4499 @opindex Wunsuffixed-float-constants
4501 GCC will issue a warning for any floating constant that does not have
4502 a suffix.  When used together with @option{-Wsystem-headers} it will
4503 warn about such constants in system header files.  This can be useful
4504 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4505 from the decimal floating-point extension to C99.
4506 @end table
4508 @node Debugging Options
4509 @section Options for Debugging Your Program or GCC
4510 @cindex options, debugging
4511 @cindex debugging information options
4513 GCC has various special options that are used for debugging
4514 either your program or GCC:
4516 @table @gcctabopt
4517 @item -g
4518 @opindex g
4519 Produce debugging information in the operating system's native format
4520 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4521 information.
4523 On most systems that use stabs format, @option{-g} enables use of extra
4524 debugging information that only GDB can use; this extra information
4525 makes debugging work better in GDB but will probably make other debuggers
4526 crash or
4527 refuse to read the program.  If you want to control for certain whether
4528 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4529 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4531 GCC allows you to use @option{-g} with
4532 @option{-O}.  The shortcuts taken by optimized code may occasionally
4533 produce surprising results: some variables you declared may not exist
4534 at all; flow of control may briefly move where you did not expect it;
4535 some statements may not be executed because they compute constant
4536 results or their values were already at hand; some statements may
4537 execute in different places because they were moved out of loops.
4539 Nevertheless it proves possible to debug optimized output.  This makes
4540 it reasonable to use the optimizer for programs that might have bugs.
4542 The following options are useful when GCC is generated with the
4543 capability for more than one debugging format.
4545 @item -ggdb
4546 @opindex ggdb
4547 Produce debugging information for use by GDB@.  This means to use the
4548 most expressive format available (DWARF 2, stabs, or the native format
4549 if neither of those are supported), including GDB extensions if at all
4550 possible.
4552 @item -gstabs
4553 @opindex gstabs
4554 Produce debugging information in stabs format (if that is supported),
4555 without GDB extensions.  This is the format used by DBX on most BSD
4556 systems.  On MIPS, Alpha and System V Release 4 systems this option
4557 produces stabs debugging output which is not understood by DBX or SDB@.
4558 On System V Release 4 systems this option requires the GNU assembler.
4560 @item -feliminate-unused-debug-symbols
4561 @opindex feliminate-unused-debug-symbols
4562 Produce debugging information in stabs format (if that is supported),
4563 for only symbols that are actually used.
4565 @item -femit-class-debug-always
4566 Instead of emitting debugging information for a C++ class in only one
4567 object file, emit it in all object files using the class.  This option
4568 should be used only with debuggers that are unable to handle the way GCC
4569 normally emits debugging information for classes because using this
4570 option will increase the size of debugging information by as much as a
4571 factor of two.
4573 @item -gstabs+
4574 @opindex gstabs+
4575 Produce debugging information in stabs format (if that is supported),
4576 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4577 use of these extensions is likely to make other debuggers crash or
4578 refuse to read the program.
4580 @item -gcoff
4581 @opindex gcoff
4582 Produce debugging information in COFF format (if that is supported).
4583 This is the format used by SDB on most System V systems prior to
4584 System V Release 4.
4586 @item -gxcoff
4587 @opindex gxcoff
4588 Produce debugging information in XCOFF format (if that is supported).
4589 This is the format used by the DBX debugger on IBM RS/6000 systems.
4591 @item -gxcoff+
4592 @opindex gxcoff+
4593 Produce debugging information in XCOFF format (if that is supported),
4594 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4595 use of these extensions is likely to make other debuggers crash or
4596 refuse to read the program, and may cause assemblers other than the GNU
4597 assembler (GAS) to fail with an error.
4599 @item -gdwarf-@var{version}
4600 @opindex gdwarf-@var{version}
4601 Produce debugging information in DWARF format (if that is
4602 supported).  This is the format used by DBX on IRIX 6.  The value
4603 of @var{version} may be either 2, 3 or 4; the default version is 2.
4605 Note that with DWARF version 2 some ports require, and will always
4606 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4608 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4609 for maximum benefit.
4611 @item -gstrict-dwarf
4612 @opindex gstrict-dwarf
4613 Disallow using extensions of later DWARF standard version than selected
4614 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4615 DWARF extensions from later standard versions is allowed.
4617 @item -gno-strict-dwarf
4618 @opindex gno-strict-dwarf
4619 Allow using extensions of later DWARF standard version than selected with
4620 @option{-gdwarf-@var{version}}.
4622 @item -gvms
4623 @opindex gvms
4624 Produce debugging information in VMS debug format (if that is
4625 supported).  This is the format used by DEBUG on VMS systems.
4627 @item -g@var{level}
4628 @itemx -ggdb@var{level}
4629 @itemx -gstabs@var{level}
4630 @itemx -gcoff@var{level}
4631 @itemx -gxcoff@var{level}
4632 @itemx -gvms@var{level}
4633 Request debugging information and also use @var{level} to specify how
4634 much information.  The default level is 2.
4636 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4637 @option{-g}.
4639 Level 1 produces minimal information, enough for making backtraces in
4640 parts of the program that you don't plan to debug.  This includes
4641 descriptions of functions and external variables, but no information
4642 about local variables and no line numbers.
4644 Level 3 includes extra information, such as all the macro definitions
4645 present in the program.  Some debuggers support macro expansion when
4646 you use @option{-g3}.
4648 @option{-gdwarf-2} does not accept a concatenated debug level, because
4649 GCC used to support an option @option{-gdwarf} that meant to generate
4650 debug information in version 1 of the DWARF format (which is very
4651 different from version 2), and it would have been too confusing.  That
4652 debug format is long obsolete, but the option cannot be changed now.
4653 Instead use an additional @option{-g@var{level}} option to change the
4654 debug level for DWARF.
4656 @item -gtoggle
4657 @opindex gtoggle
4658 Turn off generation of debug info, if leaving out this option would have
4659 generated it, or turn it on at level 2 otherwise.  The position of this
4660 argument in the command line does not matter, it takes effect after all
4661 other options are processed, and it does so only once, no matter how
4662 many times it is given.  This is mainly intended to be used with
4663 @option{-fcompare-debug}.
4665 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4666 @opindex fdump-final-insns
4667 Dump the final internal representation (RTL) to @var{file}.  If the
4668 optional argument is omitted (or if @var{file} is @code{.}), the name
4669 of the dump file will be determined by appending @code{.gkd} to the
4670 compilation output file name.
4672 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4673 @opindex fcompare-debug
4674 @opindex fno-compare-debug
4675 If no error occurs during compilation, run the compiler a second time,
4676 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4677 passed to the second compilation.  Dump the final internal
4678 representation in both compilations, and print an error if they differ.
4680 If the equal sign is omitted, the default @option{-gtoggle} is used.
4682 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4683 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4684 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4685 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4686 is used.
4688 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4689 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4690 of the final representation and the second compilation, preventing even
4691 @env{GCC_COMPARE_DEBUG} from taking effect.
4693 To verify full coverage during @option{-fcompare-debug} testing, set
4694 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4695 which GCC will reject as an invalid option in any actual compilation
4696 (rather than preprocessing, assembly or linking).  To get just a
4697 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4698 not overridden} will do.
4700 @item -fcompare-debug-second
4701 @opindex fcompare-debug-second
4702 This option is implicitly passed to the compiler for the second
4703 compilation requested by @option{-fcompare-debug}, along with options to
4704 silence warnings, and omitting other options that would cause
4705 side-effect compiler outputs to files or to the standard output.  Dump
4706 files and preserved temporary files are renamed so as to contain the
4707 @code{.gk} additional extension during the second compilation, to avoid
4708 overwriting those generated by the first.
4710 When this option is passed to the compiler driver, it causes the
4711 @emph{first} compilation to be skipped, which makes it useful for little
4712 other than debugging the compiler proper.
4714 @item -feliminate-dwarf2-dups
4715 @opindex feliminate-dwarf2-dups
4716 Compress DWARF2 debugging information by eliminating duplicated
4717 information about each symbol.  This option only makes sense when
4718 generating DWARF2 debugging information with @option{-gdwarf-2}.
4720 @item -femit-struct-debug-baseonly
4721 Emit debug information for struct-like types
4722 only when the base name of the compilation source file
4723 matches the base name of file in which the struct was defined.
4725 This option substantially reduces the size of debugging information,
4726 but at significant potential loss in type information to the debugger.
4727 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4728 See @option{-femit-struct-debug-detailed} for more detailed control.
4730 This option works only with DWARF 2.
4732 @item -femit-struct-debug-reduced
4733 Emit debug information for struct-like types
4734 only when the base name of the compilation source file
4735 matches the base name of file in which the type was defined,
4736 unless the struct is a template or defined in a system header.
4738 This option significantly reduces the size of debugging information,
4739 with some potential loss in type information to the debugger.
4740 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4741 See @option{-femit-struct-debug-detailed} for more detailed control.
4743 This option works only with DWARF 2.
4745 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4746 Specify the struct-like types
4747 for which the compiler will generate debug information.
4748 The intent is to reduce duplicate struct debug information
4749 between different object files within the same program.
4751 This option is a detailed version of
4752 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4753 which will serve for most needs.
4755 A specification has the syntax
4756 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4758 The optional first word limits the specification to
4759 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4760 A struct type is used directly when it is the type of a variable, member.
4761 Indirect uses arise through pointers to structs.
4762 That is, when use of an incomplete struct would be legal, the use is indirect.
4763 An example is
4764 @samp{struct one direct; struct two * indirect;}.
4766 The optional second word limits the specification to
4767 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4768 Generic structs are a bit complicated to explain.
4769 For C++, these are non-explicit specializations of template classes,
4770 or non-template classes within the above.
4771 Other programming languages have generics,
4772 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4774 The third word specifies the source files for those
4775 structs for which the compiler will emit debug information.
4776 The values @samp{none} and @samp{any} have the normal meaning.
4777 The value @samp{base} means that
4778 the base of name of the file in which the type declaration appears
4779 must match the base of the name of the main compilation file.
4780 In practice, this means that
4781 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4782 but types declared in other header will not.
4783 The value @samp{sys} means those types satisfying @samp{base}
4784 or declared in system or compiler headers.
4786 You may need to experiment to determine the best settings for your application.
4788 The default is @samp{-femit-struct-debug-detailed=all}.
4790 This option works only with DWARF 2.
4792 @item -fenable-icf-debug
4793 @opindex fenable-icf-debug
4794 Generate additional debug information to support identical code folding (ICF).
4795 This option only works with DWARF version 2 or higher.
4797 @item -fno-merge-debug-strings
4798 @opindex fmerge-debug-strings
4799 @opindex fno-merge-debug-strings
4800 Direct the linker to not merge together strings in the debugging
4801 information which are identical in different object files.  Merging is
4802 not supported by all assemblers or linkers.  Merging decreases the size
4803 of the debug information in the output file at the cost of increasing
4804 link processing time.  Merging is enabled by default.
4806 @item -fdebug-prefix-map=@var{old}=@var{new}
4807 @opindex fdebug-prefix-map
4808 When compiling files in directory @file{@var{old}}, record debugging
4809 information describing them as in @file{@var{new}} instead.
4811 @item -fno-dwarf2-cfi-asm
4812 @opindex fdwarf2-cfi-asm
4813 @opindex fno-dwarf2-cfi-asm
4814 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4815 instead of using GAS @code{.cfi_*} directives.
4817 @cindex @command{prof}
4818 @item -p
4819 @opindex p
4820 Generate extra code to write profile information suitable for the
4821 analysis program @command{prof}.  You must use this option when compiling
4822 the source files you want data about, and you must also use it when
4823 linking.
4825 @cindex @command{gprof}
4826 @item -pg
4827 @opindex pg
4828 Generate extra code to write profile information suitable for the
4829 analysis program @command{gprof}.  You must use this option when compiling
4830 the source files you want data about, and you must also use it when
4831 linking.
4833 @item -Q
4834 @opindex Q
4835 Makes the compiler print out each function name as it is compiled, and
4836 print some statistics about each pass when it finishes.
4838 @item -ftime-report
4839 @opindex ftime-report
4840 Makes the compiler print some statistics about the time consumed by each
4841 pass when it finishes.
4843 @item -fmem-report
4844 @opindex fmem-report
4845 Makes the compiler print some statistics about permanent memory
4846 allocation when it finishes.
4848 @item -fpre-ipa-mem-report
4849 @opindex fpre-ipa-mem-report
4850 @item -fpost-ipa-mem-report
4851 @opindex fpost-ipa-mem-report
4852 Makes the compiler print some statistics about permanent memory
4853 allocation before or after interprocedural optimization.
4855 @item -fprofile-arcs
4856 @opindex fprofile-arcs
4857 Add code so that program flow @dfn{arcs} are instrumented.  During
4858 execution the program records how many times each branch and call is
4859 executed and how many times it is taken or returns.  When the compiled
4860 program exits it saves this data to a file called
4861 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4862 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4863 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4864 @var{auxname} is generated from the name of the output file, if
4865 explicitly specified and it is not the final executable, otherwise it is
4866 the basename of the source file.  In both cases any suffix is removed
4867 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4868 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4869 @xref{Cross-profiling}.
4871 @cindex @command{gcov}
4872 @item --coverage
4873 @opindex coverage
4875 This option is used to compile and link code instrumented for coverage
4876 analysis.  The option is a synonym for @option{-fprofile-arcs}
4877 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4878 linking).  See the documentation for those options for more details.
4880 @itemize
4882 @item
4883 Compile the source files with @option{-fprofile-arcs} plus optimization
4884 and code generation options.  For test coverage analysis, use the
4885 additional @option{-ftest-coverage} option.  You do not need to profile
4886 every source file in a program.
4888 @item
4889 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4890 (the latter implies the former).
4892 @item
4893 Run the program on a representative workload to generate the arc profile
4894 information.  This may be repeated any number of times.  You can run
4895 concurrent instances of your program, and provided that the file system
4896 supports locking, the data files will be correctly updated.  Also
4897 @code{fork} calls are detected and correctly handled (double counting
4898 will not happen).
4900 @item
4901 For profile-directed optimizations, compile the source files again with
4902 the same optimization and code generation options plus
4903 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4904 Control Optimization}).
4906 @item
4907 For test coverage analysis, use @command{gcov} to produce human readable
4908 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4909 @command{gcov} documentation for further information.
4911 @end itemize
4913 With @option{-fprofile-arcs}, for each function of your program GCC
4914 creates a program flow graph, then finds a spanning tree for the graph.
4915 Only arcs that are not on the spanning tree have to be instrumented: the
4916 compiler adds code to count the number of times that these arcs are
4917 executed.  When an arc is the only exit or only entrance to a block, the
4918 instrumentation code can be added to the block; otherwise, a new basic
4919 block must be created to hold the instrumentation code.
4921 @need 2000
4922 @item -ftest-coverage
4923 @opindex ftest-coverage
4924 Produce a notes file that the @command{gcov} code-coverage utility
4925 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4926 show program coverage.  Each source file's note file is called
4927 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4928 above for a description of @var{auxname} and instructions on how to
4929 generate test coverage data.  Coverage data will match the source files
4930 more closely, if you do not optimize.
4932 @item -fdbg-cnt-list
4933 @opindex fdbg-cnt-list
4934 Print the name and the counter upperbound for all debug counters.
4936 @item -fdbg-cnt=@var{counter-value-list}
4937 @opindex fdbg-cnt
4938 Set the internal debug counter upperbound. @var{counter-value-list}
4939 is a comma-separated list of @var{name}:@var{value} pairs
4940 which sets the upperbound of each debug counter @var{name} to @var{value}.
4941 All debug counters have the initial upperbound of @var{UINT_MAX},
4942 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4943 e.g. With -fdbg-cnt=dce:10,tail_call:0
4944 dbg_cnt(dce) will return true only for first 10 invocations
4945 and dbg_cnt(tail_call) will return false always.
4947 @item -d@var{letters}
4948 @itemx -fdump-rtl-@var{pass}
4949 @opindex d
4950 Says to make debugging dumps during compilation at times specified by
4951 @var{letters}.  This is used for debugging the RTL-based passes of the
4952 compiler.  The file names for most of the dumps are made by appending
4953 a pass number and a word to the @var{dumpname}, and the files are
4954 created in the directory of the output file.  @var{dumpname} is
4955 generated from the name of the output file, if explicitly specified
4956 and it is not an executable, otherwise it is the basename of the
4957 source file. These switches may have different effects when
4958 @option{-E} is used for preprocessing.
4960 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4961 @option{-d} option @var{letters}.  Here are the possible
4962 letters for use in @var{pass} and @var{letters}, and their meanings:
4964 @table @gcctabopt
4966 @item -fdump-rtl-alignments
4967 @opindex fdump-rtl-alignments
4968 Dump after branch alignments have been computed.
4970 @item -fdump-rtl-asmcons
4971 @opindex fdump-rtl-asmcons
4972 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4974 @item -fdump-rtl-auto_inc_dec
4975 @opindex fdump-rtl-auto_inc_dec
4976 Dump after auto-inc-dec discovery.  This pass is only run on
4977 architectures that have auto inc or auto dec instructions.
4979 @item -fdump-rtl-barriers
4980 @opindex fdump-rtl-barriers
4981 Dump after cleaning up the barrier instructions.
4983 @item -fdump-rtl-bbpart
4984 @opindex fdump-rtl-bbpart
4985 Dump after partitioning hot and cold basic blocks.
4987 @item -fdump-rtl-bbro
4988 @opindex fdump-rtl-bbro
4989 Dump after block reordering.
4991 @item -fdump-rtl-btl1
4992 @itemx -fdump-rtl-btl2
4993 @opindex fdump-rtl-btl2
4994 @opindex fdump-rtl-btl2
4995 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4996 after the two branch
4997 target load optimization passes.
4999 @item -fdump-rtl-bypass
5000 @opindex fdump-rtl-bypass
5001 Dump after jump bypassing and control flow optimizations.
5003 @item -fdump-rtl-combine
5004 @opindex fdump-rtl-combine
5005 Dump after the RTL instruction combination pass.
5007 @item -fdump-rtl-compgotos
5008 @opindex fdump-rtl-compgotos
5009 Dump after duplicating the computed gotos.
5011 @item -fdump-rtl-ce1
5012 @itemx -fdump-rtl-ce2
5013 @itemx -fdump-rtl-ce3
5014 @opindex fdump-rtl-ce1
5015 @opindex fdump-rtl-ce2
5016 @opindex fdump-rtl-ce3
5017 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5018 @option{-fdump-rtl-ce3} enable dumping after the three
5019 if conversion passes.
5021 @itemx -fdump-rtl-cprop_hardreg
5022 @opindex fdump-rtl-cprop_hardreg
5023 Dump after hard register copy propagation.
5025 @itemx -fdump-rtl-csa
5026 @opindex fdump-rtl-csa
5027 Dump after combining stack adjustments.
5029 @item -fdump-rtl-cse1
5030 @itemx -fdump-rtl-cse2
5031 @opindex fdump-rtl-cse1
5032 @opindex fdump-rtl-cse2
5033 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5034 the two common sub-expression elimination passes.
5036 @itemx -fdump-rtl-dce
5037 @opindex fdump-rtl-dce
5038 Dump after the standalone dead code elimination passes.
5040 @itemx -fdump-rtl-dbr
5041 @opindex fdump-rtl-dbr
5042 Dump after delayed branch scheduling.
5044 @item -fdump-rtl-dce1
5045 @itemx -fdump-rtl-dce2
5046 @opindex fdump-rtl-dce1
5047 @opindex fdump-rtl-dce2
5048 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5049 the two dead store elimination passes.
5051 @item -fdump-rtl-eh
5052 @opindex fdump-rtl-eh
5053 Dump after finalization of EH handling code.
5055 @item -fdump-rtl-eh_ranges
5056 @opindex fdump-rtl-eh_ranges
5057 Dump after conversion of EH handling range regions.
5059 @item -fdump-rtl-expand
5060 @opindex fdump-rtl-expand
5061 Dump after RTL generation.
5063 @item -fdump-rtl-fwprop1
5064 @itemx -fdump-rtl-fwprop2
5065 @opindex fdump-rtl-fwprop1
5066 @opindex fdump-rtl-fwprop2
5067 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5068 dumping after the two forward propagation passes.
5070 @item -fdump-rtl-gcse1
5071 @itemx -fdump-rtl-gcse2
5072 @opindex fdump-rtl-gcse1
5073 @opindex fdump-rtl-gcse2
5074 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5075 after global common subexpression elimination.
5077 @item -fdump-rtl-init-regs
5078 @opindex fdump-rtl-init-regs
5079 Dump after the initialization of the registers.
5081 @item -fdump-rtl-initvals
5082 @opindex fdump-rtl-initvals
5083 Dump after the computation of the initial value sets.
5085 @itemx -fdump-rtl-into_cfglayout
5086 @opindex fdump-rtl-into_cfglayout
5087 Dump after converting to cfglayout mode.
5089 @item -fdump-rtl-ira
5090 @opindex fdump-rtl-ira
5091 Dump after iterated register allocation.
5093 @item -fdump-rtl-jump
5094 @opindex fdump-rtl-jump
5095 Dump after the second jump optimization.
5097 @item -fdump-rtl-loop2
5098 @opindex fdump-rtl-loop2
5099 @option{-fdump-rtl-loop2} enables dumping after the rtl
5100 loop optimization passes.
5102 @item -fdump-rtl-mach
5103 @opindex fdump-rtl-mach
5104 Dump after performing the machine dependent reorganization pass, if that
5105 pass exists.
5107 @item -fdump-rtl-mode_sw
5108 @opindex fdump-rtl-mode_sw
5109 Dump after removing redundant mode switches.
5111 @item -fdump-rtl-rnreg
5112 @opindex fdump-rtl-rnreg
5113 Dump after register renumbering.
5115 @itemx -fdump-rtl-outof_cfglayout
5116 @opindex fdump-rtl-outof_cfglayout
5117 Dump after converting from cfglayout mode.
5119 @item -fdump-rtl-peephole2
5120 @opindex fdump-rtl-peephole2
5121 Dump after the peephole pass.
5123 @item -fdump-rtl-postreload
5124 @opindex fdump-rtl-postreload
5125 Dump after post-reload optimizations.
5127 @itemx -fdump-rtl-pro_and_epilogue
5128 @opindex fdump-rtl-pro_and_epilogue
5129 Dump after generating the function pro and epilogues.
5131 @item -fdump-rtl-regmove
5132 @opindex fdump-rtl-regmove
5133 Dump after the register move pass.
5135 @item -fdump-rtl-sched1
5136 @itemx -fdump-rtl-sched2
5137 @opindex fdump-rtl-sched1
5138 @opindex fdump-rtl-sched2
5139 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5140 after the basic block scheduling passes.
5142 @item -fdump-rtl-see
5143 @opindex fdump-rtl-see
5144 Dump after sign extension elimination.
5146 @item -fdump-rtl-seqabstr
5147 @opindex fdump-rtl-seqabstr
5148 Dump after common sequence discovery.
5150 @item -fdump-rtl-shorten
5151 @opindex fdump-rtl-shorten
5152 Dump after shortening branches.
5154 @item -fdump-rtl-sibling
5155 @opindex fdump-rtl-sibling
5156 Dump after sibling call optimizations.
5158 @item -fdump-rtl-split1
5159 @itemx -fdump-rtl-split2
5160 @itemx -fdump-rtl-split3
5161 @itemx -fdump-rtl-split4
5162 @itemx -fdump-rtl-split5
5163 @opindex fdump-rtl-split1
5164 @opindex fdump-rtl-split2
5165 @opindex fdump-rtl-split3
5166 @opindex fdump-rtl-split4
5167 @opindex fdump-rtl-split5
5168 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5169 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5170 @option{-fdump-rtl-split5} enable dumping after five rounds of
5171 instruction splitting.
5173 @item -fdump-rtl-sms
5174 @opindex fdump-rtl-sms
5175 Dump after modulo scheduling.  This pass is only run on some
5176 architectures.
5178 @item -fdump-rtl-stack
5179 @opindex fdump-rtl-stack
5180 Dump after conversion from GCC's "flat register file" registers to the
5181 x87's stack-like registers.  This pass is only run on x86 variants.
5183 @item -fdump-rtl-subreg1
5184 @itemx -fdump-rtl-subreg2
5185 @opindex fdump-rtl-subreg1
5186 @opindex fdump-rtl-subreg2
5187 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5188 the two subreg expansion passes.
5190 @item -fdump-rtl-unshare
5191 @opindex fdump-rtl-unshare
5192 Dump after all rtl has been unshared.
5194 @item -fdump-rtl-vartrack
5195 @opindex fdump-rtl-vartrack
5196 Dump after variable tracking.
5198 @item -fdump-rtl-vregs
5199 @opindex fdump-rtl-vregs
5200 Dump after converting virtual registers to hard registers.
5202 @item -fdump-rtl-web
5203 @opindex fdump-rtl-web
5204 Dump after live range splitting.
5206 @item -fdump-rtl-regclass
5207 @itemx -fdump-rtl-subregs_of_mode_init
5208 @itemx -fdump-rtl-subregs_of_mode_finish
5209 @itemx -fdump-rtl-dfinit
5210 @itemx -fdump-rtl-dfinish
5211 @opindex fdump-rtl-regclass
5212 @opindex fdump-rtl-subregs_of_mode_init
5213 @opindex fdump-rtl-subregs_of_mode_finish
5214 @opindex fdump-rtl-dfinit
5215 @opindex fdump-rtl-dfinish
5216 These dumps are defined but always produce empty files.
5218 @item -fdump-rtl-all
5219 @opindex fdump-rtl-all
5220 Produce all the dumps listed above.
5222 @item -dA
5223 @opindex dA
5224 Annotate the assembler output with miscellaneous debugging information.
5226 @item -dD
5227 @opindex dD
5228 Dump all macro definitions, at the end of preprocessing, in addition to
5229 normal output.
5231 @item -dH
5232 @opindex dH
5233 Produce a core dump whenever an error occurs.
5235 @item -dm
5236 @opindex dm
5237 Print statistics on memory usage, at the end of the run, to
5238 standard error.
5240 @item -dp
5241 @opindex dp
5242 Annotate the assembler output with a comment indicating which
5243 pattern and alternative was used.  The length of each instruction is
5244 also printed.
5246 @item -dP
5247 @opindex dP
5248 Dump the RTL in the assembler output as a comment before each instruction.
5249 Also turns on @option{-dp} annotation.
5251 @item -dv
5252 @opindex dv
5253 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5254 dump a representation of the control flow graph suitable for viewing with VCG
5255 to @file{@var{file}.@var{pass}.vcg}.
5257 @item -dx
5258 @opindex dx
5259 Just generate RTL for a function instead of compiling it.  Usually used
5260 with @option{-fdump-rtl-expand}.
5262 @item -dy
5263 @opindex dy
5264 Dump debugging information during parsing, to standard error.
5265 @end table
5267 @item -fdump-noaddr
5268 @opindex fdump-noaddr
5269 When doing debugging dumps, suppress address output.  This makes it more
5270 feasible to use diff on debugging dumps for compiler invocations with
5271 different compiler binaries and/or different
5272 text / bss / data / heap / stack / dso start locations.
5274 @item -fdump-unnumbered
5275 @opindex fdump-unnumbered
5276 When doing debugging dumps, suppress instruction numbers and address output.
5277 This makes it more feasible to use diff on debugging dumps for compiler
5278 invocations with different options, in particular with and without
5279 @option{-g}.
5281 @item -fdump-unnumbered-links
5282 @opindex fdump-unnumbered-links
5283 When doing debugging dumps (see @option{-d} option above), suppress
5284 instruction numbers for the links to the previous and next instructions
5285 in a sequence.
5287 @item -fdump-translation-unit @r{(C++ only)}
5288 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5289 @opindex fdump-translation-unit
5290 Dump a representation of the tree structure for the entire translation
5291 unit to a file.  The file name is made by appending @file{.tu} to the
5292 source file name, and the file is created in the same directory as the
5293 output file.  If the @samp{-@var{options}} form is used, @var{options}
5294 controls the details of the dump as described for the
5295 @option{-fdump-tree} options.
5297 @item -fdump-class-hierarchy @r{(C++ only)}
5298 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5299 @opindex fdump-class-hierarchy
5300 Dump a representation of each class's hierarchy and virtual function
5301 table layout to a file.  The file name is made by appending
5302 @file{.class} to the source file name, and the file is created in the
5303 same directory as the output file.  If the @samp{-@var{options}} form
5304 is used, @var{options} controls the details of the dump as described
5305 for the @option{-fdump-tree} options.
5307 @item -fdump-ipa-@var{switch}
5308 @opindex fdump-ipa
5309 Control the dumping at various stages of inter-procedural analysis
5310 language tree to a file.  The file name is generated by appending a
5311 switch specific suffix to the source file name, and the file is created
5312 in the same directory as the output file.  The following dumps are
5313 possible:
5315 @table @samp
5316 @item all
5317 Enables all inter-procedural analysis dumps.
5319 @item cgraph
5320 Dumps information about call-graph optimization, unused function removal,
5321 and inlining decisions.
5323 @item inline
5324 Dump after function inlining.
5326 @end table
5328 @item -fdump-statistics-@var{option}
5329 @opindex fdump-statistics
5330 Enable and control dumping of pass statistics in a separate file.  The
5331 file name is generated by appending a suffix ending in
5332 @samp{.statistics} to the source file name, and the file is created in
5333 the same directory as the output file.  If the @samp{-@var{option}}
5334 form is used, @samp{-stats} will cause counters to be summed over the
5335 whole compilation unit while @samp{-details} will dump every event as
5336 the passes generate them.  The default with no option is to sum
5337 counters for each function compiled.
5339 @item -fdump-tree-@var{switch}
5340 @itemx -fdump-tree-@var{switch}-@var{options}
5341 @opindex fdump-tree
5342 Control the dumping at various stages of processing the intermediate
5343 language tree to a file.  The file name is generated by appending a
5344 switch specific suffix to the source file name, and the file is
5345 created in the same directory as the output file.  If the
5346 @samp{-@var{options}} form is used, @var{options} is a list of
5347 @samp{-} separated options that control the details of the dump.  Not
5348 all options are applicable to all dumps, those which are not
5349 meaningful will be ignored.  The following options are available
5351 @table @samp
5352 @item address
5353 Print the address of each node.  Usually this is not meaningful as it
5354 changes according to the environment and source file.  Its primary use
5355 is for tying up a dump file with a debug environment.
5356 @item asmname
5357 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5358 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5359 use working backward from mangled names in the assembly file.
5360 @item slim
5361 Inhibit dumping of members of a scope or body of a function merely
5362 because that scope has been reached.  Only dump such items when they
5363 are directly reachable by some other path.  When dumping pretty-printed
5364 trees, this option inhibits dumping the bodies of control structures.
5365 @item raw
5366 Print a raw representation of the tree.  By default, trees are
5367 pretty-printed into a C-like representation.
5368 @item details
5369 Enable more detailed dumps (not honored by every dump option).
5370 @item stats
5371 Enable dumping various statistics about the pass (not honored by every dump
5372 option).
5373 @item blocks
5374 Enable showing basic block boundaries (disabled in raw dumps).
5375 @item vops
5376 Enable showing virtual operands for every statement.
5377 @item lineno
5378 Enable showing line numbers for statements.
5379 @item uid
5380 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5381 @item verbose
5382 Enable showing the tree dump for each statement.
5383 @item eh
5384 Enable showing the EH region number holding each statement.
5385 @item all
5386 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5387 and @option{lineno}.
5388 @end table
5390 The following tree dumps are possible:
5391 @table @samp
5393 @item original
5394 @opindex fdump-tree-original
5395 Dump before any tree based optimization, to @file{@var{file}.original}.
5397 @item optimized
5398 @opindex fdump-tree-optimized
5399 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5401 @item gimple
5402 @opindex fdump-tree-gimple
5403 Dump each function before and after the gimplification pass to a file.  The
5404 file name is made by appending @file{.gimple} to the source file name.
5406 @item cfg
5407 @opindex fdump-tree-cfg
5408 Dump the control flow graph of each function to a file.  The file name is
5409 made by appending @file{.cfg} to the source file name.
5411 @item vcg
5412 @opindex fdump-tree-vcg
5413 Dump the control flow graph of each function to a file in VCG format.  The
5414 file name is made by appending @file{.vcg} to the source file name.  Note
5415 that if the file contains more than one function, the generated file cannot
5416 be used directly by VCG@.  You will need to cut and paste each function's
5417 graph into its own separate file first.
5419 @item ch
5420 @opindex fdump-tree-ch
5421 Dump each function after copying loop headers.  The file name is made by
5422 appending @file{.ch} to the source file name.
5424 @item ssa
5425 @opindex fdump-tree-ssa
5426 Dump SSA related information to a file.  The file name is made by appending
5427 @file{.ssa} to the source file name.
5429 @item alias
5430 @opindex fdump-tree-alias
5431 Dump aliasing information for each function.  The file name is made by
5432 appending @file{.alias} to the source file name.
5434 @item ccp
5435 @opindex fdump-tree-ccp
5436 Dump each function after CCP@.  The file name is made by appending
5437 @file{.ccp} to the source file name.
5439 @item storeccp
5440 @opindex fdump-tree-storeccp
5441 Dump each function after STORE-CCP@.  The file name is made by appending
5442 @file{.storeccp} to the source file name.
5444 @item pre
5445 @opindex fdump-tree-pre
5446 Dump trees after partial redundancy elimination.  The file name is made
5447 by appending @file{.pre} to the source file name.
5449 @item fre
5450 @opindex fdump-tree-fre
5451 Dump trees after full redundancy elimination.  The file name is made
5452 by appending @file{.fre} to the source file name.
5454 @item copyprop
5455 @opindex fdump-tree-copyprop
5456 Dump trees after copy propagation.  The file name is made
5457 by appending @file{.copyprop} to the source file name.
5459 @item store_copyprop
5460 @opindex fdump-tree-store_copyprop
5461 Dump trees after store copy-propagation.  The file name is made
5462 by appending @file{.store_copyprop} to the source file name.
5464 @item dce
5465 @opindex fdump-tree-dce
5466 Dump each function after dead code elimination.  The file name is made by
5467 appending @file{.dce} to the source file name.
5469 @item mudflap
5470 @opindex fdump-tree-mudflap
5471 Dump each function after adding mudflap instrumentation.  The file name is
5472 made by appending @file{.mudflap} to the source file name.
5474 @item sra
5475 @opindex fdump-tree-sra
5476 Dump each function after performing scalar replacement of aggregates.  The
5477 file name is made by appending @file{.sra} to the source file name.
5479 @item sink
5480 @opindex fdump-tree-sink
5481 Dump each function after performing code sinking.  The file name is made
5482 by appending @file{.sink} to the source file name.
5484 @item dom
5485 @opindex fdump-tree-dom
5486 Dump each function after applying dominator tree optimizations.  The file
5487 name is made by appending @file{.dom} to the source file name.
5489 @item dse
5490 @opindex fdump-tree-dse
5491 Dump each function after applying dead store elimination.  The file
5492 name is made by appending @file{.dse} to the source file name.
5494 @item phiopt
5495 @opindex fdump-tree-phiopt
5496 Dump each function after optimizing PHI nodes into straightline code.  The file
5497 name is made by appending @file{.phiopt} to the source file name.
5499 @item forwprop
5500 @opindex fdump-tree-forwprop
5501 Dump each function after forward propagating single use variables.  The file
5502 name is made by appending @file{.forwprop} to the source file name.
5504 @item copyrename
5505 @opindex fdump-tree-copyrename
5506 Dump each function after applying the copy rename optimization.  The file
5507 name is made by appending @file{.copyrename} to the source file name.
5509 @item nrv
5510 @opindex fdump-tree-nrv
5511 Dump each function after applying the named return value optimization on
5512 generic trees.  The file name is made by appending @file{.nrv} to the source
5513 file name.
5515 @item vect
5516 @opindex fdump-tree-vect
5517 Dump each function after applying vectorization of loops.  The file name is
5518 made by appending @file{.vect} to the source file name.
5520 @item slp
5521 @opindex fdump-tree-slp
5522 Dump each function after applying vectorization of basic blocks.  The file name
5523 is made by appending @file{.slp} to the source file name.
5525 @item vrp
5526 @opindex fdump-tree-vrp
5527 Dump each function after Value Range Propagation (VRP).  The file name
5528 is made by appending @file{.vrp} to the source file name.
5530 @item all
5531 @opindex fdump-tree-all
5532 Enable all the available tree dumps with the flags provided in this option.
5533 @end table
5535 @item -ftree-vectorizer-verbose=@var{n}
5536 @opindex ftree-vectorizer-verbose
5537 This option controls the amount of debugging output the vectorizer prints.
5538 This information is written to standard error, unless
5539 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5540 in which case it is output to the usual dump listing file, @file{.vect}.
5541 For @var{n}=0 no diagnostic information is reported.
5542 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5543 and the total number of loops that got vectorized.
5544 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5545 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5546 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5547 level that @option{-fdump-tree-vect-stats} uses.
5548 Higher verbosity levels mean either more information dumped for each
5549 reported loop, or same amount of information reported for more loops:
5550 if @var{n}=3, vectorizer cost model information is reported.
5551 If @var{n}=4, alignment related information is added to the reports.
5552 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5553 memory access-patterns) is added to the reports.
5554 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5555 that did not pass the first analysis phase (i.e., may not be countable, or
5556 may have complicated control-flow).
5557 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5558 If @var{n}=8, SLP related information is added to the reports.
5559 For @var{n}=9, all the information the vectorizer generates during its
5560 analysis and transformation is reported.  This is the same verbosity level
5561 that @option{-fdump-tree-vect-details} uses.
5563 @item -frandom-seed=@var{string}
5564 @opindex frandom-seed
5565 This option provides a seed that GCC uses when it would otherwise use
5566 random numbers.  It is used to generate certain symbol names
5567 that have to be different in every compiled file.  It is also used to
5568 place unique stamps in coverage data files and the object files that
5569 produce them.  You can use the @option{-frandom-seed} option to produce
5570 reproducibly identical object files.
5572 The @var{string} should be different for every file you compile.
5574 @item -fsched-verbose=@var{n}
5575 @opindex fsched-verbose
5576 On targets that use instruction scheduling, this option controls the
5577 amount of debugging output the scheduler prints.  This information is
5578 written to standard error, unless @option{-fdump-rtl-sched1} or
5579 @option{-fdump-rtl-sched2} is specified, in which case it is output
5580 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5581 respectively.  However for @var{n} greater than nine, the output is
5582 always printed to standard error.
5584 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5585 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5586 For @var{n} greater than one, it also output basic block probabilities,
5587 detailed ready list information and unit/insn info.  For @var{n} greater
5588 than two, it includes RTL at abort point, control-flow and regions info.
5589 And for @var{n} over four, @option{-fsched-verbose} also includes
5590 dependence info.
5592 @item -save-temps
5593 @itemx -save-temps=cwd
5594 @opindex save-temps
5595 Store the usual ``temporary'' intermediate files permanently; place them
5596 in the current directory and name them based on the source file.  Thus,
5597 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5598 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5599 preprocessed @file{foo.i} output file even though the compiler now
5600 normally uses an integrated preprocessor.
5602 When used in combination with the @option{-x} command line option,
5603 @option{-save-temps} is sensible enough to avoid over writing an
5604 input source file with the same extension as an intermediate file.
5605 The corresponding intermediate file may be obtained by renaming the
5606 source file before using @option{-save-temps}.
5608 If you invoke GCC in parallel, compiling several different source
5609 files that share a common base name in different subdirectories or the
5610 same source file compiled for multiple output destinations, it is
5611 likely that the different parallel compilers will interfere with each
5612 other, and overwrite the temporary files.  For instance:
5614 @smallexample
5615 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5616 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5617 @end smallexample
5619 may result in @file{foo.i} and @file{foo.o} being written to
5620 simultaneously by both compilers.
5622 @item -save-temps=obj
5623 @opindex save-temps=obj
5624 Store the usual ``temporary'' intermediate files permanently.  If the
5625 @option{-o} option is used, the temporary files are based on the
5626 object file.  If the @option{-o} option is not used, the
5627 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5629 For example:
5631 @smallexample
5632 gcc -save-temps=obj -c foo.c
5633 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5634 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5635 @end smallexample
5637 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5638 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5639 @file{dir2/yfoobar.o}.
5641 @item -time@r{[}=@var{file}@r{]}
5642 @opindex time
5643 Report the CPU time taken by each subprocess in the compilation
5644 sequence.  For C source files, this is the compiler proper and assembler
5645 (plus the linker if linking is done).
5647 Without the specification of an output file, the output looks like this:
5649 @smallexample
5650 # cc1 0.12 0.01
5651 # as 0.00 0.01
5652 @end smallexample
5654 The first number on each line is the ``user time'', that is time spent
5655 executing the program itself.  The second number is ``system time'',
5656 time spent executing operating system routines on behalf of the program.
5657 Both numbers are in seconds.
5659 With the specification of an output file, the output is appended to the
5660 named file, and it looks like this:
5662 @smallexample
5663 0.12 0.01 cc1 @var{options}
5664 0.00 0.01 as @var{options}
5665 @end smallexample
5667 The ``user time'' and the ``system time'' are moved before the program
5668 name, and the options passed to the program are displayed, so that one
5669 can later tell what file was being compiled, and with which options.
5671 @item -fvar-tracking
5672 @opindex fvar-tracking
5673 Run variable tracking pass.  It computes where variables are stored at each
5674 position in code.  Better debugging information is then generated
5675 (if the debugging information format supports this information).
5677 It is enabled by default when compiling with optimization (@option{-Os},
5678 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5679 the debug info format supports it.
5681 @item -fvar-tracking-assignments
5682 @opindex fvar-tracking-assignments
5683 @opindex fno-var-tracking-assignments
5684 Annotate assignments to user variables early in the compilation and
5685 attempt to carry the annotations over throughout the compilation all the
5686 way to the end, in an attempt to improve debug information while
5687 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5689 It can be enabled even if var-tracking is disabled, in which case
5690 annotations will be created and maintained, but discarded at the end.
5692 @item -fvar-tracking-assignments-toggle
5693 @opindex fvar-tracking-assignments-toggle
5694 @opindex fno-var-tracking-assignments-toggle
5695 Toggle @option{-fvar-tracking-assignments}, in the same way that
5696 @option{-gtoggle} toggles @option{-g}.
5698 @item -print-file-name=@var{library}
5699 @opindex print-file-name
5700 Print the full absolute name of the library file @var{library} that
5701 would be used when linking---and don't do anything else.  With this
5702 option, GCC does not compile or link anything; it just prints the
5703 file name.
5705 @item -print-multi-directory
5706 @opindex print-multi-directory
5707 Print the directory name corresponding to the multilib selected by any
5708 other switches present in the command line.  This directory is supposed
5709 to exist in @env{GCC_EXEC_PREFIX}.
5711 @item -print-multi-lib
5712 @opindex print-multi-lib
5713 Print the mapping from multilib directory names to compiler switches
5714 that enable them.  The directory name is separated from the switches by
5715 @samp{;}, and each switch starts with an @samp{@@} instead of the
5716 @samp{-}, without spaces between multiple switches.  This is supposed to
5717 ease shell-processing.
5719 @item -print-multi-os-directory
5720 @opindex print-multi-os-directory
5721 Print the path to OS libraries for the selected
5722 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
5723 present in the @file{lib} subdirectory and no multilibs are used, this is
5724 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5725 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5726 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5727 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5729 @item -print-prog-name=@var{program}
5730 @opindex print-prog-name
5731 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5733 @item -print-libgcc-file-name
5734 @opindex print-libgcc-file-name
5735 Same as @option{-print-file-name=libgcc.a}.
5737 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5738 but you do want to link with @file{libgcc.a}.  You can do
5740 @smallexample
5741 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5742 @end smallexample
5744 @item -print-search-dirs
5745 @opindex print-search-dirs
5746 Print the name of the configured installation directory and a list of
5747 program and library directories @command{gcc} will search---and don't do anything else.
5749 This is useful when @command{gcc} prints the error message
5750 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5751 To resolve this you either need to put @file{cpp0} and the other compiler
5752 components where @command{gcc} expects to find them, or you can set the environment
5753 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5754 Don't forget the trailing @samp{/}.
5755 @xref{Environment Variables}.
5757 @item -print-sysroot
5758 @opindex print-sysroot
5759 Print the target sysroot directory that will be used during
5760 compilation.  This is the target sysroot specified either at configure
5761 time or using the @option{--sysroot} option, possibly with an extra
5762 suffix that depends on compilation options.  If no target sysroot is
5763 specified, the option prints nothing.
5765 @item -print-sysroot-headers-suffix
5766 @opindex print-sysroot-headers-suffix
5767 Print the suffix added to the target sysroot when searching for
5768 headers, or give an error if the compiler is not configured with such
5769 a suffix---and don't do anything else.
5771 @item -dumpmachine
5772 @opindex dumpmachine
5773 Print the compiler's target machine (for example,
5774 @samp{i686-pc-linux-gnu})---and don't do anything else.
5776 @item -dumpversion
5777 @opindex dumpversion
5778 Print the compiler version (for example, @samp{3.0})---and don't do
5779 anything else.
5781 @item -dumpspecs
5782 @opindex dumpspecs
5783 Print the compiler's built-in specs---and don't do anything else.  (This
5784 is used when GCC itself is being built.)  @xref{Spec Files}.
5786 @item -feliminate-unused-debug-types
5787 @opindex feliminate-unused-debug-types
5788 Normally, when producing DWARF2 output, GCC will emit debugging
5789 information for all types declared in a compilation
5790 unit, regardless of whether or not they are actually used
5791 in that compilation unit.  Sometimes this is useful, such as
5792 if, in the debugger, you want to cast a value to a type that is
5793 not actually used in your program (but is declared).  More often,
5794 however, this results in a significant amount of wasted space.
5795 With this option, GCC will avoid producing debug symbol output
5796 for types that are nowhere used in the source file being compiled.
5797 @end table
5799 @node Optimize Options
5800 @section Options That Control Optimization
5801 @cindex optimize options
5802 @cindex options, optimization
5804 These options control various sorts of optimizations.
5806 Without any optimization option, the compiler's goal is to reduce the
5807 cost of compilation and to make debugging produce the expected
5808 results.  Statements are independent: if you stop the program with a
5809 breakpoint between statements, you can then assign a new value to any
5810 variable or change the program counter to any other statement in the
5811 function and get exactly the results you would expect from the source
5812 code.
5814 Turning on optimization flags makes the compiler attempt to improve
5815 the performance and/or code size at the expense of compilation time
5816 and possibly the ability to debug the program.
5818 The compiler performs optimization based on the knowledge it has of the
5819 program.  Compiling multiple files at once to a single output file mode allows
5820 the compiler to use information gained from all of the files when compiling
5821 each of them.
5823 Not all optimizations are controlled directly by a flag.  Only
5824 optimizations that have a flag are listed in this section.
5826 Most optimizations are only enabled if an @option{-O} level is set on
5827 the command line.  Otherwise they are disabled, even if individual             
5828 optimization flags are specified.
5830 Depending on the target and how GCC was configured, a slightly different
5831 set of optimizations may be enabled at each @option{-O} level than
5832 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5833 to find out the exact set of optimizations that are enabled at each level.
5834 @xref{Overall Options}, for examples.
5836 @table @gcctabopt
5837 @item -O
5838 @itemx -O1
5839 @opindex O
5840 @opindex O1
5841 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5842 more memory for a large function.
5844 With @option{-O}, the compiler tries to reduce code size and execution
5845 time, without performing any optimizations that take a great deal of
5846 compilation time.
5848 @option{-O} turns on the following optimization flags:
5849 @gccoptlist{
5850 -fauto-inc-dec @gol
5851 -fcprop-registers @gol
5852 -fdce @gol
5853 -fdefer-pop @gol
5854 -fdelayed-branch @gol
5855 -fdse @gol
5856 -fguess-branch-probability @gol
5857 -fif-conversion2 @gol
5858 -fif-conversion @gol
5859 -fipa-pure-const @gol
5860 -fipa-profile @gol
5861 -fipa-reference @gol
5862 -fmerge-constants
5863 -fsplit-wide-types @gol
5864 -ftree-bit-ccp @gol
5865 -ftree-builtin-call-dce @gol
5866 -ftree-ccp @gol
5867 -ftree-ch @gol
5868 -ftree-copyrename @gol
5869 -ftree-dce @gol
5870 -ftree-dominator-opts @gol
5871 -ftree-dse @gol
5872 -ftree-forwprop @gol
5873 -ftree-fre @gol
5874 -ftree-phiprop @gol
5875 -ftree-sra @gol
5876 -ftree-pta @gol
5877 -ftree-ter @gol
5878 -funit-at-a-time}
5880 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5881 where doing so does not interfere with debugging.
5883 @item -O2
5884 @opindex O2
5885 Optimize even more.  GCC performs nearly all supported optimizations
5886 that do not involve a space-speed tradeoff.
5887 As compared to @option{-O}, this option increases both compilation time
5888 and the performance of the generated code.
5890 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5891 also turns on the following optimization flags:
5892 @gccoptlist{-fthread-jumps @gol
5893 -falign-functions  -falign-jumps @gol
5894 -falign-loops  -falign-labels @gol
5895 -fcaller-saves @gol
5896 -fcrossjumping @gol
5897 -fcse-follow-jumps  -fcse-skip-blocks @gol
5898 -fdelete-null-pointer-checks @gol
5899 -fexpensive-optimizations @gol
5900 -fgcse  -fgcse-lm  @gol
5901 -finline-small-functions @gol
5902 -findirect-inlining @gol
5903 -fipa-sra @gol
5904 -foptimize-sibling-calls @gol
5905 -fpartial-inlining @gol
5906 -fpeephole2 @gol
5907 -fregmove @gol
5908 -freorder-blocks  -freorder-functions @gol
5909 -frerun-cse-after-loop  @gol
5910 -fsched-interblock  -fsched-spec @gol
5911 -fschedule-insns  -fschedule-insns2 @gol
5912 -fstrict-aliasing -fstrict-overflow @gol
5913 -ftree-switch-conversion @gol
5914 -ftree-pre @gol
5915 -ftree-vrp}
5917 Please note the warning under @option{-fgcse} about
5918 invoking @option{-O2} on programs that use computed gotos.
5920 @item -O3
5921 @opindex O3
5922 Optimize yet more.  @option{-O3} turns on all optimizations specified
5923 by @option{-O2} and also turns on the @option{-finline-functions},
5924 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5925 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5927 @item -O0
5928 @opindex O0
5929 Reduce compilation time and make debugging produce the expected
5930 results.  This is the default.
5932 @item -Os
5933 @opindex Os
5934 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5935 do not typically increase code size.  It also performs further
5936 optimizations designed to reduce code size.
5938 @option{-Os} disables the following optimization flags:
5939 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5940 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5941 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5943 @item -Ofast
5944 @opindex Ofast
5945 Disregard strict standards compliance.  @option{-Ofast} enables all
5946 @option{-O3} optimizations.  It also enables optimizations that are not
5947 valid for all standard compliant programs.
5948 It turns on @option{-ffast-math}.
5950 If you use multiple @option{-O} options, with or without level numbers,
5951 the last such option is the one that is effective.
5952 @end table
5954 Options of the form @option{-f@var{flag}} specify machine-independent
5955 flags.  Most flags have both positive and negative forms; the negative
5956 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5957 below, only one of the forms is listed---the one you typically will
5958 use.  You can figure out the other form by either removing @samp{no-}
5959 or adding it.
5961 The following options control specific optimizations.  They are either
5962 activated by @option{-O} options or are related to ones that are.  You
5963 can use the following flags in the rare cases when ``fine-tuning'' of
5964 optimizations to be performed is desired.
5966 @table @gcctabopt
5967 @item -fno-default-inline
5968 @opindex fno-default-inline
5969 Do not make member functions inline by default merely because they are
5970 defined inside the class scope (C++ only).  Otherwise, when you specify
5971 @w{@option{-O}}, member functions defined inside class scope are compiled
5972 inline by default; i.e., you don't need to add @samp{inline} in front of
5973 the member function name.
5975 @item -fno-defer-pop
5976 @opindex fno-defer-pop
5977 Always pop the arguments to each function call as soon as that function
5978 returns.  For machines which must pop arguments after a function call,
5979 the compiler normally lets arguments accumulate on the stack for several
5980 function calls and pops them all at once.
5982 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5984 @item -fforward-propagate
5985 @opindex fforward-propagate
5986 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5987 instructions and checks if the result can be simplified.  If loop unrolling
5988 is active, two passes are performed and the second is scheduled after
5989 loop unrolling.
5991 This option is enabled by default at optimization levels @option{-O},
5992 @option{-O2}, @option{-O3}, @option{-Os}.
5994 @item -fomit-frame-pointer
5995 @opindex fomit-frame-pointer
5996 Don't keep the frame pointer in a register for functions that
5997 don't need one.  This avoids the instructions to save, set up and
5998 restore frame pointers; it also makes an extra register available
5999 in many functions.  @strong{It also makes debugging impossible on
6000 some machines.}
6002 On some machines, such as the VAX, this flag has no effect, because
6003 the standard calling sequence automatically handles the frame pointer
6004 and nothing is saved by pretending it doesn't exist.  The
6005 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6006 whether a target machine supports this flag.  @xref{Registers,,Register
6007 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6009 Starting with GCC version 4.6, the default setting (when not optimizing for
6010 size) for 32-bit Linux x86 and 32-bit Darwin x86 targets has been changed to
6011 @option{-fomit-frame-pointer}.  The default can be reverted to
6012 @option{-fno-omit-frame-pointer} by configuring GCC with the
6013 @option{--enable-frame-pointer} configure option.
6015 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6017 @item -foptimize-sibling-calls
6018 @opindex foptimize-sibling-calls
6019 Optimize sibling and tail recursive calls.
6021 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6023 @item -fno-inline
6024 @opindex fno-inline
6025 Don't pay attention to the @code{inline} keyword.  Normally this option
6026 is used to keep the compiler from expanding any functions inline.
6027 Note that if you are not optimizing, no functions can be expanded inline.
6029 @item -finline-small-functions
6030 @opindex finline-small-functions
6031 Integrate functions into their callers when their body is smaller than expected
6032 function call code (so overall size of program gets smaller).  The compiler
6033 heuristically decides which functions are simple enough to be worth integrating
6034 in this way.
6036 Enabled at level @option{-O2}.
6038 @item -findirect-inlining
6039 @opindex findirect-inlining
6040 Inline also indirect calls that are discovered to be known at compile
6041 time thanks to previous inlining.  This option has any effect only
6042 when inlining itself is turned on by the @option{-finline-functions}
6043 or @option{-finline-small-functions} options.
6045 Enabled at level @option{-O2}.
6047 @item -finline-functions
6048 @opindex finline-functions
6049 Integrate all simple functions into their callers.  The compiler
6050 heuristically decides which functions are simple enough to be worth
6051 integrating in this way.
6053 If all calls to a given function are integrated, and the function is
6054 declared @code{static}, then the function is normally not output as
6055 assembler code in its own right.
6057 Enabled at level @option{-O3}.
6059 @item -finline-functions-called-once
6060 @opindex finline-functions-called-once
6061 Consider all @code{static} functions called once for inlining into their
6062 caller even if they are not marked @code{inline}.  If a call to a given
6063 function is integrated, then the function is not output as assembler code
6064 in its own right.
6066 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6068 @item -fearly-inlining
6069 @opindex fearly-inlining
6070 Inline functions marked by @code{always_inline} and functions whose body seems
6071 smaller than the function call overhead early before doing
6072 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6073 makes profiling significantly cheaper and usually inlining faster on programs
6074 having large chains of nested wrapper functions.
6076 Enabled by default.
6078 @item -fipa-sra
6079 @opindex fipa-sra
6080 Perform interprocedural scalar replacement of aggregates, removal of
6081 unused parameters and replacement of parameters passed by reference
6082 by parameters passed by value.
6084 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6086 @item -finline-limit=@var{n}
6087 @opindex finline-limit
6088 By default, GCC limits the size of functions that can be inlined.  This flag
6089 allows coarse control of this limit.  @var{n} is the size of functions that
6090 can be inlined in number of pseudo instructions.
6092 Inlining is actually controlled by a number of parameters, which may be
6093 specified individually by using @option{--param @var{name}=@var{value}}.
6094 The @option{-finline-limit=@var{n}} option sets some of these parameters
6095 as follows:
6097 @table @gcctabopt
6098 @item max-inline-insns-single
6099 is set to @var{n}/2.
6100 @item max-inline-insns-auto
6101 is set to @var{n}/2.
6102 @end table
6104 See below for a documentation of the individual
6105 parameters controlling inlining and for the defaults of these parameters.
6107 @emph{Note:} there may be no value to @option{-finline-limit} that results
6108 in default behavior.
6110 @emph{Note:} pseudo instruction represents, in this particular context, an
6111 abstract measurement of function's size.  In no way does it represent a count
6112 of assembly instructions and as such its exact meaning might change from one
6113 release to an another.
6115 @item -fkeep-inline-functions
6116 @opindex fkeep-inline-functions
6117 In C, emit @code{static} functions that are declared @code{inline}
6118 into the object file, even if the function has been inlined into all
6119 of its callers.  This switch does not affect functions using the
6120 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6121 inline functions into the object file.
6123 @item -fkeep-static-consts
6124 @opindex fkeep-static-consts
6125 Emit variables declared @code{static const} when optimization isn't turned
6126 on, even if the variables aren't referenced.
6128 GCC enables this option by default.  If you want to force the compiler to
6129 check if the variable was referenced, regardless of whether or not
6130 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6132 @item -fmerge-constants
6133 @opindex fmerge-constants
6134 Attempt to merge identical constants (string constants and floating point
6135 constants) across compilation units.
6137 This option is the default for optimized compilation if the assembler and
6138 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6139 behavior.
6141 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6143 @item -fmerge-all-constants
6144 @opindex fmerge-all-constants
6145 Attempt to merge identical constants and identical variables.
6147 This option implies @option{-fmerge-constants}.  In addition to
6148 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6149 arrays or initialized constant variables with integral or floating point
6150 types.  Languages like C or C++ require each variable, including multiple
6151 instances of the same variable in recursive calls, to have distinct locations,
6152 so using this option will result in non-conforming
6153 behavior.
6155 @item -fmodulo-sched
6156 @opindex fmodulo-sched
6157 Perform swing modulo scheduling immediately before the first scheduling
6158 pass.  This pass looks at innermost loops and reorders their
6159 instructions by overlapping different iterations.
6161 @item -fmodulo-sched-allow-regmoves
6162 @opindex fmodulo-sched-allow-regmoves
6163 Perform more aggressive SMS based modulo scheduling with register moves
6164 allowed.  By setting this flag certain anti-dependences edges will be
6165 deleted which will trigger the generation of reg-moves based on the
6166 life-range analysis.  This option is effective only with
6167 @option{-fmodulo-sched} enabled.
6169 @item -fno-branch-count-reg
6170 @opindex fno-branch-count-reg
6171 Do not use ``decrement and branch'' instructions on a count register,
6172 but instead generate a sequence of instructions that decrement a
6173 register, compare it against zero, then branch based upon the result.
6174 This option is only meaningful on architectures that support such
6175 instructions, which include x86, PowerPC, IA-64 and S/390.
6177 The default is @option{-fbranch-count-reg}.
6179 @item -fno-function-cse
6180 @opindex fno-function-cse
6181 Do not put function addresses in registers; make each instruction that
6182 calls a constant function contain the function's address explicitly.
6184 This option results in less efficient code, but some strange hacks
6185 that alter the assembler output may be confused by the optimizations
6186 performed when this option is not used.
6188 The default is @option{-ffunction-cse}
6190 @item -fno-zero-initialized-in-bss
6191 @opindex fno-zero-initialized-in-bss
6192 If the target supports a BSS section, GCC by default puts variables that
6193 are initialized to zero into BSS@.  This can save space in the resulting
6194 code.
6196 This option turns off this behavior because some programs explicitly
6197 rely on variables going to the data section.  E.g., so that the
6198 resulting executable can find the beginning of that section and/or make
6199 assumptions based on that.
6201 The default is @option{-fzero-initialized-in-bss}.
6203 @item -fmudflap -fmudflapth -fmudflapir
6204 @opindex fmudflap
6205 @opindex fmudflapth
6206 @opindex fmudflapir
6207 @cindex bounds checking
6208 @cindex mudflap
6209 For front-ends that support it (C and C++), instrument all risky
6210 pointer/array dereferencing operations, some standard library
6211 string/heap functions, and some other associated constructs with
6212 range/validity tests.  Modules so instrumented should be immune to
6213 buffer overflows, invalid heap use, and some other classes of C/C++
6214 programming errors.  The instrumentation relies on a separate runtime
6215 library (@file{libmudflap}), which will be linked into a program if
6216 @option{-fmudflap} is given at link time.  Run-time behavior of the
6217 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6218 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6219 for its options.
6221 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6222 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6223 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6224 instrumentation should ignore pointer reads.  This produces less
6225 instrumentation (and therefore faster execution) and still provides
6226 some protection against outright memory corrupting writes, but allows
6227 erroneously read data to propagate within a program.
6229 @item -fthread-jumps
6230 @opindex fthread-jumps
6231 Perform optimizations where we check to see if a jump branches to a
6232 location where another comparison subsumed by the first is found.  If
6233 so, the first branch is redirected to either the destination of the
6234 second branch or a point immediately following it, depending on whether
6235 the condition is known to be true or false.
6237 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6239 @item -fsplit-wide-types
6240 @opindex fsplit-wide-types
6241 When using a type that occupies multiple registers, such as @code{long
6242 long} on a 32-bit system, split the registers apart and allocate them
6243 independently.  This normally generates better code for those types,
6244 but may make debugging more difficult.
6246 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6247 @option{-Os}.
6249 @item -fcse-follow-jumps
6250 @opindex fcse-follow-jumps
6251 In common subexpression elimination (CSE), scan through jump instructions
6252 when the target of the jump is not reached by any other path.  For
6253 example, when CSE encounters an @code{if} statement with an
6254 @code{else} clause, CSE will follow the jump when the condition
6255 tested is false.
6257 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6259 @item -fcse-skip-blocks
6260 @opindex fcse-skip-blocks
6261 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6262 follow jumps which conditionally skip over blocks.  When CSE
6263 encounters a simple @code{if} statement with no else clause,
6264 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6265 body of the @code{if}.
6267 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6269 @item -frerun-cse-after-loop
6270 @opindex frerun-cse-after-loop
6271 Re-run common subexpression elimination after loop optimizations has been
6272 performed.
6274 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6276 @item -fgcse
6277 @opindex fgcse
6278 Perform a global common subexpression elimination pass.
6279 This pass also performs global constant and copy propagation.
6281 @emph{Note:} When compiling a program using computed gotos, a GCC
6282 extension, you may get better runtime performance if you disable
6283 the global common subexpression elimination pass by adding
6284 @option{-fno-gcse} to the command line.
6286 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6288 @item -fgcse-lm
6289 @opindex fgcse-lm
6290 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6291 attempt to move loads which are only killed by stores into themselves.  This
6292 allows a loop containing a load/store sequence to be changed to a load outside
6293 the loop, and a copy/store within the loop.
6295 Enabled by default when gcse is enabled.
6297 @item -fgcse-sm
6298 @opindex fgcse-sm
6299 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6300 global common subexpression elimination.  This pass will attempt to move
6301 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6302 loops containing a load/store sequence can be changed to a load before
6303 the loop and a store after the loop.
6305 Not enabled at any optimization level.
6307 @item -fgcse-las
6308 @opindex fgcse-las
6309 When @option{-fgcse-las} is enabled, the global common subexpression
6310 elimination pass eliminates redundant loads that come after stores to the
6311 same memory location (both partial and full redundancies).
6313 Not enabled at any optimization level.
6315 @item -fgcse-after-reload
6316 @opindex fgcse-after-reload
6317 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6318 pass is performed after reload.  The purpose of this pass is to cleanup
6319 redundant spilling.
6321 @item -funsafe-loop-optimizations
6322 @opindex funsafe-loop-optimizations
6323 If given, the loop optimizer will assume that loop indices do not
6324 overflow, and that the loops with nontrivial exit condition are not
6325 infinite.  This enables a wider range of loop optimizations even if
6326 the loop optimizer itself cannot prove that these assumptions are valid.
6327 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6328 if it finds this kind of loop.
6330 @item -fcrossjumping
6331 @opindex fcrossjumping
6332 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6333 resulting code may or may not perform better than without cross-jumping.
6335 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6337 @item -fauto-inc-dec
6338 @opindex fauto-inc-dec
6339 Combine increments or decrements of addresses with memory accesses.
6340 This pass is always skipped on architectures that do not have
6341 instructions to support this.  Enabled by default at @option{-O} and
6342 higher on architectures that support this.
6344 @item -fdce
6345 @opindex fdce
6346 Perform dead code elimination (DCE) on RTL@.
6347 Enabled by default at @option{-O} and higher.
6349 @item -fdse
6350 @opindex fdse
6351 Perform dead store elimination (DSE) on RTL@.
6352 Enabled by default at @option{-O} and higher.
6354 @item -fif-conversion
6355 @opindex fif-conversion
6356 Attempt to transform conditional jumps into branch-less equivalents.  This
6357 include use of conditional moves, min, max, set flags and abs instructions, and
6358 some tricks doable by standard arithmetics.  The use of conditional execution
6359 on chips where it is available is controlled by @code{if-conversion2}.
6361 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6363 @item -fif-conversion2
6364 @opindex fif-conversion2
6365 Use conditional execution (where available) to transform conditional jumps into
6366 branch-less equivalents.
6368 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6370 @item -fdelete-null-pointer-checks
6371 @opindex fdelete-null-pointer-checks
6372 Assume that programs cannot safely dereference null pointers, and that
6373 no code or data element resides there.  This enables simple constant
6374 folding optimizations at all optimization levels.  In addition, other
6375 optimization passes in GCC use this flag to control global dataflow
6376 analyses that eliminate useless checks for null pointers; these assume
6377 that if a pointer is checked after it has already been dereferenced,
6378 it cannot be null.
6380 Note however that in some environments this assumption is not true.
6381 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6382 for programs which depend on that behavior.
6384 Some targets, especially embedded ones, disable this option at all levels.
6385 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6386 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6387 are enabled independently at different optimization levels.
6389 @item -fexpensive-optimizations
6390 @opindex fexpensive-optimizations
6391 Perform a number of minor optimizations that are relatively expensive.
6393 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6395 @item -foptimize-register-move
6396 @itemx -fregmove
6397 @opindex foptimize-register-move
6398 @opindex fregmove
6399 Attempt to reassign register numbers in move instructions and as
6400 operands of other simple instructions in order to maximize the amount of
6401 register tying.  This is especially helpful on machines with two-operand
6402 instructions.
6404 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6405 optimization.
6407 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6409 @item -fira-algorithm=@var{algorithm}
6410 Use specified coloring algorithm for the integrated register
6411 allocator.  The @var{algorithm} argument should be @code{priority} or
6412 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6413 the second one specifies Chaitin-Briggs coloring.  The second
6414 algorithm can be unimplemented for some architectures.  If it is
6415 implemented, it is the default because Chaitin-Briggs coloring as a
6416 rule generates a better code.
6418 @item -fira-region=@var{region}
6419 Use specified regions for the integrated register allocator.  The
6420 @var{region} argument should be one of @code{all}, @code{mixed}, or
6421 @code{one}.  The first value means using all loops as register
6422 allocation regions, the second value which is the default means using
6423 all loops except for loops with small register pressure as the
6424 regions, and third one means using all function as a single region.
6425 The first value can give best result for machines with small size and
6426 irregular register set, the third one results in faster and generates
6427 decent code and the smallest size code, and the default value usually
6428 give the best results in most cases and for most architectures.
6430 @item -fira-coalesce
6431 @opindex fira-coalesce
6432 Do optimistic register coalescing.  This option might be profitable for
6433 architectures with big regular register files.
6435 @item -fira-loop-pressure
6436 @opindex fira-loop-pressure
6437 Use IRA to evaluate register pressure in loops for decision to move
6438 loop invariants.  Usage of this option usually results in generation
6439 of faster and smaller code on machines with big register files (>= 32
6440 registers) but it can slow compiler down.
6442 This option is enabled at level @option{-O3} for some targets.
6444 @item -fno-ira-share-save-slots
6445 @opindex fno-ira-share-save-slots
6446 Switch off sharing stack slots used for saving call used hard
6447 registers living through a call.  Each hard register will get a
6448 separate stack slot and as a result function stack frame will be
6449 bigger.
6451 @item -fno-ira-share-spill-slots
6452 @opindex fno-ira-share-spill-slots
6453 Switch off sharing stack slots allocated for pseudo-registers.  Each
6454 pseudo-register which did not get a hard register will get a separate
6455 stack slot and as a result function stack frame will be bigger.
6457 @item -fira-verbose=@var{n}
6458 @opindex fira-verbose
6459 Set up how verbose dump file for the integrated register allocator
6460 will be.  Default value is 5.  If the value is greater or equal to 10,
6461 the dump file will be stderr as if the value were @var{n} minus 10.
6463 @item -fdelayed-branch
6464 @opindex fdelayed-branch
6465 If supported for the target machine, attempt to reorder instructions
6466 to exploit instruction slots available after delayed branch
6467 instructions.
6469 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6471 @item -fschedule-insns
6472 @opindex fschedule-insns
6473 If supported for the target machine, attempt to reorder instructions to
6474 eliminate execution stalls due to required data being unavailable.  This
6475 helps machines that have slow floating point or memory load instructions
6476 by allowing other instructions to be issued until the result of the load
6477 or floating point instruction is required.
6479 Enabled at levels @option{-O2}, @option{-O3}.
6481 @item -fschedule-insns2
6482 @opindex fschedule-insns2
6483 Similar to @option{-fschedule-insns}, but requests an additional pass of
6484 instruction scheduling after register allocation has been done.  This is
6485 especially useful on machines with a relatively small number of
6486 registers and where memory load instructions take more than one cycle.
6488 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6490 @item -fno-sched-interblock
6491 @opindex fno-sched-interblock
6492 Don't schedule instructions across basic blocks.  This is normally
6493 enabled by default when scheduling before register allocation, i.e.@:
6494 with @option{-fschedule-insns} or at @option{-O2} or higher.
6496 @item -fno-sched-spec
6497 @opindex fno-sched-spec
6498 Don't allow speculative motion of non-load instructions.  This is normally
6499 enabled by default when scheduling before register allocation, i.e.@:
6500 with @option{-fschedule-insns} or at @option{-O2} or higher.
6502 @item -fsched-pressure
6503 @opindex fsched-pressure
6504 Enable register pressure sensitive insn scheduling before the register
6505 allocation.  This only makes sense when scheduling before register
6506 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6507 @option{-O2} or higher.  Usage of this option can improve the
6508 generated code and decrease its size by preventing register pressure
6509 increase above the number of available hard registers and as a
6510 consequence register spills in the register allocation.
6512 @item -fsched-spec-load
6513 @opindex fsched-spec-load
6514 Allow speculative motion of some load instructions.  This only makes
6515 sense when scheduling before register allocation, i.e.@: with
6516 @option{-fschedule-insns} or at @option{-O2} or higher.
6518 @item -fsched-spec-load-dangerous
6519 @opindex fsched-spec-load-dangerous
6520 Allow speculative motion of more load instructions.  This only makes
6521 sense when scheduling before register allocation, i.e.@: with
6522 @option{-fschedule-insns} or at @option{-O2} or higher.
6524 @item -fsched-stalled-insns
6525 @itemx -fsched-stalled-insns=@var{n}
6526 @opindex fsched-stalled-insns
6527 Define how many insns (if any) can be moved prematurely from the queue
6528 of stalled insns into the ready list, during the second scheduling pass.
6529 @option{-fno-sched-stalled-insns} means that no insns will be moved
6530 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6531 on how many queued insns can be moved prematurely.
6532 @option{-fsched-stalled-insns} without a value is equivalent to
6533 @option{-fsched-stalled-insns=1}.
6535 @item -fsched-stalled-insns-dep
6536 @itemx -fsched-stalled-insns-dep=@var{n}
6537 @opindex fsched-stalled-insns-dep
6538 Define how many insn groups (cycles) will be examined for a dependency
6539 on a stalled insn that is candidate for premature removal from the queue
6540 of stalled insns.  This has an effect only during the second scheduling pass,
6541 and only if @option{-fsched-stalled-insns} is used.
6542 @option{-fno-sched-stalled-insns-dep} is equivalent to
6543 @option{-fsched-stalled-insns-dep=0}.
6544 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6545 @option{-fsched-stalled-insns-dep=1}.
6547 @item -fsched2-use-superblocks
6548 @opindex fsched2-use-superblocks
6549 When scheduling after register allocation, do use superblock scheduling
6550 algorithm.  Superblock scheduling allows motion across basic block boundaries
6551 resulting on faster schedules.  This option is experimental, as not all machine
6552 descriptions used by GCC model the CPU closely enough to avoid unreliable
6553 results from the algorithm.
6555 This only makes sense when scheduling after register allocation, i.e.@: with
6556 @option{-fschedule-insns2} or at @option{-O2} or higher.
6558 @item -fsched-group-heuristic
6559 @opindex fsched-group-heuristic
6560 Enable the group heuristic in the scheduler.  This heuristic favors 
6561 the instruction that belongs to a schedule group.  This is enabled 
6562 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6563 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6565 @item -fsched-critical-path-heuristic
6566 @opindex fsched-critical-path-heuristic
6567 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6568 instructions on the critical path.  This is enabled by default when 
6569 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6570 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6572 @item -fsched-spec-insn-heuristic
6573 @opindex fsched-spec-insn-heuristic
6574 Enable the speculative instruction heuristic in the scheduler.  This 
6575 heuristic favors speculative instructions with greater dependency weakness.  
6576 This is enabled by default when scheduling is enabled, i.e.@: 
6577 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6578 or at @option{-O2} or higher.
6580 @item -fsched-rank-heuristic
6581 @opindex fsched-rank-heuristic
6582 Enable the rank heuristic in the scheduler.  This heuristic favors 
6583 the instruction belonging to a basic block with greater size or frequency.  
6584 This is enabled by default when scheduling is enabled, i.e.@: 
6585 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6586 at @option{-O2} or higher.
6588 @item -fsched-last-insn-heuristic
6589 @opindex fsched-last-insn-heuristic
6590 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6591 favors the instruction that is less dependent on the last instruction
6592 scheduled.  This is enabled by default when scheduling is enabled, 
6593 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6594 at @option{-O2} or higher.
6596 @item -fsched-dep-count-heuristic
6597 @opindex fsched-dep-count-heuristic
6598 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6599 favors the instruction that has more instructions depending on it.  
6600 This is enabled by default when scheduling is enabled, i.e.@: 
6601 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6602 at @option{-O2} or higher.
6604 @item -freschedule-modulo-scheduled-loops
6605 @opindex freschedule-modulo-scheduled-loops
6606 The modulo scheduling comes before the traditional scheduling, if a loop
6607 was modulo scheduled we may want to prevent the later scheduling passes
6608 from changing its schedule, we use this option to control that.
6610 @item -fselective-scheduling
6611 @opindex fselective-scheduling
6612 Schedule instructions using selective scheduling algorithm.  Selective
6613 scheduling runs instead of the first scheduler pass.
6615 @item -fselective-scheduling2
6616 @opindex fselective-scheduling2
6617 Schedule instructions using selective scheduling algorithm.  Selective
6618 scheduling runs instead of the second scheduler pass.
6620 @item -fsel-sched-pipelining
6621 @opindex fsel-sched-pipelining
6622 Enable software pipelining of innermost loops during selective scheduling.
6623 This option has no effect until one of @option{-fselective-scheduling} or
6624 @option{-fselective-scheduling2} is turned on.
6626 @item -fsel-sched-pipelining-outer-loops
6627 @opindex fsel-sched-pipelining-outer-loops
6628 When pipelining loops during selective scheduling, also pipeline outer loops.
6629 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6631 @item -fcaller-saves
6632 @opindex fcaller-saves
6633 Enable values to be allocated in registers that will be clobbered by
6634 function calls, by emitting extra instructions to save and restore the
6635 registers around such calls.  Such allocation is done only when it
6636 seems to result in better code than would otherwise be produced.
6638 This option is always enabled by default on certain machines, usually
6639 those which have no call-preserved registers to use instead.
6641 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6643 @item -fconserve-stack
6644 @opindex fconserve-stack
6645 Attempt to minimize stack usage.  The compiler will attempt to use less
6646 stack space, even if that makes the program slower.  This option
6647 implies setting the @option{large-stack-frame} parameter to 100
6648 and the @option{large-stack-frame-growth} parameter to 400.
6650 @item -ftree-reassoc
6651 @opindex ftree-reassoc
6652 Perform reassociation on trees.  This flag is enabled by default
6653 at @option{-O} and higher.
6655 @item -ftree-pre
6656 @opindex ftree-pre
6657 Perform partial redundancy elimination (PRE) on trees.  This flag is
6658 enabled by default at @option{-O2} and @option{-O3}.
6660 @item -ftree-forwprop
6661 @opindex ftree-forwprop
6662 Perform forward propagation on trees.  This flag is enabled by default
6663 at @option{-O} and higher.
6665 @item -ftree-fre
6666 @opindex ftree-fre
6667 Perform full redundancy elimination (FRE) on trees.  The difference
6668 between FRE and PRE is that FRE only considers expressions
6669 that are computed on all paths leading to the redundant computation.
6670 This analysis is faster than PRE, though it exposes fewer redundancies.
6671 This flag is enabled by default at @option{-O} and higher.
6673 @item -ftree-phiprop
6674 @opindex ftree-phiprop
6675 Perform hoisting of loads from conditional pointers on trees.  This
6676 pass is enabled by default at @option{-O} and higher.
6678 @item -ftree-copy-prop
6679 @opindex ftree-copy-prop
6680 Perform copy propagation on trees.  This pass eliminates unnecessary
6681 copy operations.  This flag is enabled by default at @option{-O} and
6682 higher.
6684 @item -fipa-pure-const
6685 @opindex fipa-pure-const
6686 Discover which functions are pure or constant.
6687 Enabled by default at @option{-O} and higher.
6689 @item -fipa-reference
6690 @opindex fipa-reference
6691 Discover which static variables do not escape cannot escape the
6692 compilation unit.
6693 Enabled by default at @option{-O} and higher.
6695 @item -fipa-struct-reorg
6696 @opindex fipa-struct-reorg
6697 Perform structure reorganization optimization, that change C-like structures
6698 layout in order to better utilize spatial locality.  This transformation is
6699 affective for programs containing arrays of structures.  Available in two
6700 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6701 or static (which uses built-in heuristics).  It works only in whole program
6702 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6703 enabled.  Structures considered @samp{cold} by this transformation are not
6704 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6706 With this flag, the program debug info reflects a new structure layout.
6708 @item -fipa-pta
6709 @opindex fipa-pta
6710 Perform interprocedural pointer analysis and interprocedural modification
6711 and reference analysis.  This option can cause excessive memory and
6712 compile-time usage on large compilation units.  It is not enabled by
6713 default at any optimization level.
6715 @item -fipa-profile
6716 @opindex fipa-profile
6717 Perform interprocedural profile propagation.  The functions called only from
6718 cold functions are marked as cold. Also functions executed once (such as
6719 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
6720 functions and loop less parts of functions executed once are then optimized for
6721 size.
6722 Enabled by default at @option{-O} and higher.
6724 @item -fipa-cp
6725 @opindex fipa-cp
6726 Perform interprocedural constant propagation.
6727 This optimization analyzes the program to determine when values passed
6728 to functions are constants and then optimizes accordingly.
6729 This optimization can substantially increase performance
6730 if the application has constants passed to functions.
6731 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6733 @item -fipa-cp-clone
6734 @opindex fipa-cp-clone
6735 Perform function cloning to make interprocedural constant propagation stronger.
6736 When enabled, interprocedural constant propagation will perform function cloning
6737 when externally visible function can be called with constant arguments.
6738 Because this optimization can create multiple copies of functions,
6739 it may significantly increase code size
6740 (see @option{--param ipcp-unit-growth=@var{value}}).
6741 This flag is enabled by default at @option{-O3}.
6743 @item -fipa-matrix-reorg
6744 @opindex fipa-matrix-reorg
6745 Perform matrix flattening and transposing.
6746 Matrix flattening tries to replace an @math{m}-dimensional matrix
6747 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6748 This reduces the level of indirection needed for accessing the elements
6749 of the matrix. The second optimization is matrix transposing that
6750 attempts to change the order of the matrix's dimensions in order to
6751 improve cache locality.
6752 Both optimizations need the @option{-fwhole-program} flag.
6753 Transposing is enabled only if profiling information is available.
6755 @item -ftree-sink
6756 @opindex ftree-sink
6757 Perform forward store motion  on trees.  This flag is
6758 enabled by default at @option{-O} and higher.
6760 @item -ftree-bit-ccp
6761 @opindex ftree-bit-ccp
6762 Perform sparse conditional bit constant propagation on trees and propagate
6763 pointer alignment information.
6764 This pass only operates on local scalar variables and is enabled by default
6765 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
6767 @item -ftree-ccp
6768 @opindex ftree-ccp
6769 Perform sparse conditional constant propagation (CCP) on trees.  This
6770 pass only operates on local scalar variables and is enabled by default
6771 at @option{-O} and higher.
6773 @item -ftree-switch-conversion
6774 Perform conversion of simple initializations in a switch to
6775 initializations from a scalar array.  This flag is enabled by default
6776 at @option{-O2} and higher.
6778 @item -ftree-dce
6779 @opindex ftree-dce
6780 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6781 default at @option{-O} and higher.
6783 @item -ftree-builtin-call-dce
6784 @opindex ftree-builtin-call-dce
6785 Perform conditional dead code elimination (DCE) for calls to builtin functions
6786 that may set @code{errno} but are otherwise side-effect free.  This flag is
6787 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6788 specified.
6790 @item -ftree-dominator-opts
6791 @opindex ftree-dominator-opts
6792 Perform a variety of simple scalar cleanups (constant/copy
6793 propagation, redundancy elimination, range propagation and expression
6794 simplification) based on a dominator tree traversal.  This also
6795 performs jump threading (to reduce jumps to jumps). This flag is
6796 enabled by default at @option{-O} and higher.
6798 @item -ftree-dse
6799 @opindex ftree-dse
6800 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6801 a memory location which will later be overwritten by another store without
6802 any intervening loads.  In this case the earlier store can be deleted.  This
6803 flag is enabled by default at @option{-O} and higher.
6805 @item -ftree-ch
6806 @opindex ftree-ch
6807 Perform loop header copying on trees.  This is beneficial since it increases
6808 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6809 is enabled by default at @option{-O} and higher.  It is not enabled
6810 for @option{-Os}, since it usually increases code size.
6812 @item -ftree-loop-optimize
6813 @opindex ftree-loop-optimize
6814 Perform loop optimizations on trees.  This flag is enabled by default
6815 at @option{-O} and higher.
6817 @item -ftree-loop-linear
6818 @opindex ftree-loop-linear
6819 Perform linear loop transformations on tree.  This flag can improve cache
6820 performance and allow further loop optimizations to take place.
6822 @item -floop-interchange
6823 Perform loop interchange transformations on loops.  Interchanging two
6824 nested loops switches the inner and outer loops.  For example, given a
6825 loop like:
6826 @smallexample
6827 DO J = 1, M
6828   DO I = 1, N
6829     A(J, I) = A(J, I) * C
6830   ENDDO
6831 ENDDO
6832 @end smallexample
6833 loop interchange will transform the loop as if the user had written:
6834 @smallexample
6835 DO I = 1, N
6836   DO J = 1, M
6837     A(J, I) = A(J, I) * C
6838   ENDDO
6839 ENDDO
6840 @end smallexample
6841 which can be beneficial when @code{N} is larger than the caches,
6842 because in Fortran, the elements of an array are stored in memory
6843 contiguously by column, and the original loop iterates over rows,
6844 potentially creating at each access a cache miss.  This optimization
6845 applies to all the languages supported by GCC and is not limited to
6846 Fortran.  To use this code transformation, GCC has to be configured
6847 with @option{--with-ppl} and @option{--with-cloog} to enable the
6848 Graphite loop transformation infrastructure.  This option is disabled
6849 when @option{-fgraphite-read} is used.
6851 @item -floop-strip-mine
6852 Perform loop strip mining transformations on loops.  Strip mining
6853 splits a loop into two nested loops.  The outer loop has strides
6854 equal to the strip size and the inner loop has strides of the
6855 original loop within a strip.  The strip length can be changed
6856 using the @option{loop-block-tile-size} parameter.  For example,
6857 given a loop like:
6858 @smallexample
6859 DO I = 1, N
6860   A(I) = A(I) + C
6861 ENDDO
6862 @end smallexample
6863 loop strip mining will transform the loop as if the user had written:
6864 @smallexample
6865 DO II = 1, N, 51
6866   DO I = II, min (II + 50, N)
6867     A(I) = A(I) + C
6868   ENDDO
6869 ENDDO
6870 @end smallexample
6871 This optimization applies to all the languages supported by GCC and is
6872 not limited to Fortran.  To use this code transformation, GCC has to
6873 be configured with @option{--with-ppl} and @option{--with-cloog} to
6874 enable the Graphite loop transformation infrastructure.  This option is
6875 disabled when @option{-fgraphite-read} is used.
6877 @item -floop-block
6878 Perform loop blocking transformations on loops.  Blocking strip mines
6879 each loop in the loop nest such that the memory accesses of the
6880 element loops fit inside caches.  The strip length can be changed
6881 using the @option{loop-block-tile-size} parameter.  For example, given
6882 a loop like:
6883 @smallexample
6884 DO I = 1, N
6885   DO J = 1, M
6886     A(J, I) = B(I) + C(J)
6887   ENDDO
6888 ENDDO
6889 @end smallexample
6890 loop blocking will transform the loop as if the user had written:
6891 @smallexample
6892 DO II = 1, N, 51
6893   DO JJ = 1, M, 51
6894     DO I = II, min (II + 50, N)
6895       DO J = JJ, min (JJ + 50, M)
6896         A(J, I) = B(I) + C(J)
6897       ENDDO
6898     ENDDO
6899   ENDDO
6900 ENDDO
6901 @end smallexample
6902 which can be beneficial when @code{M} is larger than the caches,
6903 because the innermost loop will iterate over a smaller amount of data
6904 that can be kept in the caches.  This optimization applies to all the
6905 languages supported by GCC and is not limited to Fortran.  To use this
6906 code transformation, GCC has to be configured with @option{--with-ppl}
6907 and @option{--with-cloog} to enable the Graphite loop transformation
6908 infrastructure.  This option is disabled when @option{-fgraphite-read}
6909 is used.
6911 @item -fgraphite-identity
6912 @opindex fgraphite-identity
6913 Enable the identity transformation for graphite.  For every SCoP we generate
6914 the polyhedral representation and transform it back to gimple.  Using
6915 @option{-fgraphite-identity} we can check the costs or benefits of the
6916 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
6917 are also performed by the code generator CLooG, like index splitting and
6918 dead code elimination in loops.
6920 @item -fgraphite-read
6921 @opindex fgraphite-read
6922 Enable graphite to read a scop from an external file.  Each scop in
6923 the program is described in a separate file.  This flag disables all
6924 graphite loop optimizations (@option{-floop-block},
6925 @option{-floop-strip-mine}, and @option{-floop-iterchange}).
6927 @item -fgraphite-write
6928 @opindex fgraphite-write
6929 Enable graphite to dump a scop to an external file.  Each scop in the
6930 program is described in a separate file.  For a program @code{file.c}
6931 that has 3 scops, the dumped files are named @code{file.0.graphite},
6932 @code{file.1.graphite}, and @code{file.2.graphite}.
6934 @item -floop-parallelize-all
6935 Use the Graphite data dependence analysis to identify loops that can
6936 be parallelized.  Parallelize all the loops that can be analyzed to
6937 not contain loop carried dependences without checking that it is
6938 profitable to parallelize the loops.
6940 @item -fcheck-data-deps
6941 @opindex fcheck-data-deps
6942 Compare the results of several data dependence analyzers.  This option
6943 is used for debugging the data dependence analyzers.
6945 @item -ftree-loop-if-convert
6946 Attempt to transform conditional jumps in the innermost loops to
6947 branch-less equivalents.  The intent is to remove control-flow from
6948 the innermost loops in order to improve the ability of the
6949 vectorization pass to handle these loops.  This is enabled by default
6950 if vectorization is enabled.
6952 @item -ftree-loop-distribution
6953 Perform loop distribution.  This flag can improve cache performance on
6954 big loop bodies and allow further loop optimizations, like
6955 parallelization or vectorization, to take place.  For example, the loop
6956 @smallexample
6957 DO I = 1, N
6958   A(I) = B(I) + C
6959   D(I) = E(I) * F
6960 ENDDO
6961 @end smallexample
6962 is transformed to
6963 @smallexample
6964 DO I = 1, N
6965    A(I) = B(I) + C
6966 ENDDO
6967 DO I = 1, N
6968    D(I) = E(I) * F
6969 ENDDO
6970 @end smallexample
6972 @item -ftree-loop-distribute-patterns
6973 Perform loop distribution of patterns that can be code generated with
6974 calls to a library.  This flag is enabled by default at @option{-O3}.
6976 This pass distributes the initialization loops and generates a call to
6977 memset zero.  For example, the loop
6978 @smallexample
6979 DO I = 1, N
6980   A(I) = 0
6981   B(I) = A(I) + I
6982 ENDDO
6983 @end smallexample
6984 is transformed to
6985 @smallexample
6986 DO I = 1, N
6987    A(I) = 0
6988 ENDDO
6989 DO I = 1, N
6990    B(I) = A(I) + I
6991 ENDDO
6992 @end smallexample
6993 and the initialization loop is transformed into a call to memset zero.
6995 @item -ftree-loop-im
6996 @opindex ftree-loop-im
6997 Perform loop invariant motion on trees.  This pass moves only invariants that
6998 would be hard to handle at RTL level (function calls, operations that expand to
6999 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7000 operands of conditions that are invariant out of the loop, so that we can use
7001 just trivial invariantness analysis in loop unswitching.  The pass also includes
7002 store motion.
7004 @item -ftree-loop-ivcanon
7005 @opindex ftree-loop-ivcanon
7006 Create a canonical counter for number of iterations in the loop for that
7007 determining number of iterations requires complicated analysis.  Later
7008 optimizations then may determine the number easily.  Useful especially
7009 in connection with unrolling.
7011 @item -fivopts
7012 @opindex fivopts
7013 Perform induction variable optimizations (strength reduction, induction
7014 variable merging and induction variable elimination) on trees.
7016 @item -ftree-parallelize-loops=n
7017 @opindex ftree-parallelize-loops
7018 Parallelize loops, i.e., split their iteration space to run in n threads.
7019 This is only possible for loops whose iterations are independent
7020 and can be arbitrarily reordered.  The optimization is only
7021 profitable on multiprocessor machines, for loops that are CPU-intensive,
7022 rather than constrained e.g.@: by memory bandwidth.  This option
7023 implies @option{-pthread}, and thus is only supported on targets
7024 that have support for @option{-pthread}.
7026 @item -ftree-pta
7027 @opindex ftree-pta
7028 Perform function-local points-to analysis on trees.  This flag is
7029 enabled by default at @option{-O} and higher.
7031 @item -ftree-sra
7032 @opindex ftree-sra
7033 Perform scalar replacement of aggregates.  This pass replaces structure
7034 references with scalars to prevent committing structures to memory too
7035 early.  This flag is enabled by default at @option{-O} and higher.
7037 @item -ftree-copyrename
7038 @opindex ftree-copyrename
7039 Perform copy renaming on trees.  This pass attempts to rename compiler
7040 temporaries to other variables at copy locations, usually resulting in
7041 variable names which more closely resemble the original variables.  This flag
7042 is enabled by default at @option{-O} and higher.
7044 @item -ftree-ter
7045 @opindex ftree-ter
7046 Perform temporary expression replacement during the SSA->normal phase.  Single
7047 use/single def temporaries are replaced at their use location with their
7048 defining expression.  This results in non-GIMPLE code, but gives the expanders
7049 much more complex trees to work on resulting in better RTL generation.  This is
7050 enabled by default at @option{-O} and higher.
7052 @item -ftree-vectorize
7053 @opindex ftree-vectorize
7054 Perform loop vectorization on trees. This flag is enabled by default at
7055 @option{-O3}.
7057 @item -ftree-slp-vectorize
7058 @opindex ftree-slp-vectorize
7059 Perform basic block vectorization on trees. This flag is enabled by default at
7060 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7062 @item -ftree-vect-loop-version
7063 @opindex ftree-vect-loop-version
7064 Perform loop versioning when doing loop vectorization on trees.  When a loop
7065 appears to be vectorizable except that data alignment or data dependence cannot
7066 be determined at compile time then vectorized and non-vectorized versions of
7067 the loop are generated along with runtime checks for alignment or dependence
7068 to control which version is executed.  This option is enabled by default
7069 except at level @option{-Os} where it is disabled.
7071 @item -fvect-cost-model
7072 @opindex fvect-cost-model
7073 Enable cost model for vectorization.
7075 @item -ftree-vrp
7076 @opindex ftree-vrp
7077 Perform Value Range Propagation on trees.  This is similar to the
7078 constant propagation pass, but instead of values, ranges of values are
7079 propagated.  This allows the optimizers to remove unnecessary range
7080 checks like array bound checks and null pointer checks.  This is
7081 enabled by default at @option{-O2} and higher.  Null pointer check
7082 elimination is only done if @option{-fdelete-null-pointer-checks} is
7083 enabled.
7085 @item -ftracer
7086 @opindex ftracer
7087 Perform tail duplication to enlarge superblock size.  This transformation
7088 simplifies the control flow of the function allowing other optimizations to do
7089 better job.
7091 @item -funroll-loops
7092 @opindex funroll-loops
7093 Unroll loops whose number of iterations can be determined at compile
7094 time or upon entry to the loop.  @option{-funroll-loops} implies
7095 @option{-frerun-cse-after-loop}.  This option makes code larger,
7096 and may or may not make it run faster.
7098 @item -funroll-all-loops
7099 @opindex funroll-all-loops
7100 Unroll all loops, even if their number of iterations is uncertain when
7101 the loop is entered.  This usually makes programs run more slowly.
7102 @option{-funroll-all-loops} implies the same options as
7103 @option{-funroll-loops},
7105 @item -fsplit-ivs-in-unroller
7106 @opindex fsplit-ivs-in-unroller
7107 Enables expressing of values of induction variables in later iterations
7108 of the unrolled loop using the value in the first iteration.  This breaks
7109 long dependency chains, thus improving efficiency of the scheduling passes.
7111 Combination of @option{-fweb} and CSE is often sufficient to obtain the
7112 same effect.  However in cases the loop body is more complicated than
7113 a single basic block, this is not reliable.  It also does not work at all
7114 on some of the architectures due to restrictions in the CSE pass.
7116 This optimization is enabled by default.
7118 @item -fvariable-expansion-in-unroller
7119 @opindex fvariable-expansion-in-unroller
7120 With this option, the compiler will create multiple copies of some
7121 local variables when unrolling a loop which can result in superior code.
7123 @item -fpartial-inlining
7124 @opindex fpartial-inlining
7125 Inline parts of functions.  This option has any effect only
7126 when inlining itself is turned on by the @option{-finline-functions}
7127 or @option{-finline-small-functions} options.
7129 Enabled at level @option{-O2}.
7131 @item -fpredictive-commoning
7132 @opindex fpredictive-commoning
7133 Perform predictive commoning optimization, i.e., reusing computations
7134 (especially memory loads and stores) performed in previous
7135 iterations of loops.
7137 This option is enabled at level @option{-O3}.
7139 @item -fprefetch-loop-arrays
7140 @opindex fprefetch-loop-arrays
7141 If supported by the target machine, generate instructions to prefetch
7142 memory to improve the performance of loops that access large arrays.
7144 This option may generate better or worse code; results are highly
7145 dependent on the structure of loops within the source code.
7147 Disabled at level @option{-Os}.
7149 @item -fno-peephole
7150 @itemx -fno-peephole2
7151 @opindex fno-peephole
7152 @opindex fno-peephole2
7153 Disable any machine-specific peephole optimizations.  The difference
7154 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7155 are implemented in the compiler; some targets use one, some use the
7156 other, a few use both.
7158 @option{-fpeephole} is enabled by default.
7159 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7161 @item -fno-guess-branch-probability
7162 @opindex fno-guess-branch-probability
7163 Do not guess branch probabilities using heuristics.
7165 GCC will use heuristics to guess branch probabilities if they are
7166 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7167 heuristics are based on the control flow graph.  If some branch probabilities
7168 are specified by @samp{__builtin_expect}, then the heuristics will be
7169 used to guess branch probabilities for the rest of the control flow graph,
7170 taking the @samp{__builtin_expect} info into account.  The interactions
7171 between the heuristics and @samp{__builtin_expect} can be complex, and in
7172 some cases, it may be useful to disable the heuristics so that the effects
7173 of @samp{__builtin_expect} are easier to understand.
7175 The default is @option{-fguess-branch-probability} at levels
7176 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7178 @item -freorder-blocks
7179 @opindex freorder-blocks
7180 Reorder basic blocks in the compiled function in order to reduce number of
7181 taken branches and improve code locality.
7183 Enabled at levels @option{-O2}, @option{-O3}.
7185 @item -freorder-blocks-and-partition
7186 @opindex freorder-blocks-and-partition
7187 In addition to reordering basic blocks in the compiled function, in order
7188 to reduce number of taken branches, partitions hot and cold basic blocks
7189 into separate sections of the assembly and .o files, to improve
7190 paging and cache locality performance.
7192 This optimization is automatically turned off in the presence of
7193 exception handling, for linkonce sections, for functions with a user-defined
7194 section attribute and on any architecture that does not support named
7195 sections.
7197 @item -freorder-functions
7198 @opindex freorder-functions
7199 Reorder functions in the object file in order to
7200 improve code locality.  This is implemented by using special
7201 subsections @code{.text.hot} for most frequently executed functions and
7202 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7203 the linker so object file format must support named sections and linker must
7204 place them in a reasonable way.
7206 Also profile feedback must be available in to make this option effective.  See
7207 @option{-fprofile-arcs} for details.
7209 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7211 @item -fstrict-aliasing
7212 @opindex fstrict-aliasing
7213 Allow the compiler to assume the strictest aliasing rules applicable to
7214 the language being compiled.  For C (and C++), this activates
7215 optimizations based on the type of expressions.  In particular, an
7216 object of one type is assumed never to reside at the same address as an
7217 object of a different type, unless the types are almost the same.  For
7218 example, an @code{unsigned int} can alias an @code{int}, but not a
7219 @code{void*} or a @code{double}.  A character type may alias any other
7220 type.
7222 @anchor{Type-punning}Pay special attention to code like this:
7223 @smallexample
7224 union a_union @{
7225   int i;
7226   double d;
7229 int f() @{
7230   union a_union t;
7231   t.d = 3.0;
7232   return t.i;
7234 @end smallexample
7235 The practice of reading from a different union member than the one most
7236 recently written to (called ``type-punning'') is common.  Even with
7237 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7238 is accessed through the union type.  So, the code above will work as
7239 expected.  @xref{Structures unions enumerations and bit-fields
7240 implementation}.  However, this code might not:
7241 @smallexample
7242 int f() @{
7243   union a_union t;
7244   int* ip;
7245   t.d = 3.0;
7246   ip = &t.i;
7247   return *ip;
7249 @end smallexample
7251 Similarly, access by taking the address, casting the resulting pointer
7252 and dereferencing the result has undefined behavior, even if the cast
7253 uses a union type, e.g.:
7254 @smallexample
7255 int f() @{
7256   double d = 3.0;
7257   return ((union a_union *) &d)->i;
7259 @end smallexample
7261 The @option{-fstrict-aliasing} option is enabled at levels
7262 @option{-O2}, @option{-O3}, @option{-Os}.
7264 @item -fstrict-overflow
7265 @opindex fstrict-overflow
7266 Allow the compiler to assume strict signed overflow rules, depending
7267 on the language being compiled.  For C (and C++) this means that
7268 overflow when doing arithmetic with signed numbers is undefined, which
7269 means that the compiler may assume that it will not happen.  This
7270 permits various optimizations.  For example, the compiler will assume
7271 that an expression like @code{i + 10 > i} will always be true for
7272 signed @code{i}.  This assumption is only valid if signed overflow is
7273 undefined, as the expression is false if @code{i + 10} overflows when
7274 using twos complement arithmetic.  When this option is in effect any
7275 attempt to determine whether an operation on signed numbers will
7276 overflow must be written carefully to not actually involve overflow.
7278 This option also allows the compiler to assume strict pointer
7279 semantics: given a pointer to an object, if adding an offset to that
7280 pointer does not produce a pointer to the same object, the addition is
7281 undefined.  This permits the compiler to conclude that @code{p + u >
7282 p} is always true for a pointer @code{p} and unsigned integer
7283 @code{u}.  This assumption is only valid because pointer wraparound is
7284 undefined, as the expression is false if @code{p + u} overflows using
7285 twos complement arithmetic.
7287 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7288 that integer signed overflow is fully defined: it wraps.  When
7289 @option{-fwrapv} is used, there is no difference between
7290 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7291 integers.  With @option{-fwrapv} certain types of overflow are
7292 permitted.  For example, if the compiler gets an overflow when doing
7293 arithmetic on constants, the overflowed value can still be used with
7294 @option{-fwrapv}, but not otherwise.
7296 The @option{-fstrict-overflow} option is enabled at levels
7297 @option{-O2}, @option{-O3}, @option{-Os}.
7299 @item -falign-functions
7300 @itemx -falign-functions=@var{n}
7301 @opindex falign-functions
7302 Align the start of functions to the next power-of-two greater than
7303 @var{n}, skipping up to @var{n} bytes.  For instance,
7304 @option{-falign-functions=32} aligns functions to the next 32-byte
7305 boundary, but @option{-falign-functions=24} would align to the next
7306 32-byte boundary only if this can be done by skipping 23 bytes or less.
7308 @option{-fno-align-functions} and @option{-falign-functions=1} are
7309 equivalent and mean that functions will not be aligned.
7311 Some assemblers only support this flag when @var{n} is a power of two;
7312 in that case, it is rounded up.
7314 If @var{n} is not specified or is zero, use a machine-dependent default.
7316 Enabled at levels @option{-O2}, @option{-O3}.
7318 @item -falign-labels
7319 @itemx -falign-labels=@var{n}
7320 @opindex falign-labels
7321 Align all branch targets to a power-of-two boundary, skipping up to
7322 @var{n} bytes like @option{-falign-functions}.  This option can easily
7323 make code slower, because it must insert dummy operations for when the
7324 branch target is reached in the usual flow of the code.
7326 @option{-fno-align-labels} and @option{-falign-labels=1} are
7327 equivalent and mean that labels will not be aligned.
7329 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7330 are greater than this value, then their values are used instead.
7332 If @var{n} is not specified or is zero, use a machine-dependent default
7333 which is very likely to be @samp{1}, meaning no alignment.
7335 Enabled at levels @option{-O2}, @option{-O3}.
7337 @item -falign-loops
7338 @itemx -falign-loops=@var{n}
7339 @opindex falign-loops
7340 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7341 like @option{-falign-functions}.  The hope is that the loop will be
7342 executed many times, which will make up for any execution of the dummy
7343 operations.
7345 @option{-fno-align-loops} and @option{-falign-loops=1} are
7346 equivalent and mean that loops will not be aligned.
7348 If @var{n} is not specified or is zero, use a machine-dependent default.
7350 Enabled at levels @option{-O2}, @option{-O3}.
7352 @item -falign-jumps
7353 @itemx -falign-jumps=@var{n}
7354 @opindex falign-jumps
7355 Align branch targets to a power-of-two boundary, for branch targets
7356 where the targets can only be reached by jumping, skipping up to @var{n}
7357 bytes like @option{-falign-functions}.  In this case, no dummy operations
7358 need be executed.
7360 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7361 equivalent and mean that loops will not be aligned.
7363 If @var{n} is not specified or is zero, use a machine-dependent default.
7365 Enabled at levels @option{-O2}, @option{-O3}.
7367 @item -funit-at-a-time
7368 @opindex funit-at-a-time
7369 This option is left for compatibility reasons. @option{-funit-at-a-time}
7370 has no effect, while @option{-fno-unit-at-a-time} implies
7371 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7373 Enabled by default.
7375 @item -fno-toplevel-reorder
7376 @opindex fno-toplevel-reorder
7377 Do not reorder top-level functions, variables, and @code{asm}
7378 statements.  Output them in the same order that they appear in the
7379 input file.  When this option is used, unreferenced static variables
7380 will not be removed.  This option is intended to support existing code
7381 which relies on a particular ordering.  For new code, it is better to
7382 use attributes.
7384 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7385 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7386 targets.
7388 @item -fweb
7389 @opindex fweb
7390 Constructs webs as commonly used for register allocation purposes and assign
7391 each web individual pseudo register.  This allows the register allocation pass
7392 to operate on pseudos directly, but also strengthens several other optimization
7393 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7394 however, make debugging impossible, since variables will no longer stay in a
7395 ``home register''.
7397 Enabled by default with @option{-funroll-loops}.
7399 @item -fwhole-program
7400 @opindex fwhole-program
7401 Assume that the current compilation unit represents the whole program being
7402 compiled.  All public functions and variables with the exception of @code{main}
7403 and those merged by attribute @code{externally_visible} become static functions
7404 and in effect are optimized more aggressively by interprocedural optimizers. If @command{gold} is used as the linker plugin, @code{externally_visible} attributes are automatically added to functions (not variable yet due to a current @command{gold} issue) that are accessed outside of LTO objects according to resolution file produced by @command{gold}.  For other linkers that cannot generate resolution file, explicit @code{externally_visible} attributes are still necessary.
7405 While this option is equivalent to proper use of the @code{static} keyword for
7406 programs consisting of a single file, in combination with option
7407 @option{-combine}, @option{-flto} or @option{-fwhopr} this flag can be used to
7408 compile many smaller scale programs since the functions and variables become
7409 local for the whole combined compilation unit, not for the single source file
7410 itself.
7412 This option implies @option{-fwhole-file} for Fortran programs.
7414 @item -flto
7415 @opindex flto
7416 This option runs the standard link-time optimizer.  When invoked
7417 with source code, it generates GIMPLE (one of GCC's internal
7418 representations) and writes it to special ELF sections in the object
7419 file.  When the object files are linked together, all the function
7420 bodies are read from these ELF sections and instantiated as if they
7421 had been part of the same translation unit.
7423 To use the link-timer optimizer, @option{-flto} needs to be specified at
7424 compile time and during the final link.  For example,
7426 @smallexample
7427 gcc -c -O2 -flto foo.c
7428 gcc -c -O2 -flto bar.c
7429 gcc -o myprog -flto -O2 foo.o bar.o
7430 @end smallexample
7432 The first two invocations to GCC will save a bytecode representation
7433 of GIMPLE into special ELF sections inside @file{foo.o} and
7434 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7435 @file{foo.o} and @file{bar.o}, merge the two files into a single
7436 internal image, and compile the result as usual.  Since both
7437 @file{foo.o} and @file{bar.o} are merged into a single image, this
7438 causes all the inter-procedural analyses and optimizations in GCC to
7439 work across the two files as if they were a single one.  This means,
7440 for example, that the inliner will be able to inline functions in
7441 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7443 Another (simpler) way to enable link-time optimization is,
7445 @smallexample
7446 gcc -o myprog -flto -O2 foo.c bar.c
7447 @end smallexample
7449 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7450 merge them together into a single GIMPLE representation and optimize
7451 them as usual to produce @file{myprog}.
7453 The only important thing to keep in mind is that to enable link-time
7454 optimizations the @option{-flto} flag needs to be passed to both the
7455 compile and the link commands.
7457 Note that when a file is compiled with @option{-flto}, the generated
7458 object file will be larger than a regular object file because it will
7459 contain GIMPLE bytecodes and the usual final code.  This means that
7460 object files with LTO information can be linked as a normal object
7461 file.  So, in the previous example, if the final link is done with
7463 @smallexample
7464 gcc -o myprog foo.o bar.o
7465 @end smallexample
7467 The only difference will be that no inter-procedural optimizations
7468 will be applied to produce @file{myprog}.  The two object files
7469 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7470 linker.
7472 Additionally, the optimization flags used to compile individual files
7473 are not necessarily related to those used at link-time.  For instance,
7475 @smallexample
7476 gcc -c -O0 -flto foo.c
7477 gcc -c -O0 -flto bar.c
7478 gcc -o myprog -flto -O3 foo.o bar.o
7479 @end smallexample
7481 This will produce individual object files with unoptimized assembler
7482 code, but the resulting binary @file{myprog} will be optimized at
7483 @option{-O3}.  Now, if the final binary is generated without
7484 @option{-flto}, then @file{myprog} will not be optimized.
7486 When producing the final binary with @option{-flto}, GCC will only
7487 apply link-time optimizations to those files that contain bytecode.
7488 Therefore, you can mix and match object files and libraries with
7489 GIMPLE bytecodes and final object code.  GCC will automatically select
7490 which files to optimize in LTO mode and which files to link without
7491 further processing.
7493 There are some code generation flags that GCC will preserve when
7494 generating bytecodes, as they need to be used during the final link
7495 stage.  Currently, the following options are saved into the GIMPLE
7496 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7497 @option{-m} target flags.
7499 At link time, these options are read-in and reapplied.  Note that the
7500 current implementation makes no attempt at recognizing conflicting
7501 values for these options.  If two or more files have a conflicting
7502 value (e.g., one file is compiled with @option{-fPIC} and another
7503 isn't), the compiler will simply use the last value read from the
7504 bytecode files.  It is recommended, then, that all the files
7505 participating in the same link be compiled with the same options.
7507 Another feature of LTO is that it is possible to apply interprocedural
7508 optimizations on files written in different languages.  This requires
7509 some support in the language front end.  Currently, the C, C++ and
7510 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7511 something like this should work
7513 @smallexample
7514 gcc -c -flto foo.c
7515 g++ -c -flto bar.cc
7516 gfortran -c -flto baz.f90
7517 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7518 @end smallexample
7520 Notice that the final link is done with @command{g++} to get the C++
7521 runtime libraries and @option{-lgfortran} is added to get the Fortran
7522 runtime libraries.  In general, when mixing languages in LTO mode, you
7523 should use the same link command used when mixing languages in a
7524 regular (non-LTO) compilation.  This means that if your build process
7525 was mixing languages before, all you need to add is @option{-flto} to
7526 all the compile and link commands.
7528 If LTO encounters objects with C linkage declared with incompatible
7529 types in separate translation units to be linked together (undefined
7530 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
7531 issued.  The behavior is still undefined at runtime.
7533 If object files containing GIMPLE bytecode are stored in a library
7534 archive, say @file{libfoo.a}, it is possible to extract and use them
7535 in an LTO link if you are using @command{gold} as the linker (which,
7536 in turn requires GCC to be configured with @option{--enable-gold}).
7537 To enable this feature, use the flag @option{-fuse-linker-plugin} at
7538 link-time:
7540 @smallexample
7541 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7542 @end smallexample
7544 With the linker plugin enabled, @command{gold} will extract the needed
7545 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7546 to make them part of the aggregated GIMPLE image to be optimized.
7548 If you are not using @command{gold} and/or do not specify
7549 @option{-fuse-linker-plugin} then the objects inside @file{libfoo.a}
7550 will be extracted and linked as usual, but they will not participate
7551 in the LTO optimization process.
7553 Link time optimizations do not require the presence of the whole
7554 program to operate.  If the program does not require any symbols to
7555 be exported, it is possible to combine @option{-flto} and
7556 @option{-fwhopr} with @option{-fwhole-program} to allow the
7557 interprocedural optimizers to use more aggressive assumptions which
7558 may lead to improved optimization opportunities.
7560 Regarding portability: the current implementation of LTO makes no
7561 attempt at generating bytecode that can be ported between different
7562 types of hosts.  The bytecode files are versioned and there is a
7563 strict version check, so bytecode files generated in one version of
7564 GCC will not work with an older/newer version of GCC.
7566 Link time optimization does not play well with generating debugging
7567 information.  Combining @option{-flto} or @option{-fwhopr} with
7568 @option{-g} is experimental.
7570 This option is disabled by default.
7572 @item -fwhopr[=@var{n}]
7573 @opindex fwhopr
7574 This option is identical in functionality to @option{-flto} but it
7575 differs in how the final link stage is executed.  Instead of loading
7576 all the function bodies in memory, the callgraph is analyzed and
7577 optimization decisions are made (whole program analysis or WPA). Once
7578 optimization decisions are made, the callgraph is partitioned and the
7579 different sections are compiled separately (local transformations or
7580 LTRANS)@.  This process allows optimizations on very large programs
7581 that otherwise would not fit in memory.  This option enables
7582 @option{-fwpa} and @option{-fltrans} automatically.
7584 If you specify the optional @var{n} the link stage is executed in
7585 parallel using @var{n} parallel jobs by utilizing an installed
7586 @command{make} program.  The environment variable @env{MAKE} may be
7587 used to override the program used.
7589 Disabled by default.
7591 @item -fwpa
7592 @opindex fwpa
7593 This is an internal option used by GCC when compiling with
7594 @option{-fwhopr}.  You should never need to use it.
7596 This option runs the link-time optimizer in the whole-program-analysis
7597 (WPA) mode, which reads in summary information from all inputs and
7598 performs a whole-program analysis based on summary information only.
7599 It generates object files for subsequent runs of the link-time
7600 optimizer where individual object files are optimized using both
7601 summary information from the WPA mode and the actual function bodies.
7602 It then drives the LTRANS phase.
7604 Disabled by default.
7606 @item -fltrans
7607 @opindex fltrans
7608 This is an internal option used by GCC when compiling with
7609 @option{-fwhopr}.  You should never need to use it.
7611 This option runs the link-time optimizer in the local-transformation (LTRANS)
7612 mode, which reads in output from a previous run of the LTO in WPA mode.
7613 In the LTRANS mode, LTO optimizes an object and produces the final assembly.
7615 Disabled by default.
7617 @item -fltrans-output-list=@var{file}
7618 @opindex fltrans-output-list
7619 This is an internal option used by GCC when compiling with
7620 @option{-fwhopr}.  You should never need to use it.
7622 This option specifies a file to which the names of LTRANS output files are
7623 written.  This option is only meaningful in conjunction with @option{-fwpa}.
7625 Disabled by default.
7627 @item -flto-compression-level=@var{n}
7628 This option specifies the level of compression used for intermediate
7629 language written to LTO object files, and is only meaningful in
7630 conjunction with LTO mode (@option{-fwhopr}, @option{-flto}).  Valid
7631 values are 0 (no compression) to 9 (maximum compression).  Values
7632 outside this range are clamped to either 0 or 9.  If the option is not
7633 given, a default balanced compression setting is used.
7635 @item -flto-report
7636 Prints a report with internal details on the workings of the link-time
7637 optimizer.  The contents of this report vary from version to version,
7638 it is meant to be useful to GCC developers when processing object
7639 files in LTO mode (via @option{-fwhopr} or @option{-flto}).
7641 Disabled by default.
7643 @item -fuse-linker-plugin
7644 Enables the extraction of objects with GIMPLE bytecode information
7645 from library archives.  This option relies on features available only
7646 in @command{gold}, so to use this you must configure GCC with
7647 @option{--enable-gold}.  See @option{-flto} for a description on the
7648 effect of this flag and how to use it.
7650 Disabled by default.
7652 @item -fcprop-registers
7653 @opindex fcprop-registers
7654 After register allocation and post-register allocation instruction splitting,
7655 we perform a copy-propagation pass to try to reduce scheduling dependencies
7656 and occasionally eliminate the copy.
7658 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7660 @item -fprofile-correction
7661 @opindex fprofile-correction
7662 Profiles collected using an instrumented binary for multi-threaded programs may
7663 be inconsistent due to missed counter updates. When this option is specified,
7664 GCC will use heuristics to correct or smooth out such inconsistencies. By
7665 default, GCC will emit an error message when an inconsistent profile is detected.
7667 @item -fprofile-dir=@var{path}
7668 @opindex fprofile-dir
7670 Set the directory to search the profile data files in to @var{path}.
7671 This option affects only the profile data generated by
7672 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7673 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7674 and its related options.
7675 By default, GCC will use the current directory as @var{path}
7676 thus the profile data file will appear in the same directory as the object file.
7678 @item -fprofile-generate
7679 @itemx -fprofile-generate=@var{path}
7680 @opindex fprofile-generate
7682 Enable options usually used for instrumenting application to produce
7683 profile useful for later recompilation with profile feedback based
7684 optimization.  You must use @option{-fprofile-generate} both when
7685 compiling and when linking your program.
7687 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7689 If @var{path} is specified, GCC will look at the @var{path} to find
7690 the profile feedback data files. See @option{-fprofile-dir}.
7692 @item -fprofile-use
7693 @itemx -fprofile-use=@var{path}
7694 @opindex fprofile-use
7695 Enable profile feedback directed optimizations, and optimizations
7696 generally profitable only with profile feedback available.
7698 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7699 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7701 By default, GCC emits an error message if the feedback profiles do not
7702 match the source code.  This error can be turned into a warning by using
7703 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7704 code.
7706 If @var{path} is specified, GCC will look at the @var{path} to find
7707 the profile feedback data files. See @option{-fprofile-dir}.
7708 @end table
7710 The following options control compiler behavior regarding floating
7711 point arithmetic.  These options trade off between speed and
7712 correctness.  All must be specifically enabled.
7714 @table @gcctabopt
7715 @item -ffloat-store
7716 @opindex ffloat-store
7717 Do not store floating point variables in registers, and inhibit other
7718 options that might change whether a floating point value is taken from a
7719 register or memory.
7721 @cindex floating point precision
7722 This option prevents undesirable excess precision on machines such as
7723 the 68000 where the floating registers (of the 68881) keep more
7724 precision than a @code{double} is supposed to have.  Similarly for the
7725 x86 architecture.  For most programs, the excess precision does only
7726 good, but a few programs rely on the precise definition of IEEE floating
7727 point.  Use @option{-ffloat-store} for such programs, after modifying
7728 them to store all pertinent intermediate computations into variables.
7730 @item -fexcess-precision=@var{style}
7731 @opindex fexcess-precision
7732 This option allows further control over excess precision on machines
7733 where floating-point registers have more precision than the IEEE
7734 @code{float} and @code{double} types and the processor does not
7735 support operations rounding to those types.  By default,
7736 @option{-fexcess-precision=fast} is in effect; this means that
7737 operations are carried out in the precision of the registers and that
7738 it is unpredictable when rounding to the types specified in the source
7739 code takes place.  When compiling C, if
7740 @option{-fexcess-precision=standard} is specified then excess
7741 precision will follow the rules specified in ISO C99; in particular,
7742 both casts and assignments cause values to be rounded to their
7743 semantic types (whereas @option{-ffloat-store} only affects
7744 assignments).  This option is enabled by default for C if a strict
7745 conformance option such as @option{-std=c99} is used.
7747 @opindex mfpmath
7748 @option{-fexcess-precision=standard} is not implemented for languages
7749 other than C, and has no effect if
7750 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7751 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7752 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7753 semantics apply without excess precision, and in the latter, rounding
7754 is unpredictable.
7756 @item -ffast-math
7757 @opindex ffast-math
7758 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7759 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7760 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7762 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7764 This option is not turned on by any @option{-O} option since
7765 it can result in incorrect output for programs which depend on
7766 an exact implementation of IEEE or ISO rules/specifications for
7767 math functions. It may, however, yield faster code for programs
7768 that do not require the guarantees of these specifications.
7770 @item -fno-math-errno
7771 @opindex fno-math-errno
7772 Do not set ERRNO after calling math functions that are executed
7773 with a single instruction, e.g., sqrt.  A program that relies on
7774 IEEE exceptions for math error handling may want to use this flag
7775 for speed while maintaining IEEE arithmetic compatibility.
7777 This option is not turned on by any @option{-O} option since
7778 it can result in incorrect output for programs which depend on
7779 an exact implementation of IEEE or ISO rules/specifications for
7780 math functions. It may, however, yield faster code for programs
7781 that do not require the guarantees of these specifications.
7783 The default is @option{-fmath-errno}.
7785 On Darwin systems, the math library never sets @code{errno}.  There is
7786 therefore no reason for the compiler to consider the possibility that
7787 it might, and @option{-fno-math-errno} is the default.
7789 @item -funsafe-math-optimizations
7790 @opindex funsafe-math-optimizations
7792 Allow optimizations for floating-point arithmetic that (a) assume
7793 that arguments and results are valid and (b) may violate IEEE or
7794 ANSI standards.  When used at link-time, it may include libraries
7795 or startup files that change the default FPU control word or other
7796 similar optimizations.
7798 This option is not turned on by any @option{-O} option since
7799 it can result in incorrect output for programs which depend on
7800 an exact implementation of IEEE or ISO rules/specifications for
7801 math functions. It may, however, yield faster code for programs
7802 that do not require the guarantees of these specifications.
7803 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7804 @option{-fassociative-math} and @option{-freciprocal-math}.
7806 The default is @option{-fno-unsafe-math-optimizations}.
7808 @item -fassociative-math
7809 @opindex fassociative-math
7811 Allow re-association of operands in series of floating-point operations.
7812 This violates the ISO C and C++ language standard by possibly changing
7813 computation result.  NOTE: re-ordering may change the sign of zero as
7814 well as ignore NaNs and inhibit or create underflow or overflow (and
7815 thus cannot be used on a code which relies on rounding behavior like
7816 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7817 and thus may not be used when ordered comparisons are required.
7818 This option requires that both @option{-fno-signed-zeros} and
7819 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7820 much sense with @option{-frounding-math}. For Fortran the option
7821 is automatically enabled when both @option{-fno-signed-zeros} and
7822 @option{-fno-trapping-math} are in effect.
7824 The default is @option{-fno-associative-math}.
7826 @item -freciprocal-math
7827 @opindex freciprocal-math
7829 Allow the reciprocal of a value to be used instead of dividing by
7830 the value if this enables optimizations.  For example @code{x / y}
7831 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7832 is subject to common subexpression elimination.  Note that this loses
7833 precision and increases the number of flops operating on the value.
7835 The default is @option{-fno-reciprocal-math}.
7837 @item -ffinite-math-only
7838 @opindex ffinite-math-only
7839 Allow optimizations for floating-point arithmetic that assume
7840 that arguments and results are not NaNs or +-Infs.
7842 This option is not turned on by any @option{-O} option since
7843 it can result in incorrect output for programs which depend on
7844 an exact implementation of IEEE or ISO rules/specifications for
7845 math functions. It may, however, yield faster code for programs
7846 that do not require the guarantees of these specifications.
7848 The default is @option{-fno-finite-math-only}.
7850 @item -fno-signed-zeros
7851 @opindex fno-signed-zeros
7852 Allow optimizations for floating point arithmetic that ignore the
7853 signedness of zero.  IEEE arithmetic specifies the behavior of
7854 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7855 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7856 This option implies that the sign of a zero result isn't significant.
7858 The default is @option{-fsigned-zeros}.
7860 @item -fno-trapping-math
7861 @opindex fno-trapping-math
7862 Compile code assuming that floating-point operations cannot generate
7863 user-visible traps.  These traps include division by zero, overflow,
7864 underflow, inexact result and invalid operation.  This option requires
7865 that @option{-fno-signaling-nans} be in effect.  Setting this option may
7866 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7868 This option should never be turned on by any @option{-O} option since
7869 it can result in incorrect output for programs which depend on
7870 an exact implementation of IEEE or ISO rules/specifications for
7871 math functions.
7873 The default is @option{-ftrapping-math}.
7875 @item -frounding-math
7876 @opindex frounding-math
7877 Disable transformations and optimizations that assume default floating
7878 point rounding behavior.  This is round-to-zero for all floating point
7879 to integer conversions, and round-to-nearest for all other arithmetic
7880 truncations.  This option should be specified for programs that change
7881 the FP rounding mode dynamically, or that may be executed with a
7882 non-default rounding mode.  This option disables constant folding of
7883 floating point expressions at compile-time (which may be affected by
7884 rounding mode) and arithmetic transformations that are unsafe in the
7885 presence of sign-dependent rounding modes.
7887 The default is @option{-fno-rounding-math}.
7889 This option is experimental and does not currently guarantee to
7890 disable all GCC optimizations that are affected by rounding mode.
7891 Future versions of GCC may provide finer control of this setting
7892 using C99's @code{FENV_ACCESS} pragma.  This command line option
7893 will be used to specify the default state for @code{FENV_ACCESS}.
7895 @item -fsignaling-nans
7896 @opindex fsignaling-nans
7897 Compile code assuming that IEEE signaling NaNs may generate user-visible
7898 traps during floating-point operations.  Setting this option disables
7899 optimizations that may change the number of exceptions visible with
7900 signaling NaNs.  This option implies @option{-ftrapping-math}.
7902 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7903 be defined.
7905 The default is @option{-fno-signaling-nans}.
7907 This option is experimental and does not currently guarantee to
7908 disable all GCC optimizations that affect signaling NaN behavior.
7910 @item -fsingle-precision-constant
7911 @opindex fsingle-precision-constant
7912 Treat floating point constant as single precision constant instead of
7913 implicitly converting it to double precision constant.
7915 @item -fcx-limited-range
7916 @opindex fcx-limited-range
7917 When enabled, this option states that a range reduction step is not
7918 needed when performing complex division.  Also, there is no checking
7919 whether the result of a complex multiplication or division is @code{NaN
7920 + I*NaN}, with an attempt to rescue the situation in that case.  The
7921 default is @option{-fno-cx-limited-range}, but is enabled by
7922 @option{-ffast-math}.
7924 This option controls the default setting of the ISO C99
7925 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
7926 all languages.
7928 @item -fcx-fortran-rules
7929 @opindex fcx-fortran-rules
7930 Complex multiplication and division follow Fortran rules.  Range
7931 reduction is done as part of complex division, but there is no checking
7932 whether the result of a complex multiplication or division is @code{NaN
7933 + I*NaN}, with an attempt to rescue the situation in that case.
7935 The default is @option{-fno-cx-fortran-rules}.
7937 @end table
7939 The following options control optimizations that may improve
7940 performance, but are not enabled by any @option{-O} options.  This
7941 section includes experimental options that may produce broken code.
7943 @table @gcctabopt
7944 @item -fbranch-probabilities
7945 @opindex fbranch-probabilities
7946 After running a program compiled with @option{-fprofile-arcs}
7947 (@pxref{Debugging Options,, Options for Debugging Your Program or
7948 @command{gcc}}), you can compile it a second time using
7949 @option{-fbranch-probabilities}, to improve optimizations based on
7950 the number of times each branch was taken.  When the program
7951 compiled with @option{-fprofile-arcs} exits it saves arc execution
7952 counts to a file called @file{@var{sourcename}.gcda} for each source
7953 file.  The information in this data file is very dependent on the
7954 structure of the generated code, so you must use the same source code
7955 and the same optimization options for both compilations.
7957 With @option{-fbranch-probabilities}, GCC puts a
7958 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7959 These can be used to improve optimization.  Currently, they are only
7960 used in one place: in @file{reorg.c}, instead of guessing which path a
7961 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
7962 exactly determine which path is taken more often.
7964 @item -fprofile-values
7965 @opindex fprofile-values
7966 If combined with @option{-fprofile-arcs}, it adds code so that some
7967 data about values of expressions in the program is gathered.
7969 With @option{-fbranch-probabilities}, it reads back the data gathered
7970 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
7971 notes to instructions for their later usage in optimizations.
7973 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
7975 @item -fvpt
7976 @opindex fvpt
7977 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7978 a code to gather information about values of expressions.
7980 With @option{-fbranch-probabilities}, it reads back the data gathered
7981 and actually performs the optimizations based on them.
7982 Currently the optimizations include specialization of division operation
7983 using the knowledge about the value of the denominator.
7985 @item -frename-registers
7986 @opindex frename-registers
7987 Attempt to avoid false dependencies in scheduled code by making use
7988 of registers left over after register allocation.  This optimization
7989 will most benefit processors with lots of registers.  Depending on the
7990 debug information format adopted by the target, however, it can
7991 make debugging impossible, since variables will no longer stay in
7992 a ``home register''.
7994 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
7996 @item -ftracer
7997 @opindex ftracer
7998 Perform tail duplication to enlarge superblock size.  This transformation
7999 simplifies the control flow of the function allowing other optimizations to do
8000 better job.
8002 Enabled with @option{-fprofile-use}.
8004 @item -funroll-loops
8005 @opindex funroll-loops
8006 Unroll loops whose number of iterations can be determined at compile time or
8007 upon entry to the loop.  @option{-funroll-loops} implies
8008 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8009 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8010 small constant number of iterations).  This option makes code larger, and may
8011 or may not make it run faster.
8013 Enabled with @option{-fprofile-use}.
8015 @item -funroll-all-loops
8016 @opindex funroll-all-loops
8017 Unroll all loops, even if their number of iterations is uncertain when
8018 the loop is entered.  This usually makes programs run more slowly.
8019 @option{-funroll-all-loops} implies the same options as
8020 @option{-funroll-loops}.
8022 @item -fpeel-loops
8023 @opindex fpeel-loops
8024 Peels the loops for that there is enough information that they do not
8025 roll much (from profile feedback).  It also turns on complete loop peeling
8026 (i.e.@: complete removal of loops with small constant number of iterations).
8028 Enabled with @option{-fprofile-use}.
8030 @item -fmove-loop-invariants
8031 @opindex fmove-loop-invariants
8032 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8033 at level @option{-O1}
8035 @item -funswitch-loops
8036 @opindex funswitch-loops
8037 Move branches with loop invariant conditions out of the loop, with duplicates
8038 of the loop on both branches (modified according to result of the condition).
8040 @item -ffunction-sections
8041 @itemx -fdata-sections
8042 @opindex ffunction-sections
8043 @opindex fdata-sections
8044 Place each function or data item into its own section in the output
8045 file if the target supports arbitrary sections.  The name of the
8046 function or the name of the data item determines the section's name
8047 in the output file.
8049 Use these options on systems where the linker can perform optimizations
8050 to improve locality of reference in the instruction space.  Most systems
8051 using the ELF object format and SPARC processors running Solaris 2 have
8052 linkers with such optimizations.  AIX may have these optimizations in
8053 the future.
8055 Only use these options when there are significant benefits from doing
8056 so.  When you specify these options, the assembler and linker will
8057 create larger object and executable files and will also be slower.
8058 You will not be able to use @code{gprof} on all systems if you
8059 specify this option and you may have problems with debugging if
8060 you specify both this option and @option{-g}.
8062 @item -fbranch-target-load-optimize
8063 @opindex fbranch-target-load-optimize
8064 Perform branch target register load optimization before prologue / epilogue
8065 threading.
8066 The use of target registers can typically be exposed only during reload,
8067 thus hoisting loads out of loops and doing inter-block scheduling needs
8068 a separate optimization pass.
8070 @item -fbranch-target-load-optimize2
8071 @opindex fbranch-target-load-optimize2
8072 Perform branch target register load optimization after prologue / epilogue
8073 threading.
8075 @item -fbtr-bb-exclusive
8076 @opindex fbtr-bb-exclusive
8077 When performing branch target register load optimization, don't reuse
8078 branch target registers in within any basic block.
8080 @item -fstack-protector
8081 @opindex fstack-protector
8082 Emit extra code to check for buffer overflows, such as stack smashing
8083 attacks.  This is done by adding a guard variable to functions with
8084 vulnerable objects.  This includes functions that call alloca, and
8085 functions with buffers larger than 8 bytes.  The guards are initialized
8086 when a function is entered and then checked when the function exits.
8087 If a guard check fails, an error message is printed and the program exits.
8089 @item -fstack-protector-all
8090 @opindex fstack-protector-all
8091 Like @option{-fstack-protector} except that all functions are protected.
8093 @item -fsection-anchors
8094 @opindex fsection-anchors
8095 Try to reduce the number of symbolic address calculations by using
8096 shared ``anchor'' symbols to address nearby objects.  This transformation
8097 can help to reduce the number of GOT entries and GOT accesses on some
8098 targets.
8100 For example, the implementation of the following function @code{foo}:
8102 @smallexample
8103 static int a, b, c;
8104 int foo (void) @{ return a + b + c; @}
8105 @end smallexample
8107 would usually calculate the addresses of all three variables, but if you
8108 compile it with @option{-fsection-anchors}, it will access the variables
8109 from a common anchor point instead.  The effect is similar to the
8110 following pseudocode (which isn't valid C):
8112 @smallexample
8113 int foo (void)
8115   register int *xr = &x;
8116   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8118 @end smallexample
8120 Not all targets support this option.
8122 @item --param @var{name}=@var{value}
8123 @opindex param
8124 In some places, GCC uses various constants to control the amount of
8125 optimization that is done.  For example, GCC will not inline functions
8126 that contain more that a certain number of instructions.  You can
8127 control some of these constants on the command-line using the
8128 @option{--param} option.
8130 The names of specific parameters, and the meaning of the values, are
8131 tied to the internals of the compiler, and are subject to change
8132 without notice in future releases.
8134 In each case, the @var{value} is an integer.  The allowable choices for
8135 @var{name} are given in the following table:
8137 @table @gcctabopt
8138 @item struct-reorg-cold-struct-ratio
8139 The threshold ratio (as a percentage) between a structure frequency
8140 and the frequency of the hottest structure in the program.  This parameter
8141 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
8142 We say that if the ratio of a structure frequency, calculated by profiling,
8143 to the hottest structure frequency in the program is less than this
8144 parameter, then structure reorganization is not applied to this structure.
8145 The default is 10.
8147 @item predictable-branch-outcome
8148 When branch is predicted to be taken with probability lower than this threshold
8149 (in percent), then it is considered well predictable. The default is 10.
8151 @item max-crossjump-edges
8152 The maximum number of incoming edges to consider for crossjumping.
8153 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8154 the number of edges incoming to each block.  Increasing values mean
8155 more aggressive optimization, making the compile time increase with
8156 probably small improvement in executable size.
8158 @item min-crossjump-insns
8159 The minimum number of instructions which must be matched at the end
8160 of two blocks before crossjumping will be performed on them.  This
8161 value is ignored in the case where all instructions in the block being
8162 crossjumped from are matched.  The default value is 5.
8164 @item max-grow-copy-bb-insns
8165 The maximum code size expansion factor when copying basic blocks
8166 instead of jumping.  The expansion is relative to a jump instruction.
8167 The default value is 8.
8169 @item max-goto-duplication-insns
8170 The maximum number of instructions to duplicate to a block that jumps
8171 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8172 passes, GCC factors computed gotos early in the compilation process,
8173 and unfactors them as late as possible.  Only computed jumps at the
8174 end of a basic blocks with no more than max-goto-duplication-insns are
8175 unfactored.  The default value is 8.
8177 @item max-delay-slot-insn-search
8178 The maximum number of instructions to consider when looking for an
8179 instruction to fill a delay slot.  If more than this arbitrary number of
8180 instructions is searched, the time savings from filling the delay slot
8181 will be minimal so stop searching.  Increasing values mean more
8182 aggressive optimization, making the compile time increase with probably
8183 small improvement in executable run time.
8185 @item max-delay-slot-live-search
8186 When trying to fill delay slots, the maximum number of instructions to
8187 consider when searching for a block with valid live register
8188 information.  Increasing this arbitrarily chosen value means more
8189 aggressive optimization, increasing the compile time.  This parameter
8190 should be removed when the delay slot code is rewritten to maintain the
8191 control-flow graph.
8193 @item max-gcse-memory
8194 The approximate maximum amount of memory that will be allocated in
8195 order to perform the global common subexpression elimination
8196 optimization.  If more memory than specified is required, the
8197 optimization will not be done.
8199 @item max-pending-list-length
8200 The maximum number of pending dependencies scheduling will allow
8201 before flushing the current state and starting over.  Large functions
8202 with few branches or calls can create excessively large lists which
8203 needlessly consume memory and resources.
8205 @item max-inline-insns-single
8206 Several parameters control the tree inliner used in gcc.
8207 This number sets the maximum number of instructions (counted in GCC's
8208 internal representation) in a single function that the tree inliner
8209 will consider for inlining.  This only affects functions declared
8210 inline and methods implemented in a class declaration (C++).
8211 The default value is 300.
8213 @item max-inline-insns-auto
8214 When you use @option{-finline-functions} (included in @option{-O3}),
8215 a lot of functions that would otherwise not be considered for inlining
8216 by the compiler will be investigated.  To those functions, a different
8217 (more restrictive) limit compared to functions declared inline can
8218 be applied.
8219 The default value is 40.
8221 @item large-function-insns
8222 The limit specifying really large functions.  For functions larger than this
8223 limit after inlining, inlining is constrained by
8224 @option{--param large-function-growth}.  This parameter is useful primarily
8225 to avoid extreme compilation time caused by non-linear algorithms used by the
8226 backend.
8227 The default value is 2700.
8229 @item large-function-growth
8230 Specifies maximal growth of large function caused by inlining in percents.
8231 The default value is 100 which limits large function growth to 2.0 times
8232 the original size.
8234 @item large-unit-insns
8235 The limit specifying large translation unit.  Growth caused by inlining of
8236 units larger than this limit is limited by @option{--param inline-unit-growth}.
8237 For small units this might be too tight (consider unit consisting of function A
8238 that is inline and B that just calls A three time.  If B is small relative to
8239 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8240 large units consisting of small inlineable functions however the overall unit
8241 growth limit is needed to avoid exponential explosion of code size.  Thus for
8242 smaller units, the size is increased to @option{--param large-unit-insns}
8243 before applying @option{--param inline-unit-growth}.  The default is 10000
8245 @item inline-unit-growth
8246 Specifies maximal overall growth of the compilation unit caused by inlining.
8247 The default value is 30 which limits unit growth to 1.3 times the original
8248 size.
8250 @item ipcp-unit-growth
8251 Specifies maximal overall growth of the compilation unit caused by
8252 interprocedural constant propagation.  The default value is 10 which limits
8253 unit growth to 1.1 times the original size.
8255 @item large-stack-frame
8256 The limit specifying large stack frames.  While inlining the algorithm is trying
8257 to not grow past this limit too much.  Default value is 256 bytes.
8259 @item large-stack-frame-growth
8260 Specifies maximal growth of large stack frames caused by inlining in percents.
8261 The default value is 1000 which limits large stack frame growth to 11 times
8262 the original size.
8264 @item max-inline-insns-recursive
8265 @itemx max-inline-insns-recursive-auto
8266 Specifies maximum number of instructions out-of-line copy of self recursive inline
8267 function can grow into by performing recursive inlining.
8269 For functions declared inline @option{--param max-inline-insns-recursive} is
8270 taken into account.  For function not declared inline, recursive inlining
8271 happens only when @option{-finline-functions} (included in @option{-O3}) is
8272 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8273 default value is 450.
8275 @item max-inline-recursive-depth
8276 @itemx max-inline-recursive-depth-auto
8277 Specifies maximum recursion depth used by the recursive inlining.
8279 For functions declared inline @option{--param max-inline-recursive-depth} is
8280 taken into account.  For function not declared inline, recursive inlining
8281 happens only when @option{-finline-functions} (included in @option{-O3}) is
8282 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8283 default value is 8.
8285 @item min-inline-recursive-probability
8286 Recursive inlining is profitable only for function having deep recursion
8287 in average and can hurt for function having little recursion depth by
8288 increasing the prologue size or complexity of function body to other
8289 optimizers.
8291 When profile feedback is available (see @option{-fprofile-generate}) the actual
8292 recursion depth can be guessed from probability that function will recurse via
8293 given call expression.  This parameter limits inlining only to call expression
8294 whose probability exceeds given threshold (in percents).  The default value is
8297 @item early-inlining-insns
8298 Specify growth that early inliner can make.  In effect it increases amount of
8299 inlining for code having large abstraction penalty.  The default value is 8.
8301 @item max-early-inliner-iterations
8302 @itemx max-early-inliner-iterations
8303 Limit of iterations of early inliner.  This basically bounds number of nested
8304 indirect calls early inliner can resolve.  Deeper chains are still handled by
8305 late inlining.
8307 @item min-vect-loop-bound
8308 The minimum number of iterations under which a loop will not get vectorized
8309 when @option{-ftree-vectorize} is used.  The number of iterations after
8310 vectorization needs to be greater than the value specified by this option
8311 to allow vectorization.  The default value is 0.
8313 @item gcse-cost-distance-ratio
8314 Scaling factor in calculation of maximum distance an expression
8315 can be moved by GCSE optimizations.  This is currently supported only in
8316 code hoisting pass.  The bigger the ratio, the more agressive code hoisting
8317 will be with simple expressions, i.e., the expressions which have cost
8318 less than @option{gcse-unrestricted-cost}.  Specifying 0 will disable
8319 hoisting of simple expressions.  The default value is 10.
8321 @item gcse-unrestricted-cost
8322 Cost, roughly measured as the cost of a single typical machine
8323 instruction, at which GCSE optimizations will not constrain
8324 the distance an expression can travel.  This is currently
8325 supported only in code hoisting pass.  The lesser the cost,
8326 the more aggressive code hoisting will be.  Specifying 0 will
8327 allow all expressions to travel unrestricted distances.
8328 The default value is 3.
8330 @item max-hoist-depth
8331 The depth of search in the dominator tree for expressions to hoist.
8332 This is used to avoid quadratic behavior in hoisting algorithm.
8333 The value of 0 will avoid limiting the search, but may slow down compilation
8334 of huge functions.  The default value is 30.
8336 @item max-unrolled-insns
8337 The maximum number of instructions that a loop should have if that loop
8338 is unrolled, and if the loop is unrolled, it determines how many times
8339 the loop code is unrolled.
8341 @item max-average-unrolled-insns
8342 The maximum number of instructions biased by probabilities of their execution
8343 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8344 it determines how many times the loop code is unrolled.
8346 @item max-unroll-times
8347 The maximum number of unrollings of a single loop.
8349 @item max-peeled-insns
8350 The maximum number of instructions that a loop should have if that loop
8351 is peeled, and if the loop is peeled, it determines how many times
8352 the loop code is peeled.
8354 @item max-peel-times
8355 The maximum number of peelings of a single loop.
8357 @item max-completely-peeled-insns
8358 The maximum number of insns of a completely peeled loop.
8360 @item max-completely-peel-times
8361 The maximum number of iterations of a loop to be suitable for complete peeling.
8363 @item max-completely-peel-loop-nest-depth
8364 The maximum depth of a loop nest suitable for complete peeling.
8366 @item max-unswitch-insns
8367 The maximum number of insns of an unswitched loop.
8369 @item max-unswitch-level
8370 The maximum number of branches unswitched in a single loop.
8372 @item lim-expensive
8373 The minimum cost of an expensive expression in the loop invariant motion.
8375 @item iv-consider-all-candidates-bound
8376 Bound on number of candidates for induction variables below that
8377 all candidates are considered for each use in induction variable
8378 optimizations.  Only the most relevant candidates are considered
8379 if there are more candidates, to avoid quadratic time complexity.
8381 @item iv-max-considered-uses
8382 The induction variable optimizations give up on loops that contain more
8383 induction variable uses.
8385 @item iv-always-prune-cand-set-bound
8386 If number of candidates in the set is smaller than this value,
8387 we always try to remove unnecessary ivs from the set during its
8388 optimization when a new iv is added to the set.
8390 @item scev-max-expr-size
8391 Bound on size of expressions used in the scalar evolutions analyzer.
8392 Large expressions slow the analyzer.
8394 @item omega-max-vars
8395 The maximum number of variables in an Omega constraint system.
8396 The default value is 128.
8398 @item omega-max-geqs
8399 The maximum number of inequalities in an Omega constraint system.
8400 The default value is 256.
8402 @item omega-max-eqs
8403 The maximum number of equalities in an Omega constraint system.
8404 The default value is 128.
8406 @item omega-max-wild-cards
8407 The maximum number of wildcard variables that the Omega solver will
8408 be able to insert.  The default value is 18.
8410 @item omega-hash-table-size
8411 The size of the hash table in the Omega solver.  The default value is
8412 550.
8414 @item omega-max-keys
8415 The maximal number of keys used by the Omega solver.  The default
8416 value is 500.
8418 @item omega-eliminate-redundant-constraints
8419 When set to 1, use expensive methods to eliminate all redundant
8420 constraints.  The default value is 0.
8422 @item vect-max-version-for-alignment-checks
8423 The maximum number of runtime checks that can be performed when
8424 doing loop versioning for alignment in the vectorizer.  See option
8425 ftree-vect-loop-version for more information.
8427 @item vect-max-version-for-alias-checks
8428 The maximum number of runtime checks that can be performed when
8429 doing loop versioning for alias in the vectorizer.  See option
8430 ftree-vect-loop-version for more information.
8432 @item max-iterations-to-track
8434 The maximum number of iterations of a loop the brute force algorithm
8435 for analysis of # of iterations of the loop tries to evaluate.
8437 @item hot-bb-count-fraction
8438 Select fraction of the maximal count of repetitions of basic block in program
8439 given basic block needs to have to be considered hot.
8441 @item hot-bb-frequency-fraction
8442 Select fraction of the maximal frequency of executions of basic block in
8443 function given basic block needs to have to be considered hot
8445 @item max-predicted-iterations
8446 The maximum number of loop iterations we predict statically.  This is useful
8447 in cases where function contain single loop with known bound and other loop
8448 with unknown.  We predict the known number of iterations correctly, while
8449 the unknown number of iterations average to roughly 10.  This means that the
8450 loop without bounds would appear artificially cold relative to the other one.
8452 @item align-threshold
8454 Select fraction of the maximal frequency of executions of basic block in
8455 function given basic block will get aligned.
8457 @item align-loop-iterations
8459 A loop expected to iterate at lest the selected number of iterations will get
8460 aligned.
8462 @item tracer-dynamic-coverage
8463 @itemx tracer-dynamic-coverage-feedback
8465 This value is used to limit superblock formation once the given percentage of
8466 executed instructions is covered.  This limits unnecessary code size
8467 expansion.
8469 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8470 feedback is available.  The real profiles (as opposed to statically estimated
8471 ones) are much less balanced allowing the threshold to be larger value.
8473 @item tracer-max-code-growth
8474 Stop tail duplication once code growth has reached given percentage.  This is
8475 rather hokey argument, as most of the duplicates will be eliminated later in
8476 cross jumping, so it may be set to much higher values than is the desired code
8477 growth.
8479 @item tracer-min-branch-ratio
8481 Stop reverse growth when the reverse probability of best edge is less than this
8482 threshold (in percent).
8484 @item tracer-min-branch-ratio
8485 @itemx tracer-min-branch-ratio-feedback
8487 Stop forward growth if the best edge do have probability lower than this
8488 threshold.
8490 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8491 compilation for profile feedback and one for compilation without.  The value
8492 for compilation with profile feedback needs to be more conservative (higher) in
8493 order to make tracer effective.
8495 @item max-cse-path-length
8497 Maximum number of basic blocks on path that cse considers.  The default is 10.
8499 @item max-cse-insns
8500 The maximum instructions CSE process before flushing. The default is 1000.
8502 @item ggc-min-expand
8504 GCC uses a garbage collector to manage its own memory allocation.  This
8505 parameter specifies the minimum percentage by which the garbage
8506 collector's heap should be allowed to expand between collections.
8507 Tuning this may improve compilation speed; it has no effect on code
8508 generation.
8510 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8511 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8512 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8513 GCC is not able to calculate RAM on a particular platform, the lower
8514 bound of 30% is used.  Setting this parameter and
8515 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8516 every opportunity.  This is extremely slow, but can be useful for
8517 debugging.
8519 @item ggc-min-heapsize
8521 Minimum size of the garbage collector's heap before it begins bothering
8522 to collect garbage.  The first collection occurs after the heap expands
8523 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8524 tuning this may improve compilation speed, and has no effect on code
8525 generation.
8527 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8528 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8529 with a lower bound of 4096 (four megabytes) and an upper bound of
8530 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8531 particular platform, the lower bound is used.  Setting this parameter
8532 very large effectively disables garbage collection.  Setting this
8533 parameter and @option{ggc-min-expand} to zero causes a full collection
8534 to occur at every opportunity.
8536 @item max-reload-search-insns
8537 The maximum number of instruction reload should look backward for equivalent
8538 register.  Increasing values mean more aggressive optimization, making the
8539 compile time increase with probably slightly better performance.  The default
8540 value is 100.
8542 @item max-cselib-memory-locations
8543 The maximum number of memory locations cselib should take into account.
8544 Increasing values mean more aggressive optimization, making the compile time
8545 increase with probably slightly better performance.  The default value is 500.
8547 @item reorder-blocks-duplicate
8548 @itemx reorder-blocks-duplicate-feedback
8550 Used by basic block reordering pass to decide whether to use unconditional
8551 branch or duplicate the code on its destination.  Code is duplicated when its
8552 estimated size is smaller than this value multiplied by the estimated size of
8553 unconditional jump in the hot spots of the program.
8555 The @option{reorder-block-duplicate-feedback} is used only when profile
8556 feedback is available and may be set to higher values than
8557 @option{reorder-block-duplicate} since information about the hot spots is more
8558 accurate.
8560 @item max-sched-ready-insns
8561 The maximum number of instructions ready to be issued the scheduler should
8562 consider at any given time during the first scheduling pass.  Increasing
8563 values mean more thorough searches, making the compilation time increase
8564 with probably little benefit.  The default value is 100.
8566 @item max-sched-region-blocks
8567 The maximum number of blocks in a region to be considered for
8568 interblock scheduling.  The default value is 10.
8570 @item max-pipeline-region-blocks
8571 The maximum number of blocks in a region to be considered for
8572 pipelining in the selective scheduler.  The default value is 15.
8574 @item max-sched-region-insns
8575 The maximum number of insns in a region to be considered for
8576 interblock scheduling.  The default value is 100.
8578 @item max-pipeline-region-insns
8579 The maximum number of insns in a region to be considered for
8580 pipelining in the selective scheduler.  The default value is 200.
8582 @item min-spec-prob
8583 The minimum probability (in percents) of reaching a source block
8584 for interblock speculative scheduling.  The default value is 40.
8586 @item max-sched-extend-regions-iters
8587 The maximum number of iterations through CFG to extend regions.
8588 0 - disable region extension,
8589 N - do at most N iterations.
8590 The default value is 0.
8592 @item max-sched-insn-conflict-delay
8593 The maximum conflict delay for an insn to be considered for speculative motion.
8594 The default value is 3.
8596 @item sched-spec-prob-cutoff
8597 The minimal probability of speculation success (in percents), so that
8598 speculative insn will be scheduled.
8599 The default value is 40.
8601 @item sched-mem-true-dep-cost
8602 Minimal distance (in CPU cycles) between store and load targeting same
8603 memory locations.  The default value is 1.
8605 @item selsched-max-lookahead
8606 The maximum size of the lookahead window of selective scheduling.  It is a
8607 depth of search for available instructions.
8608 The default value is 50.
8610 @item selsched-max-sched-times
8611 The maximum number of times that an instruction will be scheduled during
8612 selective scheduling.  This is the limit on the number of iterations
8613 through which the instruction may be pipelined.  The default value is 2.
8615 @item selsched-max-insns-to-rename
8616 The maximum number of best instructions in the ready list that are considered
8617 for renaming in the selective scheduler.  The default value is 2.
8619 @item max-last-value-rtl
8620 The maximum size measured as number of RTLs that can be recorded in an expression
8621 in combiner for a pseudo register as last known value of that register.  The default
8622 is 10000.
8624 @item integer-share-limit
8625 Small integer constants can use a shared data structure, reducing the
8626 compiler's memory usage and increasing its speed.  This sets the maximum
8627 value of a shared integer constant.  The default value is 256.
8629 @item min-virtual-mappings
8630 Specifies the minimum number of virtual mappings in the incremental
8631 SSA updater that should be registered to trigger the virtual mappings
8632 heuristic defined by virtual-mappings-ratio.  The default value is
8633 100.
8635 @item virtual-mappings-ratio
8636 If the number of virtual mappings is virtual-mappings-ratio bigger
8637 than the number of virtual symbols to be updated, then the incremental
8638 SSA updater switches to a full update for those symbols.  The default
8639 ratio is 3.
8641 @item ssp-buffer-size
8642 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8643 protection when @option{-fstack-protection} is used.
8645 @item max-jump-thread-duplication-stmts
8646 Maximum number of statements allowed in a block that needs to be
8647 duplicated when threading jumps.
8649 @item max-fields-for-field-sensitive
8650 Maximum number of fields in a structure we will treat in
8651 a field sensitive manner during pointer analysis.  The default is zero
8652 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8654 @item prefetch-latency
8655 Estimate on average number of instructions that are executed before
8656 prefetch finishes.  The distance we prefetch ahead is proportional
8657 to this constant.  Increasing this number may also lead to less
8658 streams being prefetched (see @option{simultaneous-prefetches}).
8660 @item simultaneous-prefetches
8661 Maximum number of prefetches that can run at the same time.
8663 @item l1-cache-line-size
8664 The size of cache line in L1 cache, in bytes.
8666 @item l1-cache-size
8667 The size of L1 cache, in kilobytes.
8669 @item l2-cache-size
8670 The size of L2 cache, in kilobytes.
8672 @item min-insn-to-prefetch-ratio
8673 The minimum ratio between the number of instructions and the
8674 number of prefetches to enable prefetching in a loop.
8676 @item prefetch-min-insn-to-mem-ratio
8677 The minimum ratio between the number of instructions and the
8678 number of memory references to enable prefetching in a loop.
8680 @item use-canonical-types
8681 Whether the compiler should use the ``canonical'' type system.  By
8682 default, this should always be 1, which uses a more efficient internal
8683 mechanism for comparing types in C++ and Objective-C++.  However, if
8684 bugs in the canonical type system are causing compilation failures,
8685 set this value to 0 to disable canonical types.
8687 @item switch-conversion-max-branch-ratio
8688 Switch initialization conversion will refuse to create arrays that are
8689 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8690 branches in the switch.
8692 @item max-partial-antic-length
8693 Maximum length of the partial antic set computed during the tree
8694 partial redundancy elimination optimization (@option{-ftree-pre}) when
8695 optimizing at @option{-O3} and above.  For some sorts of source code
8696 the enhanced partial redundancy elimination optimization can run away,
8697 consuming all of the memory available on the host machine.  This
8698 parameter sets a limit on the length of the sets that are computed,
8699 which prevents the runaway behavior.  Setting a value of 0 for
8700 this parameter will allow an unlimited set length.
8702 @item sccvn-max-scc-size
8703 Maximum size of a strongly connected component (SCC) during SCCVN
8704 processing.  If this limit is hit, SCCVN processing for the whole
8705 function will not be done and optimizations depending on it will
8706 be disabled.  The default maximum SCC size is 10000.
8708 @item ira-max-loops-num
8709 IRA uses a regional register allocation by default.  If a function
8710 contains loops more than number given by the parameter, only at most
8711 given number of the most frequently executed loops will form regions
8712 for the regional register allocation.  The default value of the
8713 parameter is 100.
8715 @item ira-max-conflict-table-size
8716 Although IRA uses a sophisticated algorithm of compression conflict
8717 table, the table can be still big for huge functions.  If the conflict
8718 table for a function could be more than size in MB given by the
8719 parameter, the conflict table is not built and faster, simpler, and
8720 lower quality register allocation algorithm will be used.  The
8721 algorithm do not use pseudo-register conflicts.  The default value of
8722 the parameter is 2000.
8724 @item ira-loop-reserved-regs
8725 IRA can be used to evaluate more accurate register pressure in loops
8726 for decision to move loop invariants (see @option{-O3}).  The number
8727 of available registers reserved for some other purposes is described
8728 by this parameter.  The default value of the parameter is 2 which is
8729 minimal number of registers needed for execution of typical
8730 instruction.  This value is the best found from numerous experiments.
8732 @item loop-invariant-max-bbs-in-loop
8733 Loop invariant motion can be very expensive, both in compile time and
8734 in amount of needed compile time memory, with very large loops.  Loops
8735 with more basic blocks than this parameter won't have loop invariant
8736 motion optimization performed on them.  The default value of the
8737 parameter is 1000 for -O1 and 10000 for -O2 and above.
8739 @item max-vartrack-size
8740 Sets a maximum number of hash table slots to use during variable
8741 tracking dataflow analysis of any function.  If this limit is exceeded
8742 with variable tracking at assignments enabled, analysis for that
8743 function is retried without it, after removing all debug insns from
8744 the function.  If the limit is exceeded even without debug insns, var
8745 tracking analysis is completely disabled for the function.  Setting
8746 the parameter to zero makes it unlimited.
8748 @item min-nondebug-insn-uid
8749 Use uids starting at this parameter for nondebug insns.  The range below
8750 the parameter is reserved exclusively for debug insns created by
8751 @option{-fvar-tracking-assignments}, but debug insns may get
8752 (non-overlapping) uids above it if the reserved range is exhausted.
8754 @item ipa-sra-ptr-growth-factor
8755 IPA-SRA will replace a pointer to an aggregate with one or more new
8756 parameters only when their cumulative size is less or equal to
8757 @option{ipa-sra-ptr-growth-factor} times the size of the original
8758 pointer parameter.
8760 @item graphite-max-nb-scop-params
8761 To avoid exponential effects in the Graphite loop transforms, the
8762 number of parameters in a Static Control Part (SCoP) is bounded.  The
8763 default value is 10 parameters.  A variable whose value is unknown at
8764 compile time and defined outside a SCoP is a parameter of the SCoP.
8766 @item graphite-max-bbs-per-function
8767 To avoid exponential effects in the detection of SCoPs, the size of
8768 the functions analyzed by Graphite is bounded.  The default value is
8769 100 basic blocks.
8771 @item loop-block-tile-size
8772 Loop blocking or strip mining transforms, enabled with
8773 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
8774 loop in the loop nest by a given number of iterations.  The strip
8775 length can be changed using the @option{loop-block-tile-size}
8776 parameter.  The default value is 51 iterations.
8778 @item devirt-type-list-size
8779 IPA-CP attempts to track all possible types passed to a function's
8780 parameter in order to perform devirtualization.
8781 @option{devirt-type-list-size} is the maximum number of types it
8782 stores per a single formal parameter of a function.
8784 @end table
8785 @end table
8787 @node Preprocessor Options
8788 @section Options Controlling the Preprocessor
8789 @cindex preprocessor options
8790 @cindex options, preprocessor
8792 These options control the C preprocessor, which is run on each C source
8793 file before actual compilation.
8795 If you use the @option{-E} option, nothing is done except preprocessing.
8796 Some of these options make sense only together with @option{-E} because
8797 they cause the preprocessor output to be unsuitable for actual
8798 compilation.
8800 @table @gcctabopt
8801 @item -Wp,@var{option}
8802 @opindex Wp
8803 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8804 and pass @var{option} directly through to the preprocessor.  If
8805 @var{option} contains commas, it is split into multiple options at the
8806 commas.  However, many options are modified, translated or interpreted
8807 by the compiler driver before being passed to the preprocessor, and
8808 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8809 interface is undocumented and subject to change, so whenever possible
8810 you should avoid using @option{-Wp} and let the driver handle the
8811 options instead.
8813 @item -Xpreprocessor @var{option}
8814 @opindex Xpreprocessor
8815 Pass @var{option} as an option to the preprocessor.  You can use this to
8816 supply system-specific preprocessor options which GCC does not know how to
8817 recognize.
8819 If you want to pass an option that takes an argument, you must use
8820 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8821 @end table
8823 @include cppopts.texi
8825 @node Assembler Options
8826 @section Passing Options to the Assembler
8828 @c prevent bad page break with this line
8829 You can pass options to the assembler.
8831 @table @gcctabopt
8832 @item -Wa,@var{option}
8833 @opindex Wa
8834 Pass @var{option} as an option to the assembler.  If @var{option}
8835 contains commas, it is split into multiple options at the commas.
8837 @item -Xassembler @var{option}
8838 @opindex Xassembler
8839 Pass @var{option} as an option to the assembler.  You can use this to
8840 supply system-specific assembler options which GCC does not know how to
8841 recognize.
8843 If you want to pass an option that takes an argument, you must use
8844 @option{-Xassembler} twice, once for the option and once for the argument.
8846 @end table
8848 @node Link Options
8849 @section Options for Linking
8850 @cindex link options
8851 @cindex options, linking
8853 These options come into play when the compiler links object files into
8854 an executable output file.  They are meaningless if the compiler is
8855 not doing a link step.
8857 @table @gcctabopt
8858 @cindex file names
8859 @item @var{object-file-name}
8860 A file name that does not end in a special recognized suffix is
8861 considered to name an object file or library.  (Object files are
8862 distinguished from libraries by the linker according to the file
8863 contents.)  If linking is done, these object files are used as input
8864 to the linker.
8866 @item -c
8867 @itemx -S
8868 @itemx -E
8869 @opindex c
8870 @opindex S
8871 @opindex E
8872 If any of these options is used, then the linker is not run, and
8873 object file names should not be used as arguments.  @xref{Overall
8874 Options}.
8876 @cindex Libraries
8877 @item -l@var{library}
8878 @itemx -l @var{library}
8879 @opindex l
8880 Search the library named @var{library} when linking.  (The second
8881 alternative with the library as a separate argument is only for
8882 POSIX compliance and is not recommended.)
8884 It makes a difference where in the command you write this option; the
8885 linker searches and processes libraries and object files in the order they
8886 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8887 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8888 to functions in @samp{z}, those functions may not be loaded.
8890 The linker searches a standard list of directories for the library,
8891 which is actually a file named @file{lib@var{library}.a}.  The linker
8892 then uses this file as if it had been specified precisely by name.
8894 The directories searched include several standard system directories
8895 plus any that you specify with @option{-L}.
8897 Normally the files found this way are library files---archive files
8898 whose members are object files.  The linker handles an archive file by
8899 scanning through it for members which define symbols that have so far
8900 been referenced but not defined.  But if the file that is found is an
8901 ordinary object file, it is linked in the usual fashion.  The only
8902 difference between using an @option{-l} option and specifying a file name
8903 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8904 and searches several directories.
8906 @item -lobjc
8907 @opindex lobjc
8908 You need this special case of the @option{-l} option in order to
8909 link an Objective-C or Objective-C++ program.
8911 @item -nostartfiles
8912 @opindex nostartfiles
8913 Do not use the standard system startup files when linking.
8914 The standard system libraries are used normally, unless @option{-nostdlib}
8915 or @option{-nodefaultlibs} is used.
8917 @item -nodefaultlibs
8918 @opindex nodefaultlibs
8919 Do not use the standard system libraries when linking.
8920 Only the libraries you specify will be passed to the linker, options
8921 specifying linkage of the system libraries, such as @code{-static-libgcc}
8922 or @code{-shared-libgcc}, will be ignored.
8923 The standard startup files are used normally, unless @option{-nostartfiles}
8924 is used.  The compiler may generate calls to @code{memcmp},
8925 @code{memset}, @code{memcpy} and @code{memmove}.
8926 These entries are usually resolved by entries in
8927 libc.  These entry points should be supplied through some other
8928 mechanism when this option is specified.
8930 @item -nostdlib
8931 @opindex nostdlib
8932 Do not use the standard system startup files or libraries when linking.
8933 No startup files and only the libraries you specify will be passed to
8934 the linker, options specifying linkage of the system libraries, such as
8935 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8936 The compiler may generate calls to @code{memcmp}, @code{memset},
8937 @code{memcpy} and @code{memmove}.
8938 These entries are usually resolved by entries in
8939 libc.  These entry points should be supplied through some other
8940 mechanism when this option is specified.
8942 @cindex @option{-lgcc}, use with @option{-nostdlib}
8943 @cindex @option{-nostdlib} and unresolved references
8944 @cindex unresolved references and @option{-nostdlib}
8945 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8946 @cindex @option{-nodefaultlibs} and unresolved references
8947 @cindex unresolved references and @option{-nodefaultlibs}
8948 One of the standard libraries bypassed by @option{-nostdlib} and
8949 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8950 that GCC uses to overcome shortcomings of particular machines, or special
8951 needs for some languages.
8952 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8953 Collection (GCC) Internals},
8954 for more discussion of @file{libgcc.a}.)
8955 In most cases, you need @file{libgcc.a} even when you want to avoid
8956 other standard libraries.  In other words, when you specify @option{-nostdlib}
8957 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8958 This ensures that you have no unresolved references to internal GCC
8959 library subroutines.  (For example, @samp{__main}, used to ensure C++
8960 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8961 GNU Compiler Collection (GCC) Internals}.)
8963 @item -pie
8964 @opindex pie
8965 Produce a position independent executable on targets which support it.
8966 For predictable results, you must also specify the same set of options
8967 that were used to generate code (@option{-fpie}, @option{-fPIE},
8968 or model suboptions) when you specify this option.
8970 @item -rdynamic
8971 @opindex rdynamic
8972 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8973 that support it. This instructs the linker to add all symbols, not
8974 only used ones, to the dynamic symbol table. This option is needed
8975 for some uses of @code{dlopen} or to allow obtaining backtraces
8976 from within a program.
8978 @item -s
8979 @opindex s
8980 Remove all symbol table and relocation information from the executable.
8982 @item -static
8983 @opindex static
8984 On systems that support dynamic linking, this prevents linking with the shared
8985 libraries.  On other systems, this option has no effect.
8987 @item -shared
8988 @opindex shared
8989 Produce a shared object which can then be linked with other objects to
8990 form an executable.  Not all systems support this option.  For predictable
8991 results, you must also specify the same set of options that were used to
8992 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
8993 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
8994 needs to build supplementary stub code for constructors to work.  On
8995 multi-libbed systems, @samp{gcc -shared} must select the correct support
8996 libraries to link against.  Failing to supply the correct flags may lead
8997 to subtle defects.  Supplying them in cases where they are not necessary
8998 is innocuous.}
9000 @item -shared-libgcc
9001 @itemx -static-libgcc
9002 @opindex shared-libgcc
9003 @opindex static-libgcc
9004 On systems that provide @file{libgcc} as a shared library, these options
9005 force the use of either the shared or static version respectively.
9006 If no shared version of @file{libgcc} was built when the compiler was
9007 configured, these options have no effect.
9009 There are several situations in which an application should use the
9010 shared @file{libgcc} instead of the static version.  The most common
9011 of these is when the application wishes to throw and catch exceptions
9012 across different shared libraries.  In that case, each of the libraries
9013 as well as the application itself should use the shared @file{libgcc}.
9015 Therefore, the G++ and GCJ drivers automatically add
9016 @option{-shared-libgcc} whenever you build a shared library or a main
9017 executable, because C++ and Java programs typically use exceptions, so
9018 this is the right thing to do.
9020 If, instead, you use the GCC driver to create shared libraries, you may
9021 find that they will not always be linked with the shared @file{libgcc}.
9022 If GCC finds, at its configuration time, that you have a non-GNU linker
9023 or a GNU linker that does not support option @option{--eh-frame-hdr},
9024 it will link the shared version of @file{libgcc} into shared libraries
9025 by default.  Otherwise, it will take advantage of the linker and optimize
9026 away the linking with the shared version of @file{libgcc}, linking with
9027 the static version of libgcc by default.  This allows exceptions to
9028 propagate through such shared libraries, without incurring relocation
9029 costs at library load time.
9031 However, if a library or main executable is supposed to throw or catch
9032 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9033 for the languages used in the program, or using the option
9034 @option{-shared-libgcc}, such that it is linked with the shared
9035 @file{libgcc}.
9037 @item -static-libstdc++
9038 When the @command{g++} program is used to link a C++ program, it will
9039 normally automatically link against @option{libstdc++}.  If
9040 @file{libstdc++} is available as a shared library, and the
9041 @option{-static} option is not used, then this will link against the
9042 shared version of @file{libstdc++}.  That is normally fine.  However, it
9043 is sometimes useful to freeze the version of @file{libstdc++} used by
9044 the program without going all the way to a fully static link.  The
9045 @option{-static-libstdc++} option directs the @command{g++} driver to
9046 link @file{libstdc++} statically, without necessarily linking other
9047 libraries statically.
9049 @item -symbolic
9050 @opindex symbolic
9051 Bind references to global symbols when building a shared object.  Warn
9052 about any unresolved references (unless overridden by the link editor
9053 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
9054 this option.
9056 @item -T @var{script}
9057 @opindex T
9058 @cindex linker script
9059 Use @var{script} as the linker script.  This option is supported by most
9060 systems using the GNU linker.  On some targets, such as bare-board
9061 targets without an operating system, the @option{-T} option may be required
9062 when linking to avoid references to undefined symbols.
9064 @item -Xlinker @var{option}
9065 @opindex Xlinker
9066 Pass @var{option} as an option to the linker.  You can use this to
9067 supply system-specific linker options which GCC does not know how to
9068 recognize.
9070 If you want to pass an option that takes a separate argument, you must use
9071 @option{-Xlinker} twice, once for the option and once for the argument.
9072 For example, to pass @option{-assert definitions}, you must write
9073 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
9074 @option{-Xlinker "-assert definitions"}, because this passes the entire
9075 string as a single argument, which is not what the linker expects.
9077 When using the GNU linker, it is usually more convenient to pass
9078 arguments to linker options using the @option{@var{option}=@var{value}}
9079 syntax than as separate arguments.  For example, you can specify
9080 @samp{-Xlinker -Map=output.map} rather than
9081 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
9082 this syntax for command-line options.
9084 @item -Wl,@var{option}
9085 @opindex Wl
9086 Pass @var{option} as an option to the linker.  If @var{option} contains
9087 commas, it is split into multiple options at the commas.  You can use this
9088 syntax to pass an argument to the option.
9089 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
9090 linker.  When using the GNU linker, you can also get the same effect with
9091 @samp{-Wl,-Map=output.map}.
9093 @item -u @var{symbol}
9094 @opindex u
9095 Pretend the symbol @var{symbol} is undefined, to force linking of
9096 library modules to define it.  You can use @option{-u} multiple times with
9097 different symbols to force loading of additional library modules.
9098 @end table
9100 @node Directory Options
9101 @section Options for Directory Search
9102 @cindex directory options
9103 @cindex options, directory search
9104 @cindex search path
9106 These options specify directories to search for header files, for
9107 libraries and for parts of the compiler:
9109 @table @gcctabopt
9110 @item -I@var{dir}
9111 @opindex I
9112 Add the directory @var{dir} to the head of the list of directories to be
9113 searched for header files.  This can be used to override a system header
9114 file, substituting your own version, since these directories are
9115 searched before the system header file directories.  However, you should
9116 not use this option to add directories that contain vendor-supplied
9117 system header files (use @option{-isystem} for that).  If you use more than
9118 one @option{-I} option, the directories are scanned in left-to-right
9119 order; the standard system directories come after.
9121 If a standard system include directory, or a directory specified with
9122 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9123 option will be ignored.  The directory will still be searched but as a
9124 system directory at its normal position in the system include chain.
9125 This is to ensure that GCC's procedure to fix buggy system headers and
9126 the ordering for the include_next directive are not inadvertently changed.
9127 If you really need to change the search order for system directories,
9128 use the @option{-nostdinc} and/or @option{-isystem} options.
9130 @item -iplugindir=@var{dir}
9131 Set the directory to search for plugins which are passed
9132 by @option{-fplugin=@var{name}} instead of
9133 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
9134 to be used by the user, but only passed by the driver.
9136 @item -iquote@var{dir}
9137 @opindex iquote
9138 Add the directory @var{dir} to the head of the list of directories to
9139 be searched for header files only for the case of @samp{#include
9140 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9141 otherwise just like @option{-I}.
9143 @item -L@var{dir}
9144 @opindex L
9145 Add directory @var{dir} to the list of directories to be searched
9146 for @option{-l}.
9148 @item -B@var{prefix}
9149 @opindex B
9150 This option specifies where to find the executables, libraries,
9151 include files, and data files of the compiler itself.
9153 The compiler driver program runs one or more of the subprograms
9154 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
9155 @var{prefix} as a prefix for each program it tries to run, both with and
9156 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9158 For each subprogram to be run, the compiler driver first tries the
9159 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
9160 was not specified, the driver tries two standard prefixes, which are
9161 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
9162 those results in a file name that is found, the unmodified program
9163 name is searched for using the directories specified in your
9164 @env{PATH} environment variable.
9166 The compiler will check to see if the path provided by the @option{-B}
9167 refers to a directory, and if necessary it will add a directory
9168 separator character at the end of the path.
9170 @option{-B} prefixes that effectively specify directory names also apply
9171 to libraries in the linker, because the compiler translates these
9172 options into @option{-L} options for the linker.  They also apply to
9173 includes files in the preprocessor, because the compiler translates these
9174 options into @option{-isystem} options for the preprocessor.  In this case,
9175 the compiler appends @samp{include} to the prefix.
9177 The run-time support file @file{libgcc.a} can also be searched for using
9178 the @option{-B} prefix, if needed.  If it is not found there, the two
9179 standard prefixes above are tried, and that is all.  The file is left
9180 out of the link if it is not found by those means.
9182 Another way to specify a prefix much like the @option{-B} prefix is to use
9183 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9184 Variables}.
9186 As a special kludge, if the path provided by @option{-B} is
9187 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9188 9, then it will be replaced by @file{[dir/]include}.  This is to help
9189 with boot-strapping the compiler.
9191 @item -specs=@var{file}
9192 @opindex specs
9193 Process @var{file} after the compiler reads in the standard @file{specs}
9194 file, in order to override the defaults that the @file{gcc} driver
9195 program uses when determining what switches to pass to @file{cc1},
9196 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
9197 @option{-specs=@var{file}} can be specified on the command line, and they
9198 are processed in order, from left to right.
9200 @item --sysroot=@var{dir}
9201 @opindex sysroot
9202 Use @var{dir} as the logical root directory for headers and libraries.
9203 For example, if the compiler would normally search for headers in
9204 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
9205 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9207 If you use both this option and the @option{-isysroot} option, then
9208 the @option{--sysroot} option will apply to libraries, but the
9209 @option{-isysroot} option will apply to header files.
9211 The GNU linker (beginning with version 2.16) has the necessary support
9212 for this option.  If your linker does not support this option, the
9213 header file aspect of @option{--sysroot} will still work, but the
9214 library aspect will not.
9216 @item -I-
9217 @opindex I-
9218 This option has been deprecated.  Please use @option{-iquote} instead for
9219 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9220 Any directories you specify with @option{-I} options before the @option{-I-}
9221 option are searched only for the case of @samp{#include "@var{file}"};
9222 they are not searched for @samp{#include <@var{file}>}.
9224 If additional directories are specified with @option{-I} options after
9225 the @option{-I-}, these directories are searched for all @samp{#include}
9226 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9227 this way.)
9229 In addition, the @option{-I-} option inhibits the use of the current
9230 directory (where the current input file came from) as the first search
9231 directory for @samp{#include "@var{file}"}.  There is no way to
9232 override this effect of @option{-I-}.  With @option{-I.} you can specify
9233 searching the directory which was current when the compiler was
9234 invoked.  That is not exactly the same as what the preprocessor does
9235 by default, but it is often satisfactory.
9237 @option{-I-} does not inhibit the use of the standard system directories
9238 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9239 independent.
9240 @end table
9242 @c man end
9244 @node Spec Files
9245 @section Specifying subprocesses and the switches to pass to them
9246 @cindex Spec Files
9248 @command{gcc} is a driver program.  It performs its job by invoking a
9249 sequence of other programs to do the work of compiling, assembling and
9250 linking.  GCC interprets its command-line parameters and uses these to
9251 deduce which programs it should invoke, and which command-line options
9252 it ought to place on their command lines.  This behavior is controlled
9253 by @dfn{spec strings}.  In most cases there is one spec string for each
9254 program that GCC can invoke, but a few programs have multiple spec
9255 strings to control their behavior.  The spec strings built into GCC can
9256 be overridden by using the @option{-specs=} command-line switch to specify
9257 a spec file.
9259 @dfn{Spec files} are plaintext files that are used to construct spec
9260 strings.  They consist of a sequence of directives separated by blank
9261 lines.  The type of directive is determined by the first non-whitespace
9262 character on the line and it can be one of the following:
9264 @table @code
9265 @item %@var{command}
9266 Issues a @var{command} to the spec file processor.  The commands that can
9267 appear here are:
9269 @table @code
9270 @item %include <@var{file}>
9271 @cindex %include
9272 Search for @var{file} and insert its text at the current point in the
9273 specs file.
9275 @item %include_noerr <@var{file}>
9276 @cindex %include_noerr
9277 Just like @samp{%include}, but do not generate an error message if the include
9278 file cannot be found.
9280 @item %rename @var{old_name} @var{new_name}
9281 @cindex %rename
9282 Rename the spec string @var{old_name} to @var{new_name}.
9284 @end table
9286 @item *[@var{spec_name}]:
9287 This tells the compiler to create, override or delete the named spec
9288 string.  All lines after this directive up to the next directive or
9289 blank line are considered to be the text for the spec string.  If this
9290 results in an empty string then the spec will be deleted.  (Or, if the
9291 spec did not exist, then nothing will happened.)  Otherwise, if the spec
9292 does not currently exist a new spec will be created.  If the spec does
9293 exist then its contents will be overridden by the text of this
9294 directive, unless the first character of that text is the @samp{+}
9295 character, in which case the text will be appended to the spec.
9297 @item [@var{suffix}]:
9298 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9299 and up to the next directive or blank line are considered to make up the
9300 spec string for the indicated suffix.  When the compiler encounters an
9301 input file with the named suffix, it will processes the spec string in
9302 order to work out how to compile that file.  For example:
9304 @smallexample
9305 .ZZ:
9306 z-compile -input %i
9307 @end smallexample
9309 This says that any input file whose name ends in @samp{.ZZ} should be
9310 passed to the program @samp{z-compile}, which should be invoked with the
9311 command-line switch @option{-input} and with the result of performing the
9312 @samp{%i} substitution.  (See below.)
9314 As an alternative to providing a spec string, the text that follows a
9315 suffix directive can be one of the following:
9317 @table @code
9318 @item @@@var{language}
9319 This says that the suffix is an alias for a known @var{language}.  This is
9320 similar to using the @option{-x} command-line switch to GCC to specify a
9321 language explicitly.  For example:
9323 @smallexample
9324 .ZZ:
9325 @@c++
9326 @end smallexample
9328 Says that .ZZ files are, in fact, C++ source files.
9330 @item #@var{name}
9331 This causes an error messages saying:
9333 @smallexample
9334 @var{name} compiler not installed on this system.
9335 @end smallexample
9336 @end table
9338 GCC already has an extensive list of suffixes built into it.
9339 This directive will add an entry to the end of the list of suffixes, but
9340 since the list is searched from the end backwards, it is effectively
9341 possible to override earlier entries using this technique.
9343 @end table
9345 GCC has the following spec strings built into it.  Spec files can
9346 override these strings or create their own.  Note that individual
9347 targets can also add their own spec strings to this list.
9349 @smallexample
9350 asm          Options to pass to the assembler
9351 asm_final    Options to pass to the assembler post-processor
9352 cpp          Options to pass to the C preprocessor
9353 cc1          Options to pass to the C compiler
9354 cc1plus      Options to pass to the C++ compiler
9355 endfile      Object files to include at the end of the link
9356 link         Options to pass to the linker
9357 lib          Libraries to include on the command line to the linker
9358 libgcc       Decides which GCC support library to pass to the linker
9359 linker       Sets the name of the linker
9360 predefines   Defines to be passed to the C preprocessor
9361 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9362              by default
9363 startfile    Object files to include at the start of the link
9364 @end smallexample
9366 Here is a small example of a spec file:
9368 @smallexample
9369 %rename lib                 old_lib
9371 *lib:
9372 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9373 @end smallexample
9375 This example renames the spec called @samp{lib} to @samp{old_lib} and
9376 then overrides the previous definition of @samp{lib} with a new one.
9377 The new definition adds in some extra command-line options before
9378 including the text of the old definition.
9380 @dfn{Spec strings} are a list of command-line options to be passed to their
9381 corresponding program.  In addition, the spec strings can contain
9382 @samp{%}-prefixed sequences to substitute variable text or to
9383 conditionally insert text into the command line.  Using these constructs
9384 it is possible to generate quite complex command lines.
9386 Here is a table of all defined @samp{%}-sequences for spec
9387 strings.  Note that spaces are not generated automatically around the
9388 results of expanding these sequences.  Therefore you can concatenate them
9389 together or combine them with constant text in a single argument.
9391 @table @code
9392 @item %%
9393 Substitute one @samp{%} into the program name or argument.
9395 @item %i
9396 Substitute the name of the input file being processed.
9398 @item %b
9399 Substitute the basename of the input file being processed.
9400 This is the substring up to (and not including) the last period
9401 and not including the directory.
9403 @item %B
9404 This is the same as @samp{%b}, but include the file suffix (text after
9405 the last period).
9407 @item %d
9408 Marks the argument containing or following the @samp{%d} as a
9409 temporary file name, so that that file will be deleted if GCC exits
9410 successfully.  Unlike @samp{%g}, this contributes no text to the
9411 argument.
9413 @item %g@var{suffix}
9414 Substitute a file name that has suffix @var{suffix} and is chosen
9415 once per compilation, and mark the argument in the same way as
9416 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9417 name is now chosen in a way that is hard to predict even when previously
9418 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9419 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9420 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9421 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9422 was simply substituted with a file name chosen once per compilation,
9423 without regard to any appended suffix (which was therefore treated
9424 just like ordinary text), making such attacks more likely to succeed.
9426 @item %u@var{suffix}
9427 Like @samp{%g}, but generates a new temporary file name even if
9428 @samp{%u@var{suffix}} was already seen.
9430 @item %U@var{suffix}
9431 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9432 new one if there is no such last file name.  In the absence of any
9433 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9434 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9435 would involve the generation of two distinct file names, one
9436 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9437 simply substituted with a file name chosen for the previous @samp{%u},
9438 without regard to any appended suffix.
9440 @item %j@var{suffix}
9441 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9442 writable, and if save-temps is off; otherwise, substitute the name
9443 of a temporary file, just like @samp{%u}.  This temporary file is not
9444 meant for communication between processes, but rather as a junk
9445 disposal mechanism.
9447 @item %|@var{suffix}
9448 @itemx %m@var{suffix}
9449 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9450 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9451 all.  These are the two most common ways to instruct a program that it
9452 should read from standard input or write to standard output.  If you
9453 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9454 construct: see for example @file{f/lang-specs.h}.
9456 @item %.@var{SUFFIX}
9457 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9458 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9459 terminated by the next space or %.
9461 @item %w
9462 Marks the argument containing or following the @samp{%w} as the
9463 designated output file of this compilation.  This puts the argument
9464 into the sequence of arguments that @samp{%o} will substitute later.
9466 @item %o
9467 Substitutes the names of all the output files, with spaces
9468 automatically placed around them.  You should write spaces
9469 around the @samp{%o} as well or the results are undefined.
9470 @samp{%o} is for use in the specs for running the linker.
9471 Input files whose names have no recognized suffix are not compiled
9472 at all, but they are included among the output files, so they will
9473 be linked.
9475 @item %O
9476 Substitutes the suffix for object files.  Note that this is
9477 handled specially when it immediately follows @samp{%g, %u, or %U},
9478 because of the need for those to form complete file names.  The
9479 handling is such that @samp{%O} is treated exactly as if it had already
9480 been substituted, except that @samp{%g, %u, and %U} do not currently
9481 support additional @var{suffix} characters following @samp{%O} as they would
9482 following, for example, @samp{.o}.
9484 @item %p
9485 Substitutes the standard macro predefinitions for the
9486 current target machine.  Use this when running @code{cpp}.
9488 @item %P
9489 Like @samp{%p}, but puts @samp{__} before and after the name of each
9490 predefined macro, except for macros that start with @samp{__} or with
9491 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9494 @item %I
9495 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9496 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9497 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9498 and @option{-imultilib} as necessary.
9500 @item %s
9501 Current argument is the name of a library or startup file of some sort.
9502 Search for that file in a standard list of directories and substitute
9503 the full name found.  The current working directory is included in the
9504 list of directories scanned.
9506 @item %T
9507 Current argument is the name of a linker script.  Search for that file
9508 in the current list of directories to scan for libraries. If the file
9509 is located insert a @option{--script} option into the command line
9510 followed by the full path name found.  If the file is not found then
9511 generate an error message.  Note: the current working directory is not
9512 searched.
9514 @item %e@var{str}
9515 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9516 Use this when inconsistent options are detected.
9518 @item %(@var{name})
9519 Substitute the contents of spec string @var{name} at this point.
9521 @item %[@var{name}]
9522 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9524 @item %x@{@var{option}@}
9525 Accumulate an option for @samp{%X}.
9527 @item %X
9528 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9529 spec string.
9531 @item %Y
9532 Output the accumulated assembler options specified by @option{-Wa}.
9534 @item %Z
9535 Output the accumulated preprocessor options specified by @option{-Wp}.
9537 @item %a
9538 Process the @code{asm} spec.  This is used to compute the
9539 switches to be passed to the assembler.
9541 @item %A
9542 Process the @code{asm_final} spec.  This is a spec string for
9543 passing switches to an assembler post-processor, if such a program is
9544 needed.
9546 @item %l
9547 Process the @code{link} spec.  This is the spec for computing the
9548 command line passed to the linker.  Typically it will make use of the
9549 @samp{%L %G %S %D and %E} sequences.
9551 @item %D
9552 Dump out a @option{-L} option for each directory that GCC believes might
9553 contain startup files.  If the target supports multilibs then the
9554 current multilib directory will be prepended to each of these paths.
9556 @item %L
9557 Process the @code{lib} spec.  This is a spec string for deciding which
9558 libraries should be included on the command line to the linker.
9560 @item %G
9561 Process the @code{libgcc} spec.  This is a spec string for deciding
9562 which GCC support library should be included on the command line to the linker.
9564 @item %S
9565 Process the @code{startfile} spec.  This is a spec for deciding which
9566 object files should be the first ones passed to the linker.  Typically
9567 this might be a file named @file{crt0.o}.
9569 @item %E
9570 Process the @code{endfile} spec.  This is a spec string that specifies
9571 the last object files that will be passed to the linker.
9573 @item %C
9574 Process the @code{cpp} spec.  This is used to construct the arguments
9575 to be passed to the C preprocessor.
9577 @item %1
9578 Process the @code{cc1} spec.  This is used to construct the options to be
9579 passed to the actual C compiler (@samp{cc1}).
9581 @item %2
9582 Process the @code{cc1plus} spec.  This is used to construct the options to be
9583 passed to the actual C++ compiler (@samp{cc1plus}).
9585 @item %*
9586 Substitute the variable part of a matched option.  See below.
9587 Note that each comma in the substituted string is replaced by
9588 a single space.
9590 @item %<@code{S}
9591 Remove all occurrences of @code{-S} from the command line.  Note---this
9592 command is position dependent.  @samp{%} commands in the spec string
9593 before this one will see @code{-S}, @samp{%} commands in the spec string
9594 after this one will not.
9596 @item %:@var{function}(@var{args})
9597 Call the named function @var{function}, passing it @var{args}.
9598 @var{args} is first processed as a nested spec string, then split
9599 into an argument vector in the usual fashion.  The function returns
9600 a string which is processed as if it had appeared literally as part
9601 of the current spec.
9603 The following built-in spec functions are provided:
9605 @table @code
9606 @item @code{getenv}
9607 The @code{getenv} spec function takes two arguments: an environment
9608 variable name and a string.  If the environment variable is not
9609 defined, a fatal error is issued.  Otherwise, the return value is the
9610 value of the environment variable concatenated with the string.  For
9611 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9613 @smallexample
9614 %:getenv(TOPDIR /include)
9615 @end smallexample
9617 expands to @file{/path/to/top/include}.
9619 @item @code{if-exists}
9620 The @code{if-exists} spec function takes one argument, an absolute
9621 pathname to a file.  If the file exists, @code{if-exists} returns the
9622 pathname.  Here is a small example of its usage:
9624 @smallexample
9625 *startfile:
9626 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9627 @end smallexample
9629 @item @code{if-exists-else}
9630 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9631 spec function, except that it takes two arguments.  The first argument is
9632 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9633 returns the pathname.  If it does not exist, it returns the second argument.
9634 This way, @code{if-exists-else} can be used to select one file or another,
9635 based on the existence of the first.  Here is a small example of its usage:
9637 @smallexample
9638 *startfile:
9639 crt0%O%s %:if-exists(crti%O%s) \
9640 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9641 @end smallexample
9643 @item @code{replace-outfile}
9644 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9645 first argument in the outfiles array and replaces it with the second argument.  Here
9646 is a small example of its usage:
9648 @smallexample
9649 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9650 @end smallexample
9652 @item @code{remove-outfile}
9653 The @code{remove-outfile} spec function takes one argument.  It looks for the
9654 first argument in the outfiles array and removes it.  Here is a small example
9655 its usage:
9657 @smallexample
9658 %:remove-outfile(-lm)
9659 @end smallexample
9661 @item @code{print-asm-header}
9662 The @code{print-asm-header} function takes no arguments and simply
9663 prints a banner like:
9665 @smallexample
9666 Assembler options
9667 =================
9669 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9670 @end smallexample
9672 It is used to separate compiler options from assembler options
9673 in the @option{--target-help} output.
9674 @end table
9676 @item %@{@code{S}@}
9677 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9678 If that switch was not specified, this substitutes nothing.  Note that
9679 the leading dash is omitted when specifying this option, and it is
9680 automatically inserted if the substitution is performed.  Thus the spec
9681 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9682 and would output the command line option @option{-foo}.
9684 @item %W@{@code{S}@}
9685 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9686 deleted on failure.
9688 @item %@{@code{S}*@}
9689 Substitutes all the switches specified to GCC whose names start
9690 with @code{-S}, but which also take an argument.  This is used for
9691 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9692 GCC considers @option{-o foo} as being
9693 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9694 text, including the space.  Thus two arguments would be generated.
9696 @item %@{@code{S}*&@code{T}*@}
9697 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9698 (the order of @code{S} and @code{T} in the spec is not significant).
9699 There can be any number of ampersand-separated variables; for each the
9700 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9702 @item %@{@code{S}:@code{X}@}
9703 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9705 @item %@{!@code{S}:@code{X}@}
9706 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9708 @item %@{@code{S}*:@code{X}@}
9709 Substitutes @code{X} if one or more switches whose names start with
9710 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9711 once, no matter how many such switches appeared.  However, if @code{%*}
9712 appears somewhere in @code{X}, then @code{X} will be substituted once
9713 for each matching switch, with the @code{%*} replaced by the part of
9714 that switch that matched the @code{*}.
9716 @item %@{.@code{S}:@code{X}@}
9717 Substitutes @code{X}, if processing a file with suffix @code{S}.
9719 @item %@{!.@code{S}:@code{X}@}
9720 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9722 @item %@{,@code{S}:@code{X}@}
9723 Substitutes @code{X}, if processing a file for language @code{S}.
9725 @item %@{!,@code{S}:@code{X}@}
9726 Substitutes @code{X}, if not processing a file for language @code{S}.
9728 @item %@{@code{S}|@code{P}:@code{X}@}
9729 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9730 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9731 @code{*} sequences as well, although they have a stronger binding than
9732 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9733 alternatives must be starred, and only the first matching alternative
9734 is substituted.
9736 For example, a spec string like this:
9738 @smallexample
9739 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9740 @end smallexample
9742 will output the following command-line options from the following input
9743 command-line options:
9745 @smallexample
9746 fred.c        -foo -baz
9747 jim.d         -bar -boggle
9748 -d fred.c     -foo -baz -boggle
9749 -d jim.d      -bar -baz -boggle
9750 @end smallexample
9752 @item %@{S:X; T:Y; :D@}
9754 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9755 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9756 be as many clauses as you need.  This may be combined with @code{.},
9757 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9760 @end table
9762 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9763 construct may contain other nested @samp{%} constructs or spaces, or
9764 even newlines.  They are processed as usual, as described above.
9765 Trailing white space in @code{X} is ignored.  White space may also
9766 appear anywhere on the left side of the colon in these constructs,
9767 except between @code{.} or @code{*} and the corresponding word.
9769 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9770 handled specifically in these constructs.  If another value of
9771 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9772 @option{-W} switch is found later in the command line, the earlier
9773 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9774 just one letter, which passes all matching options.
9776 The character @samp{|} at the beginning of the predicate text is used to
9777 indicate that a command should be piped to the following command, but
9778 only if @option{-pipe} is specified.
9780 It is built into GCC which switches take arguments and which do not.
9781 (You might think it would be useful to generalize this to allow each
9782 compiler's spec to say which switches take arguments.  But this cannot
9783 be done in a consistent fashion.  GCC cannot even decide which input
9784 files have been specified without knowing which switches take arguments,
9785 and it must know which input files to compile in order to tell which
9786 compilers to run).
9788 GCC also knows implicitly that arguments starting in @option{-l} are to be
9789 treated as compiler output files, and passed to the linker in their
9790 proper position among the other output files.
9792 @c man begin OPTIONS
9794 @node Target Options
9795 @section Specifying Target Machine and Compiler Version
9796 @cindex target options
9797 @cindex cross compiling
9798 @cindex specifying machine version
9799 @cindex specifying compiler version and target machine
9800 @cindex compiler version, specifying
9801 @cindex target machine, specifying
9803 The usual way to run GCC is to run the executable called @file{gcc}, or
9804 @file{<machine>-gcc} when cross-compiling, or
9805 @file{<machine>-gcc-<version>} to run a version other than the one that
9806 was installed last.
9808 @node Submodel Options
9809 @section Hardware Models and Configurations
9810 @cindex submodel options
9811 @cindex specifying hardware config
9812 @cindex hardware models and configurations, specifying
9813 @cindex machine dependent options
9815 Each target machine types can have its own
9816 special options, starting with @samp{-m}, to choose among various
9817 hardware models or configurations---for example, 68010 vs 68020,
9818 floating coprocessor or none.  A single installed version of the
9819 compiler can compile for any model or configuration, according to the
9820 options specified.
9822 Some configurations of the compiler also support additional special
9823 options, usually for compatibility with other compilers on the same
9824 platform.
9826 @c This list is ordered alphanumerically by subsection name.
9827 @c It should be the same order and spelling as these options are listed
9828 @c in Machine Dependent Options
9830 @menu
9831 * ARC Options::
9832 * ARM Options::
9833 * AVR Options::
9834 * Blackfin Options::
9835 * CRIS Options::
9836 * CRX Options::
9837 * Darwin Options::
9838 * DEC Alpha Options::
9839 * DEC Alpha/VMS Options::
9840 * FR30 Options::
9841 * FRV Options::
9842 * GNU/Linux Options::
9843 * H8/300 Options::
9844 * HPPA Options::
9845 * i386 and x86-64 Options::
9846 * i386 and x86-64 Windows Options::
9847 * IA-64 Options::
9848 * IA-64/VMS Options::
9849 * LM32 Options::
9850 * M32C Options::
9851 * M32R/D Options::
9852 * M680x0 Options::
9853 * M68hc1x Options::
9854 * MCore Options::
9855 * MeP Options::
9856 * MIPS Options::
9857 * MMIX Options::
9858 * MN10300 Options::
9859 * PDP-11 Options::
9860 * picoChip Options::
9861 * PowerPC Options::
9862 * RS/6000 and PowerPC Options::
9863 * RX Options::
9864 * S/390 and zSeries Options::
9865 * Score Options::
9866 * SH Options::
9867 * SPARC Options::
9868 * SPU Options::
9869 * System V Options::
9870 * V850 Options::
9871 * VAX Options::
9872 * VxWorks Options::
9873 * x86-64 Options::
9874 * Xstormy16 Options::
9875 * Xtensa Options::
9876 * zSeries Options::
9877 @end menu
9879 @node ARC Options
9880 @subsection ARC Options
9881 @cindex ARC Options
9883 These options are defined for ARC implementations:
9885 @table @gcctabopt
9886 @item -EL
9887 @opindex EL
9888 Compile code for little endian mode.  This is the default.
9890 @item -EB
9891 @opindex EB
9892 Compile code for big endian mode.
9894 @item -mmangle-cpu
9895 @opindex mmangle-cpu
9896 Prepend the name of the cpu to all public symbol names.
9897 In multiple-processor systems, there are many ARC variants with different
9898 instruction and register set characteristics.  This flag prevents code
9899 compiled for one cpu to be linked with code compiled for another.
9900 No facility exists for handling variants that are ``almost identical''.
9901 This is an all or nothing option.
9903 @item -mcpu=@var{cpu}
9904 @opindex mcpu
9905 Compile code for ARC variant @var{cpu}.
9906 Which variants are supported depend on the configuration.
9907 All variants support @option{-mcpu=base}, this is the default.
9909 @item -mtext=@var{text-section}
9910 @itemx -mdata=@var{data-section}
9911 @itemx -mrodata=@var{readonly-data-section}
9912 @opindex mtext
9913 @opindex mdata
9914 @opindex mrodata
9915 Put functions, data, and readonly data in @var{text-section},
9916 @var{data-section}, and @var{readonly-data-section} respectively
9917 by default.  This can be overridden with the @code{section} attribute.
9918 @xref{Variable Attributes}.
9920 @end table
9922 @node ARM Options
9923 @subsection ARM Options
9924 @cindex ARM options
9926 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9927 architectures:
9929 @table @gcctabopt
9930 @item -mabi=@var{name}
9931 @opindex mabi
9932 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9933 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9935 @item -mapcs-frame
9936 @opindex mapcs-frame
9937 Generate a stack frame that is compliant with the ARM Procedure Call
9938 Standard for all functions, even if this is not strictly necessary for
9939 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9940 with this option will cause the stack frames not to be generated for
9941 leaf functions.  The default is @option{-mno-apcs-frame}.
9943 @item -mapcs
9944 @opindex mapcs
9945 This is a synonym for @option{-mapcs-frame}.
9947 @ignore
9948 @c not currently implemented
9949 @item -mapcs-stack-check
9950 @opindex mapcs-stack-check
9951 Generate code to check the amount of stack space available upon entry to
9952 every function (that actually uses some stack space).  If there is
9953 insufficient space available then either the function
9954 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9955 called, depending upon the amount of stack space required.  The run time
9956 system is required to provide these functions.  The default is
9957 @option{-mno-apcs-stack-check}, since this produces smaller code.
9959 @c not currently implemented
9960 @item -mapcs-float
9961 @opindex mapcs-float
9962 Pass floating point arguments using the float point registers.  This is
9963 one of the variants of the APCS@.  This option is recommended if the
9964 target hardware has a floating point unit or if a lot of floating point
9965 arithmetic is going to be performed by the code.  The default is
9966 @option{-mno-apcs-float}, since integer only code is slightly increased in
9967 size if @option{-mapcs-float} is used.
9969 @c not currently implemented
9970 @item -mapcs-reentrant
9971 @opindex mapcs-reentrant
9972 Generate reentrant, position independent code.  The default is
9973 @option{-mno-apcs-reentrant}.
9974 @end ignore
9976 @item -mthumb-interwork
9977 @opindex mthumb-interwork
9978 Generate code which supports calling between the ARM and Thumb
9979 instruction sets.  Without this option the two instruction sets cannot
9980 be reliably used inside one program.  The default is
9981 @option{-mno-thumb-interwork}, since slightly larger code is generated
9982 when @option{-mthumb-interwork} is specified.
9984 @item -mno-sched-prolog
9985 @opindex mno-sched-prolog
9986 Prevent the reordering of instructions in the function prolog, or the
9987 merging of those instruction with the instructions in the function's
9988 body.  This means that all functions will start with a recognizable set
9989 of instructions (or in fact one of a choice from a small set of
9990 different function prologues), and this information can be used to
9991 locate the start if functions inside an executable piece of code.  The
9992 default is @option{-msched-prolog}.
9994 @item -mfloat-abi=@var{name}
9995 @opindex mfloat-abi
9996 Specifies which floating-point ABI to use.  Permissible values
9997 are: @samp{soft}, @samp{softfp} and @samp{hard}.
9999 Specifying @samp{soft} causes GCC to generate output containing
10000 library calls for floating-point operations.
10001 @samp{softfp} allows the generation of code using hardware floating-point
10002 instructions, but still uses the soft-float calling conventions.
10003 @samp{hard} allows generation of floating-point instructions
10004 and uses FPU-specific calling conventions.
10006 The default depends on the specific target configuration.  Note that
10007 the hard-float and soft-float ABIs are not link-compatible; you must
10008 compile your entire program with the same ABI, and link with a
10009 compatible set of libraries.
10011 @item -mhard-float
10012 @opindex mhard-float
10013 Equivalent to @option{-mfloat-abi=hard}.
10015 @item -msoft-float
10016 @opindex msoft-float
10017 Equivalent to @option{-mfloat-abi=soft}.
10019 @item -mlittle-endian
10020 @opindex mlittle-endian
10021 Generate code for a processor running in little-endian mode.  This is
10022 the default for all standard configurations.
10024 @item -mbig-endian
10025 @opindex mbig-endian
10026 Generate code for a processor running in big-endian mode; the default is
10027 to compile code for a little-endian processor.
10029 @item -mwords-little-endian
10030 @opindex mwords-little-endian
10031 This option only applies when generating code for big-endian processors.
10032 Generate code for a little-endian word order but a big-endian byte
10033 order.  That is, a byte order of the form @samp{32107654}.  Note: this
10034 option should only be used if you require compatibility with code for
10035 big-endian ARM processors generated by versions of the compiler prior to
10036 2.8.
10038 @item -mcpu=@var{name}
10039 @opindex mcpu
10040 This specifies the name of the target ARM processor.  GCC uses this name
10041 to determine what kind of instructions it can emit when generating
10042 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
10043 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
10044 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
10045 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
10046 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
10047 @samp{arm720},
10048 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
10049 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
10050 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
10051 @samp{strongarm1110},
10052 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
10053 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
10054 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
10055 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
10056 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
10057 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
10058 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
10059 @samp{cortex-a5}, @samp{cortex-a8}, @samp{cortex-a9},
10060 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m4}, @samp{cortex-m3},
10061 @samp{cortex-m1},
10062 @samp{cortex-m0},
10063 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10065 @item -mtune=@var{name}
10066 @opindex mtune
10067 This option is very similar to the @option{-mcpu=} option, except that
10068 instead of specifying the actual target processor type, and hence
10069 restricting which instructions can be used, it specifies that GCC should
10070 tune the performance of the code as if the target were of the type
10071 specified in this option, but still choosing the instructions that it
10072 will generate based on the cpu specified by a @option{-mcpu=} option.
10073 For some ARM implementations better performance can be obtained by using
10074 this option.
10076 @item -march=@var{name}
10077 @opindex march
10078 This specifies the name of the target ARM architecture.  GCC uses this
10079 name to determine what kind of instructions it can emit when generating
10080 assembly code.  This option can be used in conjunction with or instead
10081 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
10082 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
10083 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
10084 @samp{armv6}, @samp{armv6j},
10085 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
10086 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
10087 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10089 @item -mfpu=@var{name}
10090 @itemx -mfpe=@var{number}
10091 @itemx -mfp=@var{number}
10092 @opindex mfpu
10093 @opindex mfpe
10094 @opindex mfp
10095 This specifies what floating point hardware (or hardware emulation) is
10096 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
10097 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
10098 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
10099 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
10100 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
10101 @option{-mfp} and @option{-mfpe} are synonyms for
10102 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
10103 of GCC@.
10105 If @option{-msoft-float} is specified this specifies the format of
10106 floating point values.
10108 If the selected floating-point hardware includes the NEON extension
10109 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
10110 operations will not be used by GCC's auto-vectorization pass unless
10111 @option{-funsafe-math-optimizations} is also specified.  This is
10112 because NEON hardware does not fully implement the IEEE 754 standard for
10113 floating-point arithmetic (in particular denormal values are treated as
10114 zero), so the use of NEON instructions may lead to a loss of precision.
10116 @item -mfp16-format=@var{name}
10117 @opindex mfp16-format
10118 Specify the format of the @code{__fp16} half-precision floating-point type.
10119 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
10120 the default is @samp{none}, in which case the @code{__fp16} type is not
10121 defined.  @xref{Half-Precision}, for more information.
10123 @item -mstructure-size-boundary=@var{n}
10124 @opindex mstructure-size-boundary
10125 The size of all structures and unions will be rounded up to a multiple
10126 of the number of bits set by this option.  Permissible values are 8, 32
10127 and 64.  The default value varies for different toolchains.  For the COFF
10128 targeted toolchain the default value is 8.  A value of 64 is only allowed
10129 if the underlying ABI supports it.
10131 Specifying the larger number can produce faster, more efficient code, but
10132 can also increase the size of the program.  Different values are potentially
10133 incompatible.  Code compiled with one value cannot necessarily expect to
10134 work with code or libraries compiled with another value, if they exchange
10135 information using structures or unions.
10137 @item -mabort-on-noreturn
10138 @opindex mabort-on-noreturn
10139 Generate a call to the function @code{abort} at the end of a
10140 @code{noreturn} function.  It will be executed if the function tries to
10141 return.
10143 @item -mlong-calls
10144 @itemx -mno-long-calls
10145 @opindex mlong-calls
10146 @opindex mno-long-calls
10147 Tells the compiler to perform function calls by first loading the
10148 address of the function into a register and then performing a subroutine
10149 call on this register.  This switch is needed if the target function
10150 will lie outside of the 64 megabyte addressing range of the offset based
10151 version of subroutine call instruction.
10153 Even if this switch is enabled, not all function calls will be turned
10154 into long calls.  The heuristic is that static functions, functions
10155 which have the @samp{short-call} attribute, functions that are inside
10156 the scope of a @samp{#pragma no_long_calls} directive and functions whose
10157 definitions have already been compiled within the current compilation
10158 unit, will not be turned into long calls.  The exception to this rule is
10159 that weak function definitions, functions with the @samp{long-call}
10160 attribute or the @samp{section} attribute, and functions that are within
10161 the scope of a @samp{#pragma long_calls} directive, will always be
10162 turned into long calls.
10164 This feature is not enabled by default.  Specifying
10165 @option{-mno-long-calls} will restore the default behavior, as will
10166 placing the function calls within the scope of a @samp{#pragma
10167 long_calls_off} directive.  Note these switches have no effect on how
10168 the compiler generates code to handle function calls via function
10169 pointers.
10171 @item -msingle-pic-base
10172 @opindex msingle-pic-base
10173 Treat the register used for PIC addressing as read-only, rather than
10174 loading it in the prologue for each function.  The run-time system is
10175 responsible for initializing this register with an appropriate value
10176 before execution begins.
10178 @item -mpic-register=@var{reg}
10179 @opindex mpic-register
10180 Specify the register to be used for PIC addressing.  The default is R10
10181 unless stack-checking is enabled, when R9 is used.
10183 @item -mcirrus-fix-invalid-insns
10184 @opindex mcirrus-fix-invalid-insns
10185 @opindex mno-cirrus-fix-invalid-insns
10186 Insert NOPs into the instruction stream to in order to work around
10187 problems with invalid Maverick instruction combinations.  This option
10188 is only valid if the @option{-mcpu=ep9312} option has been used to
10189 enable generation of instructions for the Cirrus Maverick floating
10190 point co-processor.  This option is not enabled by default, since the
10191 problem is only present in older Maverick implementations.  The default
10192 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10193 switch.
10195 @item -mpoke-function-name
10196 @opindex mpoke-function-name
10197 Write the name of each function into the text section, directly
10198 preceding the function prologue.  The generated code is similar to this:
10200 @smallexample
10201      t0
10202          .ascii "arm_poke_function_name", 0
10203          .align
10204      t1
10205          .word 0xff000000 + (t1 - t0)
10206      arm_poke_function_name
10207          mov     ip, sp
10208          stmfd   sp!, @{fp, ip, lr, pc@}
10209          sub     fp, ip, #4
10210 @end smallexample
10212 When performing a stack backtrace, code can inspect the value of
10213 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
10214 location @code{pc - 12} and the top 8 bits are set, then we know that
10215 there is a function name embedded immediately preceding this location
10216 and has length @code{((pc[-3]) & 0xff000000)}.
10218 @item -mthumb
10219 @opindex mthumb
10220 Generate code for the Thumb instruction set.  The default is to
10221 use the 32-bit ARM instruction set.
10222 This option automatically enables either 16-bit Thumb-1 or
10223 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
10224 and @option{-march=@var{name}} options.  This option is not passed to the
10225 assembler. If you want to force assembler files to be interpreted as Thumb code,
10226 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
10227 option directly to the assembler by prefixing it with @option{-Wa}.
10229 @item -mtpcs-frame
10230 @opindex mtpcs-frame
10231 Generate a stack frame that is compliant with the Thumb Procedure Call
10232 Standard for all non-leaf functions.  (A leaf function is one that does
10233 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
10235 @item -mtpcs-leaf-frame
10236 @opindex mtpcs-leaf-frame
10237 Generate a stack frame that is compliant with the Thumb Procedure Call
10238 Standard for all leaf functions.  (A leaf function is one that does
10239 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
10241 @item -mcallee-super-interworking
10242 @opindex mcallee-super-interworking
10243 Gives all externally visible functions in the file being compiled an ARM
10244 instruction set header which switches to Thumb mode before executing the
10245 rest of the function.  This allows these functions to be called from
10246 non-interworking code.  This option is not valid in AAPCS configurations
10247 because interworking is enabled by default.
10249 @item -mcaller-super-interworking
10250 @opindex mcaller-super-interworking
10251 Allows calls via function pointers (including virtual functions) to
10252 execute correctly regardless of whether the target code has been
10253 compiled for interworking or not.  There is a small overhead in the cost
10254 of executing a function pointer if this option is enabled.  This option
10255 is not valid in AAPCS configurations because interworking is enabled
10256 by default.
10258 @item -mtp=@var{name}
10259 @opindex mtp
10260 Specify the access model for the thread local storage pointer.  The valid
10261 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
10262 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
10263 (supported in the arm6k architecture), and @option{auto}, which uses the
10264 best available method for the selected processor.  The default setting is
10265 @option{auto}.
10267 @item -mword-relocations
10268 @opindex mword-relocations
10269 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
10270 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
10271 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
10272 is specified.
10274 @item -mfix-cortex-m3-ldrd
10275 @opindex mfix-cortex-m3-ldrd
10276 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
10277 with overlapping destination and base registers are used.  This option avoids
10278 generating these instructions.  This option is enabled by default when
10279 @option{-mcpu=cortex-m3} is specified.
10281 @end table
10283 @node AVR Options
10284 @subsection AVR Options
10285 @cindex AVR Options
10287 These options are defined for AVR implementations:
10289 @table @gcctabopt
10290 @item -mmcu=@var{mcu}
10291 @opindex mmcu
10292 Specify ATMEL AVR instruction set or MCU type.
10294 Instruction set avr1 is for the minimal AVR core, not supported by the C
10295 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10296 attiny11, attiny12, attiny15, attiny28).
10298 Instruction set avr2 (default) is for the classic AVR core with up to
10299 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10300 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10301 at90c8534, at90s8535).
10303 Instruction set avr3 is for the classic AVR core with up to 128K program
10304 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10306 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10307 memory space (MCU types: atmega8, atmega83, atmega85).
10309 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10310 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10311 atmega64, atmega128, at43usb355, at94k).
10313 @item -mno-interrupts
10314 @opindex mno-interrupts
10315 Generated code is not compatible with hardware interrupts.
10316 Code size will be smaller.
10318 @item -mcall-prologues
10319 @opindex mcall-prologues
10320 Functions prologues/epilogues expanded as call to appropriate
10321 subroutines.  Code size will be smaller.
10323 @item -mtiny-stack
10324 @opindex mtiny-stack
10325 Change only the low 8 bits of the stack pointer.
10327 @item -mint8
10328 @opindex mint8
10329 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10330 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10331 and long long will be 4 bytes.  Please note that this option does not
10332 comply to the C standards, but it will provide you with smaller code
10333 size.
10334 @end table
10336 @node Blackfin Options
10337 @subsection Blackfin Options
10338 @cindex Blackfin Options
10340 @table @gcctabopt
10341 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10342 @opindex mcpu=
10343 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
10344 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10345 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10346 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10347 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10348 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10349 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10350 @samp{bf561}.
10351 The optional @var{sirevision} specifies the silicon revision of the target
10352 Blackfin processor.  Any workarounds available for the targeted silicon revision
10353 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
10354 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10355 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
10356 hexadecimal digits representing the major and minor numbers in the silicon
10357 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10358 is not defined.  If @var{sirevision} is @samp{any}, the
10359 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10360 If this optional @var{sirevision} is not used, GCC assumes the latest known
10361 silicon revision of the targeted Blackfin processor.
10363 Support for @samp{bf561} is incomplete.  For @samp{bf561},
10364 Only the processor macro is defined.
10365 Without this option, @samp{bf532} is used as the processor by default.
10366 The corresponding predefined processor macros for @var{cpu} is to
10367 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10368 provided by libgloss to be linked in if @option{-msim} is not given.
10370 @item -msim
10371 @opindex msim
10372 Specifies that the program will be run on the simulator.  This causes
10373 the simulator BSP provided by libgloss to be linked in.  This option
10374 has effect only for @samp{bfin-elf} toolchain.
10375 Certain other options, such as @option{-mid-shared-library} and
10376 @option{-mfdpic}, imply @option{-msim}.
10378 @item -momit-leaf-frame-pointer
10379 @opindex momit-leaf-frame-pointer
10380 Don't keep the frame pointer in a register for leaf functions.  This
10381 avoids the instructions to save, set up and restore frame pointers and
10382 makes an extra register available in leaf functions.  The option
10383 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10384 which might make debugging harder.
10386 @item -mspecld-anomaly
10387 @opindex mspecld-anomaly
10388 When enabled, the compiler will ensure that the generated code does not
10389 contain speculative loads after jump instructions. If this option is used,
10390 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10392 @item -mno-specld-anomaly
10393 @opindex mno-specld-anomaly
10394 Don't generate extra code to prevent speculative loads from occurring.
10396 @item -mcsync-anomaly
10397 @opindex mcsync-anomaly
10398 When enabled, the compiler will ensure that the generated code does not
10399 contain CSYNC or SSYNC instructions too soon after conditional branches.
10400 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10402 @item -mno-csync-anomaly
10403 @opindex mno-csync-anomaly
10404 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10405 occurring too soon after a conditional branch.
10407 @item -mlow-64k
10408 @opindex mlow-64k
10409 When enabled, the compiler is free to take advantage of the knowledge that
10410 the entire program fits into the low 64k of memory.
10412 @item -mno-low-64k
10413 @opindex mno-low-64k
10414 Assume that the program is arbitrarily large.  This is the default.
10416 @item -mstack-check-l1
10417 @opindex mstack-check-l1
10418 Do stack checking using information placed into L1 scratchpad memory by the
10419 uClinux kernel.
10421 @item -mid-shared-library
10422 @opindex mid-shared-library
10423 Generate code that supports shared libraries via the library ID method.
10424 This allows for execute in place and shared libraries in an environment
10425 without virtual memory management.  This option implies @option{-fPIC}.
10426 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10428 @item -mno-id-shared-library
10429 @opindex mno-id-shared-library
10430 Generate code that doesn't assume ID based shared libraries are being used.
10431 This is the default.
10433 @item -mleaf-id-shared-library
10434 @opindex mleaf-id-shared-library
10435 Generate code that supports shared libraries via the library ID method,
10436 but assumes that this library or executable won't link against any other
10437 ID shared libraries.  That allows the compiler to use faster code for jumps
10438 and calls.
10440 @item -mno-leaf-id-shared-library
10441 @opindex mno-leaf-id-shared-library
10442 Do not assume that the code being compiled won't link against any ID shared
10443 libraries.  Slower code will be generated for jump and call insns.
10445 @item -mshared-library-id=n
10446 @opindex mshared-library-id
10447 Specified the identification number of the ID based shared library being
10448 compiled.  Specifying a value of 0 will generate more compact code, specifying
10449 other values will force the allocation of that number to the current
10450 library but is no more space or time efficient than omitting this option.
10452 @item -msep-data
10453 @opindex msep-data
10454 Generate code that allows the data segment to be located in a different
10455 area of memory from the text segment.  This allows for execute in place in
10456 an environment without virtual memory management by eliminating relocations
10457 against the text section.
10459 @item -mno-sep-data
10460 @opindex mno-sep-data
10461 Generate code that assumes that the data segment follows the text segment.
10462 This is the default.
10464 @item -mlong-calls
10465 @itemx -mno-long-calls
10466 @opindex mlong-calls
10467 @opindex mno-long-calls
10468 Tells the compiler to perform function calls by first loading the
10469 address of the function into a register and then performing a subroutine
10470 call on this register.  This switch is needed if the target function
10471 will lie outside of the 24 bit addressing range of the offset based
10472 version of subroutine call instruction.
10474 This feature is not enabled by default.  Specifying
10475 @option{-mno-long-calls} will restore the default behavior.  Note these
10476 switches have no effect on how the compiler generates code to handle
10477 function calls via function pointers.
10479 @item -mfast-fp
10480 @opindex mfast-fp
10481 Link with the fast floating-point library. This library relaxes some of
10482 the IEEE floating-point standard's rules for checking inputs against
10483 Not-a-Number (NAN), in the interest of performance.
10485 @item -minline-plt
10486 @opindex minline-plt
10487 Enable inlining of PLT entries in function calls to functions that are
10488 not known to bind locally.  It has no effect without @option{-mfdpic}.
10490 @item -mmulticore
10491 @opindex mmulticore
10492 Build standalone application for multicore Blackfin processor. Proper
10493 start files and link scripts will be used to support multicore.
10494 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10495 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10496 @option{-mcorea} or @option{-mcoreb}. If it's used without
10497 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10498 programming model is used. In this model, the main function of Core B
10499 should be named as coreb_main. If it's used with @option{-mcorea} or
10500 @option{-mcoreb}, one application per core programming model is used.
10501 If this option is not used, single core application programming
10502 model is used.
10504 @item -mcorea
10505 @opindex mcorea
10506 Build standalone application for Core A of BF561 when using
10507 one application per core programming model. Proper start files
10508 and link scripts will be used to support Core A. This option
10509 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10511 @item -mcoreb
10512 @opindex mcoreb
10513 Build standalone application for Core B of BF561 when using
10514 one application per core programming model. Proper start files
10515 and link scripts will be used to support Core B. This option
10516 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10517 should be used instead of main. It must be used with
10518 @option{-mmulticore}.
10520 @item -msdram
10521 @opindex msdram
10522 Build standalone application for SDRAM. Proper start files and
10523 link scripts will be used to put the application into SDRAM.
10524 Loader should initialize SDRAM before loading the application
10525 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10527 @item -micplb
10528 @opindex micplb
10529 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
10530 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
10531 are enabled; for standalone applications the default is off.
10532 @end table
10534 @node CRIS Options
10535 @subsection CRIS Options
10536 @cindex CRIS Options
10538 These options are defined specifically for the CRIS ports.
10540 @table @gcctabopt
10541 @item -march=@var{architecture-type}
10542 @itemx -mcpu=@var{architecture-type}
10543 @opindex march
10544 @opindex mcpu
10545 Generate code for the specified architecture.  The choices for
10546 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10547 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10548 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10549 @samp{v10}.
10551 @item -mtune=@var{architecture-type}
10552 @opindex mtune
10553 Tune to @var{architecture-type} everything applicable about the generated
10554 code, except for the ABI and the set of available instructions.  The
10555 choices for @var{architecture-type} are the same as for
10556 @option{-march=@var{architecture-type}}.
10558 @item -mmax-stack-frame=@var{n}
10559 @opindex mmax-stack-frame
10560 Warn when the stack frame of a function exceeds @var{n} bytes.
10562 @item -metrax4
10563 @itemx -metrax100
10564 @opindex metrax4
10565 @opindex metrax100
10566 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10567 @option{-march=v3} and @option{-march=v8} respectively.
10569 @item -mmul-bug-workaround
10570 @itemx -mno-mul-bug-workaround
10571 @opindex mmul-bug-workaround
10572 @opindex mno-mul-bug-workaround
10573 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10574 models where it applies.  This option is active by default.
10576 @item -mpdebug
10577 @opindex mpdebug
10578 Enable CRIS-specific verbose debug-related information in the assembly
10579 code.  This option also has the effect to turn off the @samp{#NO_APP}
10580 formatted-code indicator to the assembler at the beginning of the
10581 assembly file.
10583 @item -mcc-init
10584 @opindex mcc-init
10585 Do not use condition-code results from previous instruction; always emit
10586 compare and test instructions before use of condition codes.
10588 @item -mno-side-effects
10589 @opindex mno-side-effects
10590 Do not emit instructions with side-effects in addressing modes other than
10591 post-increment.
10593 @item -mstack-align
10594 @itemx -mno-stack-align
10595 @itemx -mdata-align
10596 @itemx -mno-data-align
10597 @itemx -mconst-align
10598 @itemx -mno-const-align
10599 @opindex mstack-align
10600 @opindex mno-stack-align
10601 @opindex mdata-align
10602 @opindex mno-data-align
10603 @opindex mconst-align
10604 @opindex mno-const-align
10605 These options (no-options) arranges (eliminate arrangements) for the
10606 stack-frame, individual data and constants to be aligned for the maximum
10607 single data access size for the chosen CPU model.  The default is to
10608 arrange for 32-bit alignment.  ABI details such as structure layout are
10609 not affected by these options.
10611 @item -m32-bit
10612 @itemx -m16-bit
10613 @itemx -m8-bit
10614 @opindex m32-bit
10615 @opindex m16-bit
10616 @opindex m8-bit
10617 Similar to the stack- data- and const-align options above, these options
10618 arrange for stack-frame, writable data and constants to all be 32-bit,
10619 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10621 @item -mno-prologue-epilogue
10622 @itemx -mprologue-epilogue
10623 @opindex mno-prologue-epilogue
10624 @opindex mprologue-epilogue
10625 With @option{-mno-prologue-epilogue}, the normal function prologue and
10626 epilogue that sets up the stack-frame are omitted and no return
10627 instructions or return sequences are generated in the code.  Use this
10628 option only together with visual inspection of the compiled code: no
10629 warnings or errors are generated when call-saved registers must be saved,
10630 or storage for local variable needs to be allocated.
10632 @item -mno-gotplt
10633 @itemx -mgotplt
10634 @opindex mno-gotplt
10635 @opindex mgotplt
10636 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10637 instruction sequences that load addresses for functions from the PLT part
10638 of the GOT rather than (traditional on other architectures) calls to the
10639 PLT@.  The default is @option{-mgotplt}.
10641 @item -melf
10642 @opindex melf
10643 Legacy no-op option only recognized with the cris-axis-elf and
10644 cris-axis-linux-gnu targets.
10646 @item -mlinux
10647 @opindex mlinux
10648 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10650 @item -sim
10651 @opindex sim
10652 This option, recognized for the cris-axis-elf arranges
10653 to link with input-output functions from a simulator library.  Code,
10654 initialized data and zero-initialized data are allocated consecutively.
10656 @item -sim2
10657 @opindex sim2
10658 Like @option{-sim}, but pass linker options to locate initialized data at
10659 0x40000000 and zero-initialized data at 0x80000000.
10660 @end table
10662 @node CRX Options
10663 @subsection CRX Options
10664 @cindex CRX Options
10666 These options are defined specifically for the CRX ports.
10668 @table @gcctabopt
10670 @item -mmac
10671 @opindex mmac
10672 Enable the use of multiply-accumulate instructions. Disabled by default.
10674 @item -mpush-args
10675 @opindex mpush-args
10676 Push instructions will be used to pass outgoing arguments when functions
10677 are called. Enabled by default.
10678 @end table
10680 @node Darwin Options
10681 @subsection Darwin Options
10682 @cindex Darwin options
10684 These options are defined for all architectures running the Darwin operating
10685 system.
10687 FSF GCC on Darwin does not create ``fat'' object files; it will create
10688 an object file for the single architecture that it was built to
10689 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10690 @option{-arch} options are used; it does so by running the compiler or
10691 linker multiple times and joining the results together with
10692 @file{lipo}.
10694 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10695 @samp{i686}) is determined by the flags that specify the ISA
10696 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10697 @option{-force_cpusubtype_ALL} option can be used to override this.
10699 The Darwin tools vary in their behavior when presented with an ISA
10700 mismatch.  The assembler, @file{as}, will only permit instructions to
10701 be used that are valid for the subtype of the file it is generating,
10702 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10703 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10704 and print an error if asked to create a shared library with a less
10705 restrictive subtype than its input files (for instance, trying to put
10706 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10707 for executables, @file{ld}, will quietly give the executable the most
10708 restrictive subtype of any of its input files.
10710 @table @gcctabopt
10711 @item -F@var{dir}
10712 @opindex F
10713 Add the framework directory @var{dir} to the head of the list of
10714 directories to be searched for header files.  These directories are
10715 interleaved with those specified by @option{-I} options and are
10716 scanned in a left-to-right order.
10718 A framework directory is a directory with frameworks in it.  A
10719 framework is a directory with a @samp{"Headers"} and/or
10720 @samp{"PrivateHeaders"} directory contained directly in it that ends
10721 in @samp{".framework"}.  The name of a framework is the name of this
10722 directory excluding the @samp{".framework"}.  Headers associated with
10723 the framework are found in one of those two directories, with
10724 @samp{"Headers"} being searched first.  A subframework is a framework
10725 directory that is in a framework's @samp{"Frameworks"} directory.
10726 Includes of subframework headers can only appear in a header of a
10727 framework that contains the subframework, or in a sibling subframework
10728 header.  Two subframeworks are siblings if they occur in the same
10729 framework.  A subframework should not have the same name as a
10730 framework, a warning will be issued if this is violated.  Currently a
10731 subframework cannot have subframeworks, in the future, the mechanism
10732 may be extended to support this.  The standard frameworks can be found
10733 in @samp{"/System/Library/Frameworks"} and
10734 @samp{"/Library/Frameworks"}.  An example include looks like
10735 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10736 the name of the framework and header.h is found in the
10737 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10739 @item -iframework@var{dir}
10740 @opindex iframework
10741 Like @option{-F} except the directory is a treated as a system
10742 directory.  The main difference between this @option{-iframework} and
10743 @option{-F} is that with @option{-iframework} the compiler does not
10744 warn about constructs contained within header files found via
10745 @var{dir}.  This option is valid only for the C family of languages.
10747 @item -gused
10748 @opindex gused
10749 Emit debugging information for symbols that are used.  For STABS
10750 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10751 This is by default ON@.
10753 @item -gfull
10754 @opindex gfull
10755 Emit debugging information for all symbols and types.
10757 @item -mmacosx-version-min=@var{version}
10758 The earliest version of MacOS X that this executable will run on
10759 is @var{version}.  Typical values of @var{version} include @code{10.1},
10760 @code{10.2}, and @code{10.3.9}.
10762 If the compiler was built to use the system's headers by default,
10763 then the default for this option is the system version on which the
10764 compiler is running, otherwise the default is to make choices which
10765 are compatible with as many systems and code bases as possible.
10767 @item -mkernel
10768 @opindex mkernel
10769 Enable kernel development mode.  The @option{-mkernel} option sets
10770 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10771 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10772 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10773 applicable.  This mode also sets @option{-mno-altivec},
10774 @option{-msoft-float}, @option{-fno-builtin} and
10775 @option{-mlong-branch} for PowerPC targets.
10777 @item -mone-byte-bool
10778 @opindex mone-byte-bool
10779 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10780 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10781 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10782 option has no effect on x86.
10784 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10785 to generate code that is not binary compatible with code generated
10786 without that switch.  Using this switch may require recompiling all
10787 other modules in a program, including system libraries.  Use this
10788 switch to conform to a non-default data model.
10790 @item -mfix-and-continue
10791 @itemx -ffix-and-continue
10792 @itemx -findirect-data
10793 @opindex mfix-and-continue
10794 @opindex ffix-and-continue
10795 @opindex findirect-data
10796 Generate code suitable for fast turn around development.  Needed to
10797 enable gdb to dynamically load @code{.o} files into already running
10798 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10799 are provided for backwards compatibility.
10801 @item -all_load
10802 @opindex all_load
10803 Loads all members of static archive libraries.
10804 See man ld(1) for more information.
10806 @item -arch_errors_fatal
10807 @opindex arch_errors_fatal
10808 Cause the errors having to do with files that have the wrong architecture
10809 to be fatal.
10811 @item -bind_at_load
10812 @opindex bind_at_load
10813 Causes the output file to be marked such that the dynamic linker will
10814 bind all undefined references when the file is loaded or launched.
10816 @item -bundle
10817 @opindex bundle
10818 Produce a Mach-o bundle format file.
10819 See man ld(1) for more information.
10821 @item -bundle_loader @var{executable}
10822 @opindex bundle_loader
10823 This option specifies the @var{executable} that will be loading the build
10824 output file being linked.  See man ld(1) for more information.
10826 @item -dynamiclib
10827 @opindex dynamiclib
10828 When passed this option, GCC will produce a dynamic library instead of
10829 an executable when linking, using the Darwin @file{libtool} command.
10831 @item -force_cpusubtype_ALL
10832 @opindex force_cpusubtype_ALL
10833 This causes GCC's output file to have the @var{ALL} subtype, instead of
10834 one controlled by the @option{-mcpu} or @option{-march} option.
10836 @item -allowable_client  @var{client_name}
10837 @itemx -client_name
10838 @itemx -compatibility_version
10839 @itemx -current_version
10840 @itemx -dead_strip
10841 @itemx -dependency-file
10842 @itemx -dylib_file
10843 @itemx -dylinker_install_name
10844 @itemx -dynamic
10845 @itemx -exported_symbols_list
10846 @itemx -filelist
10847 @itemx -flat_namespace
10848 @itemx -force_flat_namespace
10849 @itemx -headerpad_max_install_names
10850 @itemx -image_base
10851 @itemx -init
10852 @itemx -install_name
10853 @itemx -keep_private_externs
10854 @itemx -multi_module
10855 @itemx -multiply_defined
10856 @itemx -multiply_defined_unused
10857 @itemx -noall_load
10858 @itemx -no_dead_strip_inits_and_terms
10859 @itemx -nofixprebinding
10860 @itemx -nomultidefs
10861 @itemx -noprebind
10862 @itemx -noseglinkedit
10863 @itemx -pagezero_size
10864 @itemx -prebind
10865 @itemx -prebind_all_twolevel_modules
10866 @itemx -private_bundle
10867 @itemx -read_only_relocs
10868 @itemx -sectalign
10869 @itemx -sectobjectsymbols
10870 @itemx -whyload
10871 @itemx -seg1addr
10872 @itemx -sectcreate
10873 @itemx -sectobjectsymbols
10874 @itemx -sectorder
10875 @itemx -segaddr
10876 @itemx -segs_read_only_addr
10877 @itemx -segs_read_write_addr
10878 @itemx -seg_addr_table
10879 @itemx -seg_addr_table_filename
10880 @itemx -seglinkedit
10881 @itemx -segprot
10882 @itemx -segs_read_only_addr
10883 @itemx -segs_read_write_addr
10884 @itemx -single_module
10885 @itemx -static
10886 @itemx -sub_library
10887 @itemx -sub_umbrella
10888 @itemx -twolevel_namespace
10889 @itemx -umbrella
10890 @itemx -undefined
10891 @itemx -unexported_symbols_list
10892 @itemx -weak_reference_mismatches
10893 @itemx -whatsloaded
10894 @opindex allowable_client
10895 @opindex client_name
10896 @opindex compatibility_version
10897 @opindex current_version
10898 @opindex dead_strip
10899 @opindex dependency-file
10900 @opindex dylib_file
10901 @opindex dylinker_install_name
10902 @opindex dynamic
10903 @opindex exported_symbols_list
10904 @opindex filelist
10905 @opindex flat_namespace
10906 @opindex force_flat_namespace
10907 @opindex headerpad_max_install_names
10908 @opindex image_base
10909 @opindex init
10910 @opindex install_name
10911 @opindex keep_private_externs
10912 @opindex multi_module
10913 @opindex multiply_defined
10914 @opindex multiply_defined_unused
10915 @opindex noall_load
10916 @opindex no_dead_strip_inits_and_terms
10917 @opindex nofixprebinding
10918 @opindex nomultidefs
10919 @opindex noprebind
10920 @opindex noseglinkedit
10921 @opindex pagezero_size
10922 @opindex prebind
10923 @opindex prebind_all_twolevel_modules
10924 @opindex private_bundle
10925 @opindex read_only_relocs
10926 @opindex sectalign
10927 @opindex sectobjectsymbols
10928 @opindex whyload
10929 @opindex seg1addr
10930 @opindex sectcreate
10931 @opindex sectobjectsymbols
10932 @opindex sectorder
10933 @opindex segaddr
10934 @opindex segs_read_only_addr
10935 @opindex segs_read_write_addr
10936 @opindex seg_addr_table
10937 @opindex seg_addr_table_filename
10938 @opindex seglinkedit
10939 @opindex segprot
10940 @opindex segs_read_only_addr
10941 @opindex segs_read_write_addr
10942 @opindex single_module
10943 @opindex static
10944 @opindex sub_library
10945 @opindex sub_umbrella
10946 @opindex twolevel_namespace
10947 @opindex umbrella
10948 @opindex undefined
10949 @opindex unexported_symbols_list
10950 @opindex weak_reference_mismatches
10951 @opindex whatsloaded
10952 These options are passed to the Darwin linker.  The Darwin linker man page
10953 describes them in detail.
10954 @end table
10956 @node DEC Alpha Options
10957 @subsection DEC Alpha Options
10959 These @samp{-m} options are defined for the DEC Alpha implementations:
10961 @table @gcctabopt
10962 @item -mno-soft-float
10963 @itemx -msoft-float
10964 @opindex mno-soft-float
10965 @opindex msoft-float
10966 Use (do not use) the hardware floating-point instructions for
10967 floating-point operations.  When @option{-msoft-float} is specified,
10968 functions in @file{libgcc.a} will be used to perform floating-point
10969 operations.  Unless they are replaced by routines that emulate the
10970 floating-point operations, or compiled in such a way as to call such
10971 emulations routines, these routines will issue floating-point
10972 operations.   If you are compiling for an Alpha without floating-point
10973 operations, you must ensure that the library is built so as not to call
10974 them.
10976 Note that Alpha implementations without floating-point operations are
10977 required to have floating-point registers.
10979 @item -mfp-reg
10980 @itemx -mno-fp-regs
10981 @opindex mfp-reg
10982 @opindex mno-fp-regs
10983 Generate code that uses (does not use) the floating-point register set.
10984 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
10985 register set is not used, floating point operands are passed in integer
10986 registers as if they were integers and floating-point results are passed
10987 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
10988 so any function with a floating-point argument or return value called by code
10989 compiled with @option{-mno-fp-regs} must also be compiled with that
10990 option.
10992 A typical use of this option is building a kernel that does not use,
10993 and hence need not save and restore, any floating-point registers.
10995 @item -mieee
10996 @opindex mieee
10997 The Alpha architecture implements floating-point hardware optimized for
10998 maximum performance.  It is mostly compliant with the IEEE floating
10999 point standard.  However, for full compliance, software assistance is
11000 required.  This option generates code fully IEEE compliant code
11001 @emph{except} that the @var{inexact-flag} is not maintained (see below).
11002 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
11003 defined during compilation.  The resulting code is less efficient but is
11004 able to correctly support denormalized numbers and exceptional IEEE
11005 values such as not-a-number and plus/minus infinity.  Other Alpha
11006 compilers call this option @option{-ieee_with_no_inexact}.
11008 @item -mieee-with-inexact
11009 @opindex mieee-with-inexact
11010 This is like @option{-mieee} except the generated code also maintains
11011 the IEEE @var{inexact-flag}.  Turning on this option causes the
11012 generated code to implement fully-compliant IEEE math.  In addition to
11013 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
11014 macro.  On some Alpha implementations the resulting code may execute
11015 significantly slower than the code generated by default.  Since there is
11016 very little code that depends on the @var{inexact-flag}, you should
11017 normally not specify this option.  Other Alpha compilers call this
11018 option @option{-ieee_with_inexact}.
11020 @item -mfp-trap-mode=@var{trap-mode}
11021 @opindex mfp-trap-mode
11022 This option controls what floating-point related traps are enabled.
11023 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
11024 The trap mode can be set to one of four values:
11026 @table @samp
11027 @item n
11028 This is the default (normal) setting.  The only traps that are enabled
11029 are the ones that cannot be disabled in software (e.g., division by zero
11030 trap).
11032 @item u
11033 In addition to the traps enabled by @samp{n}, underflow traps are enabled
11034 as well.
11036 @item su
11037 Like @samp{u}, but the instructions are marked to be safe for software
11038 completion (see Alpha architecture manual for details).
11040 @item sui
11041 Like @samp{su}, but inexact traps are enabled as well.
11042 @end table
11044 @item -mfp-rounding-mode=@var{rounding-mode}
11045 @opindex mfp-rounding-mode
11046 Selects the IEEE rounding mode.  Other Alpha compilers call this option
11047 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
11050 @table @samp
11051 @item n
11052 Normal IEEE rounding mode.  Floating point numbers are rounded towards
11053 the nearest machine number or towards the even machine number in case
11054 of a tie.
11056 @item m
11057 Round towards minus infinity.
11059 @item c
11060 Chopped rounding mode.  Floating point numbers are rounded towards zero.
11062 @item d
11063 Dynamic rounding mode.  A field in the floating point control register
11064 (@var{fpcr}, see Alpha architecture reference manual) controls the
11065 rounding mode in effect.  The C library initializes this register for
11066 rounding towards plus infinity.  Thus, unless your program modifies the
11067 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
11068 @end table
11070 @item -mtrap-precision=@var{trap-precision}
11071 @opindex mtrap-precision
11072 In the Alpha architecture, floating point traps are imprecise.  This
11073 means without software assistance it is impossible to recover from a
11074 floating trap and program execution normally needs to be terminated.
11075 GCC can generate code that can assist operating system trap handlers
11076 in determining the exact location that caused a floating point trap.
11077 Depending on the requirements of an application, different levels of
11078 precisions can be selected:
11080 @table @samp
11081 @item p
11082 Program precision.  This option is the default and means a trap handler
11083 can only identify which program caused a floating point exception.
11085 @item f
11086 Function precision.  The trap handler can determine the function that
11087 caused a floating point exception.
11089 @item i
11090 Instruction precision.  The trap handler can determine the exact
11091 instruction that caused a floating point exception.
11092 @end table
11094 Other Alpha compilers provide the equivalent options called
11095 @option{-scope_safe} and @option{-resumption_safe}.
11097 @item -mieee-conformant
11098 @opindex mieee-conformant
11099 This option marks the generated code as IEEE conformant.  You must not
11100 use this option unless you also specify @option{-mtrap-precision=i} and either
11101 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
11102 is to emit the line @samp{.eflag 48} in the function prologue of the
11103 generated assembly file.  Under DEC Unix, this has the effect that
11104 IEEE-conformant math library routines will be linked in.
11106 @item -mbuild-constants
11107 @opindex mbuild-constants
11108 Normally GCC examines a 32- or 64-bit integer constant to
11109 see if it can construct it from smaller constants in two or three
11110 instructions.  If it cannot, it will output the constant as a literal and
11111 generate code to load it from the data segment at runtime.
11113 Use this option to require GCC to construct @emph{all} integer constants
11114 using code, even if it takes more instructions (the maximum is six).
11116 You would typically use this option to build a shared library dynamic
11117 loader.  Itself a shared library, it must relocate itself in memory
11118 before it can find the variables and constants in its own data segment.
11120 @item -malpha-as
11121 @itemx -mgas
11122 @opindex malpha-as
11123 @opindex mgas
11124 Select whether to generate code to be assembled by the vendor-supplied
11125 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
11127 @item -mbwx
11128 @itemx -mno-bwx
11129 @itemx -mcix
11130 @itemx -mno-cix
11131 @itemx -mfix
11132 @itemx -mno-fix
11133 @itemx -mmax
11134 @itemx -mno-max
11135 @opindex mbwx
11136 @opindex mno-bwx
11137 @opindex mcix
11138 @opindex mno-cix
11139 @opindex mfix
11140 @opindex mno-fix
11141 @opindex mmax
11142 @opindex mno-max
11143 Indicate whether GCC should generate code to use the optional BWX,
11144 CIX, FIX and MAX instruction sets.  The default is to use the instruction
11145 sets supported by the CPU type specified via @option{-mcpu=} option or that
11146 of the CPU on which GCC was built if none was specified.
11148 @item -mfloat-vax
11149 @itemx -mfloat-ieee
11150 @opindex mfloat-vax
11151 @opindex mfloat-ieee
11152 Generate code that uses (does not use) VAX F and G floating point
11153 arithmetic instead of IEEE single and double precision.
11155 @item -mexplicit-relocs
11156 @itemx -mno-explicit-relocs
11157 @opindex mexplicit-relocs
11158 @opindex mno-explicit-relocs
11159 Older Alpha assemblers provided no way to generate symbol relocations
11160 except via assembler macros.  Use of these macros does not allow
11161 optimal instruction scheduling.  GNU binutils as of version 2.12
11162 supports a new syntax that allows the compiler to explicitly mark
11163 which relocations should apply to which instructions.  This option
11164 is mostly useful for debugging, as GCC detects the capabilities of
11165 the assembler when it is built and sets the default accordingly.
11167 @item -msmall-data
11168 @itemx -mlarge-data
11169 @opindex msmall-data
11170 @opindex mlarge-data
11171 When @option{-mexplicit-relocs} is in effect, static data is
11172 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
11173 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
11174 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
11175 16-bit relocations off of the @code{$gp} register.  This limits the
11176 size of the small data area to 64KB, but allows the variables to be
11177 directly accessed via a single instruction.
11179 The default is @option{-mlarge-data}.  With this option the data area
11180 is limited to just below 2GB@.  Programs that require more than 2GB of
11181 data must use @code{malloc} or @code{mmap} to allocate the data in the
11182 heap instead of in the program's data segment.
11184 When generating code for shared libraries, @option{-fpic} implies
11185 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
11187 @item -msmall-text
11188 @itemx -mlarge-text
11189 @opindex msmall-text
11190 @opindex mlarge-text
11191 When @option{-msmall-text} is used, the compiler assumes that the
11192 code of the entire program (or shared library) fits in 4MB, and is
11193 thus reachable with a branch instruction.  When @option{-msmall-data}
11194 is used, the compiler can assume that all local symbols share the
11195 same @code{$gp} value, and thus reduce the number of instructions
11196 required for a function call from 4 to 1.
11198 The default is @option{-mlarge-text}.
11200 @item -mcpu=@var{cpu_type}
11201 @opindex mcpu
11202 Set the instruction set and instruction scheduling parameters for
11203 machine type @var{cpu_type}.  You can specify either the @samp{EV}
11204 style name or the corresponding chip number.  GCC supports scheduling
11205 parameters for the EV4, EV5 and EV6 family of processors and will
11206 choose the default values for the instruction set from the processor
11207 you specify.  If you do not specify a processor type, GCC will default
11208 to the processor on which the compiler was built.
11210 Supported values for @var{cpu_type} are
11212 @table @samp
11213 @item ev4
11214 @itemx ev45
11215 @itemx 21064
11216 Schedules as an EV4 and has no instruction set extensions.
11218 @item ev5
11219 @itemx 21164
11220 Schedules as an EV5 and has no instruction set extensions.
11222 @item ev56
11223 @itemx 21164a
11224 Schedules as an EV5 and supports the BWX extension.
11226 @item pca56
11227 @itemx 21164pc
11228 @itemx 21164PC
11229 Schedules as an EV5 and supports the BWX and MAX extensions.
11231 @item ev6
11232 @itemx 21264
11233 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
11235 @item ev67
11236 @itemx 21264a
11237 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
11238 @end table
11240 Native Linux/GNU toolchains also support the value @samp{native},
11241 which selects the best architecture option for the host processor.
11242 @option{-mcpu=native} has no effect if GCC does not recognize
11243 the processor.
11245 @item -mtune=@var{cpu_type}
11246 @opindex mtune
11247 Set only the instruction scheduling parameters for machine type
11248 @var{cpu_type}.  The instruction set is not changed.
11250 Native Linux/GNU toolchains also support the value @samp{native},
11251 which selects the best architecture option for the host processor.
11252 @option{-mtune=native} has no effect if GCC does not recognize
11253 the processor.
11255 @item -mmemory-latency=@var{time}
11256 @opindex mmemory-latency
11257 Sets the latency the scheduler should assume for typical memory
11258 references as seen by the application.  This number is highly
11259 dependent on the memory access patterns used by the application
11260 and the size of the external cache on the machine.
11262 Valid options for @var{time} are
11264 @table @samp
11265 @item @var{number}
11266 A decimal number representing clock cycles.
11268 @item L1
11269 @itemx L2
11270 @itemx L3
11271 @itemx main
11272 The compiler contains estimates of the number of clock cycles for
11273 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
11274 (also called Dcache, Scache, and Bcache), as well as to main memory.
11275 Note that L3 is only valid for EV5.
11277 @end table
11278 @end table
11280 @node DEC Alpha/VMS Options
11281 @subsection DEC Alpha/VMS Options
11283 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
11285 @table @gcctabopt
11286 @item -mvms-return-codes
11287 @opindex mvms-return-codes
11288 Return VMS condition codes from main.  The default is to return POSIX
11289 style condition (e.g.@: error) codes.
11291 @item -mdebug-main=@var{prefix}
11292 @opindex mdebug-main=@var{prefix}
11293 Flag the first routine whose name starts with @var{prefix} as the main
11294 routine for the debugger.
11296 @item -mmalloc64
11297 @opindex mmalloc64
11298 Default to 64bit memory allocation routines.
11299 @end table
11301 @node FR30 Options
11302 @subsection FR30 Options
11303 @cindex FR30 Options
11305 These options are defined specifically for the FR30 port.
11307 @table @gcctabopt
11309 @item -msmall-model
11310 @opindex msmall-model
11311 Use the small address space model.  This can produce smaller code, but
11312 it does assume that all symbolic values and addresses will fit into a
11313 20-bit range.
11315 @item -mno-lsim
11316 @opindex mno-lsim
11317 Assume that run-time support has been provided and so there is no need
11318 to include the simulator library (@file{libsim.a}) on the linker
11319 command line.
11321 @end table
11323 @node FRV Options
11324 @subsection FRV Options
11325 @cindex FRV Options
11327 @table @gcctabopt
11328 @item -mgpr-32
11329 @opindex mgpr-32
11331 Only use the first 32 general purpose registers.
11333 @item -mgpr-64
11334 @opindex mgpr-64
11336 Use all 64 general purpose registers.
11338 @item -mfpr-32
11339 @opindex mfpr-32
11341 Use only the first 32 floating point registers.
11343 @item -mfpr-64
11344 @opindex mfpr-64
11346 Use all 64 floating point registers
11348 @item -mhard-float
11349 @opindex mhard-float
11351 Use hardware instructions for floating point operations.
11353 @item -msoft-float
11354 @opindex msoft-float
11356 Use library routines for floating point operations.
11358 @item -malloc-cc
11359 @opindex malloc-cc
11361 Dynamically allocate condition code registers.
11363 @item -mfixed-cc
11364 @opindex mfixed-cc
11366 Do not try to dynamically allocate condition code registers, only
11367 use @code{icc0} and @code{fcc0}.
11369 @item -mdword
11370 @opindex mdword
11372 Change ABI to use double word insns.
11374 @item -mno-dword
11375 @opindex mno-dword
11377 Do not use double word instructions.
11379 @item -mdouble
11380 @opindex mdouble
11382 Use floating point double instructions.
11384 @item -mno-double
11385 @opindex mno-double
11387 Do not use floating point double instructions.
11389 @item -mmedia
11390 @opindex mmedia
11392 Use media instructions.
11394 @item -mno-media
11395 @opindex mno-media
11397 Do not use media instructions.
11399 @item -mmuladd
11400 @opindex mmuladd
11402 Use multiply and add/subtract instructions.
11404 @item -mno-muladd
11405 @opindex mno-muladd
11407 Do not use multiply and add/subtract instructions.
11409 @item -mfdpic
11410 @opindex mfdpic
11412 Select the FDPIC ABI, that uses function descriptors to represent
11413 pointers to functions.  Without any PIC/PIE-related options, it
11414 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
11415 assumes GOT entries and small data are within a 12-bit range from the
11416 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11417 are computed with 32 bits.
11418 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11420 @item -minline-plt
11421 @opindex minline-plt
11423 Enable inlining of PLT entries in function calls to functions that are
11424 not known to bind locally.  It has no effect without @option{-mfdpic}.
11425 It's enabled by default if optimizing for speed and compiling for
11426 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11427 optimization option such as @option{-O3} or above is present in the
11428 command line.
11430 @item -mTLS
11431 @opindex mTLS
11433 Assume a large TLS segment when generating thread-local code.
11435 @item -mtls
11436 @opindex mtls
11438 Do not assume a large TLS segment when generating thread-local code.
11440 @item -mgprel-ro
11441 @opindex mgprel-ro
11443 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11444 that is known to be in read-only sections.  It's enabled by default,
11445 except for @option{-fpic} or @option{-fpie}: even though it may help
11446 make the global offset table smaller, it trades 1 instruction for 4.
11447 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11448 one of which may be shared by multiple symbols, and it avoids the need
11449 for a GOT entry for the referenced symbol, so it's more likely to be a
11450 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
11452 @item -multilib-library-pic
11453 @opindex multilib-library-pic
11455 Link with the (library, not FD) pic libraries.  It's implied by
11456 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11457 @option{-fpic} without @option{-mfdpic}.  You should never have to use
11458 it explicitly.
11460 @item -mlinked-fp
11461 @opindex mlinked-fp
11463 Follow the EABI requirement of always creating a frame pointer whenever
11464 a stack frame is allocated.  This option is enabled by default and can
11465 be disabled with @option{-mno-linked-fp}.
11467 @item -mlong-calls
11468 @opindex mlong-calls
11470 Use indirect addressing to call functions outside the current
11471 compilation unit.  This allows the functions to be placed anywhere
11472 within the 32-bit address space.
11474 @item -malign-labels
11475 @opindex malign-labels
11477 Try to align labels to an 8-byte boundary by inserting nops into the
11478 previous packet.  This option only has an effect when VLIW packing
11479 is enabled.  It doesn't create new packets; it merely adds nops to
11480 existing ones.
11482 @item -mlibrary-pic
11483 @opindex mlibrary-pic
11485 Generate position-independent EABI code.
11487 @item -macc-4
11488 @opindex macc-4
11490 Use only the first four media accumulator registers.
11492 @item -macc-8
11493 @opindex macc-8
11495 Use all eight media accumulator registers.
11497 @item -mpack
11498 @opindex mpack
11500 Pack VLIW instructions.
11502 @item -mno-pack
11503 @opindex mno-pack
11505 Do not pack VLIW instructions.
11507 @item -mno-eflags
11508 @opindex mno-eflags
11510 Do not mark ABI switches in e_flags.
11512 @item -mcond-move
11513 @opindex mcond-move
11515 Enable the use of conditional-move instructions (default).
11517 This switch is mainly for debugging the compiler and will likely be removed
11518 in a future version.
11520 @item -mno-cond-move
11521 @opindex mno-cond-move
11523 Disable the use of conditional-move instructions.
11525 This switch is mainly for debugging the compiler and will likely be removed
11526 in a future version.
11528 @item -mscc
11529 @opindex mscc
11531 Enable the use of conditional set instructions (default).
11533 This switch is mainly for debugging the compiler and will likely be removed
11534 in a future version.
11536 @item -mno-scc
11537 @opindex mno-scc
11539 Disable the use of conditional set instructions.
11541 This switch is mainly for debugging the compiler and will likely be removed
11542 in a future version.
11544 @item -mcond-exec
11545 @opindex mcond-exec
11547 Enable the use of conditional execution (default).
11549 This switch is mainly for debugging the compiler and will likely be removed
11550 in a future version.
11552 @item -mno-cond-exec
11553 @opindex mno-cond-exec
11555 Disable the use of conditional execution.
11557 This switch is mainly for debugging the compiler and will likely be removed
11558 in a future version.
11560 @item -mvliw-branch
11561 @opindex mvliw-branch
11563 Run a pass to pack branches into VLIW instructions (default).
11565 This switch is mainly for debugging the compiler and will likely be removed
11566 in a future version.
11568 @item -mno-vliw-branch
11569 @opindex mno-vliw-branch
11571 Do not run a pass to pack branches into VLIW instructions.
11573 This switch is mainly for debugging the compiler and will likely be removed
11574 in a future version.
11576 @item -mmulti-cond-exec
11577 @opindex mmulti-cond-exec
11579 Enable optimization of @code{&&} and @code{||} in conditional execution
11580 (default).
11582 This switch is mainly for debugging the compiler and will likely be removed
11583 in a future version.
11585 @item -mno-multi-cond-exec
11586 @opindex mno-multi-cond-exec
11588 Disable optimization of @code{&&} and @code{||} in conditional execution.
11590 This switch is mainly for debugging the compiler and will likely be removed
11591 in a future version.
11593 @item -mnested-cond-exec
11594 @opindex mnested-cond-exec
11596 Enable nested conditional execution optimizations (default).
11598 This switch is mainly for debugging the compiler and will likely be removed
11599 in a future version.
11601 @item -mno-nested-cond-exec
11602 @opindex mno-nested-cond-exec
11604 Disable nested conditional execution optimizations.
11606 This switch is mainly for debugging the compiler and will likely be removed
11607 in a future version.
11609 @item -moptimize-membar
11610 @opindex moptimize-membar
11612 This switch removes redundant @code{membar} instructions from the
11613 compiler generated code.  It is enabled by default.
11615 @item -mno-optimize-membar
11616 @opindex mno-optimize-membar
11618 This switch disables the automatic removal of redundant @code{membar}
11619 instructions from the generated code.
11621 @item -mtomcat-stats
11622 @opindex mtomcat-stats
11624 Cause gas to print out tomcat statistics.
11626 @item -mcpu=@var{cpu}
11627 @opindex mcpu
11629 Select the processor type for which to generate code.  Possible values are
11630 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11631 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11633 @end table
11635 @node GNU/Linux Options
11636 @subsection GNU/Linux Options
11638 These @samp{-m} options are defined for GNU/Linux targets:
11640 @table @gcctabopt
11641 @item -mglibc
11642 @opindex mglibc
11643 Use the GNU C library.  This is the default except
11644 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
11646 @item -muclibc
11647 @opindex muclibc
11648 Use uClibc C library.  This is the default on
11649 @samp{*-*-linux-*uclibc*} targets.
11651 @item -mbionic
11652 @opindex mbionic
11653 Use Bionic C library.  This is the default on
11654 @samp{*-*-linux-*android*} targets.
11656 @item -mandroid
11657 @opindex mandroid
11658 Compile code compatible with Android platform.  This is the default on
11659 @samp{*-*-linux-*android*} targets.
11661 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
11662 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
11663 this option makes the GCC driver pass Android-specific options to the linker.
11664 Finally, this option causes the preprocessor macro @code{__ANDROID__}
11665 to be defined.
11667 @item -tno-android-cc
11668 @opindex tno-android-cc
11669 Disable compilation effects of @option{-mandroid}, i.e., do not enable
11670 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
11671 @option{-fno-rtti} by default.
11673 @item -tno-android-ld
11674 @opindex tno-android-ld
11675 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
11676 linking options to the linker.
11678 @end table
11680 @node H8/300 Options
11681 @subsection H8/300 Options
11683 These @samp{-m} options are defined for the H8/300 implementations:
11685 @table @gcctabopt
11686 @item -mrelax
11687 @opindex mrelax
11688 Shorten some address references at link time, when possible; uses the
11689 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11690 ld, Using ld}, for a fuller description.
11692 @item -mh
11693 @opindex mh
11694 Generate code for the H8/300H@.
11696 @item -ms
11697 @opindex ms
11698 Generate code for the H8S@.
11700 @item -mn
11701 @opindex mn
11702 Generate code for the H8S and H8/300H in the normal mode.  This switch
11703 must be used either with @option{-mh} or @option{-ms}.
11705 @item -ms2600
11706 @opindex ms2600
11707 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11709 @item -mint32
11710 @opindex mint32
11711 Make @code{int} data 32 bits by default.
11713 @item -malign-300
11714 @opindex malign-300
11715 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11716 The default for the H8/300H and H8S is to align longs and floats on 4
11717 byte boundaries.
11718 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11719 This option has no effect on the H8/300.
11720 @end table
11722 @node HPPA Options
11723 @subsection HPPA Options
11724 @cindex HPPA Options
11726 These @samp{-m} options are defined for the HPPA family of computers:
11728 @table @gcctabopt
11729 @item -march=@var{architecture-type}
11730 @opindex march
11731 Generate code for the specified architecture.  The choices for
11732 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11733 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11734 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11735 architecture option for your machine.  Code compiled for lower numbered
11736 architectures will run on higher numbered architectures, but not the
11737 other way around.
11739 @item -mpa-risc-1-0
11740 @itemx -mpa-risc-1-1
11741 @itemx -mpa-risc-2-0
11742 @opindex mpa-risc-1-0
11743 @opindex mpa-risc-1-1
11744 @opindex mpa-risc-2-0
11745 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11747 @item -mbig-switch
11748 @opindex mbig-switch
11749 Generate code suitable for big switch tables.  Use this option only if
11750 the assembler/linker complain about out of range branches within a switch
11751 table.
11753 @item -mjump-in-delay
11754 @opindex mjump-in-delay
11755 Fill delay slots of function calls with unconditional jump instructions
11756 by modifying the return pointer for the function call to be the target
11757 of the conditional jump.
11759 @item -mdisable-fpregs
11760 @opindex mdisable-fpregs
11761 Prevent floating point registers from being used in any manner.  This is
11762 necessary for compiling kernels which perform lazy context switching of
11763 floating point registers.  If you use this option and attempt to perform
11764 floating point operations, the compiler will abort.
11766 @item -mdisable-indexing
11767 @opindex mdisable-indexing
11768 Prevent the compiler from using indexing address modes.  This avoids some
11769 rather obscure problems when compiling MIG generated code under MACH@.
11771 @item -mno-space-regs
11772 @opindex mno-space-regs
11773 Generate code that assumes the target has no space registers.  This allows
11774 GCC to generate faster indirect calls and use unscaled index address modes.
11776 Such code is suitable for level 0 PA systems and kernels.
11778 @item -mfast-indirect-calls
11779 @opindex mfast-indirect-calls
11780 Generate code that assumes calls never cross space boundaries.  This
11781 allows GCC to emit code which performs faster indirect calls.
11783 This option will not work in the presence of shared libraries or nested
11784 functions.
11786 @item -mfixed-range=@var{register-range}
11787 @opindex mfixed-range
11788 Generate code treating the given register range as fixed registers.
11789 A fixed register is one that the register allocator can not use.  This is
11790 useful when compiling kernel code.  A register range is specified as
11791 two registers separated by a dash.  Multiple register ranges can be
11792 specified separated by a comma.
11794 @item -mlong-load-store
11795 @opindex mlong-load-store
11796 Generate 3-instruction load and store sequences as sometimes required by
11797 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11798 the HP compilers.
11800 @item -mportable-runtime
11801 @opindex mportable-runtime
11802 Use the portable calling conventions proposed by HP for ELF systems.
11804 @item -mgas
11805 @opindex mgas
11806 Enable the use of assembler directives only GAS understands.
11808 @item -mschedule=@var{cpu-type}
11809 @opindex mschedule
11810 Schedule code according to the constraints for the machine type
11811 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11812 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11813 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11814 proper scheduling option for your machine.  The default scheduling is
11815 @samp{8000}.
11817 @item -mlinker-opt
11818 @opindex mlinker-opt
11819 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11820 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11821 linkers in which they give bogus error messages when linking some programs.
11823 @item -msoft-float
11824 @opindex msoft-float
11825 Generate output containing library calls for floating point.
11826 @strong{Warning:} the requisite libraries are not available for all HPPA
11827 targets.  Normally the facilities of the machine's usual C compiler are
11828 used, but this cannot be done directly in cross-compilation.  You must make
11829 your own arrangements to provide suitable library functions for
11830 cross-compilation.
11832 @option{-msoft-float} changes the calling convention in the output file;
11833 therefore, it is only useful if you compile @emph{all} of a program with
11834 this option.  In particular, you need to compile @file{libgcc.a}, the
11835 library that comes with GCC, with @option{-msoft-float} in order for
11836 this to work.
11838 @item -msio
11839 @opindex msio
11840 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11841 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11842 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11843 options are available under HP-UX and HI-UX@.
11845 @item -mgnu-ld
11846 @opindex mgnu-ld
11847 Use GNU ld specific options.  This passes @option{-shared} to ld when
11848 building a shared library.  It is the default when GCC is configured,
11849 explicitly or implicitly, with the GNU linker.  This option does not
11850 have any affect on which ld is called, it only changes what parameters
11851 are passed to that ld.  The ld that is called is determined by the
11852 @option{--with-ld} configure option, GCC's program search path, and
11853 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11854 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11855 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11857 @item -mhp-ld
11858 @opindex mhp-ld
11859 Use HP ld specific options.  This passes @option{-b} to ld when building
11860 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11861 links.  It is the default when GCC is configured, explicitly or
11862 implicitly, with the HP linker.  This option does not have any affect on
11863 which ld is called, it only changes what parameters are passed to that
11864 ld.  The ld that is called is determined by the @option{--with-ld}
11865 configure option, GCC's program search path, and finally by the user's
11866 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11867 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11868 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11870 @item -mlong-calls
11871 @opindex mno-long-calls
11872 Generate code that uses long call sequences.  This ensures that a call
11873 is always able to reach linker generated stubs.  The default is to generate
11874 long calls only when the distance from the call site to the beginning
11875 of the function or translation unit, as the case may be, exceeds a
11876 predefined limit set by the branch type being used.  The limits for
11877 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11878 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11879 240,000 bytes.
11881 Distances are measured from the beginning of functions when using the
11882 @option{-ffunction-sections} option, or when using the @option{-mgas}
11883 and @option{-mno-portable-runtime} options together under HP-UX with
11884 the SOM linker.
11886 It is normally not desirable to use this option as it will degrade
11887 performance.  However, it may be useful in large applications,
11888 particularly when partial linking is used to build the application.
11890 The types of long calls used depends on the capabilities of the
11891 assembler and linker, and the type of code being generated.  The
11892 impact on systems that support long absolute calls, and long pic
11893 symbol-difference or pc-relative calls should be relatively small.
11894 However, an indirect call is used on 32-bit ELF systems in pic code
11895 and it is quite long.
11897 @item -munix=@var{unix-std}
11898 @opindex march
11899 Generate compiler predefines and select a startfile for the specified
11900 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11901 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11902 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11903 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11904 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11905 and later.
11907 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11908 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11909 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11910 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11911 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11912 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11914 It is @emph{important} to note that this option changes the interfaces
11915 for various library routines.  It also affects the operational behavior
11916 of the C library.  Thus, @emph{extreme} care is needed in using this
11917 option.
11919 Library code that is intended to operate with more than one UNIX
11920 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11921 as appropriate.  Most GNU software doesn't provide this capability.
11923 @item -nolibdld
11924 @opindex nolibdld
11925 Suppress the generation of link options to search libdld.sl when the
11926 @option{-static} option is specified on HP-UX 10 and later.
11928 @item -static
11929 @opindex static
11930 The HP-UX implementation of setlocale in libc has a dependency on
11931 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11932 when the @option{-static} option is specified, special link options
11933 are needed to resolve this dependency.
11935 On HP-UX 10 and later, the GCC driver adds the necessary options to
11936 link with libdld.sl when the @option{-static} option is specified.
11937 This causes the resulting binary to be dynamic.  On the 64-bit port,
11938 the linkers generate dynamic binaries by default in any case.  The
11939 @option{-nolibdld} option can be used to prevent the GCC driver from
11940 adding these link options.
11942 @item -threads
11943 @opindex threads
11944 Add support for multithreading with the @dfn{dce thread} library
11945 under HP-UX@.  This option sets flags for both the preprocessor and
11946 linker.
11947 @end table
11949 @node i386 and x86-64 Options
11950 @subsection Intel 386 and AMD x86-64 Options
11951 @cindex i386 Options
11952 @cindex x86-64 Options
11953 @cindex Intel 386 Options
11954 @cindex AMD x86-64 Options
11956 These @samp{-m} options are defined for the i386 and x86-64 family of
11957 computers:
11959 @table @gcctabopt
11960 @item -mtune=@var{cpu-type}
11961 @opindex mtune
11962 Tune to @var{cpu-type} everything applicable about the generated code, except
11963 for the ABI and the set of available instructions.  The choices for
11964 @var{cpu-type} are:
11965 @table @emph
11966 @item generic
11967 Produce code optimized for the most common IA32/AMD64/EM64T processors.
11968 If you know the CPU on which your code will run, then you should use
11969 the corresponding @option{-mtune} option instead of
11970 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
11971 of your application will have, then you should use this option.
11973 As new processors are deployed in the marketplace, the behavior of this
11974 option will change.  Therefore, if you upgrade to a newer version of
11975 GCC, the code generated option will change to reflect the processors
11976 that were most common when that version of GCC was released.
11978 There is no @option{-march=generic} option because @option{-march}
11979 indicates the instruction set the compiler can use, and there is no
11980 generic instruction set applicable to all processors.  In contrast,
11981 @option{-mtune} indicates the processor (or, in this case, collection of
11982 processors) for which the code is optimized.
11983 @item native
11984 This selects the CPU to tune for at compilation time by determining
11985 the processor type of the compiling machine.  Using @option{-mtune=native}
11986 will produce code optimized for the local machine under the constraints
11987 of the selected instruction set.  Using @option{-march=native} will
11988 enable all instruction subsets supported by the local machine (hence
11989 the result might not run on different machines).
11990 @item i386
11991 Original Intel's i386 CPU@.
11992 @item i486
11993 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
11994 @item i586, pentium
11995 Intel Pentium CPU with no MMX support.
11996 @item pentium-mmx
11997 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
11998 @item pentiumpro
11999 Intel PentiumPro CPU@.
12000 @item i686
12001 Same as @code{generic}, but when used as @code{march} option, PentiumPro
12002 instruction set will be used, so the code will run on all i686 family chips.
12003 @item pentium2
12004 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
12005 @item pentium3, pentium3m
12006 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
12007 support.
12008 @item pentium-m
12009 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
12010 support.  Used by Centrino notebooks.
12011 @item pentium4, pentium4m
12012 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
12013 @item prescott
12014 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
12015 set support.
12016 @item nocona
12017 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
12018 SSE2 and SSE3 instruction set support.
12019 @item core2
12020 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
12021 instruction set support.
12022 @item atom
12023 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
12024 instruction set support.
12025 @item k6
12026 AMD K6 CPU with MMX instruction set support.
12027 @item k6-2, k6-3
12028 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
12029 @item athlon, athlon-tbird
12030 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
12031 support.
12032 @item athlon-4, athlon-xp, athlon-mp
12033 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
12034 instruction set support.
12035 @item k8, opteron, athlon64, athlon-fx
12036 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
12037 MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit instruction set extensions.)
12038 @item k8-sse3, opteron-sse3, athlon64-sse3
12039 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
12040 @item amdfam10, barcelona
12041 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
12042 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
12043 instruction set extensions.)
12044 @item winchip-c6
12045 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
12046 set support.
12047 @item winchip2
12048 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
12049 instruction set support.
12050 @item c3
12051 Via C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
12052 implemented for this chip.)
12053 @item c3-2
12054 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
12055 implemented for this chip.)
12056 @item geode
12057 Embedded AMD CPU with MMX and 3DNow!@: instruction set support.
12058 @end table
12060 While picking a specific @var{cpu-type} will schedule things appropriately
12061 for that particular chip, the compiler will not generate any code that
12062 does not run on the i386 without the @option{-march=@var{cpu-type}} option
12063 being used.
12065 @item -march=@var{cpu-type}
12066 @opindex march
12067 Generate instructions for the machine type @var{cpu-type}.  The choices
12068 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
12069 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
12071 @item -mcpu=@var{cpu-type}
12072 @opindex mcpu
12073 A deprecated synonym for @option{-mtune}.
12075 @item -mfpmath=@var{unit}
12076 @opindex mfpmath
12077 Generate floating point arithmetics for selected unit @var{unit}.  The choices
12078 for @var{unit} are:
12080 @table @samp
12081 @item 387
12082 Use the standard 387 floating point coprocessor present majority of chips and
12083 emulated otherwise.  Code compiled with this option will run almost everywhere.
12084 The temporary results are computed in 80bit precision instead of precision
12085 specified by the type resulting in slightly different results compared to most
12086 of other chips.  See @option{-ffloat-store} for more detailed description.
12088 This is the default choice for i386 compiler.
12090 @item sse
12091 Use scalar floating point instructions present in the SSE instruction set.
12092 This instruction set is supported by Pentium3 and newer chips, in the AMD line
12093 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
12094 instruction set supports only single precision arithmetics, thus the double and
12095 extended precision arithmetics is still done using 387.  Later version, present
12096 only in Pentium4 and the future AMD x86-64 chips supports double precision
12097 arithmetics too.
12099 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
12100 or @option{-msse2} switches to enable SSE extensions and make this option
12101 effective.  For the x86-64 compiler, these extensions are enabled by default.
12103 The resulting code should be considerably faster in the majority of cases and avoid
12104 the numerical instability problems of 387 code, but may break some existing
12105 code that expects temporaries to be 80bit.
12107 This is the default choice for the x86-64 compiler.
12109 @item sse,387
12110 @itemx sse+387
12111 @itemx both
12112 Attempt to utilize both instruction sets at once.  This effectively double the
12113 amount of available registers and on chips with separate execution units for
12114 387 and SSE the execution resources too.  Use this option with care, as it is
12115 still experimental, because the GCC register allocator does not model separate
12116 functional units well resulting in instable performance.
12117 @end table
12119 @item -masm=@var{dialect}
12120 @opindex masm=@var{dialect}
12121 Output asm instructions using selected @var{dialect}.  Supported
12122 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
12123 not support @samp{intel}.
12125 @item -mieee-fp
12126 @itemx -mno-ieee-fp
12127 @opindex mieee-fp
12128 @opindex mno-ieee-fp
12129 Control whether or not the compiler uses IEEE floating point
12130 comparisons.  These handle correctly the case where the result of a
12131 comparison is unordered.
12133 @item -msoft-float
12134 @opindex msoft-float
12135 Generate output containing library calls for floating point.
12136 @strong{Warning:} the requisite libraries are not part of GCC@.
12137 Normally the facilities of the machine's usual C compiler are used, but
12138 this can't be done directly in cross-compilation.  You must make your
12139 own arrangements to provide suitable library functions for
12140 cross-compilation.
12142 On machines where a function returns floating point results in the 80387
12143 register stack, some floating point opcodes may be emitted even if
12144 @option{-msoft-float} is used.
12146 @item -mno-fp-ret-in-387
12147 @opindex mno-fp-ret-in-387
12148 Do not use the FPU registers for return values of functions.
12150 The usual calling convention has functions return values of types
12151 @code{float} and @code{double} in an FPU register, even if there
12152 is no FPU@.  The idea is that the operating system should emulate
12153 an FPU@.
12155 The option @option{-mno-fp-ret-in-387} causes such values to be returned
12156 in ordinary CPU registers instead.
12158 @item -mno-fancy-math-387
12159 @opindex mno-fancy-math-387
12160 Some 387 emulators do not support the @code{sin}, @code{cos} and
12161 @code{sqrt} instructions for the 387.  Specify this option to avoid
12162 generating those instructions.  This option is the default on FreeBSD,
12163 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
12164 indicates that the target cpu will always have an FPU and so the
12165 instruction will not need emulation.  As of revision 2.6.1, these
12166 instructions are not generated unless you also use the
12167 @option{-funsafe-math-optimizations} switch.
12169 @item -malign-double
12170 @itemx -mno-align-double
12171 @opindex malign-double
12172 @opindex mno-align-double
12173 Control whether GCC aligns @code{double}, @code{long double}, and
12174 @code{long long} variables on a two word boundary or a one word
12175 boundary.  Aligning @code{double} variables on a two word boundary will
12176 produce code that runs somewhat faster on a @samp{Pentium} at the
12177 expense of more memory.
12179 On x86-64, @option{-malign-double} is enabled by default.
12181 @strong{Warning:} if you use the @option{-malign-double} switch,
12182 structures containing the above types will be aligned differently than
12183 the published application binary interface specifications for the 386
12184 and will not be binary compatible with structures in code compiled
12185 without that switch.
12187 @item -m96bit-long-double
12188 @itemx -m128bit-long-double
12189 @opindex m96bit-long-double
12190 @opindex m128bit-long-double
12191 These switches control the size of @code{long double} type.  The i386
12192 application binary interface specifies the size to be 96 bits,
12193 so @option{-m96bit-long-double} is the default in 32 bit mode.
12195 Modern architectures (Pentium and newer) would prefer @code{long double}
12196 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
12197 conforming to the ABI, this would not be possible.  So specifying a
12198 @option{-m128bit-long-double} will align @code{long double}
12199 to a 16 byte boundary by padding the @code{long double} with an additional
12200 32 bit zero.
12202 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
12203 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
12205 Notice that neither of these options enable any extra precision over the x87
12206 standard of 80 bits for a @code{long double}.
12208 @strong{Warning:} if you override the default value for your target ABI, the
12209 structures and arrays containing @code{long double} variables will change
12210 their size as well as function calling convention for function taking
12211 @code{long double} will be modified.  Hence they will not be binary
12212 compatible with arrays or structures in code compiled without that switch.
12214 @item -mlarge-data-threshold=@var{number}
12215 @opindex mlarge-data-threshold=@var{number}
12216 When @option{-mcmodel=medium} is specified, the data greater than
12217 @var{threshold} are placed in large data section.  This value must be the
12218 same across all object linked into the binary and defaults to 65535.
12220 @item -mrtd
12221 @opindex mrtd
12222 Use a different function-calling convention, in which functions that
12223 take a fixed number of arguments return with the @code{ret} @var{num}
12224 instruction, which pops their arguments while returning.  This saves one
12225 instruction in the caller since there is no need to pop the arguments
12226 there.
12228 You can specify that an individual function is called with this calling
12229 sequence with the function attribute @samp{stdcall}.  You can also
12230 override the @option{-mrtd} option by using the function attribute
12231 @samp{cdecl}.  @xref{Function Attributes}.
12233 @strong{Warning:} this calling convention is incompatible with the one
12234 normally used on Unix, so you cannot use it if you need to call
12235 libraries compiled with the Unix compiler.
12237 Also, you must provide function prototypes for all functions that
12238 take variable numbers of arguments (including @code{printf});
12239 otherwise incorrect code will be generated for calls to those
12240 functions.
12242 In addition, seriously incorrect code will result if you call a
12243 function with too many arguments.  (Normally, extra arguments are
12244 harmlessly ignored.)
12246 @item -mregparm=@var{num}
12247 @opindex mregparm
12248 Control how many registers are used to pass integer arguments.  By
12249 default, no registers are used to pass arguments, and at most 3
12250 registers can be used.  You can control this behavior for a specific
12251 function by using the function attribute @samp{regparm}.
12252 @xref{Function Attributes}.
12254 @strong{Warning:} if you use this switch, and
12255 @var{num} is nonzero, then you must build all modules with the same
12256 value, including any libraries.  This includes the system libraries and
12257 startup modules.
12259 @item -msseregparm
12260 @opindex msseregparm
12261 Use SSE register passing conventions for float and double arguments
12262 and return values.  You can control this behavior for a specific
12263 function by using the function attribute @samp{sseregparm}.
12264 @xref{Function Attributes}.
12266 @strong{Warning:} if you use this switch then you must build all
12267 modules with the same value, including any libraries.  This includes
12268 the system libraries and startup modules.
12270 @item -mpc32
12271 @itemx -mpc64
12272 @itemx -mpc80
12273 @opindex mpc32
12274 @opindex mpc64
12275 @opindex mpc80
12277 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
12278 is specified, the significands of results of floating-point operations are
12279 rounded to 24 bits (single precision); @option{-mpc64} rounds the
12280 significands of results of floating-point operations to 53 bits (double
12281 precision) and @option{-mpc80} rounds the significands of results of
12282 floating-point operations to 64 bits (extended double precision), which is
12283 the default.  When this option is used, floating-point operations in higher
12284 precisions are not available to the programmer without setting the FPU
12285 control word explicitly.
12287 Setting the rounding of floating-point operations to less than the default
12288 80 bits can speed some programs by 2% or more.  Note that some mathematical
12289 libraries assume that extended precision (80 bit) floating-point operations
12290 are enabled by default; routines in such libraries could suffer significant
12291 loss of accuracy, typically through so-called "catastrophic cancellation",
12292 when this option is used to set the precision to less than extended precision.
12294 @item -mstackrealign
12295 @opindex mstackrealign
12296 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
12297 option will generate an alternate prologue and epilogue that realigns the
12298 runtime stack if necessary.  This supports mixing legacy codes that keep
12299 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
12300 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
12301 applicable to individual functions.
12303 @item -mpreferred-stack-boundary=@var{num}
12304 @opindex mpreferred-stack-boundary
12305 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
12306 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
12307 the default is 4 (16 bytes or 128 bits).
12309 @item -mincoming-stack-boundary=@var{num}
12310 @opindex mincoming-stack-boundary
12311 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
12312 boundary.  If @option{-mincoming-stack-boundary} is not specified,
12313 the one specified by @option{-mpreferred-stack-boundary} will be used.
12315 On Pentium and PentiumPro, @code{double} and @code{long double} values
12316 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
12317 suffer significant run time performance penalties.  On Pentium III, the
12318 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
12319 properly if it is not 16 byte aligned.
12321 To ensure proper alignment of this values on the stack, the stack boundary
12322 must be as aligned as that required by any value stored on the stack.
12323 Further, every function must be generated such that it keeps the stack
12324 aligned.  Thus calling a function compiled with a higher preferred
12325 stack boundary from a function compiled with a lower preferred stack
12326 boundary will most likely misalign the stack.  It is recommended that
12327 libraries that use callbacks always use the default setting.
12329 This extra alignment does consume extra stack space, and generally
12330 increases code size.  Code that is sensitive to stack space usage, such
12331 as embedded systems and operating system kernels, may want to reduce the
12332 preferred alignment to @option{-mpreferred-stack-boundary=2}.
12334 @item -mmmx
12335 @itemx -mno-mmx
12336 @itemx -msse
12337 @itemx -mno-sse
12338 @itemx -msse2
12339 @itemx -mno-sse2
12340 @itemx -msse3
12341 @itemx -mno-sse3
12342 @itemx -mssse3
12343 @itemx -mno-ssse3
12344 @itemx -msse4.1
12345 @itemx -mno-sse4.1
12346 @itemx -msse4.2
12347 @itemx -mno-sse4.2
12348 @itemx -msse4
12349 @itemx -mno-sse4
12350 @itemx -mavx
12351 @itemx -mno-avx
12352 @itemx -maes
12353 @itemx -mno-aes
12354 @itemx -mpclmul
12355 @itemx -mno-pclmul
12356 @itemx -mfsgsbase
12357 @itemx -mno-fsgsbase
12358 @itemx -mrdrnd
12359 @itemx -mno-rdrnd
12360 @itemx -mf16c
12361 @itemx -mno-f16c
12362 @itemx -msse4a
12363 @itemx -mno-sse4a
12364 @itemx -mfma4
12365 @itemx -mno-fma4
12366 @itemx -mxop
12367 @itemx -mno-xop
12368 @itemx -mlwp
12369 @itemx -mno-lwp
12370 @itemx -m3dnow
12371 @itemx -mno-3dnow
12372 @itemx -mpopcnt
12373 @itemx -mno-popcnt
12374 @itemx -mabm
12375 @itemx -mno-abm
12376 @opindex mmmx
12377 @opindex mno-mmx
12378 @opindex msse
12379 @opindex mno-sse
12380 @opindex m3dnow
12381 @opindex mno-3dnow
12382 These switches enable or disable the use of instructions in the MMX,
12383 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, FSGSBASE, RDRND,
12384 F16C, SSE4A, FMA4, XOP, LWP, ABM or 3DNow!@: extended instruction sets.
12385 These extensions are also available as built-in functions: see
12386 @ref{X86 Built-in Functions}, for details of the functions enabled and
12387 disabled by these switches.
12389 To have SSE/SSE2 instructions generated automatically from floating-point
12390 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12392 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12393 generates new AVX instructions or AVX equivalence for all SSEx instructions
12394 when needed.
12396 These options will enable GCC to use these extended instructions in
12397 generated code, even without @option{-mfpmath=sse}.  Applications which
12398 perform runtime CPU detection must compile separate files for each
12399 supported architecture, using the appropriate flags.  In particular,
12400 the file containing the CPU detection code should be compiled without
12401 these options.
12403 @item -mfused-madd
12404 @itemx -mno-fused-madd
12405 @opindex mfused-madd
12406 @opindex mno-fused-madd
12407 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12408 instructions.  The default is to use these instructions.
12410 @item -mcld
12411 @opindex mcld
12412 This option instructs GCC to emit a @code{cld} instruction in the prologue
12413 of functions that use string instructions.  String instructions depend on
12414 the DF flag to select between autoincrement or autodecrement mode.  While the
12415 ABI specifies the DF flag to be cleared on function entry, some operating
12416 systems violate this specification by not clearing the DF flag in their
12417 exception dispatchers.  The exception handler can be invoked with the DF flag
12418 set which leads to wrong direction mode, when string instructions are used.
12419 This option can be enabled by default on 32-bit x86 targets by configuring
12420 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
12421 instructions can be suppressed with the @option{-mno-cld} compiler option
12422 in this case.
12424 @item -mcx16
12425 @opindex mcx16
12426 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12427 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12428 data types.  This is useful for high resolution counters that could be updated
12429 by multiple processors (or cores).  This instruction is generated as part of
12430 atomic built-in functions: see @ref{Atomic Builtins} for details.
12432 @item -msahf
12433 @opindex msahf
12434 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12435 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12436 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
12437 SAHF are load and store instructions, respectively, for certain status flags.
12438 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12439 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12441 @item -mmovbe
12442 @opindex mmovbe
12443 This option will enable GCC to use movbe instruction to implement
12444 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12446 @item -mcrc32
12447 @opindex mcrc32
12448 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12449 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12450 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12452 @item -mrecip
12453 @opindex mrecip
12454 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12455 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12456 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12457 variants) for single precision floating point arguments.  These instructions
12458 are generated only when @option{-funsafe-math-optimizations} is enabled
12459 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12460 Note that while the throughput of the sequence is higher than the throughput
12461 of the non-reciprocal instruction, the precision of the sequence can be
12462 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12464 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12465 already with @option{-ffast-math} (or the above option combination), and
12466 doesn't need @option{-mrecip}.
12468 @item -mveclibabi=@var{type}
12469 @opindex mveclibabi
12470 Specifies the ABI type to use for vectorizing intrinsics using an
12471 external library.  Supported types are @code{svml} for the Intel short
12472 vector math library and @code{acml} for the AMD math core library style
12473 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
12474 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12475 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12476 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12477 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12478 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12479 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12480 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12481 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12482 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12483 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12484 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12485 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12486 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12487 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12488 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12489 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12490 compatible library will have to be specified at link time.
12492 @item -mabi=@var{name}
12493 @opindex mabi
12494 Generate code for the specified calling convention.  Permissible values
12495 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12496 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
12497 ABI when targeting Windows.  On all other systems, the default is the
12498 SYSV ABI.  You can control this behavior for a specific function by
12499 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12500 @xref{Function Attributes}.
12502 @item -mpush-args
12503 @itemx -mno-push-args
12504 @opindex mpush-args
12505 @opindex mno-push-args
12506 Use PUSH operations to store outgoing parameters.  This method is shorter
12507 and usually equally fast as method using SUB/MOV operations and is enabled
12508 by default.  In some cases disabling it may improve performance because of
12509 improved scheduling and reduced dependencies.
12511 @item -maccumulate-outgoing-args
12512 @opindex maccumulate-outgoing-args
12513 If enabled, the maximum amount of space required for outgoing arguments will be
12514 computed in the function prologue.  This is faster on most modern CPUs
12515 because of reduced dependencies, improved scheduling and reduced stack usage
12516 when preferred stack boundary is not equal to 2.  The drawback is a notable
12517 increase in code size.  This switch implies @option{-mno-push-args}.
12519 @item -mthreads
12520 @opindex mthreads
12521 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
12522 on thread-safe exception handling must compile and link all code with the
12523 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
12524 @option{-D_MT}; when linking, it links in a special thread helper library
12525 @option{-lmingwthrd} which cleans up per thread exception handling data.
12527 @item -mno-align-stringops
12528 @opindex mno-align-stringops
12529 Do not align destination of inlined string operations.  This switch reduces
12530 code size and improves performance in case the destination is already aligned,
12531 but GCC doesn't know about it.
12533 @item -minline-all-stringops
12534 @opindex minline-all-stringops
12535 By default GCC inlines string operations only when destination is known to be
12536 aligned at least to 4 byte boundary.  This enables more inlining, increase code
12537 size, but may improve performance of code that depends on fast memcpy, strlen
12538 and memset for short lengths.
12540 @item -minline-stringops-dynamically
12541 @opindex minline-stringops-dynamically
12542 For string operation of unknown size, inline runtime checks so for small
12543 blocks inline code is used, while for large blocks library call is used.
12545 @item -mstringop-strategy=@var{alg}
12546 @opindex mstringop-strategy=@var{alg}
12547 Overwrite internal decision heuristic about particular algorithm to inline
12548 string operation with.  The allowed values are @code{rep_byte},
12549 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12550 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12551 expanding inline loop, @code{libcall} for always expanding library call.
12553 @item -momit-leaf-frame-pointer
12554 @opindex momit-leaf-frame-pointer
12555 Don't keep the frame pointer in a register for leaf functions.  This
12556 avoids the instructions to save, set up and restore frame pointers and
12557 makes an extra register available in leaf functions.  The option
12558 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12559 which might make debugging harder.
12561 @item -mtls-direct-seg-refs
12562 @itemx -mno-tls-direct-seg-refs
12563 @opindex mtls-direct-seg-refs
12564 Controls whether TLS variables may be accessed with offsets from the
12565 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12566 or whether the thread base pointer must be added.  Whether or not this
12567 is legal depends on the operating system, and whether it maps the
12568 segment to cover the entire TLS area.
12570 For systems that use GNU libc, the default is on.
12572 @item -msse2avx
12573 @itemx -mno-sse2avx
12574 @opindex msse2avx
12575 Specify that the assembler should encode SSE instructions with VEX
12576 prefix.  The option @option{-mavx} turns this on by default.
12578 @item -mfentry
12579 @itemx -mno-fentry
12580 @opindex mfentry
12581 If profiling is active @option{-pg} put the profiling
12582 counter call before prologue.
12583 Note: On x86 architectures the attribute @code{ms_hook_prologue}
12584 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
12585 @end table
12587 These @samp{-m} switches are supported in addition to the above
12588 on AMD x86-64 processors in 64-bit environments.
12590 @table @gcctabopt
12591 @item -m32
12592 @itemx -m64
12593 @opindex m32
12594 @opindex m64
12595 Generate code for a 32-bit or 64-bit environment.
12596 The 32-bit environment sets int, long and pointer to 32 bits and
12597 generates code that runs on any i386 system.
12598 The 64-bit environment sets int to 32 bits and long and pointer
12599 to 64 bits and generates code for AMD's x86-64 architecture. For
12600 darwin only the -m64 option turns off the @option{-fno-pic} and
12601 @option{-mdynamic-no-pic} options.
12603 @item -mno-red-zone
12604 @opindex mno-red-zone
12605 Do not use a so called red zone for x86-64 code.  The red zone is mandated
12606 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12607 stack pointer that will not be modified by signal or interrupt handlers
12608 and therefore can be used for temporary data without adjusting the stack
12609 pointer.  The flag @option{-mno-red-zone} disables this red zone.
12611 @item -mcmodel=small
12612 @opindex mcmodel=small
12613 Generate code for the small code model: the program and its symbols must
12614 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
12615 Programs can be statically or dynamically linked.  This is the default
12616 code model.
12618 @item -mcmodel=kernel
12619 @opindex mcmodel=kernel
12620 Generate code for the kernel code model.  The kernel runs in the
12621 negative 2 GB of the address space.
12622 This model has to be used for Linux kernel code.
12624 @item -mcmodel=medium
12625 @opindex mcmodel=medium
12626 Generate code for the medium model: The program is linked in the lower 2
12627 GB of the address space.  Small symbols are also placed there.  Symbols
12628 with sizes larger than @option{-mlarge-data-threshold} are put into
12629 large data or bss sections and can be located above 2GB.  Programs can
12630 be statically or dynamically linked.
12632 @item -mcmodel=large
12633 @opindex mcmodel=large
12634 Generate code for the large model: This model makes no assumptions
12635 about addresses and sizes of sections.
12636 @end table
12638 @node IA-64 Options
12639 @subsection IA-64 Options
12640 @cindex IA-64 Options
12642 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12644 @table @gcctabopt
12645 @item -mbig-endian
12646 @opindex mbig-endian
12647 Generate code for a big endian target.  This is the default for HP-UX@.
12649 @item -mlittle-endian
12650 @opindex mlittle-endian
12651 Generate code for a little endian target.  This is the default for AIX5
12652 and GNU/Linux.
12654 @item -mgnu-as
12655 @itemx -mno-gnu-as
12656 @opindex mgnu-as
12657 @opindex mno-gnu-as
12658 Generate (or don't) code for the GNU assembler.  This is the default.
12659 @c Also, this is the default if the configure option @option{--with-gnu-as}
12660 @c is used.
12662 @item -mgnu-ld
12663 @itemx -mno-gnu-ld
12664 @opindex mgnu-ld
12665 @opindex mno-gnu-ld
12666 Generate (or don't) code for the GNU linker.  This is the default.
12667 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12668 @c is used.
12670 @item -mno-pic
12671 @opindex mno-pic
12672 Generate code that does not use a global pointer register.  The result
12673 is not position independent code, and violates the IA-64 ABI@.
12675 @item -mvolatile-asm-stop
12676 @itemx -mno-volatile-asm-stop
12677 @opindex mvolatile-asm-stop
12678 @opindex mno-volatile-asm-stop
12679 Generate (or don't) a stop bit immediately before and after volatile asm
12680 statements.
12682 @item -mregister-names
12683 @itemx -mno-register-names
12684 @opindex mregister-names
12685 @opindex mno-register-names
12686 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12687 the stacked registers.  This may make assembler output more readable.
12689 @item -mno-sdata
12690 @itemx -msdata
12691 @opindex mno-sdata
12692 @opindex msdata
12693 Disable (or enable) optimizations that use the small data section.  This may
12694 be useful for working around optimizer bugs.
12696 @item -mconstant-gp
12697 @opindex mconstant-gp
12698 Generate code that uses a single constant global pointer value.  This is
12699 useful when compiling kernel code.
12701 @item -mauto-pic
12702 @opindex mauto-pic
12703 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
12704 This is useful when compiling firmware code.
12706 @item -minline-float-divide-min-latency
12707 @opindex minline-float-divide-min-latency
12708 Generate code for inline divides of floating point values
12709 using the minimum latency algorithm.
12711 @item -minline-float-divide-max-throughput
12712 @opindex minline-float-divide-max-throughput
12713 Generate code for inline divides of floating point values
12714 using the maximum throughput algorithm.
12716 @item -mno-inline-float-divide
12717 @opindex mno-inline-float-divide
12718 Do not generate inline code for divides of floating point values.
12720 @item -minline-int-divide-min-latency
12721 @opindex minline-int-divide-min-latency
12722 Generate code for inline divides of integer values
12723 using the minimum latency algorithm.
12725 @item -minline-int-divide-max-throughput
12726 @opindex minline-int-divide-max-throughput
12727 Generate code for inline divides of integer values
12728 using the maximum throughput algorithm.
12730 @item -mno-inline-int-divide
12731 @opindex mno-inline-int-divide
12732 Do not generate inline code for divides of integer values.
12734 @item -minline-sqrt-min-latency
12735 @opindex minline-sqrt-min-latency
12736 Generate code for inline square roots
12737 using the minimum latency algorithm.
12739 @item -minline-sqrt-max-throughput
12740 @opindex minline-sqrt-max-throughput
12741 Generate code for inline square roots
12742 using the maximum throughput algorithm.
12744 @item -mno-inline-sqrt
12745 @opindex mno-inline-sqrt
12746 Do not generate inline code for sqrt.
12748 @item -mfused-madd
12749 @itemx -mno-fused-madd
12750 @opindex mfused-madd
12751 @opindex mno-fused-madd
12752 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12753 instructions.  The default is to use these instructions.
12755 @item -mno-dwarf2-asm
12756 @itemx -mdwarf2-asm
12757 @opindex mno-dwarf2-asm
12758 @opindex mdwarf2-asm
12759 Don't (or do) generate assembler code for the DWARF2 line number debugging
12760 info.  This may be useful when not using the GNU assembler.
12762 @item -mearly-stop-bits
12763 @itemx -mno-early-stop-bits
12764 @opindex mearly-stop-bits
12765 @opindex mno-early-stop-bits
12766 Allow stop bits to be placed earlier than immediately preceding the
12767 instruction that triggered the stop bit.  This can improve instruction
12768 scheduling, but does not always do so.
12770 @item -mfixed-range=@var{register-range}
12771 @opindex mfixed-range
12772 Generate code treating the given register range as fixed registers.
12773 A fixed register is one that the register allocator can not use.  This is
12774 useful when compiling kernel code.  A register range is specified as
12775 two registers separated by a dash.  Multiple register ranges can be
12776 specified separated by a comma.
12778 @item -mtls-size=@var{tls-size}
12779 @opindex mtls-size
12780 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12783 @item -mtune=@var{cpu-type}
12784 @opindex mtune
12785 Tune the instruction scheduling for a particular CPU, Valid values are
12786 itanium, itanium1, merced, itanium2, and mckinley.
12788 @item -milp32
12789 @itemx -mlp64
12790 @opindex milp32
12791 @opindex mlp64
12792 Generate code for a 32-bit or 64-bit environment.
12793 The 32-bit environment sets int, long and pointer to 32 bits.
12794 The 64-bit environment sets int to 32 bits and long and pointer
12795 to 64 bits.  These are HP-UX specific flags.
12797 @item -mno-sched-br-data-spec
12798 @itemx -msched-br-data-spec
12799 @opindex mno-sched-br-data-spec
12800 @opindex msched-br-data-spec
12801 (Dis/En)able data speculative scheduling before reload.
12802 This will result in generation of the ld.a instructions and
12803 the corresponding check instructions (ld.c / chk.a).
12804 The default is 'disable'.
12806 @item -msched-ar-data-spec
12807 @itemx -mno-sched-ar-data-spec
12808 @opindex msched-ar-data-spec
12809 @opindex mno-sched-ar-data-spec
12810 (En/Dis)able data speculative scheduling after reload.
12811 This will result in generation of the ld.a instructions and
12812 the corresponding check instructions (ld.c / chk.a).
12813 The default is 'enable'.
12815 @item -mno-sched-control-spec
12816 @itemx -msched-control-spec
12817 @opindex mno-sched-control-spec
12818 @opindex msched-control-spec
12819 (Dis/En)able control speculative scheduling.  This feature is
12820 available only during region scheduling (i.e.@: before reload).
12821 This will result in generation of the ld.s instructions and
12822 the corresponding check instructions chk.s .
12823 The default is 'disable'.
12825 @item -msched-br-in-data-spec
12826 @itemx -mno-sched-br-in-data-spec
12827 @opindex msched-br-in-data-spec
12828 @opindex mno-sched-br-in-data-spec
12829 (En/Dis)able speculative scheduling of the instructions that
12830 are dependent on the data speculative loads before reload.
12831 This is effective only with @option{-msched-br-data-spec} enabled.
12832 The default is 'enable'.
12834 @item -msched-ar-in-data-spec
12835 @itemx -mno-sched-ar-in-data-spec
12836 @opindex msched-ar-in-data-spec
12837 @opindex mno-sched-ar-in-data-spec
12838 (En/Dis)able speculative scheduling of the instructions that
12839 are dependent on the data speculative loads after reload.
12840 This is effective only with @option{-msched-ar-data-spec} enabled.
12841 The default is 'enable'.
12843 @item -msched-in-control-spec
12844 @itemx -mno-sched-in-control-spec
12845 @opindex msched-in-control-spec
12846 @opindex mno-sched-in-control-spec
12847 (En/Dis)able speculative scheduling of the instructions that
12848 are dependent on the control speculative loads.
12849 This is effective only with @option{-msched-control-spec} enabled.
12850 The default is 'enable'.
12852 @item -mno-sched-prefer-non-data-spec-insns
12853 @itemx -msched-prefer-non-data-spec-insns
12854 @opindex mno-sched-prefer-non-data-spec-insns
12855 @opindex msched-prefer-non-data-spec-insns
12856 If enabled, data speculative instructions will be chosen for schedule
12857 only if there are no other choices at the moment.  This will make
12858 the use of the data speculation much more conservative.
12859 The default is 'disable'.
12861 @item -mno-sched-prefer-non-control-spec-insns
12862 @itemx -msched-prefer-non-control-spec-insns
12863 @opindex mno-sched-prefer-non-control-spec-insns
12864 @opindex msched-prefer-non-control-spec-insns
12865 If enabled, control speculative instructions will be chosen for schedule
12866 only if there are no other choices at the moment.  This will make
12867 the use of the control speculation much more conservative.
12868 The default is 'disable'.
12870 @item -mno-sched-count-spec-in-critical-path
12871 @itemx -msched-count-spec-in-critical-path
12872 @opindex mno-sched-count-spec-in-critical-path
12873 @opindex msched-count-spec-in-critical-path
12874 If enabled, speculative dependencies will be considered during
12875 computation of the instructions priorities.  This will make the use of the
12876 speculation a bit more conservative.
12877 The default is 'disable'.
12879 @item -msched-spec-ldc
12880 @opindex msched-spec-ldc
12881 Use a simple data speculation check.  This option is on by default.
12883 @item -msched-control-spec-ldc
12884 @opindex msched-spec-ldc
12885 Use a simple check for control speculation.  This option is on by default.
12887 @item -msched-stop-bits-after-every-cycle
12888 @opindex msched-stop-bits-after-every-cycle
12889 Place a stop bit after every cycle when scheduling.  This option is on
12890 by default.
12892 @item -msched-fp-mem-deps-zero-cost
12893 @opindex msched-fp-mem-deps-zero-cost
12894 Assume that floating-point stores and loads are not likely to cause a conflict
12895 when placed into the same instruction group.  This option is disabled by
12896 default.
12898 @item -msel-sched-dont-check-control-spec
12899 @opindex msel-sched-dont-check-control-spec
12900 Generate checks for control speculation in selective scheduling.
12901 This flag is disabled by default.
12903 @item -msched-max-memory-insns=@var{max-insns}
12904 @opindex msched-max-memory-insns
12905 Limit on the number of memory insns per instruction group, giving lower
12906 priority to subsequent memory insns attempting to schedule in the same
12907 instruction group. Frequently useful to prevent cache bank conflicts.
12908 The default value is 1.
12910 @item -msched-max-memory-insns-hard-limit
12911 @opindex msched-max-memory-insns-hard-limit
12912 Disallow more than `msched-max-memory-insns' in instruction group.
12913 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12914 when limit is reached but may still schedule memory operations.
12916 @end table
12918 @node IA-64/VMS Options
12919 @subsection IA-64/VMS Options
12921 These @samp{-m} options are defined for the IA-64/VMS implementations:
12923 @table @gcctabopt
12924 @item -mvms-return-codes
12925 @opindex mvms-return-codes
12926 Return VMS condition codes from main. The default is to return POSIX
12927 style condition (e.g.@ error) codes.
12929 @item -mdebug-main=@var{prefix}
12930 @opindex mdebug-main=@var{prefix}
12931 Flag the first routine whose name starts with @var{prefix} as the main
12932 routine for the debugger.
12934 @item -mmalloc64
12935 @opindex mmalloc64
12936 Default to 64bit memory allocation routines.
12937 @end table
12939 @node LM32 Options
12940 @subsection LM32 Options
12941 @cindex LM32 options
12943 These @option{-m} options are defined for the Lattice Mico32 architecture:
12945 @table @gcctabopt
12946 @item -mbarrel-shift-enabled
12947 @opindex mbarrel-shift-enabled
12948 Enable barrel-shift instructions.
12950 @item -mdivide-enabled
12951 @opindex mdivide-enabled
12952 Enable divide and modulus instructions.
12954 @item -mmultiply-enabled
12955 @opindex multiply-enabled
12956 Enable multiply instructions.
12958 @item -msign-extend-enabled
12959 @opindex msign-extend-enabled
12960 Enable sign extend instructions.
12962 @item -muser-enabled
12963 @opindex muser-enabled
12964 Enable user-defined instructions.
12966 @end table
12968 @node M32C Options
12969 @subsection M32C Options
12970 @cindex M32C options
12972 @table @gcctabopt
12973 @item -mcpu=@var{name}
12974 @opindex mcpu=
12975 Select the CPU for which code is generated.  @var{name} may be one of
12976 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
12977 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
12978 the M32C/80 series.
12980 @item -msim
12981 @opindex msim
12982 Specifies that the program will be run on the simulator.  This causes
12983 an alternate runtime library to be linked in which supports, for
12984 example, file I/O@.  You must not use this option when generating
12985 programs that will run on real hardware; you must provide your own
12986 runtime library for whatever I/O functions are needed.
12988 @item -memregs=@var{number}
12989 @opindex memregs=
12990 Specifies the number of memory-based pseudo-registers GCC will use
12991 during code generation.  These pseudo-registers will be used like real
12992 registers, so there is a tradeoff between GCC's ability to fit the
12993 code into available registers, and the performance penalty of using
12994 memory instead of registers.  Note that all modules in a program must
12995 be compiled with the same value for this option.  Because of that, you
12996 must not use this option with the default runtime libraries gcc
12997 builds.
12999 @end table
13001 @node M32R/D Options
13002 @subsection M32R/D Options
13003 @cindex M32R/D options
13005 These @option{-m} options are defined for Renesas M32R/D architectures:
13007 @table @gcctabopt
13008 @item -m32r2
13009 @opindex m32r2
13010 Generate code for the M32R/2@.
13012 @item -m32rx
13013 @opindex m32rx
13014 Generate code for the M32R/X@.
13016 @item -m32r
13017 @opindex m32r
13018 Generate code for the M32R@.  This is the default.
13020 @item -mmodel=small
13021 @opindex mmodel=small
13022 Assume all objects live in the lower 16MB of memory (so that their addresses
13023 can be loaded with the @code{ld24} instruction), and assume all subroutines
13024 are reachable with the @code{bl} instruction.
13025 This is the default.
13027 The addressability of a particular object can be set with the
13028 @code{model} attribute.
13030 @item -mmodel=medium
13031 @opindex mmodel=medium
13032 Assume objects may be anywhere in the 32-bit address space (the compiler
13033 will generate @code{seth/add3} instructions to load their addresses), and
13034 assume all subroutines are reachable with the @code{bl} instruction.
13036 @item -mmodel=large
13037 @opindex mmodel=large
13038 Assume objects may be anywhere in the 32-bit address space (the compiler
13039 will generate @code{seth/add3} instructions to load their addresses), and
13040 assume subroutines may not be reachable with the @code{bl} instruction
13041 (the compiler will generate the much slower @code{seth/add3/jl}
13042 instruction sequence).
13044 @item -msdata=none
13045 @opindex msdata=none
13046 Disable use of the small data area.  Variables will be put into
13047 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
13048 @code{section} attribute has been specified).
13049 This is the default.
13051 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
13052 Objects may be explicitly put in the small data area with the
13053 @code{section} attribute using one of these sections.
13055 @item -msdata=sdata
13056 @opindex msdata=sdata
13057 Put small global and static data in the small data area, but do not
13058 generate special code to reference them.
13060 @item -msdata=use
13061 @opindex msdata=use
13062 Put small global and static data in the small data area, and generate
13063 special instructions to reference them.
13065 @item -G @var{num}
13066 @opindex G
13067 @cindex smaller data references
13068 Put global and static objects less than or equal to @var{num} bytes
13069 into the small data or bss sections instead of the normal data or bss
13070 sections.  The default value of @var{num} is 8.
13071 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
13072 for this option to have any effect.
13074 All modules should be compiled with the same @option{-G @var{num}} value.
13075 Compiling with different values of @var{num} may or may not work; if it
13076 doesn't the linker will give an error message---incorrect code will not be
13077 generated.
13079 @item -mdebug
13080 @opindex mdebug
13081 Makes the M32R specific code in the compiler display some statistics
13082 that might help in debugging programs.
13084 @item -malign-loops
13085 @opindex malign-loops
13086 Align all loops to a 32-byte boundary.
13088 @item -mno-align-loops
13089 @opindex mno-align-loops
13090 Do not enforce a 32-byte alignment for loops.  This is the default.
13092 @item -missue-rate=@var{number}
13093 @opindex missue-rate=@var{number}
13094 Issue @var{number} instructions per cycle.  @var{number} can only be 1
13095 or 2.
13097 @item -mbranch-cost=@var{number}
13098 @opindex mbranch-cost=@var{number}
13099 @var{number} can only be 1 or 2.  If it is 1 then branches will be
13100 preferred over conditional code, if it is 2, then the opposite will
13101 apply.
13103 @item -mflush-trap=@var{number}
13104 @opindex mflush-trap=@var{number}
13105 Specifies the trap number to use to flush the cache.  The default is
13106 12.  Valid numbers are between 0 and 15 inclusive.
13108 @item -mno-flush-trap
13109 @opindex mno-flush-trap
13110 Specifies that the cache cannot be flushed by using a trap.
13112 @item -mflush-func=@var{name}
13113 @opindex mflush-func=@var{name}
13114 Specifies the name of the operating system function to call to flush
13115 the cache.  The default is @emph{_flush_cache}, but a function call
13116 will only be used if a trap is not available.
13118 @item -mno-flush-func
13119 @opindex mno-flush-func
13120 Indicates that there is no OS function for flushing the cache.
13122 @end table
13124 @node M680x0 Options
13125 @subsection M680x0 Options
13126 @cindex M680x0 options
13128 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
13129 The default settings depend on which architecture was selected when
13130 the compiler was configured; the defaults for the most common choices
13131 are given below.
13133 @table @gcctabopt
13134 @item -march=@var{arch}
13135 @opindex march
13136 Generate code for a specific M680x0 or ColdFire instruction set
13137 architecture.  Permissible values of @var{arch} for M680x0
13138 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
13139 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
13140 architectures are selected according to Freescale's ISA classification
13141 and the permissible values are: @samp{isaa}, @samp{isaaplus},
13142 @samp{isab} and @samp{isac}.
13144 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
13145 code for a ColdFire target.  The @var{arch} in this macro is one of the
13146 @option{-march} arguments given above.
13148 When used together, @option{-march} and @option{-mtune} select code
13149 that runs on a family of similar processors but that is optimized
13150 for a particular microarchitecture.
13152 @item -mcpu=@var{cpu}
13153 @opindex mcpu
13154 Generate code for a specific M680x0 or ColdFire processor.
13155 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
13156 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
13157 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
13158 below, which also classifies the CPUs into families:
13160 @multitable @columnfractions 0.20 0.80
13161 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
13162 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
13163 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
13164 @item @samp{5206e} @tab @samp{5206e}
13165 @item @samp{5208} @tab @samp{5207} @samp{5208}
13166 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
13167 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
13168 @item @samp{5216} @tab @samp{5214} @samp{5216}
13169 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
13170 @item @samp{5225} @tab @samp{5224} @samp{5225}
13171 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
13172 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
13173 @item @samp{5249} @tab @samp{5249}
13174 @item @samp{5250} @tab @samp{5250}
13175 @item @samp{5271} @tab @samp{5270} @samp{5271}
13176 @item @samp{5272} @tab @samp{5272}
13177 @item @samp{5275} @tab @samp{5274} @samp{5275}
13178 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
13179 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
13180 @item @samp{5307} @tab @samp{5307}
13181 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
13182 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
13183 @item @samp{5407} @tab @samp{5407}
13184 @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}
13185 @end multitable
13187 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
13188 @var{arch} is compatible with @var{cpu}.  Other combinations of
13189 @option{-mcpu} and @option{-march} are rejected.
13191 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
13192 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
13193 where the value of @var{family} is given by the table above.
13195 @item -mtune=@var{tune}
13196 @opindex mtune
13197 Tune the code for a particular microarchitecture, within the
13198 constraints set by @option{-march} and @option{-mcpu}.
13199 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
13200 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
13201 and @samp{cpu32}.  The ColdFire microarchitectures
13202 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
13204 You can also use @option{-mtune=68020-40} for code that needs
13205 to run relatively well on 68020, 68030 and 68040 targets.
13206 @option{-mtune=68020-60} is similar but includes 68060 targets
13207 as well.  These two options select the same tuning decisions as
13208 @option{-m68020-40} and @option{-m68020-60} respectively.
13210 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
13211 when tuning for 680x0 architecture @var{arch}.  It also defines
13212 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
13213 option is used.  If gcc is tuning for a range of architectures,
13214 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
13215 it defines the macros for every architecture in the range.
13217 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
13218 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
13219 of the arguments given above.
13221 @item -m68000
13222 @itemx -mc68000
13223 @opindex m68000
13224 @opindex mc68000
13225 Generate output for a 68000.  This is the default
13226 when the compiler is configured for 68000-based systems.
13227 It is equivalent to @option{-march=68000}.
13229 Use this option for microcontrollers with a 68000 or EC000 core,
13230 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
13232 @item -m68010
13233 @opindex m68010
13234 Generate output for a 68010.  This is the default
13235 when the compiler is configured for 68010-based systems.
13236 It is equivalent to @option{-march=68010}.
13238 @item -m68020
13239 @itemx -mc68020
13240 @opindex m68020
13241 @opindex mc68020
13242 Generate output for a 68020.  This is the default
13243 when the compiler is configured for 68020-based systems.
13244 It is equivalent to @option{-march=68020}.
13246 @item -m68030
13247 @opindex m68030
13248 Generate output for a 68030.  This is the default when the compiler is
13249 configured for 68030-based systems.  It is equivalent to
13250 @option{-march=68030}.
13252 @item -m68040
13253 @opindex m68040
13254 Generate output for a 68040.  This is the default when the compiler is
13255 configured for 68040-based systems.  It is equivalent to
13256 @option{-march=68040}.
13258 This option inhibits the use of 68881/68882 instructions that have to be
13259 emulated by software on the 68040.  Use this option if your 68040 does not
13260 have code to emulate those instructions.
13262 @item -m68060
13263 @opindex m68060
13264 Generate output for a 68060.  This is the default when the compiler is
13265 configured for 68060-based systems.  It is equivalent to
13266 @option{-march=68060}.
13268 This option inhibits the use of 68020 and 68881/68882 instructions that
13269 have to be emulated by software on the 68060.  Use this option if your 68060
13270 does not have code to emulate those instructions.
13272 @item -mcpu32
13273 @opindex mcpu32
13274 Generate output for a CPU32.  This is the default
13275 when the compiler is configured for CPU32-based systems.
13276 It is equivalent to @option{-march=cpu32}.
13278 Use this option for microcontrollers with a
13279 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
13280 68336, 68340, 68341, 68349 and 68360.
13282 @item -m5200
13283 @opindex m5200
13284 Generate output for a 520X ColdFire CPU@.  This is the default
13285 when the compiler is configured for 520X-based systems.
13286 It is equivalent to @option{-mcpu=5206}, and is now deprecated
13287 in favor of that option.
13289 Use this option for microcontroller with a 5200 core, including
13290 the MCF5202, MCF5203, MCF5204 and MCF5206.
13292 @item -m5206e
13293 @opindex m5206e
13294 Generate output for a 5206e ColdFire CPU@.  The option is now
13295 deprecated in favor of the equivalent @option{-mcpu=5206e}.
13297 @item -m528x
13298 @opindex m528x
13299 Generate output for a member of the ColdFire 528X family.
13300 The option is now deprecated in favor of the equivalent
13301 @option{-mcpu=528x}.
13303 @item -m5307
13304 @opindex m5307
13305 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
13306 in favor of the equivalent @option{-mcpu=5307}.
13308 @item -m5407
13309 @opindex m5407
13310 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
13311 in favor of the equivalent @option{-mcpu=5407}.
13313 @item -mcfv4e
13314 @opindex mcfv4e
13315 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
13316 This includes use of hardware floating point instructions.
13317 The option is equivalent to @option{-mcpu=547x}, and is now
13318 deprecated in favor of that option.
13320 @item -m68020-40
13321 @opindex m68020-40
13322 Generate output for a 68040, without using any of the new instructions.
13323 This results in code which can run relatively efficiently on either a
13324 68020/68881 or a 68030 or a 68040.  The generated code does use the
13325 68881 instructions that are emulated on the 68040.
13327 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
13329 @item -m68020-60
13330 @opindex m68020-60
13331 Generate output for a 68060, without using any of the new instructions.
13332 This results in code which can run relatively efficiently on either a
13333 68020/68881 or a 68030 or a 68040.  The generated code does use the
13334 68881 instructions that are emulated on the 68060.
13336 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
13338 @item -mhard-float
13339 @itemx -m68881
13340 @opindex mhard-float
13341 @opindex m68881
13342 Generate floating-point instructions.  This is the default for 68020
13343 and above, and for ColdFire devices that have an FPU@.  It defines the
13344 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
13345 on ColdFire targets.
13347 @item -msoft-float
13348 @opindex msoft-float
13349 Do not generate floating-point instructions; use library calls instead.
13350 This is the default for 68000, 68010, and 68832 targets.  It is also
13351 the default for ColdFire devices that have no FPU.
13353 @item -mdiv
13354 @itemx -mno-div
13355 @opindex mdiv
13356 @opindex mno-div
13357 Generate (do not generate) ColdFire hardware divide and remainder
13358 instructions.  If @option{-march} is used without @option{-mcpu},
13359 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
13360 architectures.  Otherwise, the default is taken from the target CPU
13361 (either the default CPU, or the one specified by @option{-mcpu}).  For
13362 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
13363 @option{-mcpu=5206e}.
13365 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
13367 @item -mshort
13368 @opindex mshort
13369 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13370 Additionally, parameters passed on the stack are also aligned to a
13371 16-bit boundary even on targets whose API mandates promotion to 32-bit.
13373 @item -mno-short
13374 @opindex mno-short
13375 Do not consider type @code{int} to be 16 bits wide.  This is the default.
13377 @item -mnobitfield
13378 @itemx -mno-bitfield
13379 @opindex mnobitfield
13380 @opindex mno-bitfield
13381 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
13382 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
13384 @item -mbitfield
13385 @opindex mbitfield
13386 Do use the bit-field instructions.  The @option{-m68020} option implies
13387 @option{-mbitfield}.  This is the default if you use a configuration
13388 designed for a 68020.
13390 @item -mrtd
13391 @opindex mrtd
13392 Use a different function-calling convention, in which functions
13393 that take a fixed number of arguments return with the @code{rtd}
13394 instruction, which pops their arguments while returning.  This
13395 saves one instruction in the caller since there is no need to pop
13396 the arguments there.
13398 This calling convention is incompatible with the one normally
13399 used on Unix, so you cannot use it if you need to call libraries
13400 compiled with the Unix compiler.
13402 Also, you must provide function prototypes for all functions that
13403 take variable numbers of arguments (including @code{printf});
13404 otherwise incorrect code will be generated for calls to those
13405 functions.
13407 In addition, seriously incorrect code will result if you call a
13408 function with too many arguments.  (Normally, extra arguments are
13409 harmlessly ignored.)
13411 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13412 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13414 @item -mno-rtd
13415 @opindex mno-rtd
13416 Do not use the calling conventions selected by @option{-mrtd}.
13417 This is the default.
13419 @item -malign-int
13420 @itemx -mno-align-int
13421 @opindex malign-int
13422 @opindex mno-align-int
13423 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13424 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13425 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13426 Aligning variables on 32-bit boundaries produces code that runs somewhat
13427 faster on processors with 32-bit busses at the expense of more memory.
13429 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13430 align structures containing the above types  differently than
13431 most published application binary interface specifications for the m68k.
13433 @item -mpcrel
13434 @opindex mpcrel
13435 Use the pc-relative addressing mode of the 68000 directly, instead of
13436 using a global offset table.  At present, this option implies @option{-fpic},
13437 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
13438 not presently supported with @option{-mpcrel}, though this could be supported for
13439 68020 and higher processors.
13441 @item -mno-strict-align
13442 @itemx -mstrict-align
13443 @opindex mno-strict-align
13444 @opindex mstrict-align
13445 Do not (do) assume that unaligned memory references will be handled by
13446 the system.
13448 @item -msep-data
13449 Generate code that allows the data segment to be located in a different
13450 area of memory from the text segment.  This allows for execute in place in
13451 an environment without virtual memory management.  This option implies
13452 @option{-fPIC}.
13454 @item -mno-sep-data
13455 Generate code that assumes that the data segment follows the text segment.
13456 This is the default.
13458 @item -mid-shared-library
13459 Generate code that supports shared libraries via the library ID method.
13460 This allows for execute in place and shared libraries in an environment
13461 without virtual memory management.  This option implies @option{-fPIC}.
13463 @item -mno-id-shared-library
13464 Generate code that doesn't assume ID based shared libraries are being used.
13465 This is the default.
13467 @item -mshared-library-id=n
13468 Specified the identification number of the ID based shared library being
13469 compiled.  Specifying a value of 0 will generate more compact code, specifying
13470 other values will force the allocation of that number to the current
13471 library but is no more space or time efficient than omitting this option.
13473 @item -mxgot
13474 @itemx -mno-xgot
13475 @opindex mxgot
13476 @opindex mno-xgot
13477 When generating position-independent code for ColdFire, generate code
13478 that works if the GOT has more than 8192 entries.  This code is
13479 larger and slower than code generated without this option.  On M680x0
13480 processors, this option is not needed; @option{-fPIC} suffices.
13482 GCC normally uses a single instruction to load values from the GOT@.
13483 While this is relatively efficient, it only works if the GOT
13484 is smaller than about 64k.  Anything larger causes the linker
13485 to report an error such as:
13487 @cindex relocation truncated to fit (ColdFire)
13488 @smallexample
13489 relocation truncated to fit: R_68K_GOT16O foobar
13490 @end smallexample
13492 If this happens, you should recompile your code with @option{-mxgot}.
13493 It should then work with very large GOTs.  However, code generated with
13494 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13495 the value of a global symbol.
13497 Note that some linkers, including newer versions of the GNU linker,
13498 can create multiple GOTs and sort GOT entries.  If you have such a linker,
13499 you should only need to use @option{-mxgot} when compiling a single
13500 object file that accesses more than 8192 GOT entries.  Very few do.
13502 These options have no effect unless GCC is generating
13503 position-independent code.
13505 @end table
13507 @node M68hc1x Options
13508 @subsection M68hc1x Options
13509 @cindex M68hc1x options
13511 These are the @samp{-m} options defined for the 68hc11 and 68hc12
13512 microcontrollers.  The default values for these options depends on
13513 which style of microcontroller was selected when the compiler was configured;
13514 the defaults for the most common choices are given below.
13516 @table @gcctabopt
13517 @item -m6811
13518 @itemx -m68hc11
13519 @opindex m6811
13520 @opindex m68hc11
13521 Generate output for a 68HC11.  This is the default
13522 when the compiler is configured for 68HC11-based systems.
13524 @item -m6812
13525 @itemx -m68hc12
13526 @opindex m6812
13527 @opindex m68hc12
13528 Generate output for a 68HC12.  This is the default
13529 when the compiler is configured for 68HC12-based systems.
13531 @item -m68S12
13532 @itemx -m68hcs12
13533 @opindex m68S12
13534 @opindex m68hcs12
13535 Generate output for a 68HCS12.
13537 @item -mauto-incdec
13538 @opindex mauto-incdec
13539 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
13540 addressing modes.
13542 @item -minmax
13543 @itemx -mnominmax
13544 @opindex minmax
13545 @opindex mnominmax
13546 Enable the use of 68HC12 min and max instructions.
13548 @item -mlong-calls
13549 @itemx -mno-long-calls
13550 @opindex mlong-calls
13551 @opindex mno-long-calls
13552 Treat all calls as being far away (near).  If calls are assumed to be
13553 far away, the compiler will use the @code{call} instruction to
13554 call a function and the @code{rtc} instruction for returning.
13556 @item -mshort
13557 @opindex mshort
13558 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13560 @item -msoft-reg-count=@var{count}
13561 @opindex msoft-reg-count
13562 Specify the number of pseudo-soft registers which are used for the
13563 code generation.  The maximum number is 32.  Using more pseudo-soft
13564 register may or may not result in better code depending on the program.
13565 The default is 4 for 68HC11 and 2 for 68HC12.
13567 @end table
13569 @node MCore Options
13570 @subsection MCore Options
13571 @cindex MCore options
13573 These are the @samp{-m} options defined for the Motorola M*Core
13574 processors.
13576 @table @gcctabopt
13578 @item -mhardlit
13579 @itemx -mno-hardlit
13580 @opindex mhardlit
13581 @opindex mno-hardlit
13582 Inline constants into the code stream if it can be done in two
13583 instructions or less.
13585 @item -mdiv
13586 @itemx -mno-div
13587 @opindex mdiv
13588 @opindex mno-div
13589 Use the divide instruction.  (Enabled by default).
13591 @item -mrelax-immediate
13592 @itemx -mno-relax-immediate
13593 @opindex mrelax-immediate
13594 @opindex mno-relax-immediate
13595 Allow arbitrary sized immediates in bit operations.
13597 @item -mwide-bitfields
13598 @itemx -mno-wide-bitfields
13599 @opindex mwide-bitfields
13600 @opindex mno-wide-bitfields
13601 Always treat bit-fields as int-sized.
13603 @item -m4byte-functions
13604 @itemx -mno-4byte-functions
13605 @opindex m4byte-functions
13606 @opindex mno-4byte-functions
13607 Force all functions to be aligned to a four byte boundary.
13609 @item -mcallgraph-data
13610 @itemx -mno-callgraph-data
13611 @opindex mcallgraph-data
13612 @opindex mno-callgraph-data
13613 Emit callgraph information.
13615 @item -mslow-bytes
13616 @itemx -mno-slow-bytes
13617 @opindex mslow-bytes
13618 @opindex mno-slow-bytes
13619 Prefer word access when reading byte quantities.
13621 @item -mlittle-endian
13622 @itemx -mbig-endian
13623 @opindex mlittle-endian
13624 @opindex mbig-endian
13625 Generate code for a little endian target.
13627 @item -m210
13628 @itemx -m340
13629 @opindex m210
13630 @opindex m340
13631 Generate code for the 210 processor.
13633 @item -mno-lsim
13634 @opindex mno-lsim
13635 Assume that run-time support has been provided and so omit the
13636 simulator library (@file{libsim.a)} from the linker command line.
13638 @item -mstack-increment=@var{size}
13639 @opindex mstack-increment
13640 Set the maximum amount for a single stack increment operation.  Large
13641 values can increase the speed of programs which contain functions
13642 that need a large amount of stack space, but they can also trigger a
13643 segmentation fault if the stack is extended too much.  The default
13644 value is 0x1000.
13646 @end table
13648 @node MeP Options
13649 @subsection MeP Options
13650 @cindex MeP options
13652 @table @gcctabopt
13654 @item -mabsdiff
13655 @opindex mabsdiff
13656 Enables the @code{abs} instruction, which is the absolute difference
13657 between two registers.
13659 @item -mall-opts
13660 @opindex mall-opts
13661 Enables all the optional instructions - average, multiply, divide, bit
13662 operations, leading zero, absolute difference, min/max, clip, and
13663 saturation.
13666 @item -maverage
13667 @opindex maverage
13668 Enables the @code{ave} instruction, which computes the average of two
13669 registers.
13671 @item -mbased=@var{n}
13672 @opindex mbased=
13673 Variables of size @var{n} bytes or smaller will be placed in the
13674 @code{.based} section by default.  Based variables use the @code{$tp}
13675 register as a base register, and there is a 128 byte limit to the
13676 @code{.based} section.
13678 @item -mbitops
13679 @opindex mbitops
13680 Enables the bit operation instructions - bit test (@code{btstm}), set
13681 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13682 test-and-set (@code{tas}).
13684 @item -mc=@var{name}
13685 @opindex mc=
13686 Selects which section constant data will be placed in.  @var{name} may
13687 be @code{tiny}, @code{near}, or @code{far}.
13689 @item -mclip
13690 @opindex mclip
13691 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13692 useful unless you also provide @code{-mminmax}.
13694 @item -mconfig=@var{name}
13695 @opindex mconfig=
13696 Selects one of the build-in core configurations.  Each MeP chip has
13697 one or more modules in it; each module has a core CPU and a variety of
13698 coprocessors, optional instructions, and peripherals.  The
13699 @code{MeP-Integrator} tool, not part of GCC, provides these
13700 configurations through this option; using this option is the same as
13701 using all the corresponding command line options.  The default
13702 configuration is @code{default}.
13704 @item -mcop
13705 @opindex mcop
13706 Enables the coprocessor instructions.  By default, this is a 32-bit
13707 coprocessor.  Note that the coprocessor is normally enabled via the
13708 @code{-mconfig=} option.
13710 @item -mcop32
13711 @opindex mcop32
13712 Enables the 32-bit coprocessor's instructions.
13714 @item -mcop64
13715 @opindex mcop64
13716 Enables the 64-bit coprocessor's instructions.
13718 @item -mivc2
13719 @opindex mivc2
13720 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13722 @item -mdc
13723 @opindex mdc
13724 Causes constant variables to be placed in the @code{.near} section.
13726 @item -mdiv
13727 @opindex mdiv
13728 Enables the @code{div} and @code{divu} instructions.
13730 @item -meb
13731 @opindex meb
13732 Generate big-endian code.
13734 @item -mel
13735 @opindex mel
13736 Generate little-endian code.
13738 @item -mio-volatile
13739 @opindex mio-volatile
13740 Tells the compiler that any variable marked with the @code{io}
13741 attribute is to be considered volatile.
13743 @item -ml
13744 @opindex ml
13745 Causes variables to be assigned to the @code{.far} section by default.
13747 @item -mleadz
13748 @opindex mleadz
13749 Enables the @code{leadz} (leading zero) instruction.
13751 @item -mm
13752 @opindex mm
13753 Causes variables to be assigned to the @code{.near} section by default.
13755 @item -mminmax
13756 @opindex mminmax
13757 Enables the @code{min} and @code{max} instructions.
13759 @item -mmult
13760 @opindex mmult
13761 Enables the multiplication and multiply-accumulate instructions.
13763 @item -mno-opts
13764 @opindex mno-opts
13765 Disables all the optional instructions enabled by @code{-mall-opts}.
13767 @item -mrepeat
13768 @opindex mrepeat
13769 Enables the @code{repeat} and @code{erepeat} instructions, used for
13770 low-overhead looping.
13772 @item -ms
13773 @opindex ms
13774 Causes all variables to default to the @code{.tiny} section.  Note
13775 that there is a 65536 byte limit to this section.  Accesses to these
13776 variables use the @code{%gp} base register.
13778 @item -msatur
13779 @opindex msatur
13780 Enables the saturation instructions.  Note that the compiler does not
13781 currently generate these itself, but this option is included for
13782 compatibility with other tools, like @code{as}.
13784 @item -msdram
13785 @opindex msdram
13786 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13788 @item -msim
13789 @opindex msim
13790 Link the simulator runtime libraries.
13792 @item -msimnovec
13793 @opindex msimnovec
13794 Link the simulator runtime libraries, excluding built-in support
13795 for reset and exception vectors and tables.
13797 @item -mtf
13798 @opindex mtf
13799 Causes all functions to default to the @code{.far} section.  Without
13800 this option, functions default to the @code{.near} section.
13802 @item -mtiny=@var{n}
13803 @opindex mtiny=
13804 Variables that are @var{n} bytes or smaller will be allocated to the
13805 @code{.tiny} section.  These variables use the @code{$gp} base
13806 register.  The default for this option is 4, but note that there's a
13807 65536 byte limit to the @code{.tiny} section.
13809 @end table
13811 @node MIPS Options
13812 @subsection MIPS Options
13813 @cindex MIPS options
13815 @table @gcctabopt
13817 @item -EB
13818 @opindex EB
13819 Generate big-endian code.
13821 @item -EL
13822 @opindex EL
13823 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13824 configurations.
13826 @item -march=@var{arch}
13827 @opindex march
13828 Generate code that will run on @var{arch}, which can be the name of a
13829 generic MIPS ISA, or the name of a particular processor.
13830 The ISA names are:
13831 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13832 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13833 The processor names are:
13834 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13835 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13836 @samp{5kc}, @samp{5kf},
13837 @samp{20kc},
13838 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13839 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13840 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13841 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13842 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
13843 @samp{loongson2e}, @samp{loongson2f},
13844 @samp{m4k},
13845 @samp{octeon},
13846 @samp{orion},
13847 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
13848 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
13849 @samp{rm7000}, @samp{rm9000},
13850 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
13851 @samp{sb1},
13852 @samp{sr71000},
13853 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
13854 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
13855 and @samp{xlr}.
13856 The special value @samp{from-abi} selects the
13857 most compatible architecture for the selected ABI (that is,
13858 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
13860 Native Linux/GNU toolchains also support the value @samp{native},
13861 which selects the best architecture option for the host processor.
13862 @option{-march=native} has no effect if GCC does not recognize
13863 the processor.
13865 In processor names, a final @samp{000} can be abbreviated as @samp{k}
13866 (for example, @samp{-march=r2k}).  Prefixes are optional, and
13867 @samp{vr} may be written @samp{r}.
13869 Names of the form @samp{@var{n}f2_1} refer to processors with
13870 FPUs clocked at half the rate of the core, names of the form
13871 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
13872 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
13873 processors with FPUs clocked a ratio of 3:2 with respect to the core.
13874 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
13875 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
13876 accepted as synonyms for @samp{@var{n}f1_1}.
13878 GCC defines two macros based on the value of this option.  The first
13879 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
13880 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
13881 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
13882 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
13883 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
13885 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
13886 above.  In other words, it will have the full prefix and will not
13887 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
13888 the macro names the resolved architecture (either @samp{"mips1"} or
13889 @samp{"mips3"}).  It names the default architecture when no
13890 @option{-march} option is given.
13892 @item -mtune=@var{arch}
13893 @opindex mtune
13894 Optimize for @var{arch}.  Among other things, this option controls
13895 the way instructions are scheduled, and the perceived cost of arithmetic
13896 operations.  The list of @var{arch} values is the same as for
13897 @option{-march}.
13899 When this option is not used, GCC will optimize for the processor
13900 specified by @option{-march}.  By using @option{-march} and
13901 @option{-mtune} together, it is possible to generate code that will
13902 run on a family of processors, but optimize the code for one
13903 particular member of that family.
13905 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
13906 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
13907 @samp{-march} ones described above.
13909 @item -mips1
13910 @opindex mips1
13911 Equivalent to @samp{-march=mips1}.
13913 @item -mips2
13914 @opindex mips2
13915 Equivalent to @samp{-march=mips2}.
13917 @item -mips3
13918 @opindex mips3
13919 Equivalent to @samp{-march=mips3}.
13921 @item -mips4
13922 @opindex mips4
13923 Equivalent to @samp{-march=mips4}.
13925 @item -mips32
13926 @opindex mips32
13927 Equivalent to @samp{-march=mips32}.
13929 @item -mips32r2
13930 @opindex mips32r2
13931 Equivalent to @samp{-march=mips32r2}.
13933 @item -mips64
13934 @opindex mips64
13935 Equivalent to @samp{-march=mips64}.
13937 @item -mips64r2
13938 @opindex mips64r2
13939 Equivalent to @samp{-march=mips64r2}.
13941 @item -mips16
13942 @itemx -mno-mips16
13943 @opindex mips16
13944 @opindex mno-mips16
13945 Generate (do not generate) MIPS16 code.  If GCC is targetting a
13946 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
13948 MIPS16 code generation can also be controlled on a per-function basis
13949 by means of @code{mips16} and @code{nomips16} attributes.
13950 @xref{Function Attributes}, for more information.
13952 @item -mflip-mips16
13953 @opindex mflip-mips16
13954 Generate MIPS16 code on alternating functions.  This option is provided
13955 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
13956 not intended for ordinary use in compiling user code.
13958 @item -minterlink-mips16
13959 @itemx -mno-interlink-mips16
13960 @opindex minterlink-mips16
13961 @opindex mno-interlink-mips16
13962 Require (do not require) that non-MIPS16 code be link-compatible with
13963 MIPS16 code.
13965 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
13966 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
13967 therefore disables direct jumps unless GCC knows that the target of the
13968 jump is not MIPS16.
13970 @item -mabi=32
13971 @itemx -mabi=o64
13972 @itemx -mabi=n32
13973 @itemx -mabi=64
13974 @itemx -mabi=eabi
13975 @opindex mabi=32
13976 @opindex mabi=o64
13977 @opindex mabi=n32
13978 @opindex mabi=64
13979 @opindex mabi=eabi
13980 Generate code for the given ABI@.
13982 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
13983 generates 64-bit code when you select a 64-bit architecture, but you
13984 can use @option{-mgp32} to get 32-bit code instead.
13986 For information about the O64 ABI, see
13987 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
13989 GCC supports a variant of the o32 ABI in which floating-point registers
13990 are 64 rather than 32 bits wide.  You can select this combination with
13991 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
13992 and @samp{mfhc1} instructions and is therefore only supported for
13993 MIPS32R2 processors.
13995 The register assignments for arguments and return values remain the
13996 same, but each scalar value is passed in a single 64-bit register
13997 rather than a pair of 32-bit registers.  For example, scalar
13998 floating-point values are returned in @samp{$f0} only, not a
13999 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
14000 remains the same, but all 64 bits are saved.
14002 @item -mabicalls
14003 @itemx -mno-abicalls
14004 @opindex mabicalls
14005 @opindex mno-abicalls
14006 Generate (do not generate) code that is suitable for SVR4-style
14007 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
14008 systems.
14010 @item -mshared
14011 @itemx -mno-shared
14012 Generate (do not generate) code that is fully position-independent,
14013 and that can therefore be linked into shared libraries.  This option
14014 only affects @option{-mabicalls}.
14016 All @option{-mabicalls} code has traditionally been position-independent,
14017 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
14018 as an extension, the GNU toolchain allows executables to use absolute
14019 accesses for locally-binding symbols.  It can also use shorter GP
14020 initialization sequences and generate direct calls to locally-defined
14021 functions.  This mode is selected by @option{-mno-shared}.
14023 @option{-mno-shared} depends on binutils 2.16 or higher and generates
14024 objects that can only be linked by the GNU linker.  However, the option
14025 does not affect the ABI of the final executable; it only affects the ABI
14026 of relocatable objects.  Using @option{-mno-shared} will generally make
14027 executables both smaller and quicker.
14029 @option{-mshared} is the default.
14031 @item -mplt
14032 @itemx -mno-plt
14033 @opindex mplt
14034 @opindex mno-plt
14035 Assume (do not assume) that the static and dynamic linkers
14036 support PLTs and copy relocations.  This option only affects
14037 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
14038 has no effect without @samp{-msym32}.
14040 You can make @option{-mplt} the default by configuring
14041 GCC with @option{--with-mips-plt}.  The default is
14042 @option{-mno-plt} otherwise.
14044 @item -mxgot
14045 @itemx -mno-xgot
14046 @opindex mxgot
14047 @opindex mno-xgot
14048 Lift (do not lift) the usual restrictions on the size of the global
14049 offset table.
14051 GCC normally uses a single instruction to load values from the GOT@.
14052 While this is relatively efficient, it will only work if the GOT
14053 is smaller than about 64k.  Anything larger will cause the linker
14054 to report an error such as:
14056 @cindex relocation truncated to fit (MIPS)
14057 @smallexample
14058 relocation truncated to fit: R_MIPS_GOT16 foobar
14059 @end smallexample
14061 If this happens, you should recompile your code with @option{-mxgot}.
14062 It should then work with very large GOTs, although it will also be
14063 less efficient, since it will take three instructions to fetch the
14064 value of a global symbol.
14066 Note that some linkers can create multiple GOTs.  If you have such a
14067 linker, you should only need to use @option{-mxgot} when a single object
14068 file accesses more than 64k's worth of GOT entries.  Very few do.
14070 These options have no effect unless GCC is generating position
14071 independent code.
14073 @item -mgp32
14074 @opindex mgp32
14075 Assume that general-purpose registers are 32 bits wide.
14077 @item -mgp64
14078 @opindex mgp64
14079 Assume that general-purpose registers are 64 bits wide.
14081 @item -mfp32
14082 @opindex mfp32
14083 Assume that floating-point registers are 32 bits wide.
14085 @item -mfp64
14086 @opindex mfp64
14087 Assume that floating-point registers are 64 bits wide.
14089 @item -mhard-float
14090 @opindex mhard-float
14091 Use floating-point coprocessor instructions.
14093 @item -msoft-float
14094 @opindex msoft-float
14095 Do not use floating-point coprocessor instructions.  Implement
14096 floating-point calculations using library calls instead.
14098 @item -msingle-float
14099 @opindex msingle-float
14100 Assume that the floating-point coprocessor only supports single-precision
14101 operations.
14103 @item -mdouble-float
14104 @opindex mdouble-float
14105 Assume that the floating-point coprocessor supports double-precision
14106 operations.  This is the default.
14108 @item -mllsc
14109 @itemx -mno-llsc
14110 @opindex mllsc
14111 @opindex mno-llsc
14112 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
14113 implement atomic memory built-in functions.  When neither option is
14114 specified, GCC will use the instructions if the target architecture
14115 supports them.
14117 @option{-mllsc} is useful if the runtime environment can emulate the
14118 instructions and @option{-mno-llsc} can be useful when compiling for
14119 nonstandard ISAs.  You can make either option the default by
14120 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
14121 respectively.  @option{--with-llsc} is the default for some
14122 configurations; see the installation documentation for details.
14124 @item -mdsp
14125 @itemx -mno-dsp
14126 @opindex mdsp
14127 @opindex mno-dsp
14128 Use (do not use) revision 1 of the MIPS DSP ASE@.
14129 @xref{MIPS DSP Built-in Functions}.  This option defines the
14130 preprocessor macro @samp{__mips_dsp}.  It also defines
14131 @samp{__mips_dsp_rev} to 1.
14133 @item -mdspr2
14134 @itemx -mno-dspr2
14135 @opindex mdspr2
14136 @opindex mno-dspr2
14137 Use (do not use) revision 2 of the MIPS DSP ASE@.
14138 @xref{MIPS DSP Built-in Functions}.  This option defines the
14139 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
14140 It also defines @samp{__mips_dsp_rev} to 2.
14142 @item -msmartmips
14143 @itemx -mno-smartmips
14144 @opindex msmartmips
14145 @opindex mno-smartmips
14146 Use (do not use) the MIPS SmartMIPS ASE.
14148 @item -mpaired-single
14149 @itemx -mno-paired-single
14150 @opindex mpaired-single
14151 @opindex mno-paired-single
14152 Use (do not use) paired-single floating-point instructions.
14153 @xref{MIPS Paired-Single Support}.  This option requires
14154 hardware floating-point support to be enabled.
14156 @item -mdmx
14157 @itemx -mno-mdmx
14158 @opindex mdmx
14159 @opindex mno-mdmx
14160 Use (do not use) MIPS Digital Media Extension instructions.
14161 This option can only be used when generating 64-bit code and requires
14162 hardware floating-point support to be enabled.
14164 @item -mips3d
14165 @itemx -mno-mips3d
14166 @opindex mips3d
14167 @opindex mno-mips3d
14168 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
14169 The option @option{-mips3d} implies @option{-mpaired-single}.
14171 @item -mmt
14172 @itemx -mno-mt
14173 @opindex mmt
14174 @opindex mno-mt
14175 Use (do not use) MT Multithreading instructions.
14177 @item -mlong64
14178 @opindex mlong64
14179 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
14180 an explanation of the default and the way that the pointer size is
14181 determined.
14183 @item -mlong32
14184 @opindex mlong32
14185 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
14187 The default size of @code{int}s, @code{long}s and pointers depends on
14188 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
14189 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
14190 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
14191 or the same size as integer registers, whichever is smaller.
14193 @item -msym32
14194 @itemx -mno-sym32
14195 @opindex msym32
14196 @opindex mno-sym32
14197 Assume (do not assume) that all symbols have 32-bit values, regardless
14198 of the selected ABI@.  This option is useful in combination with
14199 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
14200 to generate shorter and faster references to symbolic addresses.
14202 @item -G @var{num}
14203 @opindex G
14204 Put definitions of externally-visible data in a small data section
14205 if that data is no bigger than @var{num} bytes.  GCC can then access
14206 the data more efficiently; see @option{-mgpopt} for details.
14208 The default @option{-G} option depends on the configuration.
14210 @item -mlocal-sdata
14211 @itemx -mno-local-sdata
14212 @opindex mlocal-sdata
14213 @opindex mno-local-sdata
14214 Extend (do not extend) the @option{-G} behavior to local data too,
14215 such as to static variables in C@.  @option{-mlocal-sdata} is the
14216 default for all configurations.
14218 If the linker complains that an application is using too much small data,
14219 you might want to try rebuilding the less performance-critical parts with
14220 @option{-mno-local-sdata}.  You might also want to build large
14221 libraries with @option{-mno-local-sdata}, so that the libraries leave
14222 more room for the main program.
14224 @item -mextern-sdata
14225 @itemx -mno-extern-sdata
14226 @opindex mextern-sdata
14227 @opindex mno-extern-sdata
14228 Assume (do not assume) that externally-defined data will be in
14229 a small data section if that data is within the @option{-G} limit.
14230 @option{-mextern-sdata} is the default for all configurations.
14232 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
14233 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
14234 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
14235 is placed in a small data section.  If @var{Var} is defined by another
14236 module, you must either compile that module with a high-enough
14237 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
14238 definition.  If @var{Var} is common, you must link the application
14239 with a high-enough @option{-G} setting.
14241 The easiest way of satisfying these restrictions is to compile
14242 and link every module with the same @option{-G} option.  However,
14243 you may wish to build a library that supports several different
14244 small data limits.  You can do this by compiling the library with
14245 the highest supported @option{-G} setting and additionally using
14246 @option{-mno-extern-sdata} to stop the library from making assumptions
14247 about externally-defined data.
14249 @item -mgpopt
14250 @itemx -mno-gpopt
14251 @opindex mgpopt
14252 @opindex mno-gpopt
14253 Use (do not use) GP-relative accesses for symbols that are known to be
14254 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
14255 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
14256 configurations.
14258 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
14259 might not hold the value of @code{_gp}.  For example, if the code is
14260 part of a library that might be used in a boot monitor, programs that
14261 call boot monitor routines will pass an unknown value in @code{$gp}.
14262 (In such situations, the boot monitor itself would usually be compiled
14263 with @option{-G0}.)
14265 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
14266 @option{-mno-extern-sdata}.
14268 @item -membedded-data
14269 @itemx -mno-embedded-data
14270 @opindex membedded-data
14271 @opindex mno-embedded-data
14272 Allocate variables to the read-only data section first if possible, then
14273 next in the small data section if possible, otherwise in data.  This gives
14274 slightly slower code than the default, but reduces the amount of RAM required
14275 when executing, and thus may be preferred for some embedded systems.
14277 @item -muninit-const-in-rodata
14278 @itemx -mno-uninit-const-in-rodata
14279 @opindex muninit-const-in-rodata
14280 @opindex mno-uninit-const-in-rodata
14281 Put uninitialized @code{const} variables in the read-only data section.
14282 This option is only meaningful in conjunction with @option{-membedded-data}.
14284 @item -mcode-readable=@var{setting}
14285 @opindex mcode-readable
14286 Specify whether GCC may generate code that reads from executable sections.
14287 There are three possible settings:
14289 @table @gcctabopt
14290 @item -mcode-readable=yes
14291 Instructions may freely access executable sections.  This is the
14292 default setting.
14294 @item -mcode-readable=pcrel
14295 MIPS16 PC-relative load instructions can access executable sections,
14296 but other instructions must not do so.  This option is useful on 4KSc
14297 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
14298 It is also useful on processors that can be configured to have a dual
14299 instruction/data SRAM interface and that, like the M4K, automatically
14300 redirect PC-relative loads to the instruction RAM.
14302 @item -mcode-readable=no
14303 Instructions must not access executable sections.  This option can be
14304 useful on targets that are configured to have a dual instruction/data
14305 SRAM interface but that (unlike the M4K) do not automatically redirect
14306 PC-relative loads to the instruction RAM.
14307 @end table
14309 @item -msplit-addresses
14310 @itemx -mno-split-addresses
14311 @opindex msplit-addresses
14312 @opindex mno-split-addresses
14313 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
14314 relocation operators.  This option has been superseded by
14315 @option{-mexplicit-relocs} but is retained for backwards compatibility.
14317 @item -mexplicit-relocs
14318 @itemx -mno-explicit-relocs
14319 @opindex mexplicit-relocs
14320 @opindex mno-explicit-relocs
14321 Use (do not use) assembler relocation operators when dealing with symbolic
14322 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
14323 is to use assembler macros instead.
14325 @option{-mexplicit-relocs} is the default if GCC was configured
14326 to use an assembler that supports relocation operators.
14328 @item -mcheck-zero-division
14329 @itemx -mno-check-zero-division
14330 @opindex mcheck-zero-division
14331 @opindex mno-check-zero-division
14332 Trap (do not trap) on integer division by zero.
14334 The default is @option{-mcheck-zero-division}.
14336 @item -mdivide-traps
14337 @itemx -mdivide-breaks
14338 @opindex mdivide-traps
14339 @opindex mdivide-breaks
14340 MIPS systems check for division by zero by generating either a
14341 conditional trap or a break instruction.  Using traps results in
14342 smaller code, but is only supported on MIPS II and later.  Also, some
14343 versions of the Linux kernel have a bug that prevents trap from
14344 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
14345 allow conditional traps on architectures that support them and
14346 @option{-mdivide-breaks} to force the use of breaks.
14348 The default is usually @option{-mdivide-traps}, but this can be
14349 overridden at configure time using @option{--with-divide=breaks}.
14350 Divide-by-zero checks can be completely disabled using
14351 @option{-mno-check-zero-division}.
14353 @item -mmemcpy
14354 @itemx -mno-memcpy
14355 @opindex mmemcpy
14356 @opindex mno-memcpy
14357 Force (do not force) the use of @code{memcpy()} for non-trivial block
14358 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
14359 most constant-sized copies.
14361 @item -mlong-calls
14362 @itemx -mno-long-calls
14363 @opindex mlong-calls
14364 @opindex mno-long-calls
14365 Disable (do not disable) use of the @code{jal} instruction.  Calling
14366 functions using @code{jal} is more efficient but requires the caller
14367 and callee to be in the same 256 megabyte segment.
14369 This option has no effect on abicalls code.  The default is
14370 @option{-mno-long-calls}.
14372 @item -mmad
14373 @itemx -mno-mad
14374 @opindex mmad
14375 @opindex mno-mad
14376 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
14377 instructions, as provided by the R4650 ISA@.
14379 @item -mfused-madd
14380 @itemx -mno-fused-madd
14381 @opindex mfused-madd
14382 @opindex mno-fused-madd
14383 Enable (disable) use of the floating point multiply-accumulate
14384 instructions, when they are available.  The default is
14385 @option{-mfused-madd}.
14387 When multiply-accumulate instructions are used, the intermediate
14388 product is calculated to infinite precision and is not subject to
14389 the FCSR Flush to Zero bit.  This may be undesirable in some
14390 circumstances.
14392 @item -nocpp
14393 @opindex nocpp
14394 Tell the MIPS assembler to not run its preprocessor over user
14395 assembler files (with a @samp{.s} suffix) when assembling them.
14397 @item -mfix-r4000
14398 @itemx -mno-fix-r4000
14399 @opindex mfix-r4000
14400 @opindex mno-fix-r4000
14401 Work around certain R4000 CPU errata:
14402 @itemize @minus
14403 @item
14404 A double-word or a variable shift may give an incorrect result if executed
14405 immediately after starting an integer division.
14406 @item
14407 A double-word or a variable shift may give an incorrect result if executed
14408 while an integer multiplication is in progress.
14409 @item
14410 An integer division may give an incorrect result if started in a delay slot
14411 of a taken branch or a jump.
14412 @end itemize
14414 @item -mfix-r4400
14415 @itemx -mno-fix-r4400
14416 @opindex mfix-r4400
14417 @opindex mno-fix-r4400
14418 Work around certain R4400 CPU errata:
14419 @itemize @minus
14420 @item
14421 A double-word or a variable shift may give an incorrect result if executed
14422 immediately after starting an integer division.
14423 @end itemize
14425 @item -mfix-r10000
14426 @itemx -mno-fix-r10000
14427 @opindex mfix-r10000
14428 @opindex mno-fix-r10000
14429 Work around certain R10000 errata:
14430 @itemize @minus
14431 @item
14432 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14433 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
14434 @end itemize
14436 This option can only be used if the target architecture supports
14437 branch-likely instructions.  @option{-mfix-r10000} is the default when
14438 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14439 otherwise.
14441 @item -mfix-vr4120
14442 @itemx -mno-fix-vr4120
14443 @opindex mfix-vr4120
14444 Work around certain VR4120 errata:
14445 @itemize @minus
14446 @item
14447 @code{dmultu} does not always produce the correct result.
14448 @item
14449 @code{div} and @code{ddiv} do not always produce the correct result if one
14450 of the operands is negative.
14451 @end itemize
14452 The workarounds for the division errata rely on special functions in
14453 @file{libgcc.a}.  At present, these functions are only provided by
14454 the @code{mips64vr*-elf} configurations.
14456 Other VR4120 errata require a nop to be inserted between certain pairs of
14457 instructions.  These errata are handled by the assembler, not by GCC itself.
14459 @item -mfix-vr4130
14460 @opindex mfix-vr4130
14461 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
14462 workarounds are implemented by the assembler rather than by GCC,
14463 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14464 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14465 instructions are available instead.
14467 @item -mfix-sb1
14468 @itemx -mno-fix-sb1
14469 @opindex mfix-sb1
14470 Work around certain SB-1 CPU core errata.
14471 (This flag currently works around the SB-1 revision 2
14472 ``F1'' and ``F2'' floating point errata.)
14474 @item -mr10k-cache-barrier=@var{setting}
14475 @opindex mr10k-cache-barrier
14476 Specify whether GCC should insert cache barriers to avoid the
14477 side-effects of speculation on R10K processors.
14479 In common with many processors, the R10K tries to predict the outcome
14480 of a conditional branch and speculatively executes instructions from
14481 the ``taken'' branch.  It later aborts these instructions if the
14482 predicted outcome was wrong.  However, on the R10K, even aborted
14483 instructions can have side effects.
14485 This problem only affects kernel stores and, depending on the system,
14486 kernel loads.  As an example, a speculatively-executed store may load
14487 the target memory into cache and mark the cache line as dirty, even if
14488 the store itself is later aborted.  If a DMA operation writes to the
14489 same area of memory before the ``dirty'' line is flushed, the cached
14490 data will overwrite the DMA-ed data.  See the R10K processor manual
14491 for a full description, including other potential problems.
14493 One workaround is to insert cache barrier instructions before every memory
14494 access that might be speculatively executed and that might have side
14495 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
14496 controls GCC's implementation of this workaround.  It assumes that
14497 aborted accesses to any byte in the following regions will not have
14498 side effects:
14500 @enumerate
14501 @item
14502 the memory occupied by the current function's stack frame;
14504 @item
14505 the memory occupied by an incoming stack argument;
14507 @item
14508 the memory occupied by an object with a link-time-constant address.
14509 @end enumerate
14511 It is the kernel's responsibility to ensure that speculative
14512 accesses to these regions are indeed safe.
14514 If the input program contains a function declaration such as:
14516 @smallexample
14517 void foo (void);
14518 @end smallexample
14520 then the implementation of @code{foo} must allow @code{j foo} and
14521 @code{jal foo} to be executed speculatively.  GCC honors this
14522 restriction for functions it compiles itself.  It expects non-GCC
14523 functions (such as hand-written assembly code) to do the same.
14525 The option has three forms:
14527 @table @gcctabopt
14528 @item -mr10k-cache-barrier=load-store
14529 Insert a cache barrier before a load or store that might be
14530 speculatively executed and that might have side effects even
14531 if aborted.
14533 @item -mr10k-cache-barrier=store
14534 Insert a cache barrier before a store that might be speculatively
14535 executed and that might have side effects even if aborted.
14537 @item -mr10k-cache-barrier=none
14538 Disable the insertion of cache barriers.  This is the default setting.
14539 @end table
14541 @item -mflush-func=@var{func}
14542 @itemx -mno-flush-func
14543 @opindex mflush-func
14544 Specifies the function to call to flush the I and D caches, or to not
14545 call any such function.  If called, the function must take the same
14546 arguments as the common @code{_flush_func()}, that is, the address of the
14547 memory range for which the cache is being flushed, the size of the
14548 memory range, and the number 3 (to flush both caches).  The default
14549 depends on the target GCC was configured for, but commonly is either
14550 @samp{_flush_func} or @samp{__cpu_flush}.
14552 @item mbranch-cost=@var{num}
14553 @opindex mbranch-cost
14554 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14555 This cost is only a heuristic and is not guaranteed to produce
14556 consistent results across releases.  A zero cost redundantly selects
14557 the default, which is based on the @option{-mtune} setting.
14559 @item -mbranch-likely
14560 @itemx -mno-branch-likely
14561 @opindex mbranch-likely
14562 @opindex mno-branch-likely
14563 Enable or disable use of Branch Likely instructions, regardless of the
14564 default for the selected architecture.  By default, Branch Likely
14565 instructions may be generated if they are supported by the selected
14566 architecture.  An exception is for the MIPS32 and MIPS64 architectures
14567 and processors which implement those architectures; for those, Branch
14568 Likely instructions will not be generated by default because the MIPS32
14569 and MIPS64 architectures specifically deprecate their use.
14571 @item -mfp-exceptions
14572 @itemx -mno-fp-exceptions
14573 @opindex mfp-exceptions
14574 Specifies whether FP exceptions are enabled.  This affects how we schedule
14575 FP instructions for some processors.  The default is that FP exceptions are
14576 enabled.
14578 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14579 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
14580 FP pipe.
14582 @item -mvr4130-align
14583 @itemx -mno-vr4130-align
14584 @opindex mvr4130-align
14585 The VR4130 pipeline is two-way superscalar, but can only issue two
14586 instructions together if the first one is 8-byte aligned.  When this
14587 option is enabled, GCC will align pairs of instructions that it
14588 thinks should execute in parallel.
14590 This option only has an effect when optimizing for the VR4130.
14591 It normally makes code faster, but at the expense of making it bigger.
14592 It is enabled by default at optimization level @option{-O3}.
14594 @item -msynci
14595 @itemx -mno-synci
14596 @opindex msynci
14597 Enable (disable) generation of @code{synci} instructions on
14598 architectures that support it.  The @code{synci} instructions (if
14599 enabled) will be generated when @code{__builtin___clear_cache()} is
14600 compiled.
14602 This option defaults to @code{-mno-synci}, but the default can be
14603 overridden by configuring with @code{--with-synci}.
14605 When compiling code for single processor systems, it is generally safe
14606 to use @code{synci}.  However, on many multi-core (SMP) systems, it
14607 will not invalidate the instruction caches on all cores and may lead
14608 to undefined behavior.
14610 @item -mrelax-pic-calls
14611 @itemx -mno-relax-pic-calls
14612 @opindex mrelax-pic-calls
14613 Try to turn PIC calls that are normally dispatched via register
14614 @code{$25} into direct calls.  This is only possible if the linker can
14615 resolve the destination at link-time and if the destination is within
14616 range for a direct call.
14618 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14619 an assembler and a linker that supports the @code{.reloc} assembly
14620 directive and @code{-mexplicit-relocs} is in effect.  With
14621 @code{-mno-explicit-relocs}, this optimization can be performed by the
14622 assembler and the linker alone without help from the compiler.
14624 @item -mmcount-ra-address
14625 @itemx -mno-mcount-ra-address
14626 @opindex mmcount-ra-address
14627 @opindex mno-mcount-ra-address
14628 Emit (do not emit) code that allows @code{_mcount} to modify the
14629 calling function's return address.  When enabled, this option extends
14630 the usual @code{_mcount} interface with a new @var{ra-address}
14631 parameter, which has type @code{intptr_t *} and is passed in register
14632 @code{$12}.  @code{_mcount} can then modify the return address by
14633 doing both of the following:
14634 @itemize
14635 @item
14636 Returning the new address in register @code{$31}.
14637 @item
14638 Storing the new address in @code{*@var{ra-address}},
14639 if @var{ra-address} is nonnull.
14640 @end itemize
14642 The default is @option{-mno-mcount-ra-address}.
14644 @end table
14646 @node MMIX Options
14647 @subsection MMIX Options
14648 @cindex MMIX Options
14650 These options are defined for the MMIX:
14652 @table @gcctabopt
14653 @item -mlibfuncs
14654 @itemx -mno-libfuncs
14655 @opindex mlibfuncs
14656 @opindex mno-libfuncs
14657 Specify that intrinsic library functions are being compiled, passing all
14658 values in registers, no matter the size.
14660 @item -mepsilon
14661 @itemx -mno-epsilon
14662 @opindex mepsilon
14663 @opindex mno-epsilon
14664 Generate floating-point comparison instructions that compare with respect
14665 to the @code{rE} epsilon register.
14667 @item -mabi=mmixware
14668 @itemx -mabi=gnu
14669 @opindex mabi=mmixware
14670 @opindex mabi=gnu
14671 Generate code that passes function parameters and return values that (in
14672 the called function) are seen as registers @code{$0} and up, as opposed to
14673 the GNU ABI which uses global registers @code{$231} and up.
14675 @item -mzero-extend
14676 @itemx -mno-zero-extend
14677 @opindex mzero-extend
14678 @opindex mno-zero-extend
14679 When reading data from memory in sizes shorter than 64 bits, use (do not
14680 use) zero-extending load instructions by default, rather than
14681 sign-extending ones.
14683 @item -mknuthdiv
14684 @itemx -mno-knuthdiv
14685 @opindex mknuthdiv
14686 @opindex mno-knuthdiv
14687 Make the result of a division yielding a remainder have the same sign as
14688 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
14689 remainder follows the sign of the dividend.  Both methods are
14690 arithmetically valid, the latter being almost exclusively used.
14692 @item -mtoplevel-symbols
14693 @itemx -mno-toplevel-symbols
14694 @opindex mtoplevel-symbols
14695 @opindex mno-toplevel-symbols
14696 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
14697 code can be used with the @code{PREFIX} assembly directive.
14699 @item -melf
14700 @opindex melf
14701 Generate an executable in the ELF format, rather than the default
14702 @samp{mmo} format used by the @command{mmix} simulator.
14704 @item -mbranch-predict
14705 @itemx -mno-branch-predict
14706 @opindex mbranch-predict
14707 @opindex mno-branch-predict
14708 Use (do not use) the probable-branch instructions, when static branch
14709 prediction indicates a probable branch.
14711 @item -mbase-addresses
14712 @itemx -mno-base-addresses
14713 @opindex mbase-addresses
14714 @opindex mno-base-addresses
14715 Generate (do not generate) code that uses @emph{base addresses}.  Using a
14716 base address automatically generates a request (handled by the assembler
14717 and the linker) for a constant to be set up in a global register.  The
14718 register is used for one or more base address requests within the range 0
14719 to 255 from the value held in the register.  The generally leads to short
14720 and fast code, but the number of different data items that can be
14721 addressed is limited.  This means that a program that uses lots of static
14722 data may require @option{-mno-base-addresses}.
14724 @item -msingle-exit
14725 @itemx -mno-single-exit
14726 @opindex msingle-exit
14727 @opindex mno-single-exit
14728 Force (do not force) generated code to have a single exit point in each
14729 function.
14730 @end table
14732 @node MN10300 Options
14733 @subsection MN10300 Options
14734 @cindex MN10300 options
14736 These @option{-m} options are defined for Matsushita MN10300 architectures:
14738 @table @gcctabopt
14739 @item -mmult-bug
14740 @opindex mmult-bug
14741 Generate code to avoid bugs in the multiply instructions for the MN10300
14742 processors.  This is the default.
14744 @item -mno-mult-bug
14745 @opindex mno-mult-bug
14746 Do not generate code to avoid bugs in the multiply instructions for the
14747 MN10300 processors.
14749 @item -mam33
14750 @opindex mam33
14751 Generate code which uses features specific to the AM33 processor.
14753 @item -mno-am33
14754 @opindex mno-am33
14755 Do not generate code which uses features specific to the AM33 processor.  This
14756 is the default.
14758 @item -mreturn-pointer-on-d0
14759 @opindex mreturn-pointer-on-d0
14760 When generating a function which returns a pointer, return the pointer
14761 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
14762 only in a0, and attempts to call such functions without a prototype
14763 would result in errors.  Note that this option is on by default; use
14764 @option{-mno-return-pointer-on-d0} to disable it.
14766 @item -mno-crt0
14767 @opindex mno-crt0
14768 Do not link in the C run-time initialization object file.
14770 @item -mrelax
14771 @opindex mrelax
14772 Indicate to the linker that it should perform a relaxation optimization pass
14773 to shorten branches, calls and absolute memory addresses.  This option only
14774 has an effect when used on the command line for the final link step.
14776 This option makes symbolic debugging impossible.
14777 @end table
14779 @node PDP-11 Options
14780 @subsection PDP-11 Options
14781 @cindex PDP-11 Options
14783 These options are defined for the PDP-11:
14785 @table @gcctabopt
14786 @item -mfpu
14787 @opindex mfpu
14788 Use hardware FPP floating point.  This is the default.  (FIS floating
14789 point on the PDP-11/40 is not supported.)
14791 @item -msoft-float
14792 @opindex msoft-float
14793 Do not use hardware floating point.
14795 @item -mac0
14796 @opindex mac0
14797 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
14799 @item -mno-ac0
14800 @opindex mno-ac0
14801 Return floating-point results in memory.  This is the default.
14803 @item -m40
14804 @opindex m40
14805 Generate code for a PDP-11/40.
14807 @item -m45
14808 @opindex m45
14809 Generate code for a PDP-11/45.  This is the default.
14811 @item -m10
14812 @opindex m10
14813 Generate code for a PDP-11/10.
14815 @item -mbcopy-builtin
14816 @opindex mbcopy-builtin
14817 Use inline @code{movmemhi} patterns for copying memory.  This is the
14818 default.
14820 @item -mbcopy
14821 @opindex mbcopy
14822 Do not use inline @code{movmemhi} patterns for copying memory.
14824 @item -mint16
14825 @itemx -mno-int32
14826 @opindex mint16
14827 @opindex mno-int32
14828 Use 16-bit @code{int}.  This is the default.
14830 @item -mint32
14831 @itemx -mno-int16
14832 @opindex mint32
14833 @opindex mno-int16
14834 Use 32-bit @code{int}.
14836 @item -mfloat64
14837 @itemx -mno-float32
14838 @opindex mfloat64
14839 @opindex mno-float32
14840 Use 64-bit @code{float}.  This is the default.
14842 @item -mfloat32
14843 @itemx -mno-float64
14844 @opindex mfloat32
14845 @opindex mno-float64
14846 Use 32-bit @code{float}.
14848 @item -mabshi
14849 @opindex mabshi
14850 Use @code{abshi2} pattern.  This is the default.
14852 @item -mno-abshi
14853 @opindex mno-abshi
14854 Do not use @code{abshi2} pattern.
14856 @item -mbranch-expensive
14857 @opindex mbranch-expensive
14858 Pretend that branches are expensive.  This is for experimenting with
14859 code generation only.
14861 @item -mbranch-cheap
14862 @opindex mbranch-cheap
14863 Do not pretend that branches are expensive.  This is the default.
14865 @item -msplit
14866 @opindex msplit
14867 Generate code for a system with split I&D@.
14869 @item -mno-split
14870 @opindex mno-split
14871 Generate code for a system without split I&D@.  This is the default.
14873 @item -munix-asm
14874 @opindex munix-asm
14875 Use Unix assembler syntax.  This is the default when configured for
14876 @samp{pdp11-*-bsd}.
14878 @item -mdec-asm
14879 @opindex mdec-asm
14880 Use DEC assembler syntax.  This is the default when configured for any
14881 PDP-11 target other than @samp{pdp11-*-bsd}.
14882 @end table
14884 @node picoChip Options
14885 @subsection picoChip Options
14886 @cindex picoChip options
14888 These @samp{-m} options are defined for picoChip implementations:
14890 @table @gcctabopt
14892 @item -mae=@var{ae_type}
14893 @opindex mcpu
14894 Set the instruction set, register set, and instruction scheduling
14895 parameters for array element type @var{ae_type}.  Supported values
14896 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
14898 @option{-mae=ANY} selects a completely generic AE type.  Code
14899 generated with this option will run on any of the other AE types.  The
14900 code will not be as efficient as it would be if compiled for a specific
14901 AE type, and some types of operation (e.g., multiplication) will not
14902 work properly on all types of AE.
14904 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
14905 for compiled code, and is the default.
14907 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
14908 option may suffer from poor performance of byte (char) manipulation,
14909 since the DSP AE does not provide hardware support for byte load/stores.
14911 @item -msymbol-as-address
14912 Enable the compiler to directly use a symbol name as an address in a
14913 load/store instruction, without first loading it into a
14914 register.  Typically, the use of this option will generate larger
14915 programs, which run faster than when the option isn't used.  However, the
14916 results vary from program to program, so it is left as a user option,
14917 rather than being permanently enabled.
14919 @item -mno-inefficient-warnings
14920 Disables warnings about the generation of inefficient code.  These
14921 warnings can be generated, for example, when compiling code which
14922 performs byte-level memory operations on the MAC AE type.  The MAC AE has
14923 no hardware support for byte-level memory operations, so all byte
14924 load/stores must be synthesized from word load/store operations.  This is
14925 inefficient and a warning will be generated indicating to the programmer
14926 that they should rewrite the code to avoid byte operations, or to target
14927 an AE type which has the necessary hardware support.  This option enables
14928 the warning to be turned off.
14930 @end table
14932 @node PowerPC Options
14933 @subsection PowerPC Options
14934 @cindex PowerPC options
14936 These are listed under @xref{RS/6000 and PowerPC Options}.
14938 @node RS/6000 and PowerPC Options
14939 @subsection IBM RS/6000 and PowerPC Options
14940 @cindex RS/6000 and PowerPC Options
14941 @cindex IBM RS/6000 and PowerPC Options
14943 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
14944 @table @gcctabopt
14945 @item -mpower
14946 @itemx -mno-power
14947 @itemx -mpower2
14948 @itemx -mno-power2
14949 @itemx -mpowerpc
14950 @itemx -mno-powerpc
14951 @itemx -mpowerpc-gpopt
14952 @itemx -mno-powerpc-gpopt
14953 @itemx -mpowerpc-gfxopt
14954 @itemx -mno-powerpc-gfxopt
14955 @itemx -mpowerpc64
14956 @itemx -mno-powerpc64
14957 @itemx -mmfcrf
14958 @itemx -mno-mfcrf
14959 @itemx -mpopcntb
14960 @itemx -mno-popcntb
14961 @itemx -mpopcntd
14962 @itemx -mno-popcntd
14963 @itemx -mfprnd
14964 @itemx -mno-fprnd
14965 @itemx -mcmpb
14966 @itemx -mno-cmpb
14967 @itemx -mmfpgpr
14968 @itemx -mno-mfpgpr
14969 @itemx -mhard-dfp
14970 @itemx -mno-hard-dfp
14971 @opindex mpower
14972 @opindex mno-power
14973 @opindex mpower2
14974 @opindex mno-power2
14975 @opindex mpowerpc
14976 @opindex mno-powerpc
14977 @opindex mpowerpc-gpopt
14978 @opindex mno-powerpc-gpopt
14979 @opindex mpowerpc-gfxopt
14980 @opindex mno-powerpc-gfxopt
14981 @opindex mpowerpc64
14982 @opindex mno-powerpc64
14983 @opindex mmfcrf
14984 @opindex mno-mfcrf
14985 @opindex mpopcntb
14986 @opindex mno-popcntb
14987 @opindex mpopcntd
14988 @opindex mno-popcntd
14989 @opindex mfprnd
14990 @opindex mno-fprnd
14991 @opindex mcmpb
14992 @opindex mno-cmpb
14993 @opindex mmfpgpr
14994 @opindex mno-mfpgpr
14995 @opindex mhard-dfp
14996 @opindex mno-hard-dfp
14997 GCC supports two related instruction set architectures for the
14998 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
14999 instructions supported by the @samp{rios} chip set used in the original
15000 RS/6000 systems and the @dfn{PowerPC} instruction set is the
15001 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
15002 the IBM 4xx, 6xx, and follow-on microprocessors.
15004 Neither architecture is a subset of the other.  However there is a
15005 large common subset of instructions supported by both.  An MQ
15006 register is included in processors supporting the POWER architecture.
15008 You use these options to specify which instructions are available on the
15009 processor you are using.  The default value of these options is
15010 determined when configuring GCC@.  Specifying the
15011 @option{-mcpu=@var{cpu_type}} overrides the specification of these
15012 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
15013 rather than the options listed above.
15015 The @option{-mpower} option allows GCC to generate instructions that
15016 are found only in the POWER architecture and to use the MQ register.
15017 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
15018 to generate instructions that are present in the POWER2 architecture but
15019 not the original POWER architecture.
15021 The @option{-mpowerpc} option allows GCC to generate instructions that
15022 are found only in the 32-bit subset of the PowerPC architecture.
15023 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
15024 GCC to use the optional PowerPC architecture instructions in the
15025 General Purpose group, including floating-point square root.  Specifying
15026 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
15027 use the optional PowerPC architecture instructions in the Graphics
15028 group, including floating-point select.
15030 The @option{-mmfcrf} option allows GCC to generate the move from
15031 condition register field instruction implemented on the POWER4
15032 processor and other processors that support the PowerPC V2.01
15033 architecture.
15034 The @option{-mpopcntb} option allows GCC to generate the popcount and
15035 double precision FP reciprocal estimate instruction implemented on the
15036 POWER5 processor and other processors that support the PowerPC V2.02
15037 architecture.
15038 The @option{-mpopcntd} option allows GCC to generate the popcount
15039 instruction implemented on the POWER7 processor and other processors
15040 that support the PowerPC V2.06 architecture.
15041 The @option{-mfprnd} option allows GCC to generate the FP round to
15042 integer instructions implemented on the POWER5+ processor and other
15043 processors that support the PowerPC V2.03 architecture.
15044 The @option{-mcmpb} option allows GCC to generate the compare bytes
15045 instruction implemented on the POWER6 processor and other processors
15046 that support the PowerPC V2.05 architecture.
15047 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
15048 general purpose register instructions implemented on the POWER6X
15049 processor and other processors that support the extended PowerPC V2.05
15050 architecture.
15051 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
15052 point instructions implemented on some POWER processors.
15054 The @option{-mpowerpc64} option allows GCC to generate the additional
15055 64-bit instructions that are found in the full PowerPC64 architecture
15056 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
15057 @option{-mno-powerpc64}.
15059 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
15060 will use only the instructions in the common subset of both
15061 architectures plus some special AIX common-mode calls, and will not use
15062 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
15063 permits GCC to use any instruction from either architecture and to
15064 allow use of the MQ register; specify this for the Motorola MPC601.
15066 @item -mnew-mnemonics
15067 @itemx -mold-mnemonics
15068 @opindex mnew-mnemonics
15069 @opindex mold-mnemonics
15070 Select which mnemonics to use in the generated assembler code.  With
15071 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
15072 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
15073 assembler mnemonics defined for the POWER architecture.  Instructions
15074 defined in only one architecture have only one mnemonic; GCC uses that
15075 mnemonic irrespective of which of these options is specified.
15077 GCC defaults to the mnemonics appropriate for the architecture in
15078 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
15079 value of these option.  Unless you are building a cross-compiler, you
15080 should normally not specify either @option{-mnew-mnemonics} or
15081 @option{-mold-mnemonics}, but should instead accept the default.
15083 @item -mcpu=@var{cpu_type}
15084 @opindex mcpu
15085 Set architecture type, register usage, choice of mnemonics, and
15086 instruction scheduling parameters for machine type @var{cpu_type}.
15087 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
15088 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
15089 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
15090 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
15091 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
15092 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
15093 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
15094 @samp{G4}, @samp{G5}, @samp{titan}, @samp{power}, @samp{power2}, @samp{power3},
15095 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
15096 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
15097 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
15099 @option{-mcpu=common} selects a completely generic processor.  Code
15100 generated under this option will run on any POWER or PowerPC processor.
15101 GCC will use only the instructions in the common subset of both
15102 architectures, and will not use the MQ register.  GCC assumes a generic
15103 processor model for scheduling purposes.
15105 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
15106 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
15107 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
15108 types, with an appropriate, generic processor model assumed for
15109 scheduling purposes.
15111 The other options specify a specific processor.  Code generated under
15112 those options will run best on that processor, and may not run at all on
15113 others.
15115 The @option{-mcpu} options automatically enable or disable the
15116 following options:
15118 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
15119 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
15120 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
15121 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
15123 The particular options set for any particular CPU will vary between
15124 compiler versions, depending on what setting seems to produce optimal
15125 code for that CPU; it doesn't necessarily reflect the actual hardware's
15126 capabilities.  If you wish to set an individual option to a particular
15127 value, you may specify it after the @option{-mcpu} option, like
15128 @samp{-mcpu=970 -mno-altivec}.
15130 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
15131 not enabled or disabled by the @option{-mcpu} option at present because
15132 AIX does not have full support for these options.  You may still
15133 enable or disable them individually if you're sure it'll work in your
15134 environment.
15136 @item -mtune=@var{cpu_type}
15137 @opindex mtune
15138 Set the instruction scheduling parameters for machine type
15139 @var{cpu_type}, but do not set the architecture type, register usage, or
15140 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
15141 values for @var{cpu_type} are used for @option{-mtune} as for
15142 @option{-mcpu}.  If both are specified, the code generated will use the
15143 architecture, registers, and mnemonics set by @option{-mcpu}, but the
15144 scheduling parameters set by @option{-mtune}.
15146 @item -mcmodel=small
15147 @opindex mcmodel=small
15148 Generate PowerPC64 code for the small model: The TOC is limited to
15149 64k.
15151 @item -mcmodel=large
15152 @opindex mcmodel=large
15153 Generate PowerPC64 code for the large model: The TOC may be up to 4G
15154 in size.  Other data and code is only limited by the 64-bit address
15155 space.
15157 @item -maltivec
15158 @itemx -mno-altivec
15159 @opindex maltivec
15160 @opindex mno-altivec
15161 Generate code that uses (does not use) AltiVec instructions, and also
15162 enable the use of built-in functions that allow more direct access to
15163 the AltiVec instruction set.  You may also need to set
15164 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
15165 enhancements.
15167 @item -mvrsave
15168 @itemx -mno-vrsave
15169 @opindex mvrsave
15170 @opindex mno-vrsave
15171 Generate VRSAVE instructions when generating AltiVec code.
15173 @item -mgen-cell-microcode
15174 @opindex mgen-cell-microcode
15175 Generate Cell microcode instructions
15177 @item -mwarn-cell-microcode
15178 @opindex mwarn-cell-microcode
15179 Warning when a Cell microcode instruction is going to emitted.  An example
15180 of a Cell microcode instruction is a variable shift.
15182 @item -msecure-plt
15183 @opindex msecure-plt
15184 Generate code that allows ld and ld.so to build executables and shared
15185 libraries with non-exec .plt and .got sections.  This is a PowerPC
15186 32-bit SYSV ABI option.
15188 @item -mbss-plt
15189 @opindex mbss-plt
15190 Generate code that uses a BSS .plt section that ld.so fills in, and
15191 requires .plt and .got sections that are both writable and executable.
15192 This is a PowerPC 32-bit SYSV ABI option.
15194 @item -misel
15195 @itemx -mno-isel
15196 @opindex misel
15197 @opindex mno-isel
15198 This switch enables or disables the generation of ISEL instructions.
15200 @item -misel=@var{yes/no}
15201 This switch has been deprecated.  Use @option{-misel} and
15202 @option{-mno-isel} instead.
15204 @item -mspe
15205 @itemx -mno-spe
15206 @opindex mspe
15207 @opindex mno-spe
15208 This switch enables or disables the generation of SPE simd
15209 instructions.
15211 @item -mpaired
15212 @itemx -mno-paired
15213 @opindex mpaired
15214 @opindex mno-paired
15215 This switch enables or disables the generation of PAIRED simd
15216 instructions.
15218 @item -mspe=@var{yes/no}
15219 This option has been deprecated.  Use @option{-mspe} and
15220 @option{-mno-spe} instead.
15222 @item -mvsx
15223 @itemx -mno-vsx
15224 @opindex mvsx
15225 @opindex mno-vsx
15226 Generate code that uses (does not use) vector/scalar (VSX)
15227 instructions, and also enable the use of built-in functions that allow
15228 more direct access to the VSX instruction set.
15230 @item -mfloat-gprs=@var{yes/single/double/no}
15231 @itemx -mfloat-gprs
15232 @opindex mfloat-gprs
15233 This switch enables or disables the generation of floating point
15234 operations on the general purpose registers for architectures that
15235 support it.
15237 The argument @var{yes} or @var{single} enables the use of
15238 single-precision floating point operations.
15240 The argument @var{double} enables the use of single and
15241 double-precision floating point operations.
15243 The argument @var{no} disables floating point operations on the
15244 general purpose registers.
15246 This option is currently only available on the MPC854x.
15248 @item -m32
15249 @itemx -m64
15250 @opindex m32
15251 @opindex m64
15252 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
15253 targets (including GNU/Linux).  The 32-bit environment sets int, long
15254 and pointer to 32 bits and generates code that runs on any PowerPC
15255 variant.  The 64-bit environment sets int to 32 bits and long and
15256 pointer to 64 bits, and generates code for PowerPC64, as for
15257 @option{-mpowerpc64}.
15259 @item -mfull-toc
15260 @itemx -mno-fp-in-toc
15261 @itemx -mno-sum-in-toc
15262 @itemx -mminimal-toc
15263 @opindex mfull-toc
15264 @opindex mno-fp-in-toc
15265 @opindex mno-sum-in-toc
15266 @opindex mminimal-toc
15267 Modify generation of the TOC (Table Of Contents), which is created for
15268 every executable file.  The @option{-mfull-toc} option is selected by
15269 default.  In that case, GCC will allocate at least one TOC entry for
15270 each unique non-automatic variable reference in your program.  GCC
15271 will also place floating-point constants in the TOC@.  However, only
15272 16,384 entries are available in the TOC@.
15274 If you receive a linker error message that saying you have overflowed
15275 the available TOC space, you can reduce the amount of TOC space used
15276 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
15277 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
15278 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
15279 generate code to calculate the sum of an address and a constant at
15280 run-time instead of putting that sum into the TOC@.  You may specify one
15281 or both of these options.  Each causes GCC to produce very slightly
15282 slower and larger code at the expense of conserving TOC space.
15284 If you still run out of space in the TOC even when you specify both of
15285 these options, specify @option{-mminimal-toc} instead.  This option causes
15286 GCC to make only one TOC entry for every file.  When you specify this
15287 option, GCC will produce code that is slower and larger but which
15288 uses extremely little TOC space.  You may wish to use this option
15289 only on files that contain less frequently executed code.
15291 @item -maix64
15292 @itemx -maix32
15293 @opindex maix64
15294 @opindex maix32
15295 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
15296 @code{long} type, and the infrastructure needed to support them.
15297 Specifying @option{-maix64} implies @option{-mpowerpc64} and
15298 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
15299 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
15301 @item -mxl-compat
15302 @itemx -mno-xl-compat
15303 @opindex mxl-compat
15304 @opindex mno-xl-compat
15305 Produce code that conforms more closely to IBM XL compiler semantics
15306 when using AIX-compatible ABI@.  Pass floating-point arguments to
15307 prototyped functions beyond the register save area (RSA) on the stack
15308 in addition to argument FPRs.  Do not assume that most significant
15309 double in 128-bit long double value is properly rounded when comparing
15310 values and converting to double.  Use XL symbol names for long double
15311 support routines.
15313 The AIX calling convention was extended but not initially documented to
15314 handle an obscure K&R C case of calling a function that takes the
15315 address of its arguments with fewer arguments than declared.  IBM XL
15316 compilers access floating point arguments which do not fit in the
15317 RSA from the stack when a subroutine is compiled without
15318 optimization.  Because always storing floating-point arguments on the
15319 stack is inefficient and rarely needed, this option is not enabled by
15320 default and only is necessary when calling subroutines compiled by IBM
15321 XL compilers without optimization.
15323 @item -mpe
15324 @opindex mpe
15325 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
15326 application written to use message passing with special startup code to
15327 enable the application to run.  The system must have PE installed in the
15328 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
15329 must be overridden with the @option{-specs=} option to specify the
15330 appropriate directory location.  The Parallel Environment does not
15331 support threads, so the @option{-mpe} option and the @option{-pthread}
15332 option are incompatible.
15334 @item -malign-natural
15335 @itemx -malign-power
15336 @opindex malign-natural
15337 @opindex malign-power
15338 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
15339 @option{-malign-natural} overrides the ABI-defined alignment of larger
15340 types, such as floating-point doubles, on their natural size-based boundary.
15341 The option @option{-malign-power} instructs GCC to follow the ABI-specified
15342 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
15344 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
15345 is not supported.
15347 @item -msoft-float
15348 @itemx -mhard-float
15349 @opindex msoft-float
15350 @opindex mhard-float
15351 Generate code that does not use (uses) the floating-point register set.
15352 Software floating point emulation is provided if you use the
15353 @option{-msoft-float} option, and pass the option to GCC when linking.
15355 @item -msingle-float
15356 @itemx -mdouble-float
15357 @opindex msingle-float
15358 @opindex mdouble-float
15359 Generate code for single or double-precision floating point operations.
15360 @option{-mdouble-float} implies @option{-msingle-float}.
15362 @item -msimple-fpu
15363 @opindex msimple-fpu
15364 Do not generate sqrt and div instructions for hardware floating point unit.
15366 @item -mfpu
15367 @opindex mfpu
15368 Specify type of floating point unit.  Valid values are @var{sp_lite}
15369 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
15370 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
15371 and @var{dp_full} (equivalent to -mdouble-float).
15373 @item -mxilinx-fpu
15374 @opindex mxilinx-fpu
15375 Perform optimizations for floating point unit on Xilinx PPC 405/440.
15377 @item -mmultiple
15378 @itemx -mno-multiple
15379 @opindex mmultiple
15380 @opindex mno-multiple
15381 Generate code that uses (does not use) the load multiple word
15382 instructions and the store multiple word instructions.  These
15383 instructions are generated by default on POWER systems, and not
15384 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
15385 endian PowerPC systems, since those instructions do not work when the
15386 processor is in little endian mode.  The exceptions are PPC740 and
15387 PPC750 which permit the instructions usage in little endian mode.
15389 @item -mstring
15390 @itemx -mno-string
15391 @opindex mstring
15392 @opindex mno-string
15393 Generate code that uses (does not use) the load string instructions
15394 and the store string word instructions to save multiple registers and
15395 do small block moves.  These instructions are generated by default on
15396 POWER systems, and not generated on PowerPC systems.  Do not use
15397 @option{-mstring} on little endian PowerPC systems, since those
15398 instructions do not work when the processor is in little endian mode.
15399 The exceptions are PPC740 and PPC750 which permit the instructions
15400 usage in little endian mode.
15402 @item -mupdate
15403 @itemx -mno-update
15404 @opindex mupdate
15405 @opindex mno-update
15406 Generate code that uses (does not use) the load or store instructions
15407 that update the base register to the address of the calculated memory
15408 location.  These instructions are generated by default.  If you use
15409 @option{-mno-update}, there is a small window between the time that the
15410 stack pointer is updated and the address of the previous frame is
15411 stored, which means code that walks the stack frame across interrupts or
15412 signals may get corrupted data.
15414 @item -mavoid-indexed-addresses
15415 @itemx -mno-avoid-indexed-addresses
15416 @opindex mavoid-indexed-addresses
15417 @opindex mno-avoid-indexed-addresses
15418 Generate code that tries to avoid (not avoid) the use of indexed load
15419 or store instructions. These instructions can incur a performance
15420 penalty on Power6 processors in certain situations, such as when
15421 stepping through large arrays that cross a 16M boundary.  This option
15422 is enabled by default when targetting Power6 and disabled otherwise.
15424 @item -mfused-madd
15425 @itemx -mno-fused-madd
15426 @opindex mfused-madd
15427 @opindex mno-fused-madd
15428 Generate code that uses (does not use) the floating point multiply and
15429 accumulate instructions.  These instructions are generated by default if
15430 hardware floating is used.
15432 @item -mmulhw
15433 @itemx -mno-mulhw
15434 @opindex mmulhw
15435 @opindex mno-mulhw
15436 Generate code that uses (does not use) the half-word multiply and
15437 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15438 These instructions are generated by default when targetting those
15439 processors.
15441 @item -mdlmzb
15442 @itemx -mno-dlmzb
15443 @opindex mdlmzb
15444 @opindex mno-dlmzb
15445 Generate code that uses (does not use) the string-search @samp{dlmzb}
15446 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
15447 generated by default when targetting those processors.
15449 @item -mno-bit-align
15450 @itemx -mbit-align
15451 @opindex mno-bit-align
15452 @opindex mbit-align
15453 On System V.4 and embedded PowerPC systems do not (do) force structures
15454 and unions that contain bit-fields to be aligned to the base type of the
15455 bit-field.
15457 For example, by default a structure containing nothing but 8
15458 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15459 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
15460 the structure would be aligned to a 1 byte boundary and be one byte in
15461 size.
15463 @item -mno-strict-align
15464 @itemx -mstrict-align
15465 @opindex mno-strict-align
15466 @opindex mstrict-align
15467 On System V.4 and embedded PowerPC systems do not (do) assume that
15468 unaligned memory references will be handled by the system.
15470 @item -mrelocatable
15471 @itemx -mno-relocatable
15472 @opindex mrelocatable
15473 @opindex mno-relocatable
15474 Generate code that allows (does not allow) a static executable to be
15475 relocated to a different address at runtime.  A simple embedded
15476 PowerPC system loader should relocate the entire contents of
15477 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
15478 a table of 32-bit addresses generated by this option.  For this to
15479 work, all objects linked together must be compiled with
15480 @option{-mrelocatable} or @option{-mrelocatable-lib}.
15481 @option{-mrelocatable} code aligns the stack to an 8 byte boundary.
15483 @item -mrelocatable-lib
15484 @itemx -mno-relocatable-lib
15485 @opindex mrelocatable-lib
15486 @opindex mno-relocatable-lib
15487 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
15488 @code{.fixup} section to allow static executables to be relocated at
15489 runtime, but @option{-mrelocatable-lib} does not use the smaller stack
15490 alignment of @option{-mrelocatable}.  Objects compiled with
15491 @option{-mrelocatable-lib} may be linked with objects compiled with
15492 any combination of the @option{-mrelocatable} options.
15494 @item -mno-toc
15495 @itemx -mtoc
15496 @opindex mno-toc
15497 @opindex mtoc
15498 On System V.4 and embedded PowerPC systems do not (do) assume that
15499 register 2 contains a pointer to a global area pointing to the addresses
15500 used in the program.
15502 @item -mlittle
15503 @itemx -mlittle-endian
15504 @opindex mlittle
15505 @opindex mlittle-endian
15506 On System V.4 and embedded PowerPC systems compile code for the
15507 processor in little endian mode.  The @option{-mlittle-endian} option is
15508 the same as @option{-mlittle}.
15510 @item -mbig
15511 @itemx -mbig-endian
15512 @opindex mbig
15513 @opindex mbig-endian
15514 On System V.4 and embedded PowerPC systems compile code for the
15515 processor in big endian mode.  The @option{-mbig-endian} option is
15516 the same as @option{-mbig}.
15518 @item -mdynamic-no-pic
15519 @opindex mdynamic-no-pic
15520 On Darwin and Mac OS X systems, compile code so that it is not
15521 relocatable, but that its external references are relocatable.  The
15522 resulting code is suitable for applications, but not shared
15523 libraries.
15525 @item -mprioritize-restricted-insns=@var{priority}
15526 @opindex mprioritize-restricted-insns
15527 This option controls the priority that is assigned to
15528 dispatch-slot restricted instructions during the second scheduling
15529 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
15530 @var{no/highest/second-highest} priority to dispatch slot restricted
15531 instructions.
15533 @item -msched-costly-dep=@var{dependence_type}
15534 @opindex msched-costly-dep
15535 This option controls which dependences are considered costly
15536 by the target during instruction scheduling.  The argument
15537 @var{dependence_type} takes one of the following values:
15538 @var{no}: no dependence is costly,
15539 @var{all}: all dependences are costly,
15540 @var{true_store_to_load}: a true dependence from store to load is costly,
15541 @var{store_to_load}: any dependence from store to load is costly,
15542 @var{number}: any dependence which latency >= @var{number} is costly.
15544 @item -minsert-sched-nops=@var{scheme}
15545 @opindex minsert-sched-nops
15546 This option controls which nop insertion scheme will be used during
15547 the second scheduling pass.  The argument @var{scheme} takes one of the
15548 following values:
15549 @var{no}: Don't insert nops.
15550 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15551 according to the scheduler's grouping.
15552 @var{regroup_exact}: Insert nops to force costly dependent insns into
15553 separate groups.  Insert exactly as many nops as needed to force an insn
15554 to a new group, according to the estimated processor grouping.
15555 @var{number}: Insert nops to force costly dependent insns into
15556 separate groups.  Insert @var{number} nops to force an insn to a new group.
15558 @item -mcall-sysv
15559 @opindex mcall-sysv
15560 On System V.4 and embedded PowerPC systems compile code using calling
15561 conventions that adheres to the March 1995 draft of the System V
15562 Application Binary Interface, PowerPC processor supplement.  This is the
15563 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15565 @item -mcall-sysv-eabi
15566 @itemx -mcall-eabi
15567 @opindex mcall-sysv-eabi
15568 @opindex mcall-eabi
15569 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15571 @item -mcall-sysv-noeabi
15572 @opindex mcall-sysv-noeabi
15573 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15575 @item -mcall-aixdesc
15576 @opindex m
15577 On System V.4 and embedded PowerPC systems compile code for the AIX
15578 operating system.
15580 @item -mcall-linux
15581 @opindex mcall-linux
15582 On System V.4 and embedded PowerPC systems compile code for the
15583 Linux-based GNU system.
15585 @item -mcall-gnu
15586 @opindex mcall-gnu
15587 On System V.4 and embedded PowerPC systems compile code for the
15588 Hurd-based GNU system.
15590 @item -mcall-freebsd
15591 @opindex mcall-freebsd
15592 On System V.4 and embedded PowerPC systems compile code for the
15593 FreeBSD operating system.
15595 @item -mcall-netbsd
15596 @opindex mcall-netbsd
15597 On System V.4 and embedded PowerPC systems compile code for the
15598 NetBSD operating system.
15600 @item -mcall-openbsd
15601 @opindex mcall-netbsd
15602 On System V.4 and embedded PowerPC systems compile code for the
15603 OpenBSD operating system.
15605 @item -maix-struct-return
15606 @opindex maix-struct-return
15607 Return all structures in memory (as specified by the AIX ABI)@.
15609 @item -msvr4-struct-return
15610 @opindex msvr4-struct-return
15611 Return structures smaller than 8 bytes in registers (as specified by the
15612 SVR4 ABI)@.
15614 @item -mabi=@var{abi-type}
15615 @opindex mabi
15616 Extend the current ABI with a particular extension, or remove such extension.
15617 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
15618 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
15620 @item -mabi=spe
15621 @opindex mabi=spe
15622 Extend the current ABI with SPE ABI extensions.  This does not change
15623 the default ABI, instead it adds the SPE ABI extensions to the current
15624 ABI@.
15626 @item -mabi=no-spe
15627 @opindex mabi=no-spe
15628 Disable Booke SPE ABI extensions for the current ABI@.
15630 @item -mabi=ibmlongdouble
15631 @opindex mabi=ibmlongdouble
15632 Change the current ABI to use IBM extended precision long double.
15633 This is a PowerPC 32-bit SYSV ABI option.
15635 @item -mabi=ieeelongdouble
15636 @opindex mabi=ieeelongdouble
15637 Change the current ABI to use IEEE extended precision long double.
15638 This is a PowerPC 32-bit Linux ABI option.
15640 @item -mprototype
15641 @itemx -mno-prototype
15642 @opindex mprototype
15643 @opindex mno-prototype
15644 On System V.4 and embedded PowerPC systems assume that all calls to
15645 variable argument functions are properly prototyped.  Otherwise, the
15646 compiler must insert an instruction before every non prototyped call to
15647 set or clear bit 6 of the condition code register (@var{CR}) to
15648 indicate whether floating point values were passed in the floating point
15649 registers in case the function takes a variable arguments.  With
15650 @option{-mprototype}, only calls to prototyped variable argument functions
15651 will set or clear the bit.
15653 @item -msim
15654 @opindex msim
15655 On embedded PowerPC systems, assume that the startup module is called
15656 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
15657 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
15658 configurations.
15660 @item -mmvme
15661 @opindex mmvme
15662 On embedded PowerPC systems, assume that the startup module is called
15663 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
15664 @file{libc.a}.
15666 @item -mads
15667 @opindex mads
15668 On embedded PowerPC systems, assume that the startup module is called
15669 @file{crt0.o} and the standard C libraries are @file{libads.a} and
15670 @file{libc.a}.
15672 @item -myellowknife
15673 @opindex myellowknife
15674 On embedded PowerPC systems, assume that the startup module is called
15675 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
15676 @file{libc.a}.
15678 @item -mvxworks
15679 @opindex mvxworks
15680 On System V.4 and embedded PowerPC systems, specify that you are
15681 compiling for a VxWorks system.
15683 @item -memb
15684 @opindex memb
15685 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
15686 header to indicate that @samp{eabi} extended relocations are used.
15688 @item -meabi
15689 @itemx -mno-eabi
15690 @opindex meabi
15691 @opindex mno-eabi
15692 On System V.4 and embedded PowerPC systems do (do not) adhere to the
15693 Embedded Applications Binary Interface (eabi) which is a set of
15694 modifications to the System V.4 specifications.  Selecting @option{-meabi}
15695 means that the stack is aligned to an 8 byte boundary, a function
15696 @code{__eabi} is called to from @code{main} to set up the eabi
15697 environment, and the @option{-msdata} option can use both @code{r2} and
15698 @code{r13} to point to two separate small data areas.  Selecting
15699 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
15700 do not call an initialization function from @code{main}, and the
15701 @option{-msdata} option will only use @code{r13} to point to a single
15702 small data area.  The @option{-meabi} option is on by default if you
15703 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
15705 @item -msdata=eabi
15706 @opindex msdata=eabi
15707 On System V.4 and embedded PowerPC systems, put small initialized
15708 @code{const} global and static data in the @samp{.sdata2} section, which
15709 is pointed to by register @code{r2}.  Put small initialized
15710 non-@code{const} global and static data in the @samp{.sdata} section,
15711 which is pointed to by register @code{r13}.  Put small uninitialized
15712 global and static data in the @samp{.sbss} section, which is adjacent to
15713 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
15714 incompatible with the @option{-mrelocatable} option.  The
15715 @option{-msdata=eabi} option also sets the @option{-memb} option.
15717 @item -msdata=sysv
15718 @opindex msdata=sysv
15719 On System V.4 and embedded PowerPC systems, put small global and static
15720 data in the @samp{.sdata} section, which is pointed to by register
15721 @code{r13}.  Put small uninitialized global and static data in the
15722 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15723 The @option{-msdata=sysv} option is incompatible with the
15724 @option{-mrelocatable} option.
15726 @item -msdata=default
15727 @itemx -msdata
15728 @opindex msdata=default
15729 @opindex msdata
15730 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15731 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15732 same as @option{-msdata=sysv}.
15734 @item -msdata=data
15735 @opindex msdata=data
15736 On System V.4 and embedded PowerPC systems, put small global
15737 data in the @samp{.sdata} section.  Put small uninitialized global
15738 data in the @samp{.sbss} section.  Do not use register @code{r13}
15739 to address small data however.  This is the default behavior unless
15740 other @option{-msdata} options are used.
15742 @item -msdata=none
15743 @itemx -mno-sdata
15744 @opindex msdata=none
15745 @opindex mno-sdata
15746 On embedded PowerPC systems, put all initialized global and static data
15747 in the @samp{.data} section, and all uninitialized data in the
15748 @samp{.bss} section.
15750 @item -mblock-move-inline-limit=@var{num}
15751 @opindex mblock-move-inline-limit
15752 Inline all block moves (such as calls to @code{memcpy} or structure
15753 copies) less than or equal to @var{num} bytes.  The minimum value for
15754 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
15755 targets.  The default value is target-specific.
15757 @item -G @var{num}
15758 @opindex G
15759 @cindex smaller data references (PowerPC)
15760 @cindex .sdata/.sdata2 references (PowerPC)
15761 On embedded PowerPC systems, put global and static items less than or
15762 equal to @var{num} bytes into the small data or bss sections instead of
15763 the normal data or bss section.  By default, @var{num} is 8.  The
15764 @option{-G @var{num}} switch is also passed to the linker.
15765 All modules should be compiled with the same @option{-G @var{num}} value.
15767 @item -mregnames
15768 @itemx -mno-regnames
15769 @opindex mregnames
15770 @opindex mno-regnames
15771 On System V.4 and embedded PowerPC systems do (do not) emit register
15772 names in the assembly language output using symbolic forms.
15774 @item -mlongcall
15775 @itemx -mno-longcall
15776 @opindex mlongcall
15777 @opindex mno-longcall
15778 By default assume that all calls are far away so that a longer more
15779 expensive calling sequence is required.  This is required for calls
15780 further than 32 megabytes (33,554,432 bytes) from the current location.
15781 A short call will be generated if the compiler knows
15782 the call cannot be that far away.  This setting can be overridden by
15783 the @code{shortcall} function attribute, or by @code{#pragma
15784 longcall(0)}.
15786 Some linkers are capable of detecting out-of-range calls and generating
15787 glue code on the fly.  On these systems, long calls are unnecessary and
15788 generate slower code.  As of this writing, the AIX linker can do this,
15789 as can the GNU linker for PowerPC/64.  It is planned to add this feature
15790 to the GNU linker for 32-bit PowerPC systems as well.
15792 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
15793 callee, L42'', plus a ``branch island'' (glue code).  The two target
15794 addresses represent the callee and the ``branch island''.  The
15795 Darwin/PPC linker will prefer the first address and generate a ``bl
15796 callee'' if the PPC ``bl'' instruction will reach the callee directly;
15797 otherwise, the linker will generate ``bl L42'' to call the ``branch
15798 island''.  The ``branch island'' is appended to the body of the
15799 calling function; it computes the full 32-bit address of the callee
15800 and jumps to it.
15802 On Mach-O (Darwin) systems, this option directs the compiler emit to
15803 the glue for every direct call, and the Darwin linker decides whether
15804 to use or discard it.
15806 In the future, we may cause GCC to ignore all longcall specifications
15807 when the linker is known to generate glue.
15809 @item -mtls-markers
15810 @itemx -mno-tls-markers
15811 @opindex mtls-markers
15812 @opindex mno-tls-markers
15813 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
15814 specifying the function argument.  The relocation allows ld to
15815 reliably associate function call with argument setup instructions for
15816 TLS optimization, which in turn allows gcc to better schedule the
15817 sequence.
15819 @item -pthread
15820 @opindex pthread
15821 Adds support for multithreading with the @dfn{pthreads} library.
15822 This option sets flags for both the preprocessor and linker.
15824 @item -mrecip
15825 @itemx -mno-recip
15826 @opindex mrecip
15827 This option will enable GCC to use the reciprocal estimate and
15828 reciprocal square root estimate instructions with additional
15829 Newton-Raphson steps to increase precision instead of doing a divide or
15830 square root and divide for floating point arguments.  You should use
15831 the @option{-ffast-math} option when using @option{-mrecip} (or at
15832 least @option{-funsafe-math-optimizations},
15833 @option{-finite-math-only}, @option{-freciprocal-math} and
15834 @option{-fno-trapping-math}).  Note that while the throughput of the
15835 sequence is generally higher than the throughput of the non-reciprocal
15836 instruction, the precision of the sequence can be decreased by up to 2
15837 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
15838 roots.
15840 @item -mrecip=@var{opt}
15841 @opindex mrecip=opt
15842 This option allows to control which reciprocal estimate instructions
15843 may be used.  @var{opt} is a comma separated list of options, that may
15844 be preceeded by a @code{!} to invert the option:
15845 @code{all}: enable all estimate instructions,
15846 @code{default}: enable the default instructions, equvalent to @option{-mrecip},
15847 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
15848 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
15849 @code{divf}: enable the single precision reciprocal approximation instructions;
15850 @code{divd}: enable the double precision reciprocal approximation instructions;
15851 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
15852 @code{rsqrtf}: enable the single precision reciprocal square root approximation instructions;
15853 @code{rsqrtd}: enable the double precision reciprocal square root approximation instructions;
15855 So for example, @option{-mrecip=all,!rsqrtd} would enable the
15856 all of the reciprocal estimate instructions, except for the
15857 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
15858 which handle the double precision reciprocal square root calculations.
15860 @item -mrecip-precision
15861 @itemx -mno-recip-precision
15862 @opindex mrecip-precision
15863 Assume (do not assume) that the reciprocal estimate instructions
15864 provide higher precision estimates than is mandated by the powerpc
15865 ABI.  Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
15866 automatically selects @option{-mrecip-precision}.  The double
15867 precision square root estimate instructions are not generated by
15868 default on low precision machines, since they do not provide an
15869 estimate that converges after three steps.
15871 @item -mveclibabi=@var{type}
15872 @opindex mveclibabi
15873 Specifies the ABI type to use for vectorizing intrinsics using an
15874 external library.  The only type supported at present is @code{mass},
15875 which specifies to use IBM's Mathematical Acceleration Subsystem
15876 (MASS) libraries for vectorizing intrinsics using external libraries.
15877 GCC will currently emit calls to @code{acosd2}, @code{acosf4},
15878 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
15879 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
15880 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
15881 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
15882 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
15883 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
15884 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
15885 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
15886 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
15887 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
15888 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
15889 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
15890 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
15891 for power7.  Both @option{-ftree-vectorize} and
15892 @option{-funsafe-math-optimizations} have to be enabled.  The MASS
15893 libraries will have to be specified at link time.
15894 @end table
15896 @node RX Options
15897 @subsection RX Options
15898 @cindex RX Options
15900 These command line options are defined for RX targets:
15902 @table @gcctabopt
15903 @item -m64bit-doubles
15904 @itemx -m32bit-doubles
15905 @opindex m64bit-doubles
15906 @opindex m32bit-doubles
15907 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
15908 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
15909 @option{-m32bit-doubles}.  @emph{Note} RX floating point hardware only
15910 works on 32-bit values, which is why the default is
15911 @option{-m32bit-doubles}.
15913 @item -fpu
15914 @itemx -nofpu
15915 @opindex fpu
15916 @opindex nofpu
15917 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
15918 floating point hardware.  The default is enabled for the @var{RX600}
15919 series and disabled for the @var{RX200} series.
15921 Floating point instructions will only be generated for 32-bit floating
15922 point values however, so if the @option{-m64bit-doubles} option is in
15923 use then the FPU hardware will not be used for doubles.
15925 @emph{Note} If the @option{-fpu} option is enabled then
15926 @option{-funsafe-math-optimizations} is also enabled automatically.
15927 This is because the RX FPU instructions are themselves unsafe.
15929 @item -mcpu=@var{name}
15930 @opindex -mcpu
15931 Selects the type of RX CPU to be targeted.  Currently three types are
15932 supported, the generic @var{RX600} and @var{RX200} series hardware and
15933 the specific @var{RX610} cpu.  The default is @var{RX600}.
15935 The only difference between @var{RX600} and @var{RX610} is that the
15936 @var{RX610} does not support the @code{MVTIPL} instruction.
15938 The @var{RX200} series does not have a hardware floating point unit
15939 and so @option{-nofpu} is enabled by default when this type is
15940 selected.
15942 @item -mbig-endian-data
15943 @itemx -mlittle-endian-data
15944 @opindex mbig-endian-data
15945 @opindex mlittle-endian-data
15946 Store data (but not code) in the big-endian format.  The default is
15947 @option{-mlittle-endian-data}, ie to store data in the little endian
15948 format.
15950 @item -msmall-data-limit=@var{N}
15951 @opindex msmall-data-limit
15952 Specifies the maximum size in bytes of global and static variables
15953 which can be placed into the small data area.  Using the small data
15954 area can lead to smaller and faster code, but the size of area is
15955 limited and it is up to the programmer to ensure that the area does
15956 not overflow.  Also when the small data area is used one of the RX's
15957 registers (@code{r13}) is reserved for use pointing to this area, so
15958 it is no longer available for use by the compiler.  This could result
15959 in slower and/or larger code if variables which once could have been
15960 held in @code{r13} are now pushed onto the stack.
15962 Note, common variables (variables which have not been initialised) and
15963 constants are not placed into the small data area as they are assigned
15964 to other sections in the output executable.
15966 The default value is zero, which disables this feature.  Note, this
15967 feature is not enabled by default with higher optimization levels
15968 (@option{-O2} etc) because of the potentially detrimental effects of
15969 reserving register @code{r13}.  It is up to the programmer to
15970 experiment and discover whether this feature is of benefit to their
15971 program.
15973 @item -msim
15974 @itemx -mno-sim
15975 @opindex msim
15976 @opindex mno-sim
15977 Use the simulator runtime.  The default is to use the libgloss board
15978 specific runtime.
15980 @item -mas100-syntax
15981 @itemx -mno-as100-syntax
15982 @opindex mas100-syntax
15983 @opindex mno-as100-syntax
15984 When generating assembler output use a syntax that is compatible with
15985 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
15986 assembler but it has some restrictions so generating it is not the
15987 default option.
15989 @item -mmax-constant-size=@var{N}
15990 @opindex mmax-constant-size
15991 Specifies the maximum size, in bytes, of a constant that can be used as
15992 an operand in a RX instruction.  Although the RX instruction set does
15993 allow constants of up to 4 bytes in length to be used in instructions,
15994 a longer value equates to a longer instruction.  Thus in some
15995 circumstances it can be beneficial to restrict the size of constants
15996 that are used in instructions.  Constants that are too big are instead
15997 placed into a constant pool and referenced via register indirection.
15999 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
16000 or 4 means that constants of any size are allowed.
16002 @item -mrelax
16003 @opindex mrelax
16004 Enable linker relaxation.  Linker relaxation is a process whereby the
16005 linker will attempt to reduce the size of a program by finding shorter
16006 versions of various instructions.  Disabled by default.
16008 @item -mint-register=@var{N}
16009 @opindex mint-register
16010 Specify the number of registers to reserve for fast interrupt handler
16011 functions.  The value @var{N} can be between 0 and 4.  A value of 1
16012 means that register @code{r13} will be reserved for the exclusive use
16013 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
16014 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
16015 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
16016 A value of 0, the default, does not reserve any registers.
16018 @item -msave-acc-in-interrupts
16019 @opindex msave-acc-in-interrupts
16020 Specifies that interrupt handler functions should preserve the
16021 accumulator register.  This is only necessary if normal code might use
16022 the accumulator register, for example because it performs 64-bit
16023 multiplications.  The default is to ignore the accumulator as this
16024 makes the interrupt handlers faster.
16026 @end table
16028 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
16029 has special significance to the RX port when used with the
16030 @code{interrupt} function attribute.  This attribute indicates a
16031 function intended to process fast interrupts.  GCC will will ensure
16032 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
16033 and/or @code{r13} and only provided that the normal use of the
16034 corresponding registers have been restricted via the
16035 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
16036 options.
16038 @node S/390 and zSeries Options
16039 @subsection S/390 and zSeries Options
16040 @cindex S/390 and zSeries Options
16042 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
16044 @table @gcctabopt
16045 @item -mhard-float
16046 @itemx -msoft-float
16047 @opindex mhard-float
16048 @opindex msoft-float
16049 Use (do not use) the hardware floating-point instructions and registers
16050 for floating-point operations.  When @option{-msoft-float} is specified,
16051 functions in @file{libgcc.a} will be used to perform floating-point
16052 operations.  When @option{-mhard-float} is specified, the compiler
16053 generates IEEE floating-point instructions.  This is the default.
16055 @item -mhard-dfp
16056 @itemx -mno-hard-dfp
16057 @opindex mhard-dfp
16058 @opindex mno-hard-dfp
16059 Use (do not use) the hardware decimal-floating-point instructions for
16060 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
16061 specified, functions in @file{libgcc.a} will be used to perform
16062 decimal-floating-point operations.  When @option{-mhard-dfp} is
16063 specified, the compiler generates decimal-floating-point hardware
16064 instructions.  This is the default for @option{-march=z9-ec} or higher.
16066 @item -mlong-double-64
16067 @itemx -mlong-double-128
16068 @opindex mlong-double-64
16069 @opindex mlong-double-128
16070 These switches control the size of @code{long double} type. A size
16071 of 64bit makes the @code{long double} type equivalent to the @code{double}
16072 type. This is the default.
16074 @item -mbackchain
16075 @itemx -mno-backchain
16076 @opindex mbackchain
16077 @opindex mno-backchain
16078 Store (do not store) the address of the caller's frame as backchain pointer
16079 into the callee's stack frame.
16080 A backchain may be needed to allow debugging using tools that do not understand
16081 DWARF-2 call frame information.
16082 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
16083 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
16084 the backchain is placed into the topmost word of the 96/160 byte register
16085 save area.
16087 In general, code compiled with @option{-mbackchain} is call-compatible with
16088 code compiled with @option{-mmo-backchain}; however, use of the backchain
16089 for debugging purposes usually requires that the whole binary is built with
16090 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
16091 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
16092 to build a linux kernel use @option{-msoft-float}.
16094 The default is to not maintain the backchain.
16096 @item -mpacked-stack
16097 @itemx -mno-packed-stack
16098 @opindex mpacked-stack
16099 @opindex mno-packed-stack
16100 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
16101 specified, the compiler uses the all fields of the 96/160 byte register save
16102 area only for their default purpose; unused fields still take up stack space.
16103 When @option{-mpacked-stack} is specified, register save slots are densely
16104 packed at the top of the register save area; unused space is reused for other
16105 purposes, allowing for more efficient use of the available stack space.
16106 However, when @option{-mbackchain} is also in effect, the topmost word of
16107 the save area is always used to store the backchain, and the return address
16108 register is always saved two words below the backchain.
16110 As long as the stack frame backchain is not used, code generated with
16111 @option{-mpacked-stack} is call-compatible with code generated with
16112 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
16113 S/390 or zSeries generated code that uses the stack frame backchain at run
16114 time, not just for debugging purposes.  Such code is not call-compatible
16115 with code compiled with @option{-mpacked-stack}.  Also, note that the
16116 combination of @option{-mbackchain},
16117 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
16118 to build a linux kernel use @option{-msoft-float}.
16120 The default is to not use the packed stack layout.
16122 @item -msmall-exec
16123 @itemx -mno-small-exec
16124 @opindex msmall-exec
16125 @opindex mno-small-exec
16126 Generate (or do not generate) code using the @code{bras} instruction
16127 to do subroutine calls.
16128 This only works reliably if the total executable size does not
16129 exceed 64k.  The default is to use the @code{basr} instruction instead,
16130 which does not have this limitation.
16132 @item -m64
16133 @itemx -m31
16134 @opindex m64
16135 @opindex m31
16136 When @option{-m31} is specified, generate code compliant to the
16137 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
16138 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
16139 particular to generate 64-bit instructions.  For the @samp{s390}
16140 targets, the default is @option{-m31}, while the @samp{s390x}
16141 targets default to @option{-m64}.
16143 @item -mzarch
16144 @itemx -mesa
16145 @opindex mzarch
16146 @opindex mesa
16147 When @option{-mzarch} is specified, generate code using the
16148 instructions available on z/Architecture.
16149 When @option{-mesa} is specified, generate code using the
16150 instructions available on ESA/390.  Note that @option{-mesa} is
16151 not possible with @option{-m64}.
16152 When generating code compliant to the GNU/Linux for S/390 ABI,
16153 the default is @option{-mesa}.  When generating code compliant
16154 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
16156 @item -mmvcle
16157 @itemx -mno-mvcle
16158 @opindex mmvcle
16159 @opindex mno-mvcle
16160 Generate (or do not generate) code using the @code{mvcle} instruction
16161 to perform block moves.  When @option{-mno-mvcle} is specified,
16162 use a @code{mvc} loop instead.  This is the default unless optimizing for
16163 size.
16165 @item -mdebug
16166 @itemx -mno-debug
16167 @opindex mdebug
16168 @opindex mno-debug
16169 Print (or do not print) additional debug information when compiling.
16170 The default is to not print debug information.
16172 @item -march=@var{cpu-type}
16173 @opindex march
16174 Generate code that will run on @var{cpu-type}, which is the name of a system
16175 representing a certain processor type.  Possible values for
16176 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
16177 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
16178 When generating code using the instructions available on z/Architecture,
16179 the default is @option{-march=z900}.  Otherwise, the default is
16180 @option{-march=g5}.
16182 @item -mtune=@var{cpu-type}
16183 @opindex mtune
16184 Tune to @var{cpu-type} everything applicable about the generated code,
16185 except for the ABI and the set of available instructions.
16186 The list of @var{cpu-type} values is the same as for @option{-march}.
16187 The default is the value used for @option{-march}.
16189 @item -mtpf-trace
16190 @itemx -mno-tpf-trace
16191 @opindex mtpf-trace
16192 @opindex mno-tpf-trace
16193 Generate code that adds (does not add) in TPF OS specific branches to trace
16194 routines in the operating system.  This option is off by default, even
16195 when compiling for the TPF OS@.
16197 @item -mfused-madd
16198 @itemx -mno-fused-madd
16199 @opindex mfused-madd
16200 @opindex mno-fused-madd
16201 Generate code that uses (does not use) the floating point multiply and
16202 accumulate instructions.  These instructions are generated by default if
16203 hardware floating point is used.
16205 @item -mwarn-framesize=@var{framesize}
16206 @opindex mwarn-framesize
16207 Emit a warning if the current function exceeds the given frame size.  Because
16208 this is a compile time check it doesn't need to be a real problem when the program
16209 runs.  It is intended to identify functions which most probably cause
16210 a stack overflow.  It is useful to be used in an environment with limited stack
16211 size e.g.@: the linux kernel.
16213 @item -mwarn-dynamicstack
16214 @opindex mwarn-dynamicstack
16215 Emit a warning if the function calls alloca or uses dynamically
16216 sized arrays.  This is generally a bad idea with a limited stack size.
16218 @item -mstack-guard=@var{stack-guard}
16219 @itemx -mstack-size=@var{stack-size}
16220 @opindex mstack-guard
16221 @opindex mstack-size
16222 If these options are provided the s390 back end emits additional instructions in
16223 the function prologue which trigger a trap if the stack size is @var{stack-guard}
16224 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
16225 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
16226 the frame size of the compiled function is chosen.
16227 These options are intended to be used to help debugging stack overflow problems.
16228 The additionally emitted code causes only little overhead and hence can also be
16229 used in production like systems without greater performance degradation.  The given
16230 values have to be exact powers of 2 and @var{stack-size} has to be greater than
16231 @var{stack-guard} without exceeding 64k.
16232 In order to be efficient the extra code makes the assumption that the stack starts
16233 at an address aligned to the value given by @var{stack-size}.
16234 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
16235 @end table
16237 @node Score Options
16238 @subsection Score Options
16239 @cindex Score Options
16241 These options are defined for Score implementations:
16243 @table @gcctabopt
16244 @item -meb
16245 @opindex meb
16246 Compile code for big endian mode.  This is the default.
16248 @item -mel
16249 @opindex mel
16250 Compile code for little endian mode.
16252 @item -mnhwloop
16253 @opindex mnhwloop
16254 Disable generate bcnz instruction.
16256 @item -muls
16257 @opindex muls
16258 Enable generate unaligned load and store instruction.
16260 @item -mmac
16261 @opindex mmac
16262 Enable the use of multiply-accumulate instructions. Disabled by default.
16264 @item -mscore5
16265 @opindex mscore5
16266 Specify the SCORE5 as the target architecture.
16268 @item -mscore5u
16269 @opindex mscore5u
16270 Specify the SCORE5U of the target architecture.
16272 @item -mscore7
16273 @opindex mscore7
16274 Specify the SCORE7 as the target architecture. This is the default.
16276 @item -mscore7d
16277 @opindex mscore7d
16278 Specify the SCORE7D as the target architecture.
16279 @end table
16281 @node SH Options
16282 @subsection SH Options
16284 These @samp{-m} options are defined for the SH implementations:
16286 @table @gcctabopt
16287 @item -m1
16288 @opindex m1
16289 Generate code for the SH1.
16291 @item -m2
16292 @opindex m2
16293 Generate code for the SH2.
16295 @item -m2e
16296 Generate code for the SH2e.
16298 @item -m2a-nofpu
16299 @opindex m2a-nofpu
16300 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
16301 that the floating-point unit is not used.
16303 @item -m2a-single-only
16304 @opindex m2a-single-only
16305 Generate code for the SH2a-FPU, in such a way that no double-precision
16306 floating point operations are used.
16308 @item -m2a-single
16309 @opindex m2a-single
16310 Generate code for the SH2a-FPU assuming the floating-point unit is in
16311 single-precision mode by default.
16313 @item -m2a
16314 @opindex m2a
16315 Generate code for the SH2a-FPU assuming the floating-point unit is in
16316 double-precision mode by default.
16318 @item -m3
16319 @opindex m3
16320 Generate code for the SH3.
16322 @item -m3e
16323 @opindex m3e
16324 Generate code for the SH3e.
16326 @item -m4-nofpu
16327 @opindex m4-nofpu
16328 Generate code for the SH4 without a floating-point unit.
16330 @item -m4-single-only
16331 @opindex m4-single-only
16332 Generate code for the SH4 with a floating-point unit that only
16333 supports single-precision arithmetic.
16335 @item -m4-single
16336 @opindex m4-single
16337 Generate code for the SH4 assuming the floating-point unit is in
16338 single-precision mode by default.
16340 @item -m4
16341 @opindex m4
16342 Generate code for the SH4.
16344 @item -m4a-nofpu
16345 @opindex m4a-nofpu
16346 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
16347 floating-point unit is not used.
16349 @item -m4a-single-only
16350 @opindex m4a-single-only
16351 Generate code for the SH4a, in such a way that no double-precision
16352 floating point operations are used.
16354 @item -m4a-single
16355 @opindex m4a-single
16356 Generate code for the SH4a assuming the floating-point unit is in
16357 single-precision mode by default.
16359 @item -m4a
16360 @opindex m4a
16361 Generate code for the SH4a.
16363 @item -m4al
16364 @opindex m4al
16365 Same as @option{-m4a-nofpu}, except that it implicitly passes
16366 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
16367 instructions at the moment.
16369 @item -mb
16370 @opindex mb
16371 Compile code for the processor in big endian mode.
16373 @item -ml
16374 @opindex ml
16375 Compile code for the processor in little endian mode.
16377 @item -mdalign
16378 @opindex mdalign
16379 Align doubles at 64-bit boundaries.  Note that this changes the calling
16380 conventions, and thus some functions from the standard C library will
16381 not work unless you recompile it first with @option{-mdalign}.
16383 @item -mrelax
16384 @opindex mrelax
16385 Shorten some address references at link time, when possible; uses the
16386 linker option @option{-relax}.
16388 @item -mbigtable
16389 @opindex mbigtable
16390 Use 32-bit offsets in @code{switch} tables.  The default is to use
16391 16-bit offsets.
16393 @item -mbitops
16394 @opindex mbitops
16395 Enable the use of bit manipulation instructions on SH2A.
16397 @item -mfmovd
16398 @opindex mfmovd
16399 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
16400 alignment constraints.
16402 @item -mhitachi
16403 @opindex mhitachi
16404 Comply with the calling conventions defined by Renesas.
16406 @item -mrenesas
16407 @opindex mhitachi
16408 Comply with the calling conventions defined by Renesas.
16410 @item -mno-renesas
16411 @opindex mhitachi
16412 Comply with the calling conventions defined for GCC before the Renesas
16413 conventions were available.  This option is the default for all
16414 targets of the SH toolchain except for @samp{sh-symbianelf}.
16416 @item -mnomacsave
16417 @opindex mnomacsave
16418 Mark the @code{MAC} register as call-clobbered, even if
16419 @option{-mhitachi} is given.
16421 @item -mieee
16422 @opindex mieee
16423 Increase IEEE-compliance of floating-point code.
16424 At the moment, this is equivalent to @option{-fno-finite-math-only}.
16425 When generating 16 bit SH opcodes, getting IEEE-conforming results for
16426 comparisons of NANs / infinities incurs extra overhead in every
16427 floating point comparison, therefore the default is set to
16428 @option{-ffinite-math-only}.
16430 @item -minline-ic_invalidate
16431 @opindex minline-ic_invalidate
16432 Inline code to invalidate instruction cache entries after setting up
16433 nested function trampolines.
16434 This option has no effect if -musermode is in effect and the selected
16435 code generation option (e.g. -m4) does not allow the use of the icbi
16436 instruction.
16437 If the selected code generation option does not allow the use of the icbi
16438 instruction, and -musermode is not in effect, the inlined code will
16439 manipulate the instruction cache address array directly with an associative
16440 write.  This not only requires privileged mode, but it will also
16441 fail if the cache line had been mapped via the TLB and has become unmapped.
16443 @item -misize
16444 @opindex misize
16445 Dump instruction size and location in the assembly code.
16447 @item -mpadstruct
16448 @opindex mpadstruct
16449 This option is deprecated.  It pads structures to multiple of 4 bytes,
16450 which is incompatible with the SH ABI@.
16452 @item -mspace
16453 @opindex mspace
16454 Optimize for space instead of speed.  Implied by @option{-Os}.
16456 @item -mprefergot
16457 @opindex mprefergot
16458 When generating position-independent code, emit function calls using
16459 the Global Offset Table instead of the Procedure Linkage Table.
16461 @item -musermode
16462 @opindex musermode
16463 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
16464 if the inlined code would not work in user mode.
16465 This is the default when the target is @code{sh-*-linux*}.
16467 @item -multcost=@var{number}
16468 @opindex multcost=@var{number}
16469 Set the cost to assume for a multiply insn.
16471 @item -mdiv=@var{strategy}
16472 @opindex mdiv=@var{strategy}
16473 Set the division strategy to use for SHmedia code.  @var{strategy} must be
16474 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
16475 inv:call2, inv:fp .
16476 "fp" performs the operation in floating point.  This has a very high latency,
16477 but needs only a few instructions, so it might be a good choice if
16478 your code has enough easily exploitable ILP to allow the compiler to
16479 schedule the floating point instructions together with other instructions.
16480 Division by zero causes a floating point exception.
16481 "inv" uses integer operations to calculate the inverse of the divisor,
16482 and then multiplies the dividend with the inverse.  This strategy allows
16483 cse and hoisting of the inverse calculation.  Division by zero calculates
16484 an unspecified result, but does not trap.
16485 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
16486 have been found, or if the entire operation has been hoisted to the same
16487 place, the last stages of the inverse calculation are intertwined with the
16488 final multiply to reduce the overall latency, at the expense of using a few
16489 more instructions, and thus offering fewer scheduling opportunities with
16490 other code.
16491 "call" calls a library function that usually implements the inv:minlat
16492 strategy.
16493 This gives high code density for m5-*media-nofpu compilations.
16494 "call2" uses a different entry point of the same library function, where it
16495 assumes that a pointer to a lookup table has already been set up, which
16496 exposes the pointer load to cse / code hoisting optimizations.
16497 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16498 code generation, but if the code stays unoptimized, revert to the "call",
16499 "call2", or "fp" strategies, respectively.  Note that the
16500 potentially-trapping side effect of division by zero is carried by a
16501 separate instruction, so it is possible that all the integer instructions
16502 are hoisted out, but the marker for the side effect stays where it is.
16503 A recombination to fp operations or a call is not possible in that case.
16504 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
16505 that the inverse calculation was nor separated from the multiply, they speed
16506 up division where the dividend fits into 20 bits (plus sign where applicable),
16507 by inserting a test to skip a number of operations in this case; this test
16508 slows down the case of larger dividends.  inv20u assumes the case of a such
16509 a small dividend to be unlikely, and inv20l assumes it to be likely.
16511 @item -maccumulate-outgoing-args
16512 @opindex maccumulate-outgoing-args
16513 Reserve space once for outgoing arguments in the function prologue rather 
16514 than around each call.  Generally beneficial for performance and size.  Also
16515 needed for unwinding to avoid changing the stack frame around conditional code.
16517 @item -mdivsi3_libfunc=@var{name}
16518 @opindex mdivsi3_libfunc=@var{name}
16519 Set the name of the library function used for 32 bit signed division to
16520 @var{name}.  This only affect the name used in the call and inv:call
16521 division strategies, and the compiler will still expect the same
16522 sets of input/output/clobbered registers as if this option was not present.
16524 @item -mfixed-range=@var{register-range}
16525 @opindex mfixed-range
16526 Generate code treating the given register range as fixed registers.
16527 A fixed register is one that the register allocator can not use.  This is
16528 useful when compiling kernel code.  A register range is specified as
16529 two registers separated by a dash.  Multiple register ranges can be
16530 specified separated by a comma.
16532 @item -madjust-unroll
16533 @opindex madjust-unroll
16534 Throttle unrolling to avoid thrashing target registers.
16535 This option only has an effect if the gcc code base supports the
16536 TARGET_ADJUST_UNROLL_MAX target hook.
16538 @item -mindexed-addressing
16539 @opindex mindexed-addressing
16540 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16541 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16542 semantics for the indexed addressing mode.  The architecture allows the
16543 implementation of processors with 64 bit MMU, which the OS could use to
16544 get 32 bit addressing, but since no current hardware implementation supports
16545 this or any other way to make the indexed addressing mode safe to use in
16546 the 32 bit ABI, the default is -mno-indexed-addressing.
16548 @item -mgettrcost=@var{number}
16549 @opindex mgettrcost=@var{number}
16550 Set the cost assumed for the gettr instruction to @var{number}.
16551 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16553 @item -mpt-fixed
16554 @opindex mpt-fixed
16555 Assume pt* instructions won't trap.  This will generally generate better
16556 scheduled code, but is unsafe on current hardware.  The current architecture
16557 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16558 This has the unintentional effect of making it unsafe to schedule ptabs /
16559 ptrel before a branch, or hoist it out of a loop.  For example,
16560 __do_global_ctors, a part of libgcc that runs constructors at program
16561 startup, calls functions in a list which is delimited by @minus{}1.  With the
16562 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16563 That means that all the constructors will be run a bit quicker, but when
16564 the loop comes to the end of the list, the program crashes because ptabs
16565 loads @minus{}1 into a target register.  Since this option is unsafe for any
16566 hardware implementing the current architecture specification, the default
16567 is -mno-pt-fixed.  Unless the user specifies a specific cost with
16568 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16569 this deters register allocation using target registers for storing
16570 ordinary integers.
16572 @item -minvalid-symbols
16573 @opindex minvalid-symbols
16574 Assume symbols might be invalid.  Ordinary function symbols generated by
16575 the compiler will always be valid to load with movi/shori/ptabs or
16576 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16577 to generate symbols that will cause ptabs / ptrel to trap.
16578 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16579 It will then prevent cross-basic-block cse, hoisting and most scheduling
16580 of symbol loads.  The default is @option{-mno-invalid-symbols}.
16581 @end table
16583 @node SPARC Options
16584 @subsection SPARC Options
16585 @cindex SPARC options
16587 These @samp{-m} options are supported on the SPARC:
16589 @table @gcctabopt
16590 @item -mno-app-regs
16591 @itemx -mapp-regs
16592 @opindex mno-app-regs
16593 @opindex mapp-regs
16594 Specify @option{-mapp-regs} to generate output using the global registers
16595 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
16596 is the default.
16598 To be fully SVR4 ABI compliant at the cost of some performance loss,
16599 specify @option{-mno-app-regs}.  You should compile libraries and system
16600 software with this option.
16602 @item -mfpu
16603 @itemx -mhard-float
16604 @opindex mfpu
16605 @opindex mhard-float
16606 Generate output containing floating point instructions.  This is the
16607 default.
16609 @item -mno-fpu
16610 @itemx -msoft-float
16611 @opindex mno-fpu
16612 @opindex msoft-float
16613 Generate output containing library calls for floating point.
16614 @strong{Warning:} the requisite libraries are not available for all SPARC
16615 targets.  Normally the facilities of the machine's usual C compiler are
16616 used, but this cannot be done directly in cross-compilation.  You must make
16617 your own arrangements to provide suitable library functions for
16618 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
16619 @samp{sparclite-*-*} do provide software floating point support.
16621 @option{-msoft-float} changes the calling convention in the output file;
16622 therefore, it is only useful if you compile @emph{all} of a program with
16623 this option.  In particular, you need to compile @file{libgcc.a}, the
16624 library that comes with GCC, with @option{-msoft-float} in order for
16625 this to work.
16627 @item -mhard-quad-float
16628 @opindex mhard-quad-float
16629 Generate output containing quad-word (long double) floating point
16630 instructions.
16632 @item -msoft-quad-float
16633 @opindex msoft-quad-float
16634 Generate output containing library calls for quad-word (long double)
16635 floating point instructions.  The functions called are those specified
16636 in the SPARC ABI@.  This is the default.
16638 As of this writing, there are no SPARC implementations that have hardware
16639 support for the quad-word floating point instructions.  They all invoke
16640 a trap handler for one of these instructions, and then the trap handler
16641 emulates the effect of the instruction.  Because of the trap handler overhead,
16642 this is much slower than calling the ABI library routines.  Thus the
16643 @option{-msoft-quad-float} option is the default.
16645 @item -mno-unaligned-doubles
16646 @itemx -munaligned-doubles
16647 @opindex mno-unaligned-doubles
16648 @opindex munaligned-doubles
16649 Assume that doubles have 8 byte alignment.  This is the default.
16651 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
16652 alignment only if they are contained in another type, or if they have an
16653 absolute address.  Otherwise, it assumes they have 4 byte alignment.
16654 Specifying this option avoids some rare compatibility problems with code
16655 generated by other compilers.  It is not the default because it results
16656 in a performance loss, especially for floating point code.
16658 @item -mno-faster-structs
16659 @itemx -mfaster-structs
16660 @opindex mno-faster-structs
16661 @opindex mfaster-structs
16662 With @option{-mfaster-structs}, the compiler assumes that structures
16663 should have 8 byte alignment.  This enables the use of pairs of
16664 @code{ldd} and @code{std} instructions for copies in structure
16665 assignment, in place of twice as many @code{ld} and @code{st} pairs.
16666 However, the use of this changed alignment directly violates the SPARC
16667 ABI@.  Thus, it's intended only for use on targets where the developer
16668 acknowledges that their resulting code will not be directly in line with
16669 the rules of the ABI@.
16671 @item -mimpure-text
16672 @opindex mimpure-text
16673 @option{-mimpure-text}, used in addition to @option{-shared}, tells
16674 the compiler to not pass @option{-z text} to the linker when linking a
16675 shared object.  Using this option, you can link position-dependent
16676 code into a shared object.
16678 @option{-mimpure-text} suppresses the ``relocations remain against
16679 allocatable but non-writable sections'' linker error message.
16680 However, the necessary relocations will trigger copy-on-write, and the
16681 shared object is not actually shared across processes.  Instead of
16682 using @option{-mimpure-text}, you should compile all source code with
16683 @option{-fpic} or @option{-fPIC}.
16685 This option is only available on SunOS and Solaris.
16687 @item -mcpu=@var{cpu_type}
16688 @opindex mcpu
16689 Set the instruction set, register set, and instruction scheduling parameters
16690 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
16691 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
16692 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
16693 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
16694 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
16696 Default instruction scheduling parameters are used for values that select
16697 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
16698 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
16700 Here is a list of each supported architecture and their supported
16701 implementations.
16703 @smallexample
16704     v7:             cypress
16705     v8:             supersparc, hypersparc
16706     sparclite:      f930, f934, sparclite86x
16707     sparclet:       tsc701
16708     v9:             ultrasparc, ultrasparc3, niagara, niagara2
16709 @end smallexample
16711 By default (unless configured otherwise), GCC generates code for the V7
16712 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
16713 additionally optimizes it for the Cypress CY7C602 chip, as used in the
16714 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
16715 SPARCStation 1, 2, IPX etc.
16717 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
16718 architecture.  The only difference from V7 code is that the compiler emits
16719 the integer multiply and integer divide instructions which exist in SPARC-V8
16720 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
16721 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
16722 2000 series.
16724 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
16725 the SPARC architecture.  This adds the integer multiply, integer divide step
16726 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
16727 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
16728 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
16729 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
16730 MB86934 chip, which is the more recent SPARClite with FPU@.
16732 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
16733 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
16734 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
16735 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
16736 optimizes it for the TEMIC SPARClet chip.
16738 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
16739 architecture.  This adds 64-bit integer and floating-point move instructions,
16740 3 additional floating-point condition code registers and conditional move
16741 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
16742 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
16743 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
16744 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
16745 @option{-mcpu=niagara}, the compiler additionally optimizes it for
16746 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
16747 additionally optimizes it for Sun UltraSPARC T2 chips.
16749 @item -mtune=@var{cpu_type}
16750 @opindex mtune
16751 Set the instruction scheduling parameters for machine type
16752 @var{cpu_type}, but do not set the instruction set or register set that the
16753 option @option{-mcpu=@var{cpu_type}} would.
16755 The same values for @option{-mcpu=@var{cpu_type}} can be used for
16756 @option{-mtune=@var{cpu_type}}, but the only useful values are those
16757 that select a particular cpu implementation.  Those are @samp{cypress},
16758 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
16759 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
16760 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
16762 @item -mv8plus
16763 @itemx -mno-v8plus
16764 @opindex mv8plus
16765 @opindex mno-v8plus
16766 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
16767 difference from the V8 ABI is that the global and out registers are
16768 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
16769 mode for all SPARC-V9 processors.
16771 @item -mvis
16772 @itemx -mno-vis
16773 @opindex mvis
16774 @opindex mno-vis
16775 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
16776 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
16777 @end table
16779 These @samp{-m} options are supported in addition to the above
16780 on SPARC-V9 processors in 64-bit environments:
16782 @table @gcctabopt
16783 @item -mlittle-endian
16784 @opindex mlittle-endian
16785 Generate code for a processor running in little-endian mode.  It is only
16786 available for a few configurations and most notably not on Solaris and Linux.
16788 @item -m32
16789 @itemx -m64
16790 @opindex m32
16791 @opindex m64
16792 Generate code for a 32-bit or 64-bit environment.
16793 The 32-bit environment sets int, long and pointer to 32 bits.
16794 The 64-bit environment sets int to 32 bits and long and pointer
16795 to 64 bits.
16797 @item -mcmodel=medlow
16798 @opindex mcmodel=medlow
16799 Generate code for the Medium/Low code model: 64-bit addresses, programs
16800 must be linked in the low 32 bits of memory.  Programs can be statically
16801 or dynamically linked.
16803 @item -mcmodel=medmid
16804 @opindex mcmodel=medmid
16805 Generate code for the Medium/Middle code model: 64-bit addresses, programs
16806 must be linked in the low 44 bits of memory, the text and data segments must
16807 be less than 2GB in size and the data segment must be located within 2GB of
16808 the text segment.
16810 @item -mcmodel=medany
16811 @opindex mcmodel=medany
16812 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
16813 may be linked anywhere in memory, the text and data segments must be less
16814 than 2GB in size and the data segment must be located within 2GB of the
16815 text segment.
16817 @item -mcmodel=embmedany
16818 @opindex mcmodel=embmedany
16819 Generate code for the Medium/Anywhere code model for embedded systems:
16820 64-bit addresses, the text and data segments must be less than 2GB in
16821 size, both starting anywhere in memory (determined at link time).  The
16822 global register %g4 points to the base of the data segment.  Programs
16823 are statically linked and PIC is not supported.
16825 @item -mstack-bias
16826 @itemx -mno-stack-bias
16827 @opindex mstack-bias
16828 @opindex mno-stack-bias
16829 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
16830 frame pointer if present, are offset by @minus{}2047 which must be added back
16831 when making stack frame references.  This is the default in 64-bit mode.
16832 Otherwise, assume no such offset is present.
16833 @end table
16835 These switches are supported in addition to the above on Solaris:
16837 @table @gcctabopt
16838 @item -threads
16839 @opindex threads
16840 Add support for multithreading using the Solaris threads library.  This
16841 option sets flags for both the preprocessor and linker.  This option does
16842 not affect the thread safety of object code produced by the compiler or
16843 that of libraries supplied with it.
16845 @item -pthreads
16846 @opindex pthreads
16847 Add support for multithreading using the POSIX threads library.  This
16848 option sets flags for both the preprocessor and linker.  This option does
16849 not affect the thread safety of object code produced  by the compiler or
16850 that of libraries supplied with it.
16852 @item -pthread
16853 @opindex pthread
16854 This is a synonym for @option{-pthreads}.
16855 @end table
16857 @node SPU Options
16858 @subsection SPU Options
16859 @cindex SPU options
16861 These @samp{-m} options are supported on the SPU:
16863 @table @gcctabopt
16864 @item -mwarn-reloc
16865 @itemx -merror-reloc
16866 @opindex mwarn-reloc
16867 @opindex merror-reloc
16869 The loader for SPU does not handle dynamic relocations.  By default, GCC
16870 will give an error when it generates code that requires a dynamic
16871 relocation.  @option{-mno-error-reloc} disables the error,
16872 @option{-mwarn-reloc} will generate a warning instead.
16874 @item -msafe-dma
16875 @itemx -munsafe-dma
16876 @opindex msafe-dma
16877 @opindex munsafe-dma
16879 Instructions which initiate or test completion of DMA must not be
16880 reordered with respect to loads and stores of the memory which is being
16881 accessed.  Users typically address this problem using the volatile
16882 keyword, but that can lead to inefficient code in places where the
16883 memory is known to not change.  Rather than mark the memory as volatile
16884 we treat the DMA instructions as potentially effecting all memory.  With
16885 @option{-munsafe-dma} users must use the volatile keyword to protect
16886 memory accesses.
16888 @item -mbranch-hints
16889 @opindex mbranch-hints
16891 By default, GCC will generate a branch hint instruction to avoid
16892 pipeline stalls for always taken or probably taken branches.  A hint
16893 will not be generated closer than 8 instructions away from its branch.
16894 There is little reason to disable them, except for debugging purposes,
16895 or to make an object a little bit smaller.
16897 @item -msmall-mem
16898 @itemx -mlarge-mem
16899 @opindex msmall-mem
16900 @opindex mlarge-mem
16902 By default, GCC generates code assuming that addresses are never larger
16903 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
16904 a full 32 bit address.
16906 @item -mstdmain
16907 @opindex mstdmain
16909 By default, GCC links against startup code that assumes the SPU-style
16910 main function interface (which has an unconventional parameter list).
16911 With @option{-mstdmain}, GCC will link your program against startup
16912 code that assumes a C99-style interface to @code{main}, including a
16913 local copy of @code{argv} strings.
16915 @item -mfixed-range=@var{register-range}
16916 @opindex mfixed-range
16917 Generate code treating the given register range as fixed registers.
16918 A fixed register is one that the register allocator can not use.  This is
16919 useful when compiling kernel code.  A register range is specified as
16920 two registers separated by a dash.  Multiple register ranges can be
16921 specified separated by a comma.
16923 @item -mea32
16924 @itemx -mea64
16925 @opindex mea32
16926 @opindex mea64
16927 Compile code assuming that pointers to the PPU address space accessed
16928 via the @code{__ea} named address space qualifier are either 32 or 64
16929 bits wide.  The default is 32 bits.  As this is an ABI changing option,
16930 all object code in an executable must be compiled with the same setting.
16932 @item -maddress-space-conversion
16933 @itemx -mno-address-space-conversion
16934 @opindex maddress-space-conversion
16935 @opindex mno-address-space-conversion
16936 Allow/disallow treating the @code{__ea} address space as superset
16937 of the generic address space.  This enables explicit type casts
16938 between @code{__ea} and generic pointer as well as implicit
16939 conversions of generic pointers to @code{__ea} pointers.  The
16940 default is to allow address space pointer conversions.
16942 @item -mcache-size=@var{cache-size}
16943 @opindex mcache-size
16944 This option controls the version of libgcc that the compiler links to an
16945 executable and selects a software-managed cache for accessing variables
16946 in the @code{__ea} address space with a particular cache size.  Possible
16947 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
16948 and @samp{128}.  The default cache size is 64KB.
16950 @item -matomic-updates
16951 @itemx -mno-atomic-updates
16952 @opindex matomic-updates
16953 @opindex mno-atomic-updates
16954 This option controls the version of libgcc that the compiler links to an
16955 executable and selects whether atomic updates to the software-managed
16956 cache of PPU-side variables are used.  If you use atomic updates, changes
16957 to a PPU variable from SPU code using the @code{__ea} named address space
16958 qualifier will not interfere with changes to other PPU variables residing
16959 in the same cache line from PPU code.  If you do not use atomic updates,
16960 such interference may occur; however, writing back cache lines will be
16961 more efficient.  The default behavior is to use atomic updates.
16963 @item -mdual-nops
16964 @itemx -mdual-nops=@var{n}
16965 @opindex mdual-nops
16966 By default, GCC will insert nops to increase dual issue when it expects
16967 it to increase performance.  @var{n} can be a value from 0 to 10.  A
16968 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
16969 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
16971 @item -mhint-max-nops=@var{n}
16972 @opindex mhint-max-nops
16973 Maximum number of nops to insert for a branch hint.  A branch hint must
16974 be at least 8 instructions away from the branch it is effecting.  GCC
16975 will insert up to @var{n} nops to enforce this, otherwise it will not
16976 generate the branch hint.
16978 @item -mhint-max-distance=@var{n}
16979 @opindex mhint-max-distance
16980 The encoding of the branch hint instruction limits the hint to be within
16981 256 instructions of the branch it is effecting.  By default, GCC makes
16982 sure it is within 125.
16984 @item -msafe-hints
16985 @opindex msafe-hints
16986 Work around a hardware bug which causes the SPU to stall indefinitely.
16987 By default, GCC will insert the @code{hbrp} instruction to make sure
16988 this stall won't happen.
16990 @end table
16992 @node System V Options
16993 @subsection Options for System V
16995 These additional options are available on System V Release 4 for
16996 compatibility with other compilers on those systems:
16998 @table @gcctabopt
16999 @item -G
17000 @opindex G
17001 Create a shared object.
17002 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
17004 @item -Qy
17005 @opindex Qy
17006 Identify the versions of each tool used by the compiler, in a
17007 @code{.ident} assembler directive in the output.
17009 @item -Qn
17010 @opindex Qn
17011 Refrain from adding @code{.ident} directives to the output file (this is
17012 the default).
17014 @item -YP,@var{dirs}
17015 @opindex YP
17016 Search the directories @var{dirs}, and no others, for libraries
17017 specified with @option{-l}.
17019 @item -Ym,@var{dir}
17020 @opindex Ym
17021 Look in the directory @var{dir} to find the M4 preprocessor.
17022 The assembler uses this option.
17023 @c This is supposed to go with a -Yd for predefined M4 macro files, but
17024 @c the generic assembler that comes with Solaris takes just -Ym.
17025 @end table
17027 @node V850 Options
17028 @subsection V850 Options
17029 @cindex V850 Options
17031 These @samp{-m} options are defined for V850 implementations:
17033 @table @gcctabopt
17034 @item -mlong-calls
17035 @itemx -mno-long-calls
17036 @opindex mlong-calls
17037 @opindex mno-long-calls
17038 Treat all calls as being far away (near).  If calls are assumed to be
17039 far away, the compiler will always load the functions address up into a
17040 register, and call indirect through the pointer.
17042 @item -mno-ep
17043 @itemx -mep
17044 @opindex mno-ep
17045 @opindex mep
17046 Do not optimize (do optimize) basic blocks that use the same index
17047 pointer 4 or more times to copy pointer into the @code{ep} register, and
17048 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
17049 option is on by default if you optimize.
17051 @item -mno-prolog-function
17052 @itemx -mprolog-function
17053 @opindex mno-prolog-function
17054 @opindex mprolog-function
17055 Do not use (do use) external functions to save and restore registers
17056 at the prologue and epilogue of a function.  The external functions
17057 are slower, but use less code space if more than one function saves
17058 the same number of registers.  The @option{-mprolog-function} option
17059 is on by default if you optimize.
17061 @item -mspace
17062 @opindex mspace
17063 Try to make the code as small as possible.  At present, this just turns
17064 on the @option{-mep} and @option{-mprolog-function} options.
17066 @item -mtda=@var{n}
17067 @opindex mtda
17068 Put static or global variables whose size is @var{n} bytes or less into
17069 the tiny data area that register @code{ep} points to.  The tiny data
17070 area can hold up to 256 bytes in total (128 bytes for byte references).
17072 @item -msda=@var{n}
17073 @opindex msda
17074 Put static or global variables whose size is @var{n} bytes or less into
17075 the small data area that register @code{gp} points to.  The small data
17076 area can hold up to 64 kilobytes.
17078 @item -mzda=@var{n}
17079 @opindex mzda
17080 Put static or global variables whose size is @var{n} bytes or less into
17081 the first 32 kilobytes of memory.
17083 @item -mv850
17084 @opindex mv850
17085 Specify that the target processor is the V850.
17087 @item -mbig-switch
17088 @opindex mbig-switch
17089 Generate code suitable for big switch tables.  Use this option only if
17090 the assembler/linker complain about out of range branches within a switch
17091 table.
17093 @item -mapp-regs
17094 @opindex mapp-regs
17095 This option will cause r2 and r5 to be used in the code generated by
17096 the compiler.  This setting is the default.
17098 @item -mno-app-regs
17099 @opindex mno-app-regs
17100 This option will cause r2 and r5 to be treated as fixed registers.
17102 @item -mv850e2v3
17103 @opindex mv850e2v3
17104 Specify that the target processor is the V850E2V3.  The preprocessor
17105 constants @samp{__v850e2v3__} will be defined if
17106 this option is used.
17108 @item -mv850e2
17109 @opindex mv850e2
17110 Specify that the target processor is the V850E2.  The preprocessor
17111 constants @samp{__v850e2__} will be defined if
17113 @item -mv850e1
17114 @opindex mv850e1
17115 Specify that the target processor is the V850E1.  The preprocessor
17116 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
17118 @item -mv850e
17119 @opindex mv850e
17120 Specify that the target processor is the V850E@.  The preprocessor
17121 constant @samp{__v850e__} will be defined if this option is used.
17123 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
17124 nor @option{-mv850e2} nor @option{-mv850e2v3}
17125 are defined then a default target processor will be chosen and the
17126 relevant @samp{__v850*__} preprocessor constant will be defined.
17128 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
17129 defined, regardless of which processor variant is the target.
17131 @item -mdisable-callt
17132 @opindex mdisable-callt
17133 This option will suppress generation of the CALLT instruction for the
17134 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture.  The default is
17135 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
17137 @end table
17139 @node VAX Options
17140 @subsection VAX Options
17141 @cindex VAX options
17143 These @samp{-m} options are defined for the VAX:
17145 @table @gcctabopt
17146 @item -munix
17147 @opindex munix
17148 Do not output certain jump instructions (@code{aobleq} and so on)
17149 that the Unix assembler for the VAX cannot handle across long
17150 ranges.
17152 @item -mgnu
17153 @opindex mgnu
17154 Do output those jump instructions, on the assumption that you
17155 will assemble with the GNU assembler.
17157 @item -mg
17158 @opindex mg
17159 Output code for g-format floating point numbers instead of d-format.
17160 @end table
17162 @node VxWorks Options
17163 @subsection VxWorks Options
17164 @cindex VxWorks Options
17166 The options in this section are defined for all VxWorks targets.
17167 Options specific to the target hardware are listed with the other
17168 options for that target.
17170 @table @gcctabopt
17171 @item -mrtp
17172 @opindex mrtp
17173 GCC can generate code for both VxWorks kernels and real time processes
17174 (RTPs).  This option switches from the former to the latter.  It also
17175 defines the preprocessor macro @code{__RTP__}.
17177 @item -non-static
17178 @opindex non-static
17179 Link an RTP executable against shared libraries rather than static
17180 libraries.  The options @option{-static} and @option{-shared} can
17181 also be used for RTPs (@pxref{Link Options}); @option{-static}
17182 is the default.
17184 @item -Bstatic
17185 @itemx -Bdynamic
17186 @opindex Bstatic
17187 @opindex Bdynamic
17188 These options are passed down to the linker.  They are defined for
17189 compatibility with Diab.
17191 @item -Xbind-lazy
17192 @opindex Xbind-lazy
17193 Enable lazy binding of function calls.  This option is equivalent to
17194 @option{-Wl,-z,now} and is defined for compatibility with Diab.
17196 @item -Xbind-now
17197 @opindex Xbind-now
17198 Disable lazy binding of function calls.  This option is the default and
17199 is defined for compatibility with Diab.
17200 @end table
17202 @node x86-64 Options
17203 @subsection x86-64 Options
17204 @cindex x86-64 options
17206 These are listed under @xref{i386 and x86-64 Options}.
17208 @node i386 and x86-64 Windows Options
17209 @subsection i386 and x86-64 Windows Options
17210 @cindex i386 and x86-64 Windows Options
17212 These additional options are available for Windows targets:
17214 @table @gcctabopt
17215 @item -mconsole
17216 @opindex mconsole
17217 This option is available for Cygwin and MinGW targets.  It
17218 specifies that a console application is to be generated, by
17219 instructing the linker to set the PE header subsystem type
17220 required for console applications.
17221 This is the default behavior for Cygwin and MinGW targets.
17223 @item -mcygwin
17224 @opindex mcygwin
17225 This option is available for Cygwin targets.  It specifies that
17226 the Cygwin internal interface is to be used for predefined
17227 preprocessor macros, C runtime libraries and related linker
17228 paths and options.  For Cygwin targets this is the default behavior.
17229 This option is deprecated and will be removed in a future release.
17231 @item -mno-cygwin
17232 @opindex mno-cygwin
17233 This option is available for Cygwin targets.  It specifies that
17234 the MinGW internal interface is to be used instead of Cygwin's, by
17235 setting MinGW-related predefined macros and linker paths and default
17236 library options.
17237 This option is deprecated and will be removed in a future release.
17239 @item -mdll
17240 @opindex mdll
17241 This option is available for Cygwin and MinGW targets.  It
17242 specifies that a DLL - a dynamic link library - is to be
17243 generated, enabling the selection of the required runtime
17244 startup object and entry point.
17246 @item -mnop-fun-dllimport
17247 @opindex mnop-fun-dllimport
17248 This option is available for Cygwin and MinGW targets.  It
17249 specifies that the dllimport attribute should be ignored.
17251 @item -mthread
17252 @opindex mthread
17253 This option is available for MinGW targets. It specifies
17254 that MinGW-specific thread support is to be used.
17256 @item -municode
17257 @opindex municode
17258 This option is available for mingw-w64 targets.  It specifies
17259 that the UNICODE macro is getting pre-defined and that the
17260 unicode capable runtime startup code is chosen.
17262 @item -mwin32
17263 @opindex mwin32
17264 This option is available for Cygwin and MinGW targets.  It
17265 specifies that the typical Windows pre-defined macros are to
17266 be set in the pre-processor, but does not influence the choice
17267 of runtime library/startup code.
17269 @item -mwindows
17270 @opindex mwindows
17271 This option is available for Cygwin and MinGW targets.  It
17272 specifies that a GUI application is to be generated by
17273 instructing the linker to set the PE header subsystem type
17274 appropriately.
17276 @item -fno-set-stack-executable
17277 @opindex fno-set-stack-executable
17278 This option is available for MinGW targets. It specifies that
17279 the executable flag for stack used by nested functions isn't
17280 set. This is necessary for binaries running in kernel mode of
17281 Windows, as there the user32 API, which is used to set executable
17282 privileges, isn't available.
17284 @item -mpe-aligned-commons
17285 @opindex mpe-aligned-commons
17286 This option is available for Cygwin and MinGW targets.  It
17287 specifies that the GNU extension to the PE file format that
17288 permits the correct alignment of COMMON variables should be
17289 used when generating code.  It will be enabled by default if
17290 GCC detects that the target assembler found during configuration
17291 supports the feature.
17292 @end table
17294 See also under @ref{i386 and x86-64 Options} for standard options.
17296 @node Xstormy16 Options
17297 @subsection Xstormy16 Options
17298 @cindex Xstormy16 Options
17300 These options are defined for Xstormy16:
17302 @table @gcctabopt
17303 @item -msim
17304 @opindex msim
17305 Choose startup files and linker script suitable for the simulator.
17306 @end table
17308 @node Xtensa Options
17309 @subsection Xtensa Options
17310 @cindex Xtensa Options
17312 These options are supported for Xtensa targets:
17314 @table @gcctabopt
17315 @item -mconst16
17316 @itemx -mno-const16
17317 @opindex mconst16
17318 @opindex mno-const16
17319 Enable or disable use of @code{CONST16} instructions for loading
17320 constant values.  The @code{CONST16} instruction is currently not a
17321 standard option from Tensilica.  When enabled, @code{CONST16}
17322 instructions are always used in place of the standard @code{L32R}
17323 instructions.  The use of @code{CONST16} is enabled by default only if
17324 the @code{L32R} instruction is not available.
17326 @item -mfused-madd
17327 @itemx -mno-fused-madd
17328 @opindex mfused-madd
17329 @opindex mno-fused-madd
17330 Enable or disable use of fused multiply/add and multiply/subtract
17331 instructions in the floating-point option.  This has no effect if the
17332 floating-point option is not also enabled.  Disabling fused multiply/add
17333 and multiply/subtract instructions forces the compiler to use separate
17334 instructions for the multiply and add/subtract operations.  This may be
17335 desirable in some cases where strict IEEE 754-compliant results are
17336 required: the fused multiply add/subtract instructions do not round the
17337 intermediate result, thereby producing results with @emph{more} bits of
17338 precision than specified by the IEEE standard.  Disabling fused multiply
17339 add/subtract instructions also ensures that the program output is not
17340 sensitive to the compiler's ability to combine multiply and add/subtract
17341 operations.
17343 @item -mserialize-volatile
17344 @itemx -mno-serialize-volatile
17345 @opindex mserialize-volatile
17346 @opindex mno-serialize-volatile
17347 When this option is enabled, GCC inserts @code{MEMW} instructions before
17348 @code{volatile} memory references to guarantee sequential consistency.
17349 The default is @option{-mserialize-volatile}.  Use
17350 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
17352 @item -mforce-no-pic
17353 @opindex mforce-no-pic
17354 For targets, like GNU/Linux, where all user-mode Xtensa code must be
17355 position-independent code (PIC), this option disables PIC for compiling
17356 kernel code.
17358 @item -mtext-section-literals
17359 @itemx -mno-text-section-literals
17360 @opindex mtext-section-literals
17361 @opindex mno-text-section-literals
17362 Control the treatment of literal pools.  The default is
17363 @option{-mno-text-section-literals}, which places literals in a separate
17364 section in the output file.  This allows the literal pool to be placed
17365 in a data RAM/ROM, and it also allows the linker to combine literal
17366 pools from separate object files to remove redundant literals and
17367 improve code size.  With @option{-mtext-section-literals}, the literals
17368 are interspersed in the text section in order to keep them as close as
17369 possible to their references.  This may be necessary for large assembly
17370 files.
17372 @item -mtarget-align
17373 @itemx -mno-target-align
17374 @opindex mtarget-align
17375 @opindex mno-target-align
17376 When this option is enabled, GCC instructs the assembler to
17377 automatically align instructions to reduce branch penalties at the
17378 expense of some code density.  The assembler attempts to widen density
17379 instructions to align branch targets and the instructions following call
17380 instructions.  If there are not enough preceding safe density
17381 instructions to align a target, no widening will be performed.  The
17382 default is @option{-mtarget-align}.  These options do not affect the
17383 treatment of auto-aligned instructions like @code{LOOP}, which the
17384 assembler will always align, either by widening density instructions or
17385 by inserting no-op instructions.
17387 @item -mlongcalls
17388 @itemx -mno-longcalls
17389 @opindex mlongcalls
17390 @opindex mno-longcalls
17391 When this option is enabled, GCC instructs the assembler to translate
17392 direct calls to indirect calls unless it can determine that the target
17393 of a direct call is in the range allowed by the call instruction.  This
17394 translation typically occurs for calls to functions in other source
17395 files.  Specifically, the assembler translates a direct @code{CALL}
17396 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
17397 The default is @option{-mno-longcalls}.  This option should be used in
17398 programs where the call target can potentially be out of range.  This
17399 option is implemented in the assembler, not the compiler, so the
17400 assembly code generated by GCC will still show direct call
17401 instructions---look at the disassembled object code to see the actual
17402 instructions.  Note that the assembler will use an indirect call for
17403 every cross-file call, not just those that really will be out of range.
17404 @end table
17406 @node zSeries Options
17407 @subsection zSeries Options
17408 @cindex zSeries options
17410 These are listed under @xref{S/390 and zSeries Options}.
17412 @node Code Gen Options
17413 @section Options for Code Generation Conventions
17414 @cindex code generation conventions
17415 @cindex options, code generation
17416 @cindex run-time options
17418 These machine-independent options control the interface conventions
17419 used in code generation.
17421 Most of them have both positive and negative forms; the negative form
17422 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
17423 one of the forms is listed---the one which is not the default.  You
17424 can figure out the other form by either removing @samp{no-} or adding
17427 @table @gcctabopt
17428 @item -fbounds-check
17429 @opindex fbounds-check
17430 For front-ends that support it, generate additional code to check that
17431 indices used to access arrays are within the declared range.  This is
17432 currently only supported by the Java and Fortran front-ends, where
17433 this option defaults to true and false respectively.
17435 @item -ftrapv
17436 @opindex ftrapv
17437 This option generates traps for signed overflow on addition, subtraction,
17438 multiplication operations.
17440 @item -fwrapv
17441 @opindex fwrapv
17442 This option instructs the compiler to assume that signed arithmetic
17443 overflow of addition, subtraction and multiplication wraps around
17444 using twos-complement representation.  This flag enables some optimizations
17445 and disables others.  This option is enabled by default for the Java
17446 front-end, as required by the Java language specification.
17448 @item -fexceptions
17449 @opindex fexceptions
17450 Enable exception handling.  Generates extra code needed to propagate
17451 exceptions.  For some targets, this implies GCC will generate frame
17452 unwind information for all functions, which can produce significant data
17453 size overhead, although it does not affect execution.  If you do not
17454 specify this option, GCC will enable it by default for languages like
17455 C++ which normally require exception handling, and disable it for
17456 languages like C that do not normally require it.  However, you may need
17457 to enable this option when compiling C code that needs to interoperate
17458 properly with exception handlers written in C++.  You may also wish to
17459 disable this option if you are compiling older C++ programs that don't
17460 use exception handling.
17462 @item -fnon-call-exceptions
17463 @opindex fnon-call-exceptions
17464 Generate code that allows trapping instructions to throw exceptions.
17465 Note that this requires platform-specific runtime support that does
17466 not exist everywhere.  Moreover, it only allows @emph{trapping}
17467 instructions to throw exceptions, i.e.@: memory references or floating
17468 point instructions.  It does not allow exceptions to be thrown from
17469 arbitrary signal handlers such as @code{SIGALRM}.
17471 @item -funwind-tables
17472 @opindex funwind-tables
17473 Similar to @option{-fexceptions}, except that it will just generate any needed
17474 static data, but will not affect the generated code in any other way.
17475 You will normally not enable this option; instead, a language processor
17476 that needs this handling would enable it on your behalf.
17478 @item -fasynchronous-unwind-tables
17479 @opindex fasynchronous-unwind-tables
17480 Generate unwind table in dwarf2 format, if supported by target machine.  The
17481 table is exact at each instruction boundary, so it can be used for stack
17482 unwinding from asynchronous events (such as debugger or garbage collector).
17484 @item -fpcc-struct-return
17485 @opindex fpcc-struct-return
17486 Return ``short'' @code{struct} and @code{union} values in memory like
17487 longer ones, rather than in registers.  This convention is less
17488 efficient, but it has the advantage of allowing intercallability between
17489 GCC-compiled files and files compiled with other compilers, particularly
17490 the Portable C Compiler (pcc).
17492 The precise convention for returning structures in memory depends
17493 on the target configuration macros.
17495 Short structures and unions are those whose size and alignment match
17496 that of some integer type.
17498 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
17499 switch is not binary compatible with code compiled with the
17500 @option{-freg-struct-return} switch.
17501 Use it to conform to a non-default application binary interface.
17503 @item -freg-struct-return
17504 @opindex freg-struct-return
17505 Return @code{struct} and @code{union} values in registers when possible.
17506 This is more efficient for small structures than
17507 @option{-fpcc-struct-return}.
17509 If you specify neither @option{-fpcc-struct-return} nor
17510 @option{-freg-struct-return}, GCC defaults to whichever convention is
17511 standard for the target.  If there is no standard convention, GCC
17512 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17513 the principal compiler.  In those cases, we can choose the standard, and
17514 we chose the more efficient register return alternative.
17516 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17517 switch is not binary compatible with code compiled with the
17518 @option{-fpcc-struct-return} switch.
17519 Use it to conform to a non-default application binary interface.
17521 @item -fshort-enums
17522 @opindex fshort-enums
17523 Allocate to an @code{enum} type only as many bytes as it needs for the
17524 declared range of possible values.  Specifically, the @code{enum} type
17525 will be equivalent to the smallest integer type which has enough room.
17527 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17528 code that is not binary compatible with code generated without that switch.
17529 Use it to conform to a non-default application binary interface.
17531 @item -fshort-double
17532 @opindex fshort-double
17533 Use the same size for @code{double} as for @code{float}.
17535 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17536 code that is not binary compatible with code generated without that switch.
17537 Use it to conform to a non-default application binary interface.
17539 @item -fshort-wchar
17540 @opindex fshort-wchar
17541 Override the underlying type for @samp{wchar_t} to be @samp{short
17542 unsigned int} instead of the default for the target.  This option is
17543 useful for building programs to run under WINE@.
17545 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17546 code that is not binary compatible with code generated without that switch.
17547 Use it to conform to a non-default application binary interface.
17549 @item -fno-common
17550 @opindex fno-common
17551 In C code, controls the placement of uninitialized global variables.
17552 Unix C compilers have traditionally permitted multiple definitions of
17553 such variables in different compilation units by placing the variables
17554 in a common block.
17555 This is the behavior specified by @option{-fcommon}, and is the default
17556 for GCC on most targets.
17557 On the other hand, this behavior is not required by ISO C, and on some
17558 targets may carry a speed or code size penalty on variable references.
17559 The @option{-fno-common} option specifies that the compiler should place
17560 uninitialized global variables in the data section of the object file,
17561 rather than generating them as common blocks.
17562 This has the effect that if the same variable is declared
17563 (without @code{extern}) in two different compilations,
17564 you will get a multiple-definition error when you link them.
17565 In this case, you must compile with @option{-fcommon} instead.
17566 Compiling with @option{-fno-common} is useful on targets for which
17567 it provides better performance, or if you wish to verify that the
17568 program will work on other systems which always treat uninitialized
17569 variable declarations this way.
17571 @item -fno-ident
17572 @opindex fno-ident
17573 Ignore the @samp{#ident} directive.
17575 @item -finhibit-size-directive
17576 @opindex finhibit-size-directive
17577 Don't output a @code{.size} assembler directive, or anything else that
17578 would cause trouble if the function is split in the middle, and the
17579 two halves are placed at locations far apart in memory.  This option is
17580 used when compiling @file{crtstuff.c}; you should not need to use it
17581 for anything else.
17583 @item -fverbose-asm
17584 @opindex fverbose-asm
17585 Put extra commentary information in the generated assembly code to
17586 make it more readable.  This option is generally only of use to those
17587 who actually need to read the generated assembly code (perhaps while
17588 debugging the compiler itself).
17590 @option{-fno-verbose-asm}, the default, causes the
17591 extra information to be omitted and is useful when comparing two assembler
17592 files.
17594 @item -frecord-gcc-switches
17595 @opindex frecord-gcc-switches
17596 This switch causes the command line that was used to invoke the
17597 compiler to be recorded into the object file that is being created.
17598 This switch is only implemented on some targets and the exact format
17599 of the recording is target and binary file format dependent, but it
17600 usually takes the form of a section containing ASCII text.  This
17601 switch is related to the @option{-fverbose-asm} switch, but that
17602 switch only records information in the assembler output file as
17603 comments, so it never reaches the object file.
17605 @item -fpic
17606 @opindex fpic
17607 @cindex global offset table
17608 @cindex PIC
17609 Generate position-independent code (PIC) suitable for use in a shared
17610 library, if supported for the target machine.  Such code accesses all
17611 constant addresses through a global offset table (GOT)@.  The dynamic
17612 loader resolves the GOT entries when the program starts (the dynamic
17613 loader is not part of GCC; it is part of the operating system).  If
17614 the GOT size for the linked executable exceeds a machine-specific
17615 maximum size, you get an error message from the linker indicating that
17616 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17617 instead.  (These maximums are 8k on the SPARC and 32k
17618 on the m68k and RS/6000.  The 386 has no such limit.)
17620 Position-independent code requires special support, and therefore works
17621 only on certain machines.  For the 386, GCC supports PIC for System V
17622 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
17623 position-independent.
17625 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17626 are defined to 1.
17628 @item -fPIC
17629 @opindex fPIC
17630 If supported for the target machine, emit position-independent code,
17631 suitable for dynamic linking and avoiding any limit on the size of the
17632 global offset table.  This option makes a difference on the m68k,
17633 PowerPC and SPARC@.
17635 Position-independent code requires special support, and therefore works
17636 only on certain machines.
17638 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17639 are defined to 2.
17641 @item -fpie
17642 @itemx -fPIE
17643 @opindex fpie
17644 @opindex fPIE
17645 These options are similar to @option{-fpic} and @option{-fPIC}, but
17646 generated position independent code can be only linked into executables.
17647 Usually these options are used when @option{-pie} GCC option will be
17648 used during linking.
17650 @option{-fpie} and @option{-fPIE} both define the macros
17651 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
17652 for @option{-fpie} and 2 for @option{-fPIE}.
17654 @item -fno-jump-tables
17655 @opindex fno-jump-tables
17656 Do not use jump tables for switch statements even where it would be
17657 more efficient than other code generation strategies.  This option is
17658 of use in conjunction with @option{-fpic} or @option{-fPIC} for
17659 building code which forms part of a dynamic linker and cannot
17660 reference the address of a jump table.  On some targets, jump tables
17661 do not require a GOT and this option is not needed.
17663 @item -ffixed-@var{reg}
17664 @opindex ffixed
17665 Treat the register named @var{reg} as a fixed register; generated code
17666 should never refer to it (except perhaps as a stack pointer, frame
17667 pointer or in some other fixed role).
17669 @var{reg} must be the name of a register.  The register names accepted
17670 are machine-specific and are defined in the @code{REGISTER_NAMES}
17671 macro in the machine description macro file.
17673 This flag does not have a negative form, because it specifies a
17674 three-way choice.
17676 @item -fcall-used-@var{reg}
17677 @opindex fcall-used
17678 Treat the register named @var{reg} as an allocable register that is
17679 clobbered by function calls.  It may be allocated for temporaries or
17680 variables that do not live across a call.  Functions compiled this way
17681 will not save and restore the register @var{reg}.
17683 It is an error to used this flag with the frame pointer or stack pointer.
17684 Use of this flag for other registers that have fixed pervasive roles in
17685 the machine's execution model will produce disastrous results.
17687 This flag does not have a negative form, because it specifies a
17688 three-way choice.
17690 @item -fcall-saved-@var{reg}
17691 @opindex fcall-saved
17692 Treat the register named @var{reg} as an allocable register saved by
17693 functions.  It may be allocated even for temporaries or variables that
17694 live across a call.  Functions compiled this way will save and restore
17695 the register @var{reg} if they use it.
17697 It is an error to used this flag with the frame pointer or stack pointer.
17698 Use of this flag for other registers that have fixed pervasive roles in
17699 the machine's execution model will produce disastrous results.
17701 A different sort of disaster will result from the use of this flag for
17702 a register in which function values may be returned.
17704 This flag does not have a negative form, because it specifies a
17705 three-way choice.
17707 @item -fpack-struct[=@var{n}]
17708 @opindex fpack-struct
17709 Without a value specified, pack all structure members together without
17710 holes.  When a value is specified (which must be a small power of two), pack
17711 structure members according to this value, representing the maximum
17712 alignment (that is, objects with default alignment requirements larger than
17713 this will be output potentially unaligned at the next fitting location.
17715 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
17716 code that is not binary compatible with code generated without that switch.
17717 Additionally, it makes the code suboptimal.
17718 Use it to conform to a non-default application binary interface.
17720 @item -finstrument-functions
17721 @opindex finstrument-functions
17722 Generate instrumentation calls for entry and exit to functions.  Just
17723 after function entry and just before function exit, the following
17724 profiling functions will be called with the address of the current
17725 function and its call site.  (On some platforms,
17726 @code{__builtin_return_address} does not work beyond the current
17727 function, so the call site information may not be available to the
17728 profiling functions otherwise.)
17730 @smallexample
17731 void __cyg_profile_func_enter (void *this_fn,
17732                                void *call_site);
17733 void __cyg_profile_func_exit  (void *this_fn,
17734                                void *call_site);
17735 @end smallexample
17737 The first argument is the address of the start of the current function,
17738 which may be looked up exactly in the symbol table.
17740 This instrumentation is also done for functions expanded inline in other
17741 functions.  The profiling calls will indicate where, conceptually, the
17742 inline function is entered and exited.  This means that addressable
17743 versions of such functions must be available.  If all your uses of a
17744 function are expanded inline, this may mean an additional expansion of
17745 code size.  If you use @samp{extern inline} in your C code, an
17746 addressable version of such functions must be provided.  (This is
17747 normally the case anyways, but if you get lucky and the optimizer always
17748 expands the functions inline, you might have gotten away without
17749 providing static copies.)
17751 A function may be given the attribute @code{no_instrument_function}, in
17752 which case this instrumentation will not be done.  This can be used, for
17753 example, for the profiling functions listed above, high-priority
17754 interrupt routines, and any functions from which the profiling functions
17755 cannot safely be called (perhaps signal handlers, if the profiling
17756 routines generate output or allocate memory).
17758 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
17759 @opindex finstrument-functions-exclude-file-list
17761 Set the list of functions that are excluded from instrumentation (see
17762 the description of @code{-finstrument-functions}).  If the file that
17763 contains a function definition matches with one of @var{file}, then
17764 that function is not instrumented.  The match is done on substrings:
17765 if the @var{file} parameter is a substring of the file name, it is
17766 considered to be a match.
17768 For example,
17769 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
17770 will exclude any inline function defined in files whose pathnames
17771 contain @code{/bits/stl} or @code{include/sys}.
17773 If, for some reason, you want to include letter @code{','} in one of
17774 @var{sym}, write @code{'\,'}. For example,
17775 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
17776 (note the single quote surrounding the option).
17778 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
17779 @opindex finstrument-functions-exclude-function-list
17781 This is similar to @code{-finstrument-functions-exclude-file-list},
17782 but this option sets the list of function names to be excluded from
17783 instrumentation.  The function name to be matched is its user-visible
17784 name, such as @code{vector<int> blah(const vector<int> &)}, not the
17785 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
17786 match is done on substrings: if the @var{sym} parameter is a substring
17787 of the function name, it is considered to be a match.  For C99 and C++
17788 extended identifiers, the function name must be given in UTF-8, not
17789 using universal character names.
17791 @item -fstack-check
17792 @opindex fstack-check
17793 Generate code to verify that you do not go beyond the boundary of the
17794 stack.  You should specify this flag if you are running in an
17795 environment with multiple threads, but only rarely need to specify it in
17796 a single-threaded environment since stack overflow is automatically
17797 detected on nearly all systems if there is only one stack.
17799 Note that this switch does not actually cause checking to be done; the
17800 operating system or the language runtime must do that.  The switch causes
17801 generation of code to ensure that they see the stack being extended.
17803 You can additionally specify a string parameter: @code{no} means no
17804 checking, @code{generic} means force the use of old-style checking,
17805 @code{specific} means use the best checking method and is equivalent
17806 to bare @option{-fstack-check}.
17808 Old-style checking is a generic mechanism that requires no specific
17809 target support in the compiler but comes with the following drawbacks:
17811 @enumerate
17812 @item
17813 Modified allocation strategy for large objects: they will always be
17814 allocated dynamically if their size exceeds a fixed threshold.
17816 @item
17817 Fixed limit on the size of the static frame of functions: when it is
17818 topped by a particular function, stack checking is not reliable and
17819 a warning is issued by the compiler.
17821 @item
17822 Inefficiency: because of both the modified allocation strategy and the
17823 generic implementation, the performances of the code are hampered.
17824 @end enumerate
17826 Note that old-style stack checking is also the fallback method for
17827 @code{specific} if no target support has been added in the compiler.
17829 @item -fstack-limit-register=@var{reg}
17830 @itemx -fstack-limit-symbol=@var{sym}
17831 @itemx -fno-stack-limit
17832 @opindex fstack-limit-register
17833 @opindex fstack-limit-symbol
17834 @opindex fno-stack-limit
17835 Generate code to ensure that the stack does not grow beyond a certain value,
17836 either the value of a register or the address of a symbol.  If the stack
17837 would grow beyond the value, a signal is raised.  For most targets,
17838 the signal is raised before the stack overruns the boundary, so
17839 it is possible to catch the signal without taking special precautions.
17841 For instance, if the stack starts at absolute address @samp{0x80000000}
17842 and grows downwards, you can use the flags
17843 @option{-fstack-limit-symbol=__stack_limit} and
17844 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
17845 of 128KB@.  Note that this may only work with the GNU linker.
17847 @item -fleading-underscore
17848 @opindex fleading-underscore
17849 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
17850 change the way C symbols are represented in the object file.  One use
17851 is to help link with legacy assembly code.
17853 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
17854 generate code that is not binary compatible with code generated without that
17855 switch.  Use it to conform to a non-default application binary interface.
17856 Not all targets provide complete support for this switch.
17858 @item -ftls-model=@var{model}
17859 @opindex ftls-model
17860 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
17861 The @var{model} argument should be one of @code{global-dynamic},
17862 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
17864 The default without @option{-fpic} is @code{initial-exec}; with
17865 @option{-fpic} the default is @code{global-dynamic}.
17867 @item -fvisibility=@var{default|internal|hidden|protected}
17868 @opindex fvisibility
17869 Set the default ELF image symbol visibility to the specified option---all
17870 symbols will be marked with this unless overridden within the code.
17871 Using this feature can very substantially improve linking and
17872 load times of shared object libraries, produce more optimized
17873 code, provide near-perfect API export and prevent symbol clashes.
17874 It is @strong{strongly} recommended that you use this in any shared objects
17875 you distribute.
17877 Despite the nomenclature, @code{default} always means public ie;
17878 available to be linked against from outside the shared object.
17879 @code{protected} and @code{internal} are pretty useless in real-world
17880 usage so the only other commonly used option will be @code{hidden}.
17881 The default if @option{-fvisibility} isn't specified is
17882 @code{default}, i.e., make every
17883 symbol public---this causes the same behavior as previous versions of
17884 GCC@.
17886 A good explanation of the benefits offered by ensuring ELF
17887 symbols have the correct visibility is given by ``How To Write
17888 Shared Libraries'' by Ulrich Drepper (which can be found at
17889 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
17890 solution made possible by this option to marking things hidden when
17891 the default is public is to make the default hidden and mark things
17892 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
17893 and @code{__attribute__ ((visibility("default")))} instead of
17894 @code{__declspec(dllexport)} you get almost identical semantics with
17895 identical syntax.  This is a great boon to those working with
17896 cross-platform projects.
17898 For those adding visibility support to existing code, you may find
17899 @samp{#pragma GCC visibility} of use.  This works by you enclosing
17900 the declarations you wish to set visibility for with (for example)
17901 @samp{#pragma GCC visibility push(hidden)} and
17902 @samp{#pragma GCC visibility pop}.
17903 Bear in mind that symbol visibility should be viewed @strong{as
17904 part of the API interface contract} and thus all new code should
17905 always specify visibility when it is not the default ie; declarations
17906 only for use within the local DSO should @strong{always} be marked explicitly
17907 as hidden as so to avoid PLT indirection overheads---making this
17908 abundantly clear also aids readability and self-documentation of the code.
17909 Note that due to ISO C++ specification requirements, operator new and
17910 operator delete must always be of default visibility.
17912 Be aware that headers from outside your project, in particular system
17913 headers and headers from any other library you use, may not be
17914 expecting to be compiled with visibility other than the default.  You
17915 may need to explicitly say @samp{#pragma GCC visibility push(default)}
17916 before including any such headers.
17918 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
17919 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
17920 no modifications.  However, this means that calls to @samp{extern}
17921 functions with no explicit visibility will use the PLT, so it is more
17922 effective to use @samp{__attribute ((visibility))} and/or
17923 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
17924 declarations should be treated as hidden.
17926 Note that @samp{-fvisibility} does affect C++ vague linkage
17927 entities. This means that, for instance, an exception class that will
17928 be thrown between DSOs must be explicitly marked with default
17929 visibility so that the @samp{type_info} nodes will be unified between
17930 the DSOs.
17932 An overview of these techniques, their benefits and how to use them
17933 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
17935 @item -fstrict-volatile-bitfields
17936 This option should be used if accesses to volatile bitfields (or other
17937 structure fields, although the compiler usually honors those types
17938 anyway) should use a single access in a mode of the same size as the
17939 container's type, aligned to a natural alignment if possible.  For
17940 example, targets with memory-mapped peripheral registers might require
17941 all such accesses to be 16 bits wide; with this flag the user could
17942 declare all peripheral bitfields as ``unsigned short'' (assuming short
17943 is 16 bits on these targets) to force GCC to use 16 bit accesses
17944 instead of, perhaps, a more efficient 32 bit access.
17946 If this option is disabled, the compiler will use the most efficient
17947 instruction.  In the previous example, that might be a 32-bit load
17948 instruction, even though that will access bytes that do not contain
17949 any portion of the bitfield, or memory-mapped registers unrelated to
17950 the one being updated.
17952 If the target requires strict alignment, and honoring the container
17953 type would require violating this alignment, a warning is issued.
17954 However, the access happens as the user requested, under the
17955 assumption that the user knows something about the target hardware
17956 that GCC is unaware of.
17958 The default value of this option is determined by the application binary
17959 interface for the target processor.
17961 @end table
17963 @c man end
17965 @node Environment Variables
17966 @section Environment Variables Affecting GCC
17967 @cindex environment variables
17969 @c man begin ENVIRONMENT
17970 This section describes several environment variables that affect how GCC
17971 operates.  Some of them work by specifying directories or prefixes to use
17972 when searching for various kinds of files.  Some are used to specify other
17973 aspects of the compilation environment.
17975 Note that you can also specify places to search using options such as
17976 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
17977 take precedence over places specified using environment variables, which
17978 in turn take precedence over those specified by the configuration of GCC@.
17979 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
17980 GNU Compiler Collection (GCC) Internals}.
17982 @table @env
17983 @item LANG
17984 @itemx LC_CTYPE
17985 @c @itemx LC_COLLATE
17986 @itemx LC_MESSAGES
17987 @c @itemx LC_MONETARY
17988 @c @itemx LC_NUMERIC
17989 @c @itemx LC_TIME
17990 @itemx LC_ALL
17991 @findex LANG
17992 @findex LC_CTYPE
17993 @c @findex LC_COLLATE
17994 @findex LC_MESSAGES
17995 @c @findex LC_MONETARY
17996 @c @findex LC_NUMERIC
17997 @c @findex LC_TIME
17998 @findex LC_ALL
17999 @cindex locale
18000 These environment variables control the way that GCC uses
18001 localization information that allow GCC to work with different
18002 national conventions.  GCC inspects the locale categories
18003 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
18004 so.  These locale categories can be set to any value supported by your
18005 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
18006 Kingdom encoded in UTF-8.
18008 The @env{LC_CTYPE} environment variable specifies character
18009 classification.  GCC uses it to determine the character boundaries in
18010 a string; this is needed for some multibyte encodings that contain quote
18011 and escape characters that would otherwise be interpreted as a string
18012 end or escape.
18014 The @env{LC_MESSAGES} environment variable specifies the language to
18015 use in diagnostic messages.
18017 If the @env{LC_ALL} environment variable is set, it overrides the value
18018 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
18019 and @env{LC_MESSAGES} default to the value of the @env{LANG}
18020 environment variable.  If none of these variables are set, GCC
18021 defaults to traditional C English behavior.
18023 @item TMPDIR
18024 @findex TMPDIR
18025 If @env{TMPDIR} is set, it specifies the directory to use for temporary
18026 files.  GCC uses temporary files to hold the output of one stage of
18027 compilation which is to be used as input to the next stage: for example,
18028 the output of the preprocessor, which is the input to the compiler
18029 proper.
18031 @item GCC_EXEC_PREFIX
18032 @findex GCC_EXEC_PREFIX
18033 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
18034 names of the subprograms executed by the compiler.  No slash is added
18035 when this prefix is combined with the name of a subprogram, but you can
18036 specify a prefix that ends with a slash if you wish.
18038 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
18039 an appropriate prefix to use based on the pathname it was invoked with.
18041 If GCC cannot find the subprogram using the specified prefix, it
18042 tries looking in the usual places for the subprogram.
18044 The default value of @env{GCC_EXEC_PREFIX} is
18045 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
18046 the installed compiler. In many cases @var{prefix} is the value
18047 of @code{prefix} when you ran the @file{configure} script.
18049 Other prefixes specified with @option{-B} take precedence over this prefix.
18051 This prefix is also used for finding files such as @file{crt0.o} that are
18052 used for linking.
18054 In addition, the prefix is used in an unusual way in finding the
18055 directories to search for header files.  For each of the standard
18056 directories whose name normally begins with @samp{/usr/local/lib/gcc}
18057 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
18058 replacing that beginning with the specified prefix to produce an
18059 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
18060 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
18061 These alternate directories are searched first; the standard directories
18062 come next. If a standard directory begins with the configured
18063 @var{prefix} then the value of @var{prefix} is replaced by
18064 @env{GCC_EXEC_PREFIX} when looking for header files.
18066 @item COMPILER_PATH
18067 @findex COMPILER_PATH
18068 The value of @env{COMPILER_PATH} is a colon-separated list of
18069 directories, much like @env{PATH}.  GCC tries the directories thus
18070 specified when searching for subprograms, if it can't find the
18071 subprograms using @env{GCC_EXEC_PREFIX}.
18073 @item LIBRARY_PATH
18074 @findex LIBRARY_PATH
18075 The value of @env{LIBRARY_PATH} is a colon-separated list of
18076 directories, much like @env{PATH}.  When configured as a native compiler,
18077 GCC tries the directories thus specified when searching for special
18078 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
18079 using GCC also uses these directories when searching for ordinary
18080 libraries for the @option{-l} option (but directories specified with
18081 @option{-L} come first).
18083 @item LANG
18084 @findex LANG
18085 @cindex locale definition
18086 This variable is used to pass locale information to the compiler.  One way in
18087 which this information is used is to determine the character set to be used
18088 when character literals, string literals and comments are parsed in C and C++.
18089 When the compiler is configured to allow multibyte characters,
18090 the following values for @env{LANG} are recognized:
18092 @table @samp
18093 @item C-JIS
18094 Recognize JIS characters.
18095 @item C-SJIS
18096 Recognize SJIS characters.
18097 @item C-EUCJP
18098 Recognize EUCJP characters.
18099 @end table
18101 If @env{LANG} is not defined, or if it has some other value, then the
18102 compiler will use mblen and mbtowc as defined by the default locale to
18103 recognize and translate multibyte characters.
18104 @end table
18106 @noindent
18107 Some additional environments variables affect the behavior of the
18108 preprocessor.
18110 @include cppenv.texi
18112 @c man end
18114 @node Precompiled Headers
18115 @section Using Precompiled Headers
18116 @cindex precompiled headers
18117 @cindex speed of compilation
18119 Often large projects have many header files that are included in every
18120 source file.  The time the compiler takes to process these header files
18121 over and over again can account for nearly all of the time required to
18122 build the project.  To make builds faster, GCC allows users to
18123 `precompile' a header file; then, if builds can use the precompiled
18124 header file they will be much faster.
18126 To create a precompiled header file, simply compile it as you would any
18127 other file, if necessary using the @option{-x} option to make the driver
18128 treat it as a C or C++ header file.  You will probably want to use a
18129 tool like @command{make} to keep the precompiled header up-to-date when
18130 the headers it contains change.
18132 A precompiled header file will be searched for when @code{#include} is
18133 seen in the compilation.  As it searches for the included file
18134 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
18135 compiler looks for a precompiled header in each directory just before it
18136 looks for the include file in that directory.  The name searched for is
18137 the name specified in the @code{#include} with @samp{.gch} appended.  If
18138 the precompiled header file can't be used, it is ignored.
18140 For instance, if you have @code{#include "all.h"}, and you have
18141 @file{all.h.gch} in the same directory as @file{all.h}, then the
18142 precompiled header file will be used if possible, and the original
18143 header will be used otherwise.
18145 Alternatively, you might decide to put the precompiled header file in a
18146 directory and use @option{-I} to ensure that directory is searched
18147 before (or instead of) the directory containing the original header.
18148 Then, if you want to check that the precompiled header file is always
18149 used, you can put a file of the same name as the original header in this
18150 directory containing an @code{#error} command.
18152 This also works with @option{-include}.  So yet another way to use
18153 precompiled headers, good for projects not designed with precompiled
18154 header files in mind, is to simply take most of the header files used by
18155 a project, include them from another header file, precompile that header
18156 file, and @option{-include} the precompiled header.  If the header files
18157 have guards against multiple inclusion, they will be skipped because
18158 they've already been included (in the precompiled header).
18160 If you need to precompile the same header file for different
18161 languages, targets, or compiler options, you can instead make a
18162 @emph{directory} named like @file{all.h.gch}, and put each precompiled
18163 header in the directory, perhaps using @option{-o}.  It doesn't matter
18164 what you call the files in the directory, every precompiled header in
18165 the directory will be considered.  The first precompiled header
18166 encountered in the directory that is valid for this compilation will
18167 be used; they're searched in no particular order.
18169 There are many other possibilities, limited only by your imagination,
18170 good sense, and the constraints of your build system.
18172 A precompiled header file can be used only when these conditions apply:
18174 @itemize
18175 @item
18176 Only one precompiled header can be used in a particular compilation.
18178 @item
18179 A precompiled header can't be used once the first C token is seen.  You
18180 can have preprocessor directives before a precompiled header; you can
18181 even include a precompiled header from inside another header, so long as
18182 there are no C tokens before the @code{#include}.
18184 @item
18185 The precompiled header file must be produced for the same language as
18186 the current compilation.  You can't use a C precompiled header for a C++
18187 compilation.
18189 @item
18190 The precompiled header file must have been produced by the same compiler
18191 binary as the current compilation is using.
18193 @item
18194 Any macros defined before the precompiled header is included must
18195 either be defined in the same way as when the precompiled header was
18196 generated, or must not affect the precompiled header, which usually
18197 means that they don't appear in the precompiled header at all.
18199 The @option{-D} option is one way to define a macro before a
18200 precompiled header is included; using a @code{#define} can also do it.
18201 There are also some options that define macros implicitly, like
18202 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
18203 defined this way.
18205 @item If debugging information is output when using the precompiled
18206 header, using @option{-g} or similar, the same kind of debugging information
18207 must have been output when building the precompiled header.  However,
18208 a precompiled header built using @option{-g} can be used in a compilation
18209 when no debugging information is being output.
18211 @item The same @option{-m} options must generally be used when building
18212 and using the precompiled header.  @xref{Submodel Options},
18213 for any cases where this rule is relaxed.
18215 @item Each of the following options must be the same when building and using
18216 the precompiled header:
18218 @gccoptlist{-fexceptions}
18220 @item
18221 Some other command-line options starting with @option{-f},
18222 @option{-p}, or @option{-O} must be defined in the same way as when
18223 the precompiled header was generated.  At present, it's not clear
18224 which options are safe to change and which are not; the safest choice
18225 is to use exactly the same options when generating and using the
18226 precompiled header.  The following are known to be safe:
18228 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
18229 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
18230 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
18231 -pedantic-errors}
18233 @end itemize
18235 For all of these except the last, the compiler will automatically
18236 ignore the precompiled header if the conditions aren't met.  If you
18237 find an option combination that doesn't work and doesn't cause the
18238 precompiled header to be ignored, please consider filing a bug report,
18239 see @ref{Bugs}.
18241 If you do use differing options when generating and using the
18242 precompiled header, the actual behavior will be a mixture of the
18243 behavior for the options.  For instance, if you use @option{-g} to
18244 generate the precompiled header but not when using it, you may or may
18245 not get debugging information for routines in the precompiled header.