* config.gcc (c_target_objs)[i?86-*-pe|i?86-*-cygwin*]: Don't add
[official-gcc.git] / gcc / doc / invoke.texi
blob776fdd0a6010d18fd1b02da2e761a275713e9457
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}  -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 -fplan9-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 -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
239 -Wno-endif-labels -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 @gol
267 -Wunused-variable -Wunused-but-set-parameter -Wunused-but-set-variable @gol
268 -Wvariadic-macros -Wvla -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 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
314 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
315 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
316 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
317 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
318 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
319 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
320 -gvms  -gxcoff  -gxcoff+ @gol
321 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
322 -fdebug-prefix-map=@var{old}=@var{new} @gol
323 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
324 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
325 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
326 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
327 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
328 -print-sysroot -print-sysroot-headers-suffix @gol
329 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
331 @item Optimization Options
332 @xref{Optimize Options,,Options that Control Optimization}.
333 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
334 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
335 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
336 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
337 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
338 -fcprop-registers -fcrossjumping @gol
339 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
340 -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 @gol
350 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
351 -fipa-struct-reorg -fira-algorithm=@var{algorithm} @gol
352 -fira-region=@var{region} @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-flatten -floop-interchange -floop-strip-mine @gol
357 -floop-parallelize-all -flto -flto-compression-level -flto-partition=@var{alg} @gol
358 -flto-report -fltrans -fltrans-output-list -fmerge-all-constants @gol
359 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
360 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
361 -fno-default-inline @gol
362 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
363 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
364 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
365 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
366 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
367 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
368 -fprefetch-loop-arrays @gol
369 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
370 -fprofile-generate=@var{path} @gol
371 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
372 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
373 -freorder-blocks-and-partition -freorder-functions @gol
374 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
375 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
376 -fsched-spec-load -fsched-spec-load-dangerous @gol
377 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
378 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
379 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
380 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
381 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
382 -fselective-scheduling -fselective-scheduling2 @gol
383 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
384 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
385 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
386 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
387 -ftree-bit-ccp @gol
388 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
389 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
390 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
391 -ftree-loop-if-convert-memory-writes -ftree-loop-im @gol
392 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
393 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
394 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
395 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
396 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
397 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
398 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
399 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
400 -fwhole-program -fwhopr[=@var{n}] -fwpa -fuse-linker-plugin @gol
401 --param @var{name}=@var{value}
402 -O  -O0  -O1  -O2  -O3  -Os -Ofast}
404 @item Preprocessor Options
405 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
406 @gccoptlist{-A@var{question}=@var{answer} @gol
407 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
408 -C  -dD  -dI  -dM  -dN @gol
409 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
410 -idirafter @var{dir} @gol
411 -include @var{file}  -imacros @var{file} @gol
412 -iprefix @var{file}  -iwithprefix @var{dir} @gol
413 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
414 -imultilib @var{dir} -isysroot @var{dir} @gol
415 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
416 -P  -fworking-directory  -remap @gol
417 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
418 -Xpreprocessor @var{option}}
420 @item Assembler Option
421 @xref{Assembler Options,,Passing Options to the Assembler}.
422 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
424 @item Linker Options
425 @xref{Link Options,,Options for Linking}.
426 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
427 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
428 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
429 -shared-libgcc  -symbolic @gol
430 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
431 -u @var{symbol}}
433 @item Directory Options
434 @xref{Directory Options,,Options for Directory Search}.
435 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir}}
436 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I-
437 --sysroot=@var{dir}
439 @item Machine Dependent Options
440 @xref{Submodel Options,,Hardware Models and Configurations}.
441 @c This list is ordered alphanumerically by subsection name.
442 @c Try and put the significant identifier (CPU or system) first,
443 @c so users have a clue at guessing where the ones they want will be.
445 @emph{ARC Options}
446 @gccoptlist{-EB  -EL @gol
447 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
448 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
450 @emph{ARM Options}
451 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
452 -mabi=@var{name} @gol
453 -mapcs-stack-check  -mno-apcs-stack-check @gol
454 -mapcs-float  -mno-apcs-float @gol
455 -mapcs-reentrant  -mno-apcs-reentrant @gol
456 -msched-prolog  -mno-sched-prolog @gol
457 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
458 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
459 -mfp16-format=@var{name}
460 -mthumb-interwork  -mno-thumb-interwork @gol
461 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
462 -mstructure-size-boundary=@var{n} @gol
463 -mabort-on-noreturn @gol
464 -mlong-calls  -mno-long-calls @gol
465 -msingle-pic-base  -mno-single-pic-base @gol
466 -mpic-register=@var{reg} @gol
467 -mnop-fun-dllimport @gol
468 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
469 -mpoke-function-name @gol
470 -mthumb  -marm @gol
471 -mtpcs-frame  -mtpcs-leaf-frame @gol
472 -mcaller-super-interworking  -mcallee-super-interworking @gol
473 -mtp=@var{name} @gol
474 -mword-relocations @gol
475 -mfix-cortex-m3-ldrd}
477 @emph{AVR Options}
478 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
479 -mcall-prologues  -mtiny-stack  -mint8}
481 @emph{Blackfin Options}
482 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
483 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
484 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
485 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
486 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
487 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
488 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
489 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
490 -micplb}
492 @emph{CRIS Options}
493 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
494 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
495 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
496 -mstack-align  -mdata-align  -mconst-align @gol
497 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
498 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
499 -mmul-bug-workaround  -mno-mul-bug-workaround}
501 @emph{CRX Options}
502 @gccoptlist{-mmac -mpush-args}
504 @emph{Darwin Options}
505 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
506 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
507 -client_name  -compatibility_version  -current_version @gol
508 -dead_strip @gol
509 -dependency-file  -dylib_file  -dylinker_install_name @gol
510 -dynamic  -dynamiclib  -exported_symbols_list @gol
511 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
512 -force_flat_namespace  -headerpad_max_install_names @gol
513 -iframework @gol
514 -image_base  -init  -install_name  -keep_private_externs @gol
515 -multi_module  -multiply_defined  -multiply_defined_unused @gol
516 -noall_load   -no_dead_strip_inits_and_terms @gol
517 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
518 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
519 -private_bundle  -read_only_relocs  -sectalign @gol
520 -sectobjectsymbols  -whyload  -seg1addr @gol
521 -sectcreate  -sectobjectsymbols  -sectorder @gol
522 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
523 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
524 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
525 -single_module  -static  -sub_library  -sub_umbrella @gol
526 -twolevel_namespace  -umbrella  -undefined @gol
527 -unexported_symbols_list  -weak_reference_mismatches @gol
528 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
529 -mkernel -mone-byte-bool}
531 @emph{DEC Alpha Options}
532 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
533 -mieee  -mieee-with-inexact  -mieee-conformant @gol
534 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
535 -mtrap-precision=@var{mode}  -mbuild-constants @gol
536 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
537 -mbwx  -mmax  -mfix  -mcix @gol
538 -mfloat-vax  -mfloat-ieee @gol
539 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
540 -msmall-text  -mlarge-text @gol
541 -mmemory-latency=@var{time}}
543 @emph{DEC Alpha/VMS Options}
544 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
546 @emph{FR30 Options}
547 @gccoptlist{-msmall-model -mno-lsim}
549 @emph{FRV Options}
550 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
551 -mhard-float  -msoft-float @gol
552 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
553 -mdouble  -mno-double @gol
554 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
555 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
556 -mlinked-fp  -mlong-calls  -malign-labels @gol
557 -mlibrary-pic  -macc-4  -macc-8 @gol
558 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
559 -moptimize-membar -mno-optimize-membar @gol
560 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
561 -mvliw-branch  -mno-vliw-branch @gol
562 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
563 -mno-nested-cond-exec  -mtomcat-stats @gol
564 -mTLS -mtls @gol
565 -mcpu=@var{cpu}}
567 @emph{GNU/Linux Options}
568 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
569 -tno-android-cc -tno-android-ld}
571 @emph{H8/300 Options}
572 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
574 @emph{HPPA Options}
575 @gccoptlist{-march=@var{architecture-type} @gol
576 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
577 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
578 -mfixed-range=@var{register-range} @gol
579 -mjump-in-delay -mlinker-opt -mlong-calls @gol
580 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
581 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
582 -mno-jump-in-delay  -mno-long-load-store @gol
583 -mno-portable-runtime  -mno-soft-float @gol
584 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
585 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
586 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
587 -munix=@var{unix-std}  -nolibdld  -static  -threads}
589 @emph{i386 and x86-64 Options}
590 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
591 -mfpmath=@var{unit} @gol
592 -masm=@var{dialect}  -mno-fancy-math-387 @gol
593 -mno-fp-ret-in-387  -msoft-float @gol
594 -mno-wide-multiply  -mrtd  -malign-double @gol
595 -mpreferred-stack-boundary=@var{num}
596 -mincoming-stack-boundary=@var{num} @gol
597 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
598 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
599 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfused-madd @gol
600 -msse4a -m3dnow -mpopcnt -mabm -mfma4 -mxop -mlwp @gol
601 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
602 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
603 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
604 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
605 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
606 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
607 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
608 -mcmodel=@var{code-model} -mabi=@var{name} @gol
609 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
610 -msse2avx -mfentry -m8bit-idiv}
612 @emph{IA-64 Options}
613 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
614 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
615 -mconstant-gp  -mauto-pic  -mfused-madd @gol
616 -minline-float-divide-min-latency @gol
617 -minline-float-divide-max-throughput @gol
618 -mno-inline-float-divide @gol
619 -minline-int-divide-min-latency @gol
620 -minline-int-divide-max-throughput  @gol
621 -mno-inline-int-divide @gol
622 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
623 -mno-inline-sqrt @gol
624 -mdwarf2-asm -mearly-stop-bits @gol
625 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
626 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
627 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
628 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
629 -msched-spec-ldc -msched-spec-control-ldc @gol
630 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
631 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
632 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
633 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
635 @emph{IA-64/VMS Options}
636 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
638 @emph{LM32 Options}
639 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
640 -msign-extend-enabled -muser-enabled}
642 @emph{M32R/D Options}
643 @gccoptlist{-m32r2 -m32rx -m32r @gol
644 -mdebug @gol
645 -malign-loops -mno-align-loops @gol
646 -missue-rate=@var{number} @gol
647 -mbranch-cost=@var{number} @gol
648 -mmodel=@var{code-size-model-type} @gol
649 -msdata=@var{sdata-type} @gol
650 -mno-flush-func -mflush-func=@var{name} @gol
651 -mno-flush-trap -mflush-trap=@var{number} @gol
652 -G @var{num}}
654 @emph{M32C Options}
655 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
657 @emph{M680x0 Options}
658 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
659 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
660 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
661 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
662 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
663 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
664 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
665 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
666 -mxgot -mno-xgot}
668 @emph{M68hc1x Options}
669 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
670 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
671 -msoft-reg-count=@var{count}}
673 @emph{MCore Options}
674 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
675 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
676 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
677 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
678 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
680 @emph{MeP Options}
681 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
682 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
683 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
684 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
685 -mtiny=@var{n}}
687 @emph{MicroBlaze Options}
688 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
689 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
690 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
691 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
692 -mxl-mode-@var{app-model}}
694 @emph{MIPS Options}
695 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
696 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
697 -mips64  -mips64r2 @gol
698 -mips16  -mno-mips16  -mflip-mips16 @gol
699 -minterlink-mips16  -mno-interlink-mips16 @gol
700 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
701 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
702 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
703 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
704 -mfpu=@var{fpu-type} @gol
705 -msmartmips  -mno-smartmips @gol
706 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
707 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
708 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
709 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
710 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
711 -membedded-data  -mno-embedded-data @gol
712 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
713 -mcode-readable=@var{setting} @gol
714 -msplit-addresses  -mno-split-addresses @gol
715 -mexplicit-relocs  -mno-explicit-relocs @gol
716 -mcheck-zero-division  -mno-check-zero-division @gol
717 -mdivide-traps  -mdivide-breaks @gol
718 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
719 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
720 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
721 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
722 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
723 -mflush-func=@var{func}  -mno-flush-func @gol
724 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
725 -mfp-exceptions -mno-fp-exceptions @gol
726 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
727 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
729 @emph{MMIX Options}
730 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
731 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
732 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
733 -mno-base-addresses  -msingle-exit  -mno-single-exit}
735 @emph{MN10300 Options}
736 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
737 -mam33  -mno-am33 @gol
738 -mam33-2  -mno-am33-2 @gol
739 -mreturn-pointer-on-d0 @gol
740 -mno-crt0  -mrelax}
742 @emph{PDP-11 Options}
743 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
744 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
745 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
746 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
747 -mbranch-expensive  -mbranch-cheap @gol
748 -msplit  -mno-split  -munix-asm  -mdec-asm}
750 @emph{picoChip Options}
751 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
752 -msymbol-as-address -mno-inefficient-warnings}
754 @emph{PowerPC Options}
755 See RS/6000 and PowerPC Options.
757 @emph{RS/6000 and PowerPC Options}
758 @gccoptlist{-mcpu=@var{cpu-type} @gol
759 -mtune=@var{cpu-type} @gol
760 -mcmodel=@var{code-model} @gol
761 -mpower  -mno-power  -mpower2  -mno-power2 @gol
762 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
763 -maltivec  -mno-altivec @gol
764 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
765 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
766 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
767 -mfprnd  -mno-fprnd @gol
768 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
769 -mnew-mnemonics  -mold-mnemonics @gol
770 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
771 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
772 -malign-power  -malign-natural @gol
773 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
774 -msingle-float -mdouble-float -msimple-fpu @gol
775 -mstring  -mno-string  -mupdate  -mno-update @gol
776 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
777 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
778 -mstrict-align  -mno-strict-align  -mrelocatable @gol
779 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
780 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
781 -mdynamic-no-pic  -maltivec -mswdiv @gol
782 -mprioritize-restricted-insns=@var{priority} @gol
783 -msched-costly-dep=@var{dependence_type} @gol
784 -minsert-sched-nops=@var{scheme} @gol
785 -mcall-sysv  -mcall-netbsd @gol
786 -maix-struct-return  -msvr4-struct-return @gol
787 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
788 -mblock-move-inline-limit=@var{num} @gol
789 -misel -mno-isel @gol
790 -misel=yes  -misel=no @gol
791 -mspe -mno-spe @gol
792 -mspe=yes  -mspe=no @gol
793 -mpaired @gol
794 -mgen-cell-microcode -mwarn-cell-microcode @gol
795 -mvrsave -mno-vrsave @gol
796 -mmulhw -mno-mulhw @gol
797 -mdlmzb -mno-dlmzb @gol
798 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
799 -mprototype  -mno-prototype @gol
800 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
801 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
802 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision
803 -mno-recip-precision @gol
804 -mveclibabi=@var{type} -mfriz -mno-friz}
806 @emph{RX Options}
807 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
808 -mcpu=@gol
809 -mbig-endian-data -mlittle-endian-data @gol
810 -msmall-data @gol
811 -msim  -mno-sim@gol
812 -mas100-syntax -mno-as100-syntax@gol
813 -mrelax@gol
814 -mmax-constant-size=@gol
815 -mint-register=@gol
816 -msave-acc-in-interrupts}
818 @emph{S/390 and zSeries Options}
819 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
820 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
821 -mlong-double-64 -mlong-double-128 @gol
822 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
823 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
824 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
825 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
826 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
828 @emph{Score Options}
829 @gccoptlist{-meb -mel @gol
830 -mnhwloop @gol
831 -muls @gol
832 -mmac @gol
833 -mscore5 -mscore5u -mscore7 -mscore7d}
835 @emph{SH Options}
836 @gccoptlist{-m1  -m2  -m2e @gol
837 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
838 -m3  -m3e @gol
839 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
840 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
841 -m5-64media  -m5-64media-nofpu @gol
842 -m5-32media  -m5-32media-nofpu @gol
843 -m5-compact  -m5-compact-nofpu @gol
844 -mb  -ml  -mdalign  -mrelax @gol
845 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
846 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
847 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
848 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
849 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
850 -maccumulate-outgoing-args -minvalid-symbols}
852 @emph{Solaris 2 Options}
853 @gccoptlist{-mimpure-text  -mno-impure-text @gol
854 -threads -pthreads -pthread}
856 @emph{SPARC Options}
857 @gccoptlist{-mcpu=@var{cpu-type} @gol
858 -mtune=@var{cpu-type} @gol
859 -mcmodel=@var{code-model} @gol
860 -m32  -m64  -mapp-regs  -mno-app-regs @gol
861 -mfaster-structs  -mno-faster-structs @gol
862 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
863 -mhard-quad-float  -msoft-quad-float @gol
864 -mlittle-endian @gol
865 -mstack-bias  -mno-stack-bias @gol
866 -munaligned-doubles  -mno-unaligned-doubles @gol
867 -mv8plus  -mno-v8plus  -mvis  -mno-vis}
869 @emph{SPU Options}
870 @gccoptlist{-mwarn-reloc -merror-reloc @gol
871 -msafe-dma -munsafe-dma @gol
872 -mbranch-hints @gol
873 -msmall-mem -mlarge-mem -mstdmain @gol
874 -mfixed-range=@var{register-range} @gol
875 -mea32 -mea64 @gol
876 -maddress-space-conversion -mno-address-space-conversion @gol
877 -mcache-size=@var{cache-size} @gol
878 -matomic-updates -mno-atomic-updates}
880 @emph{System V Options}
881 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
883 @emph{V850 Options}
884 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
885 -mprolog-function  -mno-prolog-function  -mspace @gol
886 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
887 -mapp-regs  -mno-app-regs @gol
888 -mdisable-callt  -mno-disable-callt @gol
889 -mv850e2v3 @gol
890 -mv850e2 @gol
891 -mv850e1 @gol
892 -mv850e @gol
893 -mv850  -mbig-switch}
895 @emph{VAX Options}
896 @gccoptlist{-mg  -mgnu  -munix}
898 @emph{VxWorks Options}
899 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
900 -Xbind-lazy  -Xbind-now}
902 @emph{x86-64 Options}
903 See i386 and x86-64 Options.
905 @emph{i386 and x86-64 Windows Options}
906 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
907 -mnop-fun-dllimport -mthread @gol
908 -municode -mwin32 -mwindows -fno-set-stack-executable}
910 @emph{Xstormy16 Options}
911 @gccoptlist{-msim}
913 @emph{Xtensa Options}
914 @gccoptlist{-mconst16 -mno-const16 @gol
915 -mfused-madd  -mno-fused-madd @gol
916 -mforce-no-pic @gol
917 -mserialize-volatile  -mno-serialize-volatile @gol
918 -mtext-section-literals  -mno-text-section-literals @gol
919 -mtarget-align  -mno-target-align @gol
920 -mlongcalls  -mno-longcalls}
922 @emph{zSeries Options}
923 See S/390 and zSeries Options.
925 @item Code Generation Options
926 @xref{Code Gen Options,,Options for Code Generation Conventions}.
927 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
928 -ffixed-@var{reg}  -fexceptions @gol
929 -fnon-call-exceptions  -funwind-tables @gol
930 -fasynchronous-unwind-tables @gol
931 -finhibit-size-directive  -finstrument-functions @gol
932 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
933 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
934 -fno-common  -fno-ident @gol
935 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
936 -fno-jump-tables @gol
937 -frecord-gcc-switches @gol
938 -freg-struct-return  -fshort-enums @gol
939 -fshort-double  -fshort-wchar @gol
940 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
941 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
942 -fno-stack-limit -fsplit-stack @gol
943 -fleading-underscore  -ftls-model=@var{model} @gol
944 -ftrapv  -fwrapv  -fbounds-check @gol
945 -fvisibility}
946 @end table
948 @menu
949 * Overall Options::     Controlling the kind of output:
950                         an executable, object files, assembler files,
951                         or preprocessed source.
952 * C Dialect Options::   Controlling the variant of C language compiled.
953 * C++ Dialect Options:: Variations on C++.
954 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
955                         and Objective-C++.
956 * Language Independent Options:: Controlling how diagnostics should be
957                         formatted.
958 * Warning Options::     How picky should the compiler be?
959 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
960 * Optimize Options::    How much optimization?
961 * Preprocessor Options:: Controlling header files and macro definitions.
962                          Also, getting dependency information for Make.
963 * Assembler Options::   Passing options to the assembler.
964 * Link Options::        Specifying libraries and so on.
965 * Directory Options::   Where to find header files and libraries.
966                         Where to find the compiler executable files.
967 * Spec Files::          How to pass switches to sub-processes.
968 * Target Options::      Running a cross-compiler, or an old version of GCC.
969 @end menu
971 @node Overall Options
972 @section Options Controlling the Kind of Output
974 Compilation can involve up to four stages: preprocessing, compilation
975 proper, assembly and linking, always in that order.  GCC is capable of
976 preprocessing and compiling several files either into several
977 assembler input files, or into one assembler input file; then each
978 assembler input file produces an object file, and linking combines all
979 the object files (those newly compiled, and those specified as input)
980 into an executable file.
982 @cindex file name suffix
983 For any given input file, the file name suffix determines what kind of
984 compilation is done:
986 @table @gcctabopt
987 @item @var{file}.c
988 C source code which must be preprocessed.
990 @item @var{file}.i
991 C source code which should not be preprocessed.
993 @item @var{file}.ii
994 C++ source code which should not be preprocessed.
996 @item @var{file}.m
997 Objective-C source code.  Note that you must link with the @file{libobjc}
998 library to make an Objective-C program work.
1000 @item @var{file}.mi
1001 Objective-C source code which should not be preprocessed.
1003 @item @var{file}.mm
1004 @itemx @var{file}.M
1005 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1006 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1007 to a literal capital M@.
1009 @item @var{file}.mii
1010 Objective-C++ source code which should not be preprocessed.
1012 @item @var{file}.h
1013 C, C++, Objective-C or Objective-C++ header file to be turned into a
1014 precompiled header (default), or C, C++ header file to be turned into an
1015 Ada spec (via the @option{-fdump-ada-spec} switch).
1017 @item @var{file}.cc
1018 @itemx @var{file}.cp
1019 @itemx @var{file}.cxx
1020 @itemx @var{file}.cpp
1021 @itemx @var{file}.CPP
1022 @itemx @var{file}.c++
1023 @itemx @var{file}.C
1024 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
1025 the last two letters must both be literally @samp{x}.  Likewise,
1026 @samp{.C} refers to a literal capital C@.
1028 @item @var{file}.mm
1029 @itemx @var{file}.M
1030 Objective-C++ source code which must be preprocessed.
1032 @item @var{file}.mii
1033 Objective-C++ source code which should not be preprocessed.
1035 @item @var{file}.hh
1036 @itemx @var{file}.H
1037 @itemx @var{file}.hp
1038 @itemx @var{file}.hxx
1039 @itemx @var{file}.hpp
1040 @itemx @var{file}.HPP
1041 @itemx @var{file}.h++
1042 @itemx @var{file}.tcc
1043 C++ header file to be turned into a precompiled header or Ada spec.
1045 @item @var{file}.f
1046 @itemx @var{file}.for
1047 @itemx @var{file}.ftn
1048 Fixed form Fortran source code which should not be preprocessed.
1050 @item @var{file}.F
1051 @itemx @var{file}.FOR
1052 @itemx @var{file}.fpp
1053 @itemx @var{file}.FPP
1054 @itemx @var{file}.FTN
1055 Fixed form Fortran source code which must be preprocessed (with the traditional
1056 preprocessor).
1058 @item @var{file}.f90
1059 @itemx @var{file}.f95
1060 @itemx @var{file}.f03
1061 @itemx @var{file}.f08
1062 Free form Fortran source code which should not be preprocessed.
1064 @item @var{file}.F90
1065 @itemx @var{file}.F95
1066 @itemx @var{file}.F03
1067 @itemx @var{file}.F08
1068 Free form Fortran source code which must be preprocessed (with the
1069 traditional preprocessor).
1071 @c FIXME: Descriptions of Java file types.
1072 @c @var{file}.java
1073 @c @var{file}.class
1074 @c @var{file}.zip
1075 @c @var{file}.jar
1077 @item @var{file}.ads
1078 Ada source code file which contains a library unit declaration (a
1079 declaration of a package, subprogram, or generic, or a generic
1080 instantiation), or a library unit renaming declaration (a package,
1081 generic, or subprogram renaming declaration).  Such files are also
1082 called @dfn{specs}.
1084 @item @var{file}.adb
1085 Ada source code file containing a library unit body (a subprogram or
1086 package body).  Such files are also called @dfn{bodies}.
1088 @c GCC also knows about some suffixes for languages not yet included:
1089 @c Pascal:
1090 @c @var{file}.p
1091 @c @var{file}.pas
1092 @c Ratfor:
1093 @c @var{file}.r
1095 @item @var{file}.s
1096 Assembler code.
1098 @item @var{file}.S
1099 @itemx @var{file}.sx
1100 Assembler code which must be preprocessed.
1102 @item @var{other}
1103 An object file to be fed straight into linking.
1104 Any file name with no recognized suffix is treated this way.
1105 @end table
1107 @opindex x
1108 You can specify the input language explicitly with the @option{-x} option:
1110 @table @gcctabopt
1111 @item -x @var{language}
1112 Specify explicitly the @var{language} for the following input files
1113 (rather than letting the compiler choose a default based on the file
1114 name suffix).  This option applies to all following input files until
1115 the next @option{-x} option.  Possible values for @var{language} are:
1116 @smallexample
1117 c  c-header  cpp-output
1118 c++  c++-header  c++-cpp-output
1119 objective-c  objective-c-header  objective-c-cpp-output
1120 objective-c++ objective-c++-header objective-c++-cpp-output
1121 assembler  assembler-with-cpp
1123 f77  f77-cpp-input f95  f95-cpp-input
1124 java
1125 @end smallexample
1127 @item -x none
1128 Turn off any specification of a language, so that subsequent files are
1129 handled according to their file name suffixes (as they are if @option{-x}
1130 has not been used at all).
1132 @item -pass-exit-codes
1133 @opindex pass-exit-codes
1134 Normally the @command{gcc} program will exit with the code of 1 if any
1135 phase of the compiler returns a non-success return code.  If you specify
1136 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1137 numerically highest error produced by any phase that returned an error
1138 indication.  The C, C++, and Fortran frontends return 4, if an internal
1139 compiler error is encountered.
1140 @end table
1142 If you only want some of the stages of compilation, you can use
1143 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1144 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1145 @command{gcc} is to stop.  Note that some combinations (for example,
1146 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1148 @table @gcctabopt
1149 @item -c
1150 @opindex c
1151 Compile or assemble the source files, but do not link.  The linking
1152 stage simply is not done.  The ultimate output is in the form of an
1153 object file for each source file.
1155 By default, the object file name for a source file is made by replacing
1156 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1158 Unrecognized input files, not requiring compilation or assembly, are
1159 ignored.
1161 @item -S
1162 @opindex S
1163 Stop after the stage of compilation proper; do not assemble.  The output
1164 is in the form of an assembler code file for each non-assembler input
1165 file specified.
1167 By default, the assembler file name for a source file is made by
1168 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1170 Input files that don't require compilation are ignored.
1172 @item -E
1173 @opindex E
1174 Stop after the preprocessing stage; do not run the compiler proper.  The
1175 output is in the form of preprocessed source code, which is sent to the
1176 standard output.
1178 Input files which don't require preprocessing are ignored.
1180 @cindex output file option
1181 @item -o @var{file}
1182 @opindex o
1183 Place output in file @var{file}.  This applies regardless to whatever
1184 sort of output is being produced, whether it be an executable file,
1185 an object file, an assembler file or preprocessed C code.
1187 If @option{-o} is not specified, the default is to put an executable
1188 file in @file{a.out}, the object file for
1189 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1190 assembler file in @file{@var{source}.s}, a precompiled header file in
1191 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1192 standard output.
1194 @item -v
1195 @opindex v
1196 Print (on standard error output) the commands executed to run the stages
1197 of compilation.  Also print the version number of the compiler driver
1198 program and of the preprocessor and the compiler proper.
1200 @item -###
1201 @opindex ###
1202 Like @option{-v} except the commands are not executed and arguments
1203 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1204 This is useful for shell scripts to capture the driver-generated command lines.
1206 @item -pipe
1207 @opindex pipe
1208 Use pipes rather than temporary files for communication between the
1209 various stages of compilation.  This fails to work on some systems where
1210 the assembler is unable to read from a pipe; but the GNU assembler has
1211 no trouble.
1213 @item --help
1214 @opindex help
1215 Print (on the standard output) a description of the command line options
1216 understood by @command{gcc}.  If the @option{-v} option is also specified
1217 then @option{--help} will also be passed on to the various processes
1218 invoked by @command{gcc}, so that they can display the command line options
1219 they accept.  If the @option{-Wextra} option has also been specified
1220 (prior to the @option{--help} option), then command line options which
1221 have no documentation associated with them will also be displayed.
1223 @item --target-help
1224 @opindex target-help
1225 Print (on the standard output) a description of target-specific command
1226 line options for each tool.  For some targets extra target-specific
1227 information may also be printed.
1229 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1230 Print (on the standard output) a description of the command line
1231 options understood by the compiler that fit into all specified classes
1232 and qualifiers.  These are the supported classes:
1234 @table @asis
1235 @item @samp{optimizers}
1236 This will display all of the optimization options supported by the
1237 compiler.
1239 @item @samp{warnings}
1240 This will display all of the options controlling warning messages
1241 produced by the compiler.
1243 @item @samp{target}
1244 This will display target-specific options.  Unlike the
1245 @option{--target-help} option however, target-specific options of the
1246 linker and assembler will not be displayed.  This is because those
1247 tools do not currently support the extended @option{--help=} syntax.
1249 @item @samp{params}
1250 This will display the values recognized by the @option{--param}
1251 option.
1253 @item @var{language}
1254 This will display the options supported for @var{language}, where
1255 @var{language} is the name of one of the languages supported in this
1256 version of GCC.
1258 @item @samp{common}
1259 This will display the options that are common to all languages.
1260 @end table
1262 These are the supported qualifiers:
1264 @table @asis
1265 @item @samp{undocumented}
1266 Display only those options which are undocumented.
1268 @item @samp{joined}
1269 Display options which take an argument that appears after an equal
1270 sign in the same continuous piece of text, such as:
1271 @samp{--help=target}.
1273 @item @samp{separate}
1274 Display options which take an argument that appears as a separate word
1275 following the original option, such as: @samp{-o output-file}.
1276 @end table
1278 Thus for example to display all the undocumented target-specific
1279 switches supported by the compiler the following can be used:
1281 @smallexample
1282 --help=target,undocumented
1283 @end smallexample
1285 The sense of a qualifier can be inverted by prefixing it with the
1286 @samp{^} character, so for example to display all binary warning
1287 options (i.e., ones that are either on or off and that do not take an
1288 argument), which have a description the following can be used:
1290 @smallexample
1291 --help=warnings,^joined,^undocumented
1292 @end smallexample
1294 The argument to @option{--help=} should not consist solely of inverted
1295 qualifiers.
1297 Combining several classes is possible, although this usually
1298 restricts the output by so much that there is nothing to display.  One
1299 case where it does work however is when one of the classes is
1300 @var{target}.  So for example to display all the target-specific
1301 optimization options the following can be used:
1303 @smallexample
1304 --help=target,optimizers
1305 @end smallexample
1307 The @option{--help=} option can be repeated on the command line.  Each
1308 successive use will display its requested class of options, skipping
1309 those that have already been displayed.
1311 If the @option{-Q} option appears on the command line before the
1312 @option{--help=} option, then the descriptive text displayed by
1313 @option{--help=} is changed.  Instead of describing the displayed
1314 options, an indication is given as to whether the option is enabled,
1315 disabled or set to a specific value (assuming that the compiler
1316 knows this at the point where the @option{--help=} option is used).
1318 Here is a truncated example from the ARM port of @command{gcc}:
1320 @smallexample
1321   % gcc -Q -mabi=2 --help=target -c
1322   The following options are target specific:
1323   -mabi=                                2
1324   -mabort-on-noreturn                   [disabled]
1325   -mapcs                                [disabled]
1326 @end smallexample
1328 The output is sensitive to the effects of previous command line
1329 options, so for example it is possible to find out which optimizations
1330 are enabled at @option{-O2} by using:
1332 @smallexample
1333 -Q -O2 --help=optimizers
1334 @end smallexample
1336 Alternatively you can discover which binary optimizations are enabled
1337 by @option{-O3} by using:
1339 @smallexample
1340 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1341 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1342 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1343 @end smallexample
1345 @item -no-canonical-prefixes
1346 @opindex no-canonical-prefixes
1347 Do not expand any symbolic links, resolve references to @samp{/../}
1348 or @samp{/./}, or make the path absolute when generating a relative
1349 prefix.
1351 @item --version
1352 @opindex version
1353 Display the version number and copyrights of the invoked GCC@.
1355 @item -wrapper
1356 @opindex wrapper
1357 Invoke all subcommands under a wrapper program. It takes a single
1358 comma separated list as an argument, which will be used to invoke
1359 the wrapper:
1361 @smallexample
1362 gcc -c t.c -wrapper gdb,--args
1363 @end smallexample
1365 This will invoke all subprograms of gcc under "gdb --args",
1366 thus cc1 invocation will be "gdb --args cc1 ...".
1368 @item -fplugin=@var{name}.so
1369 Load the plugin code in file @var{name}.so, assumed to be a
1370 shared object to be dlopen'd by the compiler.  The base name of
1371 the shared object file is used to identify the plugin for the
1372 purposes of argument parsing (See
1373 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1374 Each plugin should define the callback functions specified in the
1375 Plugins API.
1377 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1378 Define an argument called @var{key} with a value of @var{value}
1379 for the plugin called @var{name}.
1381 @item -fdump-ada-spec@r{[}-slim@r{]}
1382 For C and C++ source and include files, generate corresponding Ada
1383 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1384 GNAT User's Guide}, which provides detailed documentation on this feature.
1386 @include @value{srcdir}/../libiberty/at-file.texi
1387 @end table
1389 @node Invoking G++
1390 @section Compiling C++ Programs
1392 @cindex suffixes for C++ source
1393 @cindex C++ source file suffixes
1394 C++ source files conventionally use one of the suffixes @samp{.C},
1395 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1396 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1397 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1398 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1399 files with these names and compiles them as C++ programs even if you
1400 call the compiler the same way as for compiling C programs (usually
1401 with the name @command{gcc}).
1403 @findex g++
1404 @findex c++
1405 However, the use of @command{gcc} does not add the C++ library.
1406 @command{g++} is a program that calls GCC and treats @samp{.c},
1407 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1408 files unless @option{-x} is used, and automatically specifies linking
1409 against the C++ library.  This program is also useful when
1410 precompiling a C header file with a @samp{.h} extension for use in C++
1411 compilations.  On many systems, @command{g++} is also installed with
1412 the name @command{c++}.
1414 @cindex invoking @command{g++}
1415 When you compile C++ programs, you may specify many of the same
1416 command-line options that you use for compiling programs in any
1417 language; or command-line options meaningful for C and related
1418 languages; or options that are meaningful only for C++ programs.
1419 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1420 explanations of options for languages related to C@.
1421 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1422 explanations of options that are meaningful only for C++ programs.
1424 @node C Dialect Options
1425 @section Options Controlling C Dialect
1426 @cindex dialect options
1427 @cindex language dialect options
1428 @cindex options, dialect
1430 The following options control the dialect of C (or languages derived
1431 from C, such as C++, Objective-C and Objective-C++) that the compiler
1432 accepts:
1434 @table @gcctabopt
1435 @cindex ANSI support
1436 @cindex ISO support
1437 @item -ansi
1438 @opindex ansi
1439 In C mode, this is equivalent to @samp{-std=c90}. In C++ mode, it is
1440 equivalent to @samp{-std=c++98}.
1442 This turns off certain features of GCC that are incompatible with ISO
1443 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1444 such as the @code{asm} and @code{typeof} keywords, and
1445 predefined macros such as @code{unix} and @code{vax} that identify the
1446 type of system you are using.  It also enables the undesirable and
1447 rarely used ISO trigraph feature.  For the C compiler,
1448 it disables recognition of C++ style @samp{//} comments as well as
1449 the @code{inline} keyword.
1451 The alternate keywords @code{__asm__}, @code{__extension__},
1452 @code{__inline__} and @code{__typeof__} continue to work despite
1453 @option{-ansi}.  You would not want to use them in an ISO C program, of
1454 course, but it is useful to put them in header files that might be included
1455 in compilations done with @option{-ansi}.  Alternate predefined macros
1456 such as @code{__unix__} and @code{__vax__} are also available, with or
1457 without @option{-ansi}.
1459 The @option{-ansi} option does not cause non-ISO programs to be
1460 rejected gratuitously.  For that, @option{-pedantic} is required in
1461 addition to @option{-ansi}.  @xref{Warning Options}.
1463 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1464 option is used.  Some header files may notice this macro and refrain
1465 from declaring certain functions or defining certain macros that the
1466 ISO standard doesn't call for; this is to avoid interfering with any
1467 programs that might use these names for other things.
1469 Functions that would normally be built in but do not have semantics
1470 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1471 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1472 built-in functions provided by GCC}, for details of the functions
1473 affected.
1475 @item -std=
1476 @opindex std
1477 Determine the language standard. @xref{Standards,,Language Standards
1478 Supported by GCC}, for details of these standard versions.  This option
1479 is currently only supported when compiling C or C++.
1481 The compiler can accept several base standards, such as @samp{c90} or
1482 @samp{c++98}, and GNU dialects of those standards, such as
1483 @samp{gnu90} or @samp{gnu++98}.  By specifying a base standard, the
1484 compiler will accept all programs following that standard and those
1485 using GNU extensions that do not contradict it.  For example,
1486 @samp{-std=c90} turns off certain features of GCC that are
1487 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1488 keywords, but not other GNU extensions that do not have a meaning in
1489 ISO C90, such as omitting the middle term of a @code{?:}
1490 expression. On the other hand, by specifying a GNU dialect of a
1491 standard, all features the compiler support are enabled, even when
1492 those features change the meaning of the base standard and some
1493 strict-conforming programs may be rejected.  The particular standard
1494 is used by @option{-pedantic} to identify which features are GNU
1495 extensions given that version of the standard. For example
1496 @samp{-std=gnu90 -pedantic} would warn about C++ style @samp{//}
1497 comments, while @samp{-std=gnu99 -pedantic} would not.
1499 A value for this option must be provided; possible values are
1501 @table @samp
1502 @item c90
1503 @itemx c89
1504 @itemx iso9899:1990
1505 Support all ISO C90 programs (certain GNU extensions that conflict
1506 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1508 @item iso9899:199409
1509 ISO C90 as modified in amendment 1.
1511 @item c99
1512 @itemx c9x
1513 @itemx iso9899:1999
1514 @itemx iso9899:199x
1515 ISO C99.  Note that this standard is not yet fully supported; see
1516 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1517 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1519 @item c1x
1520 ISO C1X, the draft of the next revision of the ISO C standard.
1521 Support is limited and experimental and features enabled by this
1522 option may be changed or removed if changed in or removed from the
1523 standard draft.
1525 @item gnu90
1526 @itemx gnu89
1527 GNU dialect of ISO C90 (including some C99 features). This
1528 is the default for C code.
1530 @item gnu99
1531 @itemx gnu9x
1532 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1533 this will become the default.  The name @samp{gnu9x} is deprecated.
1535 @item gnu1x
1536 GNU dialect of ISO C1X.  Support is limited and experimental and
1537 features enabled by this option may be changed or removed if changed
1538 in or removed from the standard draft.
1540 @item c++98
1541 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1542 C++ code.
1544 @item gnu++98
1545 GNU dialect of @option{-std=c++98}.  This is the default for
1546 C++ code.
1548 @item c++0x
1549 The working draft of the upcoming ISO C++0x standard. This option
1550 enables experimental features that are likely to be included in
1551 C++0x. The working draft is constantly changing, and any feature that is
1552 enabled by this flag may be removed from future versions of GCC if it is
1553 not part of the C++0x standard.
1555 @item gnu++0x
1556 GNU dialect of @option{-std=c++0x}. This option enables
1557 experimental features that may be removed in future versions of GCC.
1558 @end table
1560 @item -fgnu89-inline
1561 @opindex fgnu89-inline
1562 The option @option{-fgnu89-inline} tells GCC to use the traditional
1563 GNU semantics for @code{inline} functions when in C99 mode.
1564 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1565 is accepted and ignored by GCC versions 4.1.3 up to but not including
1566 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1567 C99 mode.  Using this option is roughly equivalent to adding the
1568 @code{gnu_inline} function attribute to all inline functions
1569 (@pxref{Function Attributes}).
1571 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1572 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1573 specifies the default behavior).  This option was first supported in
1574 GCC 4.3.  This option is not supported in @option{-std=c90} or
1575 @option{-std=gnu90} mode.
1577 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1578 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1579 in effect for @code{inline} functions.  @xref{Common Predefined
1580 Macros,,,cpp,The C Preprocessor}.
1582 @item -aux-info @var{filename}
1583 @opindex aux-info
1584 Output to the given filename prototyped declarations for all functions
1585 declared and/or defined in a translation unit, including those in header
1586 files.  This option is silently ignored in any language other than C@.
1588 Besides declarations, the file indicates, in comments, the origin of
1589 each declaration (source file and line), whether the declaration was
1590 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1591 @samp{O} for old, respectively, in the first character after the line
1592 number and the colon), and whether it came from a declaration or a
1593 definition (@samp{C} or @samp{F}, respectively, in the following
1594 character).  In the case of function definitions, a K&R-style list of
1595 arguments followed by their declarations is also provided, inside
1596 comments, after the declaration.
1598 @item -fno-asm
1599 @opindex fno-asm
1600 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1601 keyword, so that code can use these words as identifiers.  You can use
1602 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1603 instead.  @option{-ansi} implies @option{-fno-asm}.
1605 In C++, this switch only affects the @code{typeof} keyword, since
1606 @code{asm} and @code{inline} are standard keywords.  You may want to
1607 use the @option{-fno-gnu-keywords} flag instead, which has the same
1608 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1609 switch only affects the @code{asm} and @code{typeof} keywords, since
1610 @code{inline} is a standard keyword in ISO C99.
1612 @item -fno-builtin
1613 @itemx -fno-builtin-@var{function}
1614 @opindex fno-builtin
1615 @cindex built-in functions
1616 Don't recognize built-in functions that do not begin with
1617 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1618 functions provided by GCC}, for details of the functions affected,
1619 including those which are not built-in functions when @option{-ansi} or
1620 @option{-std} options for strict ISO C conformance are used because they
1621 do not have an ISO standard meaning.
1623 GCC normally generates special code to handle certain built-in functions
1624 more efficiently; for instance, calls to @code{alloca} may become single
1625 instructions that adjust the stack directly, and calls to @code{memcpy}
1626 may become inline copy loops.  The resulting code is often both smaller
1627 and faster, but since the function calls no longer appear as such, you
1628 cannot set a breakpoint on those calls, nor can you change the behavior
1629 of the functions by linking with a different library.  In addition,
1630 when a function is recognized as a built-in function, GCC may use
1631 information about that function to warn about problems with calls to
1632 that function, or to generate more efficient code, even if the
1633 resulting code still contains calls to that function.  For example,
1634 warnings are given with @option{-Wformat} for bad calls to
1635 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1636 known not to modify global memory.
1638 With the @option{-fno-builtin-@var{function}} option
1639 only the built-in function @var{function} is
1640 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1641 function is named that is not built-in in this version of GCC, this
1642 option is ignored.  There is no corresponding
1643 @option{-fbuiltin-@var{function}} option; if you wish to enable
1644 built-in functions selectively when using @option{-fno-builtin} or
1645 @option{-ffreestanding}, you may define macros such as:
1647 @smallexample
1648 #define abs(n)          __builtin_abs ((n))
1649 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1650 @end smallexample
1652 @item -fhosted
1653 @opindex fhosted
1654 @cindex hosted environment
1656 Assert that compilation takes place in a hosted environment.  This implies
1657 @option{-fbuiltin}.  A hosted environment is one in which the
1658 entire standard library is available, and in which @code{main} has a return
1659 type of @code{int}.  Examples are nearly everything except a kernel.
1660 This is equivalent to @option{-fno-freestanding}.
1662 @item -ffreestanding
1663 @opindex ffreestanding
1664 @cindex hosted environment
1666 Assert that compilation takes place in a freestanding environment.  This
1667 implies @option{-fno-builtin}.  A freestanding environment
1668 is one in which the standard library may not exist, and program startup may
1669 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1670 This is equivalent to @option{-fno-hosted}.
1672 @xref{Standards,,Language Standards Supported by GCC}, for details of
1673 freestanding and hosted environments.
1675 @item -fopenmp
1676 @opindex fopenmp
1677 @cindex OpenMP parallel
1678 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1679 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1680 compiler generates parallel code according to the OpenMP Application
1681 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1682 implies @option{-pthread}, and thus is only supported on targets that
1683 have support for @option{-pthread}.
1685 @item -fms-extensions
1686 @opindex fms-extensions
1687 Accept some non-standard constructs used in Microsoft header files.
1689 It allows for c++ that member-names in structures can be similiar
1690 to previous types declarations.
1692 @smallexample
1693 typedef int UOW;
1694 struct ABC @{
1695   UOW UOW;
1697 @end smallexample
1699 Some cases of unnamed fields in structures and unions are only
1700 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1701 fields within structs/unions}, for details.
1703 @item -fplan9-extensions
1704 Accept some non-standard constructs used in Plan 9 code.
1706 This enables @option{-fms-extensions}, permits passing pointers to
1707 structures with anonymous fields to functions which expect pointers to
1708 elements of the type of the field, and permits referring to anonymous
1709 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1710 struct/union fields within structs/unions}, for details.  This is only
1711 supported for C, not C++.
1713 @item -trigraphs
1714 @opindex trigraphs
1715 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1716 options for strict ISO C conformance) implies @option{-trigraphs}.
1718 @item -no-integrated-cpp
1719 @opindex no-integrated-cpp
1720 Performs a compilation in two passes: preprocessing and compiling.  This
1721 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1722 @option{-B} option.  The user supplied compilation step can then add in
1723 an additional preprocessing step after normal preprocessing but before
1724 compiling.  The default is to use the integrated cpp (internal cpp)
1726 The semantics of this option will change if "cc1", "cc1plus", and
1727 "cc1obj" are merged.
1729 @cindex traditional C language
1730 @cindex C language, traditional
1731 @item -traditional
1732 @itemx -traditional-cpp
1733 @opindex traditional-cpp
1734 @opindex traditional
1735 Formerly, these options caused GCC to attempt to emulate a pre-standard
1736 C compiler.  They are now only supported with the @option{-E} switch.
1737 The preprocessor continues to support a pre-standard mode.  See the GNU
1738 CPP manual for details.
1740 @item -fcond-mismatch
1741 @opindex fcond-mismatch
1742 Allow conditional expressions with mismatched types in the second and
1743 third arguments.  The value of such an expression is void.  This option
1744 is not supported for C++.
1746 @item -flax-vector-conversions
1747 @opindex flax-vector-conversions
1748 Allow implicit conversions between vectors with differing numbers of
1749 elements and/or incompatible element types.  This option should not be
1750 used for new code.
1752 @item -funsigned-char
1753 @opindex funsigned-char
1754 Let the type @code{char} be unsigned, like @code{unsigned char}.
1756 Each kind of machine has a default for what @code{char} should
1757 be.  It is either like @code{unsigned char} by default or like
1758 @code{signed char} by default.
1760 Ideally, a portable program should always use @code{signed char} or
1761 @code{unsigned char} when it depends on the signedness of an object.
1762 But many programs have been written to use plain @code{char} and
1763 expect it to be signed, or expect it to be unsigned, depending on the
1764 machines they were written for.  This option, and its inverse, let you
1765 make such a program work with the opposite default.
1767 The type @code{char} is always a distinct type from each of
1768 @code{signed char} or @code{unsigned char}, even though its behavior
1769 is always just like one of those two.
1771 @item -fsigned-char
1772 @opindex fsigned-char
1773 Let the type @code{char} be signed, like @code{signed char}.
1775 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1776 the negative form of @option{-funsigned-char}.  Likewise, the option
1777 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1779 @item -fsigned-bitfields
1780 @itemx -funsigned-bitfields
1781 @itemx -fno-signed-bitfields
1782 @itemx -fno-unsigned-bitfields
1783 @opindex fsigned-bitfields
1784 @opindex funsigned-bitfields
1785 @opindex fno-signed-bitfields
1786 @opindex fno-unsigned-bitfields
1787 These options control whether a bit-field is signed or unsigned, when the
1788 declaration does not use either @code{signed} or @code{unsigned}.  By
1789 default, such a bit-field is signed, because this is consistent: the
1790 basic integer types such as @code{int} are signed types.
1791 @end table
1793 @node C++ Dialect Options
1794 @section Options Controlling C++ Dialect
1796 @cindex compiler options, C++
1797 @cindex C++ options, command line
1798 @cindex options, C++
1799 This section describes the command-line options that are only meaningful
1800 for C++ programs; but you can also use most of the GNU compiler options
1801 regardless of what language your program is in.  For example, you
1802 might compile a file @code{firstClass.C} like this:
1804 @smallexample
1805 g++ -g -frepo -O -c firstClass.C
1806 @end smallexample
1808 @noindent
1809 In this example, only @option{-frepo} is an option meant
1810 only for C++ programs; you can use the other options with any
1811 language supported by GCC@.
1813 Here is a list of options that are @emph{only} for compiling C++ programs:
1815 @table @gcctabopt
1817 @item -fabi-version=@var{n}
1818 @opindex fabi-version
1819 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1820 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1821 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1822 the version that conforms most closely to the C++ ABI specification.
1823 Therefore, the ABI obtained using version 0 will change as ABI bugs
1824 are fixed.
1826 The default is version 2.
1828 Version 3 corrects an error in mangling a constant address as a
1829 template argument.
1831 Version 4 implements a standard mangling for vector types.
1833 See also @option{-Wabi}.
1835 @item -fno-access-control
1836 @opindex fno-access-control
1837 Turn off all access checking.  This switch is mainly useful for working
1838 around bugs in the access control code.
1840 @item -fcheck-new
1841 @opindex fcheck-new
1842 Check that the pointer returned by @code{operator new} is non-null
1843 before attempting to modify the storage allocated.  This check is
1844 normally unnecessary because the C++ standard specifies that
1845 @code{operator new} will only return @code{0} if it is declared
1846 @samp{throw()}, in which case the compiler will always check the
1847 return value even without this option.  In all other cases, when
1848 @code{operator new} has a non-empty exception specification, memory
1849 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1850 @samp{new (nothrow)}.
1852 @item -fconserve-space
1853 @opindex fconserve-space
1854 Put uninitialized or runtime-initialized global variables into the
1855 common segment, as C does.  This saves space in the executable at the
1856 cost of not diagnosing duplicate definitions.  If you compile with this
1857 flag and your program mysteriously crashes after @code{main()} has
1858 completed, you may have an object that is being destroyed twice because
1859 two definitions were merged.
1861 This option is no longer useful on most targets, now that support has
1862 been added for putting variables into BSS without making them common.
1864 @item -fno-deduce-init-list
1865 @opindex fno-deduce-init-list
1866 Disable deduction of a template type parameter as
1867 std::initializer_list from a brace-enclosed initializer list, i.e.
1869 @smallexample
1870 template <class T> auto forward(T t) -> decltype (realfn (t))
1872   return realfn (t);
1875 void f()
1877   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1879 @end smallexample
1881 This option is present because this deduction is an extension to the
1882 current specification in the C++0x working draft, and there was
1883 some concern about potential overload resolution problems.
1885 @item -ffriend-injection
1886 @opindex ffriend-injection
1887 Inject friend functions into the enclosing namespace, so that they are
1888 visible outside the scope of the class in which they are declared.
1889 Friend functions were documented to work this way in the old Annotated
1890 C++ Reference Manual, and versions of G++ before 4.1 always worked
1891 that way.  However, in ISO C++ a friend function which is not declared
1892 in an enclosing scope can only be found using argument dependent
1893 lookup.  This option causes friends to be injected as they were in
1894 earlier releases.
1896 This option is for compatibility, and may be removed in a future
1897 release of G++.
1899 @item -fno-elide-constructors
1900 @opindex fno-elide-constructors
1901 The C++ standard allows an implementation to omit creating a temporary
1902 which is only used to initialize another object of the same type.
1903 Specifying this option disables that optimization, and forces G++ to
1904 call the copy constructor in all cases.
1906 @item -fno-enforce-eh-specs
1907 @opindex fno-enforce-eh-specs
1908 Don't generate code to check for violation of exception specifications
1909 at runtime.  This option violates the C++ standard, but may be useful
1910 for reducing code size in production builds, much like defining
1911 @samp{NDEBUG}.  This does not give user code permission to throw
1912 exceptions in violation of the exception specifications; the compiler
1913 will still optimize based on the specifications, so throwing an
1914 unexpected exception will result in undefined behavior.
1916 @item -ffor-scope
1917 @itemx -fno-for-scope
1918 @opindex ffor-scope
1919 @opindex fno-for-scope
1920 If @option{-ffor-scope} is specified, the scope of variables declared in
1921 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1922 as specified by the C++ standard.
1923 If @option{-fno-for-scope} is specified, the scope of variables declared in
1924 a @i{for-init-statement} extends to the end of the enclosing scope,
1925 as was the case in old versions of G++, and other (traditional)
1926 implementations of C++.
1928 The default if neither flag is given to follow the standard,
1929 but to allow and give a warning for old-style code that would
1930 otherwise be invalid, or have different behavior.
1932 @item -fno-gnu-keywords
1933 @opindex fno-gnu-keywords
1934 Do not recognize @code{typeof} as a keyword, so that code can use this
1935 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1936 @option{-ansi} implies @option{-fno-gnu-keywords}.
1938 @item -fno-implicit-templates
1939 @opindex fno-implicit-templates
1940 Never emit code for non-inline templates which are instantiated
1941 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1942 @xref{Template Instantiation}, for more information.
1944 @item -fno-implicit-inline-templates
1945 @opindex fno-implicit-inline-templates
1946 Don't emit code for implicit instantiations of inline templates, either.
1947 The default is to handle inlines differently so that compiles with and
1948 without optimization will need the same set of explicit instantiations.
1950 @item -fno-implement-inlines
1951 @opindex fno-implement-inlines
1952 To save space, do not emit out-of-line copies of inline functions
1953 controlled by @samp{#pragma implementation}.  This will cause linker
1954 errors if these functions are not inlined everywhere they are called.
1956 @item -fms-extensions
1957 @opindex fms-extensions
1958 Disable pedantic warnings about constructs used in MFC, such as implicit
1959 int and getting a pointer to member function via non-standard syntax.
1961 @item -fno-nonansi-builtins
1962 @opindex fno-nonansi-builtins
1963 Disable built-in declarations of functions that are not mandated by
1964 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1965 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1967 @item -fnothrow-opt
1968 @opindex fnothrow-opt
1969 Treat a @code{throw()} exception specification as though it were a
1970 @code{noexcept} specification to reduce or eliminate the text size
1971 overhead relative to a function with no exception specification.  If
1972 the function has local variables of types with non-trivial
1973 destructors, the exception specification will actually make the
1974 function smaller because the EH cleanups for those variables can be
1975 optimized away.  The semantic effect is that an exception thrown out of
1976 a function with such an exception specification will result in a call
1977 to @code{terminate} rather than @code{unexpected}.
1979 @item -fno-operator-names
1980 @opindex fno-operator-names
1981 Do not treat the operator name keywords @code{and}, @code{bitand},
1982 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1983 synonyms as keywords.
1985 @item -fno-optional-diags
1986 @opindex fno-optional-diags
1987 Disable diagnostics that the standard says a compiler does not need to
1988 issue.  Currently, the only such diagnostic issued by G++ is the one for
1989 a name having multiple meanings within a class.
1991 @item -fpermissive
1992 @opindex fpermissive
1993 Downgrade some diagnostics about nonconformant code from errors to
1994 warnings.  Thus, using @option{-fpermissive} will allow some
1995 nonconforming code to compile.
1997 @item -fno-pretty-templates
1998 @opindex fno-pretty-templates
1999 When an error message refers to a specialization of a function
2000 template, the compiler will normally print the signature of the
2001 template followed by the template arguments and any typedefs or
2002 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2003 rather than @code{void f(int)}) so that it's clear which template is
2004 involved.  When an error message refers to a specialization of a class
2005 template, the compiler will omit any template arguments which match
2006 the default template arguments for that template.  If either of these
2007 behaviors make it harder to understand the error message rather than
2008 easier, using @option{-fno-pretty-templates} will disable them.
2010 @item -frepo
2011 @opindex frepo
2012 Enable automatic template instantiation at link time.  This option also
2013 implies @option{-fno-implicit-templates}.  @xref{Template
2014 Instantiation}, for more information.
2016 @item -fno-rtti
2017 @opindex fno-rtti
2018 Disable generation of information about every class with virtual
2019 functions for use by the C++ runtime type identification features
2020 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2021 of the language, you can save some space by using this flag.  Note that
2022 exception handling uses the same information, but it will generate it as
2023 needed. The @samp{dynamic_cast} operator can still be used for casts that
2024 do not require runtime type information, i.e.@: casts to @code{void *} or to
2025 unambiguous base classes.
2027 @item -fstats
2028 @opindex fstats
2029 Emit statistics about front-end processing at the end of the compilation.
2030 This information is generally only useful to the G++ development team.
2032 @item -fstrict-enums
2033 @opindex fstrict-enums
2034 Allow the compiler to optimize using the assumption that a value of
2035 enumeration type can only be one of the values of the enumeration (as
2036 defined in the C++ standard; basically, a value which can be
2037 represented in the minimum number of bits needed to represent all the
2038 enumerators).  This assumption may not be valid if the program uses a
2039 cast to convert an arbitrary integer value to the enumeration type.
2041 @item -ftemplate-depth=@var{n}
2042 @opindex ftemplate-depth
2043 Set the maximum instantiation depth for template classes to @var{n}.
2044 A limit on the template instantiation depth is needed to detect
2045 endless recursions during template class instantiation.  ANSI/ISO C++
2046 conforming programs must not rely on a maximum depth greater than 17
2047 (changed to 1024 in C++0x).
2049 @item -fno-threadsafe-statics
2050 @opindex fno-threadsafe-statics
2051 Do not emit the extra code to use the routines specified in the C++
2052 ABI for thread-safe initialization of local statics.  You can use this
2053 option to reduce code size slightly in code that doesn't need to be
2054 thread-safe.
2056 @item -fuse-cxa-atexit
2057 @opindex fuse-cxa-atexit
2058 Register destructors for objects with static storage duration with the
2059 @code{__cxa_atexit} function rather than the @code{atexit} function.
2060 This option is required for fully standards-compliant handling of static
2061 destructors, but will only work if your C library supports
2062 @code{__cxa_atexit}.
2064 @item -fno-use-cxa-get-exception-ptr
2065 @opindex fno-use-cxa-get-exception-ptr
2066 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2067 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2068 if the runtime routine is not available.
2070 @item -fvisibility-inlines-hidden
2071 @opindex fvisibility-inlines-hidden
2072 This switch declares that the user does not attempt to compare
2073 pointers to inline methods where the addresses of the two functions
2074 were taken in different shared objects.
2076 The effect of this is that GCC may, effectively, mark inline methods with
2077 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2078 appear in the export table of a DSO and do not require a PLT indirection
2079 when used within the DSO@.  Enabling this option can have a dramatic effect
2080 on load and link times of a DSO as it massively reduces the size of the
2081 dynamic export table when the library makes heavy use of templates.
2083 The behavior of this switch is not quite the same as marking the
2084 methods as hidden directly, because it does not affect static variables
2085 local to the function or cause the compiler to deduce that
2086 the function is defined in only one shared object.
2088 You may mark a method as having a visibility explicitly to negate the
2089 effect of the switch for that method.  For example, if you do want to
2090 compare pointers to a particular inline method, you might mark it as
2091 having default visibility.  Marking the enclosing class with explicit
2092 visibility will have no effect.
2094 Explicitly instantiated inline methods are unaffected by this option
2095 as their linkage might otherwise cross a shared library boundary.
2096 @xref{Template Instantiation}.
2098 @item -fvisibility-ms-compat
2099 @opindex fvisibility-ms-compat
2100 This flag attempts to use visibility settings to make GCC's C++
2101 linkage model compatible with that of Microsoft Visual Studio.
2103 The flag makes these changes to GCC's linkage model:
2105 @enumerate
2106 @item
2107 It sets the default visibility to @code{hidden}, like
2108 @option{-fvisibility=hidden}.
2110 @item
2111 Types, but not their members, are not hidden by default.
2113 @item
2114 The One Definition Rule is relaxed for types without explicit
2115 visibility specifications which are defined in more than one different
2116 shared object: those declarations are permitted if they would have
2117 been permitted when this option was not used.
2118 @end enumerate
2120 In new code it is better to use @option{-fvisibility=hidden} and
2121 export those classes which are intended to be externally visible.
2122 Unfortunately it is possible for code to rely, perhaps accidentally,
2123 on the Visual Studio behavior.
2125 Among the consequences of these changes are that static data members
2126 of the same type with the same name but defined in different shared
2127 objects will be different, so changing one will not change the other;
2128 and that pointers to function members defined in different shared
2129 objects may not compare equal.  When this flag is given, it is a
2130 violation of the ODR to define types with the same name differently.
2132 @item -fno-weak
2133 @opindex fno-weak
2134 Do not use weak symbol support, even if it is provided by the linker.
2135 By default, G++ will use weak symbols if they are available.  This
2136 option exists only for testing, and should not be used by end-users;
2137 it will result in inferior code and has no benefits.  This option may
2138 be removed in a future release of G++.
2140 @item -nostdinc++
2141 @opindex nostdinc++
2142 Do not search for header files in the standard directories specific to
2143 C++, but do still search the other standard directories.  (This option
2144 is used when building the C++ library.)
2145 @end table
2147 In addition, these optimization, warning, and code generation options
2148 have meanings only for C++ programs:
2150 @table @gcctabopt
2151 @item -fno-default-inline
2152 @opindex fno-default-inline
2153 Do not assume @samp{inline} for functions defined inside a class scope.
2154 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2155 functions will have linkage like inline functions; they just won't be
2156 inlined by default.
2158 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2159 @opindex Wabi
2160 @opindex Wno-abi
2161 Warn when G++ generates code that is probably not compatible with the
2162 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2163 all such cases, there are probably some cases that are not warned about,
2164 even though G++ is generating incompatible code.  There may also be
2165 cases where warnings are emitted even though the code that is generated
2166 will be compatible.
2168 You should rewrite your code to avoid these warnings if you are
2169 concerned about the fact that code generated by G++ may not be binary
2170 compatible with code generated by other compilers.
2172 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2174 @itemize @bullet
2176 @item
2177 A template with a non-type template parameter of reference type is
2178 mangled incorrectly:
2179 @smallexample
2180 extern int N;
2181 template <int &> struct S @{@};
2182 void n (S<N>) @{2@}
2183 @end smallexample
2185 This is fixed in @option{-fabi-version=3}.
2187 @item
2188 SIMD vector types declared using @code{__attribute ((vector_size))} are
2189 mangled in a non-standard way that does not allow for overloading of
2190 functions taking vectors of different sizes.
2192 The mangling is changed in @option{-fabi-version=4}.
2193 @end itemize
2195 The known incompatibilities in @option{-fabi-version=1} include:
2197 @itemize @bullet
2199 @item
2200 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2201 pack data into the same byte as a base class.  For example:
2203 @smallexample
2204 struct A @{ virtual void f(); int f1 : 1; @};
2205 struct B : public A @{ int f2 : 1; @};
2206 @end smallexample
2208 @noindent
2209 In this case, G++ will place @code{B::f2} into the same byte
2210 as@code{A::f1}; other compilers will not.  You can avoid this problem
2211 by explicitly padding @code{A} so that its size is a multiple of the
2212 byte size on your platform; that will cause G++ and other compilers to
2213 layout @code{B} identically.
2215 @item
2216 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2217 tail padding when laying out virtual bases.  For example:
2219 @smallexample
2220 struct A @{ virtual void f(); char c1; @};
2221 struct B @{ B(); char c2; @};
2222 struct C : public A, public virtual B @{@};
2223 @end smallexample
2225 @noindent
2226 In this case, G++ will not place @code{B} into the tail-padding for
2227 @code{A}; other compilers will.  You can avoid this problem by
2228 explicitly padding @code{A} so that its size is a multiple of its
2229 alignment (ignoring virtual base classes); that will cause G++ and other
2230 compilers to layout @code{C} identically.
2232 @item
2233 Incorrect handling of bit-fields with declared widths greater than that
2234 of their underlying types, when the bit-fields appear in a union.  For
2235 example:
2237 @smallexample
2238 union U @{ int i : 4096; @};
2239 @end smallexample
2241 @noindent
2242 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2243 union too small by the number of bits in an @code{int}.
2245 @item
2246 Empty classes can be placed at incorrect offsets.  For example:
2248 @smallexample
2249 struct A @{@};
2251 struct B @{
2252   A a;
2253   virtual void f ();
2256 struct C : public B, public A @{@};
2257 @end smallexample
2259 @noindent
2260 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2261 it should be placed at offset zero.  G++ mistakenly believes that the
2262 @code{A} data member of @code{B} is already at offset zero.
2264 @item
2265 Names of template functions whose types involve @code{typename} or
2266 template template parameters can be mangled incorrectly.
2268 @smallexample
2269 template <typename Q>
2270 void f(typename Q::X) @{@}
2272 template <template <typename> class Q>
2273 void f(typename Q<int>::X) @{@}
2274 @end smallexample
2276 @noindent
2277 Instantiations of these templates may be mangled incorrectly.
2279 @end itemize
2281 It also warns psABI related changes.  The known psABI changes at this
2282 point include:
2284 @itemize @bullet
2286 @item
2287 For SYSV/x86-64, when passing union with long double, it is changed to
2288 pass in memory as specified in psABI.  For example:
2290 @smallexample
2291 union U @{
2292   long double ld;
2293   int i;
2295 @end smallexample
2297 @noindent
2298 @code{union U} will always be passed in memory.
2300 @end itemize
2302 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2303 @opindex Wctor-dtor-privacy
2304 @opindex Wno-ctor-dtor-privacy
2305 Warn when a class seems unusable because all the constructors or
2306 destructors in that class are private, and it has neither friends nor
2307 public static member functions.
2309 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2310 @opindex Wnoexcept
2311 @opindex Wno-noexcept
2312 Warn when a noexcept-expression evaluates to false because of a call
2313 to a function that does not have a non-throwing exception
2314 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2315 the compiler to never throw an exception.
2317 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2318 @opindex Wnon-virtual-dtor
2319 @opindex Wno-non-virtual-dtor
2320 Warn when a class has virtual functions and accessible non-virtual
2321 destructor, in which case it would be possible but unsafe to delete
2322 an instance of a derived class through a pointer to the base class.
2323 This warning is also enabled if -Weffc++ is specified.
2325 @item -Wreorder @r{(C++ and Objective-C++ only)}
2326 @opindex Wreorder
2327 @opindex Wno-reorder
2328 @cindex reordering, warning
2329 @cindex warning for reordering of member initializers
2330 Warn when the order of member initializers given in the code does not
2331 match the order in which they must be executed.  For instance:
2333 @smallexample
2334 struct A @{
2335   int i;
2336   int j;
2337   A(): j (0), i (1) @{ @}
2339 @end smallexample
2341 The compiler will rearrange the member initializers for @samp{i}
2342 and @samp{j} to match the declaration order of the members, emitting
2343 a warning to that effect.  This warning is enabled by @option{-Wall}.
2344 @end table
2346 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2348 @table @gcctabopt
2349 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2350 @opindex Weffc++
2351 @opindex Wno-effc++
2352 Warn about violations of the following style guidelines from Scott Meyers'
2353 @cite{Effective C++} book:
2355 @itemize @bullet
2356 @item
2357 Item 11:  Define a copy constructor and an assignment operator for classes
2358 with dynamically allocated memory.
2360 @item
2361 Item 12:  Prefer initialization to assignment in constructors.
2363 @item
2364 Item 14:  Make destructors virtual in base classes.
2366 @item
2367 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2369 @item
2370 Item 23:  Don't try to return a reference when you must return an object.
2372 @end itemize
2374 Also warn about violations of the following style guidelines from
2375 Scott Meyers' @cite{More Effective C++} book:
2377 @itemize @bullet
2378 @item
2379 Item 6:  Distinguish between prefix and postfix forms of increment and
2380 decrement operators.
2382 @item
2383 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2385 @end itemize
2387 When selecting this option, be aware that the standard library
2388 headers do not obey all of these guidelines; use @samp{grep -v}
2389 to filter out those warnings.
2391 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2392 @opindex Wstrict-null-sentinel
2393 @opindex Wno-strict-null-sentinel
2394 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2395 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2396 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2397 it is guaranteed to be of the same size as a pointer.  But this use is
2398 not portable across different compilers.
2400 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2401 @opindex Wno-non-template-friend
2402 @opindex Wnon-template-friend
2403 Disable warnings when non-templatized friend functions are declared
2404 within a template.  Since the advent of explicit template specification
2405 support in G++, if the name of the friend is an unqualified-id (i.e.,
2406 @samp{friend foo(int)}), the C++ language specification demands that the
2407 friend declare or define an ordinary, nontemplate function.  (Section
2408 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2409 could be interpreted as a particular specialization of a templatized
2410 function.  Because this non-conforming behavior is no longer the default
2411 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2412 check existing code for potential trouble spots and is on by default.
2413 This new compiler behavior can be turned off with
2414 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2415 but disables the helpful warning.
2417 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2418 @opindex Wold-style-cast
2419 @opindex Wno-old-style-cast
2420 Warn if an old-style (C-style) cast to a non-void type is used within
2421 a C++ program.  The new-style casts (@samp{dynamic_cast},
2422 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2423 less vulnerable to unintended effects and much easier to search for.
2425 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2426 @opindex Woverloaded-virtual
2427 @opindex Wno-overloaded-virtual
2428 @cindex overloaded virtual function, warning
2429 @cindex warning for overloaded virtual function
2430 Warn when a function declaration hides virtual functions from a
2431 base class.  For example, in:
2433 @smallexample
2434 struct A @{
2435   virtual void f();
2438 struct B: public A @{
2439   void f(int);
2441 @end smallexample
2443 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2444 like:
2446 @smallexample
2447 B* b;
2448 b->f();
2449 @end smallexample
2451 will fail to compile.
2453 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2454 @opindex Wno-pmf-conversions
2455 @opindex Wpmf-conversions
2456 Disable the diagnostic for converting a bound pointer to member function
2457 to a plain pointer.
2459 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2460 @opindex Wsign-promo
2461 @opindex Wno-sign-promo
2462 Warn when overload resolution chooses a promotion from unsigned or
2463 enumerated type to a signed type, over a conversion to an unsigned type of
2464 the same size.  Previous versions of G++ would try to preserve
2465 unsignedness, but the standard mandates the current behavior.
2467 @smallexample
2468 struct A @{
2469   operator int ();
2470   A& operator = (int);
2473 main ()
2475   A a,b;
2476   a = b;
2478 @end smallexample
2480 In this example, G++ will synthesize a default @samp{A& operator =
2481 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2482 @end table
2484 @node Objective-C and Objective-C++ Dialect Options
2485 @section Options Controlling Objective-C and Objective-C++ Dialects
2487 @cindex compiler options, Objective-C and Objective-C++
2488 @cindex Objective-C and Objective-C++ options, command line
2489 @cindex options, Objective-C and Objective-C++
2490 (NOTE: This manual does not describe the Objective-C and Objective-C++
2491 languages themselves.  See @xref{Standards,,Language Standards
2492 Supported by GCC}, for references.)
2494 This section describes the command-line options that are only meaningful
2495 for Objective-C and Objective-C++ programs, but you can also use most of
2496 the language-independent GNU compiler options.
2497 For example, you might compile a file @code{some_class.m} like this:
2499 @smallexample
2500 gcc -g -fgnu-runtime -O -c some_class.m
2501 @end smallexample
2503 @noindent
2504 In this example, @option{-fgnu-runtime} is an option meant only for
2505 Objective-C and Objective-C++ programs; you can use the other options with
2506 any language supported by GCC@.
2508 Note that since Objective-C is an extension of the C language, Objective-C
2509 compilations may also use options specific to the C front-end (e.g.,
2510 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2511 C++-specific options (e.g., @option{-Wabi}).
2513 Here is a list of options that are @emph{only} for compiling Objective-C
2514 and Objective-C++ programs:
2516 @table @gcctabopt
2517 @item -fconstant-string-class=@var{class-name}
2518 @opindex fconstant-string-class
2519 Use @var{class-name} as the name of the class to instantiate for each
2520 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2521 class name is @code{NXConstantString} if the GNU runtime is being used, and
2522 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2523 @option{-fconstant-cfstrings} option, if also present, will override the
2524 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2525 to be laid out as constant CoreFoundation strings.
2527 @item -fgnu-runtime
2528 @opindex fgnu-runtime
2529 Generate object code compatible with the standard GNU Objective-C
2530 runtime.  This is the default for most types of systems.
2532 @item -fnext-runtime
2533 @opindex fnext-runtime
2534 Generate output compatible with the NeXT runtime.  This is the default
2535 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2536 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2537 used.
2539 @item -fno-nil-receivers
2540 @opindex fno-nil-receivers
2541 Assume that all Objective-C message dispatches (@code{[receiver
2542 message:arg]}) in this translation unit ensure that the receiver is
2543 not @code{nil}.  This allows for more efficient entry points in the
2544 runtime to be used.  Currently, this option is only available in
2545 conjunction with the NeXT runtime on Mac OS X 10.3 and later.
2547 @item -fobjc-call-cxx-cdtors
2548 @opindex fobjc-call-cxx-cdtors
2549 For each Objective-C class, check if any of its instance variables is a
2550 C++ object with a non-trivial default constructor.  If so, synthesize a
2551 special @code{- (id) .cxx_construct} instance method that will run
2552 non-trivial default constructors on any such instance variables, in order,
2553 and then return @code{self}.  Similarly, check if any instance variable
2554 is a C++ object with a non-trivial destructor, and if so, synthesize a
2555 special @code{- (void) .cxx_destruct} method that will run
2556 all such default destructors, in reverse order.
2558 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2559 methods thusly generated will only operate on instance variables
2560 declared in the current Objective-C class, and not those inherited
2561 from superclasses.  It is the responsibility of the Objective-C
2562 runtime to invoke all such methods in an object's inheritance
2563 hierarchy.  The @code{- (id) .cxx_construct} methods will be invoked
2564 by the runtime immediately after a new object instance is allocated;
2565 the @code{- (void) .cxx_destruct} methods will be invoked immediately
2566 before the runtime deallocates an object instance.
2568 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2569 support for invoking the @code{- (id) .cxx_construct} and
2570 @code{- (void) .cxx_destruct} methods.
2572 @item -fobjc-direct-dispatch
2573 @opindex fobjc-direct-dispatch
2574 Allow fast jumps to the message dispatcher.  On Darwin this is
2575 accomplished via the comm page.
2577 @item -fobjc-exceptions
2578 @opindex fobjc-exceptions
2579 Enable syntactic support for structured exception handling in
2580 Objective-C, similar to what is offered by C++ and Java.  This option
2581 is required to use the Objective-C keywords @code{@@try},
2582 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2583 @code{@@synchronized}.  This option is available with both the GNU
2584 runtime and the NeXT runtime (but not available in conjunction with
2585 the NeXT runtime on Mac OS X 10.2 and earlier).
2587 @item -fobjc-gc
2588 @opindex fobjc-gc
2589 Enable garbage collection (GC) in Objective-C and Objective-C++
2590 programs.  This option is only available with the NeXT runtime; the
2591 GNU runtime has a different garbage collection implementation that
2592 does not require special compiler flags.
2594 @item -freplace-objc-classes
2595 @opindex freplace-objc-classes
2596 Emit a special marker instructing @command{ld(1)} not to statically link in
2597 the resulting object file, and allow @command{dyld(1)} to load it in at
2598 run time instead.  This is used in conjunction with the Fix-and-Continue
2599 debugging mode, where the object file in question may be recompiled and
2600 dynamically reloaded in the course of program execution, without the need
2601 to restart the program itself.  Currently, Fix-and-Continue functionality
2602 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2603 and later.
2605 @item -fzero-link
2606 @opindex fzero-link
2607 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2608 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2609 compile time) with static class references that get initialized at load time,
2610 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2611 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2612 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2613 for individual class implementations to be modified during program execution.
2614 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2615 regardless of command line options.
2617 @item -gen-decls
2618 @opindex gen-decls
2619 Dump interface declarations for all classes seen in the source file to a
2620 file named @file{@var{sourcename}.decl}.
2622 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2623 @opindex Wassign-intercept
2624 @opindex Wno-assign-intercept
2625 Warn whenever an Objective-C assignment is being intercepted by the
2626 garbage collector.
2628 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2629 @opindex Wno-protocol
2630 @opindex Wprotocol
2631 If a class is declared to implement a protocol, a warning is issued for
2632 every method in the protocol that is not implemented by the class.  The
2633 default behavior is to issue a warning for every method not explicitly
2634 implemented in the class, even if a method implementation is inherited
2635 from the superclass.  If you use the @option{-Wno-protocol} option, then
2636 methods inherited from the superclass are considered to be implemented,
2637 and no warning is issued for them.
2639 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2640 @opindex Wselector
2641 @opindex Wno-selector
2642 Warn if multiple methods of different types for the same selector are
2643 found during compilation.  The check is performed on the list of methods
2644 in the final stage of compilation.  Additionally, a check is performed
2645 for each selector appearing in a @code{@@selector(@dots{})}
2646 expression, and a corresponding method for that selector has been found
2647 during compilation.  Because these checks scan the method table only at
2648 the end of compilation, these warnings are not produced if the final
2649 stage of compilation is not reached, for example because an error is
2650 found during compilation, or because the @option{-fsyntax-only} option is
2651 being used.
2653 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2654 @opindex Wstrict-selector-match
2655 @opindex Wno-strict-selector-match
2656 Warn if multiple methods with differing argument and/or return types are
2657 found for a given selector when attempting to send a message using this
2658 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2659 is off (which is the default behavior), the compiler will omit such warnings
2660 if any differences found are confined to types which share the same size
2661 and alignment.
2663 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2664 @opindex Wundeclared-selector
2665 @opindex Wno-undeclared-selector
2666 Warn if a @code{@@selector(@dots{})} expression referring to an
2667 undeclared selector is found.  A selector is considered undeclared if no
2668 method with that name has been declared before the
2669 @code{@@selector(@dots{})} expression, either explicitly in an
2670 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2671 an @code{@@implementation} section.  This option always performs its
2672 checks as soon as a @code{@@selector(@dots{})} expression is found,
2673 while @option{-Wselector} only performs its checks in the final stage of
2674 compilation.  This also enforces the coding style convention
2675 that methods and selectors must be declared before being used.
2677 @item -print-objc-runtime-info
2678 @opindex print-objc-runtime-info
2679 Generate C header describing the largest structure that is passed by
2680 value, if any.
2682 @end table
2684 @node Language Independent Options
2685 @section Options to Control Diagnostic Messages Formatting
2686 @cindex options to control diagnostics formatting
2687 @cindex diagnostic messages
2688 @cindex message formatting
2690 Traditionally, diagnostic messages have been formatted irrespective of
2691 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2692 below can be used to control the diagnostic messages formatting
2693 algorithm, e.g.@: how many characters per line, how often source location
2694 information should be reported.  Right now, only the C++ front end can
2695 honor these options.  However it is expected, in the near future, that
2696 the remaining front ends would be able to digest them correctly.
2698 @table @gcctabopt
2699 @item -fmessage-length=@var{n}
2700 @opindex fmessage-length
2701 Try to format error messages so that they fit on lines of about @var{n}
2702 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2703 the front ends supported by GCC@.  If @var{n} is zero, then no
2704 line-wrapping will be done; each error message will appear on a single
2705 line.
2707 @opindex fdiagnostics-show-location
2708 @item -fdiagnostics-show-location=once
2709 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2710 reporter to emit @emph{once} source location information; that is, in
2711 case the message is too long to fit on a single physical line and has to
2712 be wrapped, the source location won't be emitted (as prefix) again,
2713 over and over, in subsequent continuation lines.  This is the default
2714 behavior.
2716 @item -fdiagnostics-show-location=every-line
2717 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2718 messages reporter to emit the same source location information (as
2719 prefix) for physical lines that result from the process of breaking
2720 a message which is too long to fit on a single line.
2722 @item -fdiagnostics-show-option
2723 @opindex fdiagnostics-show-option
2724 This option instructs the diagnostic machinery to add text to each
2725 diagnostic emitted, which indicates which command line option directly
2726 controls that diagnostic, when such an option is known to the
2727 diagnostic machinery.
2729 @item -Wcoverage-mismatch
2730 @opindex Wcoverage-mismatch
2731 Warn if feedback profiles do not match when using the
2732 @option{-fprofile-use} option.
2733 If a source file was changed between @option{-fprofile-gen} and
2734 @option{-fprofile-use}, the files with the profile feedback can fail
2735 to match the source file and GCC can not use the profile feedback
2736 information.  By default, this warning is enabled and is treated as an
2737 error.  @option{-Wno-coverage-mismatch} can be used to disable the
2738 warning or @option{-Wno-error=coverage-mismatch} can be used to
2739 disable the error.  Disable the error for this warning can result in
2740 poorly optimized code, so disabling the error is useful only in the
2741 case of very minor changes such as bug fixes to an existing code-base.
2742 Completely disabling the warning is not recommended.
2744 @end table
2746 @node Warning Options
2747 @section Options to Request or Suppress Warnings
2748 @cindex options to control warnings
2749 @cindex warning messages
2750 @cindex messages, warning
2751 @cindex suppressing warnings
2753 Warnings are diagnostic messages that report constructions which
2754 are not inherently erroneous but which are risky or suggest there
2755 may have been an error.
2757 The following language-independent options do not enable specific
2758 warnings but control the kinds of diagnostics produced by GCC.
2760 @table @gcctabopt
2761 @cindex syntax checking
2762 @item -fsyntax-only
2763 @opindex fsyntax-only
2764 Check the code for syntax errors, but don't do anything beyond that.
2766 @item -w
2767 @opindex w
2768 Inhibit all warning messages.
2770 @item -Werror
2771 @opindex Werror
2772 @opindex Wno-error
2773 Make all warnings into errors.
2775 @item -Werror=
2776 @opindex Werror=
2777 @opindex Wno-error=
2778 Make the specified warning into an error.  The specifier for a warning
2779 is appended, for example @option{-Werror=switch} turns the warnings
2780 controlled by @option{-Wswitch} into errors.  This switch takes a
2781 negative form, to be used to negate @option{-Werror} for specific
2782 warnings, for example @option{-Wno-error=switch} makes
2783 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2784 is in effect.  You can use the @option{-fdiagnostics-show-option}
2785 option to have each controllable warning amended with the option which
2786 controls it, to determine what to use with this option.
2788 Note that specifying @option{-Werror=}@var{foo} automatically implies
2789 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2790 imply anything.
2792 @item -Wfatal-errors
2793 @opindex Wfatal-errors
2794 @opindex Wno-fatal-errors
2795 This option causes the compiler to abort compilation on the first error
2796 occurred rather than trying to keep going and printing further error
2797 messages.
2799 @end table
2801 You can request many specific warnings with options beginning
2802 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2803 implicit declarations.  Each of these specific warning options also
2804 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2805 example, @option{-Wno-implicit}.  This manual lists only one of the
2806 two forms, whichever is not the default.  For further,
2807 language-specific options also refer to @ref{C++ Dialect Options} and
2808 @ref{Objective-C and Objective-C++ Dialect Options}.
2810 When an unrecognized warning option is requested (e.g.,
2811 @option{-Wunknown-warning}), GCC will emit a diagnostic stating
2812 that the option is not recognized.  However, if the @option{-Wno-} form
2813 is used, the behavior is slightly different: No diagnostic will be
2814 produced for @option{-Wno-unknown-warning} unless other diagnostics
2815 are being produced.  This allows the use of new @option{-Wno-} options
2816 with old compilers, but if something goes wrong, the compiler will
2817 warn that an unrecognized option was used.
2819 @table @gcctabopt
2820 @item -pedantic
2821 @opindex pedantic
2822 Issue all the warnings demanded by strict ISO C and ISO C++;
2823 reject all programs that use forbidden extensions, and some other
2824 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2825 version of the ISO C standard specified by any @option{-std} option used.
2827 Valid ISO C and ISO C++ programs should compile properly with or without
2828 this option (though a rare few will require @option{-ansi} or a
2829 @option{-std} option specifying the required version of ISO C)@.  However,
2830 without this option, certain GNU extensions and traditional C and C++
2831 features are supported as well.  With this option, they are rejected.
2833 @option{-pedantic} does not cause warning messages for use of the
2834 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2835 warnings are also disabled in the expression that follows
2836 @code{__extension__}.  However, only system header files should use
2837 these escape routes; application programs should avoid them.
2838 @xref{Alternate Keywords}.
2840 Some users try to use @option{-pedantic} to check programs for strict ISO
2841 C conformance.  They soon find that it does not do quite what they want:
2842 it finds some non-ISO practices, but not all---only those for which
2843 ISO C @emph{requires} a diagnostic, and some others for which
2844 diagnostics have been added.
2846 A feature to report any failure to conform to ISO C might be useful in
2847 some instances, but would require considerable additional work and would
2848 be quite different from @option{-pedantic}.  We don't have plans to
2849 support such a feature in the near future.
2851 Where the standard specified with @option{-std} represents a GNU
2852 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
2853 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2854 extended dialect is based.  Warnings from @option{-pedantic} are given
2855 where they are required by the base standard.  (It would not make sense
2856 for such warnings to be given only for features not in the specified GNU
2857 C dialect, since by definition the GNU dialects of C include all
2858 features the compiler supports with the given option, and there would be
2859 nothing to warn about.)
2861 @item -pedantic-errors
2862 @opindex pedantic-errors
2863 Like @option{-pedantic}, except that errors are produced rather than
2864 warnings.
2866 @item -Wall
2867 @opindex Wall
2868 @opindex Wno-all
2869 This enables all the warnings about constructions that some users
2870 consider questionable, and that are easy to avoid (or modify to
2871 prevent the warning), even in conjunction with macros.  This also
2872 enables some language-specific warnings described in @ref{C++ Dialect
2873 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2875 @option{-Wall} turns on the following warning flags:
2877 @gccoptlist{-Waddress   @gol
2878 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2879 -Wc++0x-compat  @gol
2880 -Wchar-subscripts  @gol
2881 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2882 -Wimplicit-int @r{(C and Objective-C only)} @gol
2883 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
2884 -Wcomment  @gol
2885 -Wformat   @gol
2886 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2887 -Wmissing-braces  @gol
2888 -Wnonnull  @gol
2889 -Wparentheses  @gol
2890 -Wpointer-sign  @gol
2891 -Wreorder   @gol
2892 -Wreturn-type  @gol
2893 -Wsequence-point  @gol
2894 -Wsign-compare @r{(only in C++)}  @gol
2895 -Wstrict-aliasing  @gol
2896 -Wstrict-overflow=1  @gol
2897 -Wswitch  @gol
2898 -Wtrigraphs  @gol
2899 -Wuninitialized  @gol
2900 -Wunknown-pragmas  @gol
2901 -Wunused-function  @gol
2902 -Wunused-label     @gol
2903 -Wunused-value     @gol
2904 -Wunused-variable  @gol
2905 -Wvolatile-register-var @gol
2908 Note that some warning flags are not implied by @option{-Wall}.  Some of
2909 them warn about constructions that users generally do not consider
2910 questionable, but which occasionally you might wish to check for;
2911 others warn about constructions that are necessary or hard to avoid in
2912 some cases, and there is no simple way to modify the code to suppress
2913 the warning. Some of them are enabled by @option{-Wextra} but many of
2914 them must be enabled individually.
2916 @item -Wextra
2917 @opindex W
2918 @opindex Wextra
2919 @opindex Wno-extra
2920 This enables some extra warning flags that are not enabled by
2921 @option{-Wall}. (This option used to be called @option{-W}.  The older
2922 name is still supported, but the newer name is more descriptive.)
2924 @gccoptlist{-Wclobbered  @gol
2925 -Wempty-body  @gol
2926 -Wignored-qualifiers @gol
2927 -Wmissing-field-initializers  @gol
2928 -Wmissing-parameter-type @r{(C only)}  @gol
2929 -Wold-style-declaration @r{(C only)}  @gol
2930 -Woverride-init  @gol
2931 -Wsign-compare  @gol
2932 -Wtype-limits  @gol
2933 -Wuninitialized  @gol
2934 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
2935 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2938 The option @option{-Wextra} also prints warning messages for the
2939 following cases:
2941 @itemize @bullet
2943 @item
2944 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2945 @samp{>}, or @samp{>=}.
2947 @item
2948 (C++ only) An enumerator and a non-enumerator both appear in a
2949 conditional expression.
2951 @item
2952 (C++ only) Ambiguous virtual bases.
2954 @item
2955 (C++ only) Subscripting an array which has been declared @samp{register}.
2957 @item
2958 (C++ only) Taking the address of a variable which has been declared
2959 @samp{register}.
2961 @item
2962 (C++ only) A base class is not initialized in a derived class' copy
2963 constructor.
2965 @end itemize
2967 @item -Wchar-subscripts
2968 @opindex Wchar-subscripts
2969 @opindex Wno-char-subscripts
2970 Warn if an array subscript has type @code{char}.  This is a common cause
2971 of error, as programmers often forget that this type is signed on some
2972 machines.
2973 This warning is enabled by @option{-Wall}.
2975 @item -Wcomment
2976 @opindex Wcomment
2977 @opindex Wno-comment
2978 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2979 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2980 This warning is enabled by @option{-Wall}.
2982 @item -Wno-cpp \
2983 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
2985 Suppress warning messages emitted by @code{#warning} directives.
2987 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
2988 @opindex Wdouble-promotion
2989 @opindex Wno-double-promotion
2990 Give a warning when a value of type @code{float} is implicitly
2991 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
2992 floating-point unit implement @code{float} in hardware, but emulate
2993 @code{double} in software.  On such a machine, doing computations
2994 using @code{double} values is much more expensive because of the
2995 overhead required for software emulation.  
2997 It is easy to accidentally do computations with @code{double} because
2998 floating-point literals are implicitly of type @code{double}.  For
2999 example, in:
3000 @smallexample
3001 @group
3002 float area(float radius)
3004    return 3.14159 * radius * radius;        
3006 @end group
3007 @end smallexample
3008 the compiler will perform the entire computation with @code{double}
3009 because the floating-point literal is a @code{double}.
3011 @item -Wformat
3012 @opindex Wformat
3013 @opindex Wno-format
3014 @opindex ffreestanding
3015 @opindex fno-builtin
3016 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3017 the arguments supplied have types appropriate to the format string
3018 specified, and that the conversions specified in the format string make
3019 sense.  This includes standard functions, and others specified by format
3020 attributes (@pxref{Function Attributes}), in the @code{printf},
3021 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3022 not in the C standard) families (or other target-specific families).
3023 Which functions are checked without format attributes having been
3024 specified depends on the standard version selected, and such checks of
3025 functions without the attribute specified are disabled by
3026 @option{-ffreestanding} or @option{-fno-builtin}.
3028 The formats are checked against the format features supported by GNU
3029 libc version 2.2.  These include all ISO C90 and C99 features, as well
3030 as features from the Single Unix Specification and some BSD and GNU
3031 extensions.  Other library implementations may not support all these
3032 features; GCC does not support warning about features that go beyond a
3033 particular library's limitations.  However, if @option{-pedantic} is used
3034 with @option{-Wformat}, warnings will be given about format features not
3035 in the selected standard version (but not for @code{strfmon} formats,
3036 since those are not in any version of the C standard).  @xref{C Dialect
3037 Options,,Options Controlling C Dialect}.
3039 Since @option{-Wformat} also checks for null format arguments for
3040 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3042 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3043 aspects of format checking, the options @option{-Wformat-y2k},
3044 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3045 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3046 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3048 @item -Wformat-y2k
3049 @opindex Wformat-y2k
3050 @opindex Wno-format-y2k
3051 If @option{-Wformat} is specified, also warn about @code{strftime}
3052 formats which may yield only a two-digit year.
3054 @item -Wno-format-contains-nul
3055 @opindex Wno-format-contains-nul
3056 @opindex Wformat-contains-nul
3057 If @option{-Wformat} is specified, do not warn about format strings that
3058 contain NUL bytes.
3060 @item -Wno-format-extra-args
3061 @opindex Wno-format-extra-args
3062 @opindex Wformat-extra-args
3063 If @option{-Wformat} is specified, do not warn about excess arguments to a
3064 @code{printf} or @code{scanf} format function.  The C standard specifies
3065 that such arguments are ignored.
3067 Where the unused arguments lie between used arguments that are
3068 specified with @samp{$} operand number specifications, normally
3069 warnings are still given, since the implementation could not know what
3070 type to pass to @code{va_arg} to skip the unused arguments.  However,
3071 in the case of @code{scanf} formats, this option will suppress the
3072 warning if the unused arguments are all pointers, since the Single
3073 Unix Specification says that such unused arguments are allowed.
3075 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3076 @opindex Wno-format-zero-length
3077 @opindex Wformat-zero-length
3078 If @option{-Wformat} is specified, do not warn about zero-length formats.
3079 The C standard specifies that zero-length formats are allowed.
3081 @item -Wformat-nonliteral
3082 @opindex Wformat-nonliteral
3083 @opindex Wno-format-nonliteral
3084 If @option{-Wformat} is specified, also warn if the format string is not a
3085 string literal and so cannot be checked, unless the format function
3086 takes its format arguments as a @code{va_list}.
3088 @item -Wformat-security
3089 @opindex Wformat-security
3090 @opindex Wno-format-security
3091 If @option{-Wformat} is specified, also warn about uses of format
3092 functions that represent possible security problems.  At present, this
3093 warns about calls to @code{printf} and @code{scanf} functions where the
3094 format string is not a string literal and there are no format arguments,
3095 as in @code{printf (foo);}.  This may be a security hole if the format
3096 string came from untrusted input and contains @samp{%n}.  (This is
3097 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3098 in future warnings may be added to @option{-Wformat-security} that are not
3099 included in @option{-Wformat-nonliteral}.)
3101 @item -Wformat=2
3102 @opindex Wformat=2
3103 @opindex Wno-format=2
3104 Enable @option{-Wformat} plus format checks not included in
3105 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3106 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3108 @item -Wnonnull @r{(C and Objective-C only)}
3109 @opindex Wnonnull
3110 @opindex Wno-nonnull
3111 Warn about passing a null pointer for arguments marked as
3112 requiring a non-null value by the @code{nonnull} function attribute.
3114 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3115 can be disabled with the @option{-Wno-nonnull} option.
3117 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3118 @opindex Winit-self
3119 @opindex Wno-init-self
3120 Warn about uninitialized variables which are initialized with themselves.
3121 Note this option can only be used with the @option{-Wuninitialized} option.
3123 For example, GCC will warn about @code{i} being uninitialized in the
3124 following snippet only when @option{-Winit-self} has been specified:
3125 @smallexample
3126 @group
3127 int f()
3129   int i = i;
3130   return i;
3132 @end group
3133 @end smallexample
3135 @item -Wimplicit-int @r{(C and Objective-C only)}
3136 @opindex Wimplicit-int
3137 @opindex Wno-implicit-int
3138 Warn when a declaration does not specify a type.
3139 This warning is enabled by @option{-Wall}.
3141 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3142 @opindex Wimplicit-function-declaration
3143 @opindex Wno-implicit-function-declaration
3144 Give a warning whenever a function is used before being declared. In
3145 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3146 enabled by default and it is made into an error by
3147 @option{-pedantic-errors}. This warning is also enabled by
3148 @option{-Wall}.
3150 @item -Wimplicit @r{(C and Objective-C only)}
3151 @opindex Wimplicit
3152 @opindex Wno-implicit
3153 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3154 This warning is enabled by @option{-Wall}.
3156 @item -Wignored-qualifiers @r{(C and C++ only)}
3157 @opindex Wignored-qualifiers
3158 @opindex Wno-ignored-qualifiers
3159 Warn if the return type of a function has a type qualifier
3160 such as @code{const}.  For ISO C such a type qualifier has no effect,
3161 since the value returned by a function is not an lvalue.
3162 For C++, the warning is only emitted for scalar types or @code{void}.
3163 ISO C prohibits qualified @code{void} return types on function
3164 definitions, so such return types always receive a warning
3165 even without this option.
3167 This warning is also enabled by @option{-Wextra}.
3169 @item -Wmain
3170 @opindex Wmain
3171 @opindex Wno-main
3172 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3173 a function with external linkage, returning int, taking either zero
3174 arguments, two, or three arguments of appropriate types.  This warning
3175 is enabled by default in C++ and is enabled by either @option{-Wall}
3176 or @option{-pedantic}.
3178 @item -Wmissing-braces
3179 @opindex Wmissing-braces
3180 @opindex Wno-missing-braces
3181 Warn if an aggregate or union initializer is not fully bracketed.  In
3182 the following example, the initializer for @samp{a} is not fully
3183 bracketed, but that for @samp{b} is fully bracketed.
3185 @smallexample
3186 int a[2][2] = @{ 0, 1, 2, 3 @};
3187 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3188 @end smallexample
3190 This warning is enabled by @option{-Wall}.
3192 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3193 @opindex Wmissing-include-dirs
3194 @opindex Wno-missing-include-dirs
3195 Warn if a user-supplied include directory does not exist.
3197 @item -Wparentheses
3198 @opindex Wparentheses
3199 @opindex Wno-parentheses
3200 Warn if parentheses are omitted in certain contexts, such
3201 as when there is an assignment in a context where a truth value
3202 is expected, or when operators are nested whose precedence people
3203 often get confused about.
3205 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3206 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3207 interpretation from that of ordinary mathematical notation.
3209 Also warn about constructions where there may be confusion to which
3210 @code{if} statement an @code{else} branch belongs.  Here is an example of
3211 such a case:
3213 @smallexample
3214 @group
3216   if (a)
3217     if (b)
3218       foo ();
3219   else
3220     bar ();
3222 @end group
3223 @end smallexample
3225 In C/C++, every @code{else} branch belongs to the innermost possible
3226 @code{if} statement, which in this example is @code{if (b)}.  This is
3227 often not what the programmer expected, as illustrated in the above
3228 example by indentation the programmer chose.  When there is the
3229 potential for this confusion, GCC will issue a warning when this flag
3230 is specified.  To eliminate the warning, add explicit braces around
3231 the innermost @code{if} statement so there is no way the @code{else}
3232 could belong to the enclosing @code{if}.  The resulting code would
3233 look like this:
3235 @smallexample
3236 @group
3238   if (a)
3239     @{
3240       if (b)
3241         foo ();
3242       else
3243         bar ();
3244     @}
3246 @end group
3247 @end smallexample
3249 Also warn for dangerous uses of the 
3250 ?: with omitted middle operand GNU extension. When the condition
3251 in the ?: operator is a boolean expression the omitted value will
3252 be always 1. Often the user expects it to be a value computed
3253 inside the conditional expression instead. 
3255 This warning is enabled by @option{-Wall}.
3257 @item -Wsequence-point
3258 @opindex Wsequence-point
3259 @opindex Wno-sequence-point
3260 Warn about code that may have undefined semantics because of violations
3261 of sequence point rules in the C and C++ standards.
3263 The C and C++ standards defines the order in which expressions in a C/C++
3264 program are evaluated in terms of @dfn{sequence points}, which represent
3265 a partial ordering between the execution of parts of the program: those
3266 executed before the sequence point, and those executed after it.  These
3267 occur after the evaluation of a full expression (one which is not part
3268 of a larger expression), after the evaluation of the first operand of a
3269 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3270 function is called (but after the evaluation of its arguments and the
3271 expression denoting the called function), and in certain other places.
3272 Other than as expressed by the sequence point rules, the order of
3273 evaluation of subexpressions of an expression is not specified.  All
3274 these rules describe only a partial order rather than a total order,
3275 since, for example, if two functions are called within one expression
3276 with no sequence point between them, the order in which the functions
3277 are called is not specified.  However, the standards committee have
3278 ruled that function calls do not overlap.
3280 It is not specified when between sequence points modifications to the
3281 values of objects take effect.  Programs whose behavior depends on this
3282 have undefined behavior; the C and C++ standards specify that ``Between
3283 the previous and next sequence point an object shall have its stored
3284 value modified at most once by the evaluation of an expression.
3285 Furthermore, the prior value shall be read only to determine the value
3286 to be stored.''.  If a program breaks these rules, the results on any
3287 particular implementation are entirely unpredictable.
3289 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3290 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3291 diagnosed by this option, and it may give an occasional false positive
3292 result, but in general it has been found fairly effective at detecting
3293 this sort of problem in programs.
3295 The standard is worded confusingly, therefore there is some debate
3296 over the precise meaning of the sequence point rules in subtle cases.
3297 Links to discussions of the problem, including proposed formal
3298 definitions, may be found on the GCC readings page, at
3299 @uref{http://gcc.gnu.org/@/readings.html}.
3301 This warning is enabled by @option{-Wall} for C and C++.
3303 @item -Wreturn-type
3304 @opindex Wreturn-type
3305 @opindex Wno-return-type
3306 Warn whenever a function is defined with a return-type that defaults
3307 to @code{int}.  Also warn about any @code{return} statement with no
3308 return-value in a function whose return-type is not @code{void}
3309 (falling off the end of the function body is considered returning
3310 without a value), and about a @code{return} statement with an
3311 expression in a function whose return-type is @code{void}.
3313 For C++, a function without return type always produces a diagnostic
3314 message, even when @option{-Wno-return-type} is specified.  The only
3315 exceptions are @samp{main} and functions defined in system headers.
3317 This warning is enabled by @option{-Wall}.
3319 @item -Wswitch
3320 @opindex Wswitch
3321 @opindex Wno-switch
3322 Warn whenever a @code{switch} statement has an index of enumerated type
3323 and lacks a @code{case} for one or more of the named codes of that
3324 enumeration.  (The presence of a @code{default} label prevents this
3325 warning.)  @code{case} labels outside the enumeration range also
3326 provoke warnings when this option is used (even if there is a
3327 @code{default} label).
3328 This warning is enabled by @option{-Wall}.
3330 @item -Wswitch-default
3331 @opindex Wswitch-default
3332 @opindex Wno-switch-default
3333 Warn whenever a @code{switch} statement does not have a @code{default}
3334 case.
3336 @item -Wswitch-enum
3337 @opindex Wswitch-enum
3338 @opindex Wno-switch-enum
3339 Warn whenever a @code{switch} statement has an index of enumerated type
3340 and lacks a @code{case} for one or more of the named codes of that
3341 enumeration.  @code{case} labels outside the enumeration range also
3342 provoke warnings when this option is used.  The only difference
3343 between @option{-Wswitch} and this option is that this option gives a
3344 warning about an omitted enumeration code even if there is a
3345 @code{default} label.
3347 @item -Wsync-nand @r{(C and C++ only)}
3348 @opindex Wsync-nand
3349 @opindex Wno-sync-nand
3350 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3351 built-in functions are used.  These functions changed semantics in GCC 4.4.
3353 @item -Wtrigraphs
3354 @opindex Wtrigraphs
3355 @opindex Wno-trigraphs
3356 Warn if any trigraphs are encountered that might change the meaning of
3357 the program (trigraphs within comments are not warned about).
3358 This warning is enabled by @option{-Wall}.
3360 @item -Wunused-but-set-parameter
3361 @opindex Wunused-but-set-parameter
3362 @opindex Wno-unused-but-set-parameter
3363 Warn whenever a function parameter is assigned to, but otherwise unused
3364 (aside from its declaration).
3366 To suppress this warning use the @samp{unused} attribute
3367 (@pxref{Variable Attributes}).
3369 This warning is also enabled by @option{-Wunused} together with
3370 @option{-Wextra}.
3372 @item -Wunused-but-set-variable
3373 @opindex Wunused-but-set-variable
3374 @opindex Wno-unused-but-set-variable
3375 Warn whenever a local variable is assigned to, but otherwise unused
3376 (aside from its declaration).
3377 This warning is enabled by @option{-Wall}.
3379 To suppress this warning use the @samp{unused} attribute
3380 (@pxref{Variable Attributes}).
3382 This warning is also enabled by @option{-Wunused}, which is enabled
3383 by @option{-Wall}.
3385 @item -Wunused-function
3386 @opindex Wunused-function
3387 @opindex Wno-unused-function
3388 Warn whenever a static function is declared but not defined or a
3389 non-inline static function is unused.
3390 This warning is enabled by @option{-Wall}.
3392 @item -Wunused-label
3393 @opindex Wunused-label
3394 @opindex Wno-unused-label
3395 Warn whenever a label is declared but not used.
3396 This warning is enabled by @option{-Wall}.
3398 To suppress this warning use the @samp{unused} attribute
3399 (@pxref{Variable Attributes}).
3401 @item -Wunused-parameter
3402 @opindex Wunused-parameter
3403 @opindex Wno-unused-parameter
3404 Warn whenever a function parameter is unused aside from its declaration.
3406 To suppress this warning use the @samp{unused} attribute
3407 (@pxref{Variable Attributes}).
3409 @item -Wno-unused-result
3410 @opindex Wunused-result
3411 @opindex Wno-unused-result
3412 Do not warn if a caller of a function marked with attribute
3413 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3414 its return value. The default is @option{-Wunused-result}.
3416 @item -Wunused-variable
3417 @opindex Wunused-variable
3418 @opindex Wno-unused-variable
3419 Warn whenever a local variable or non-constant static variable is unused
3420 aside from its declaration.
3421 This warning is enabled by @option{-Wall}.
3423 To suppress this warning use the @samp{unused} attribute
3424 (@pxref{Variable Attributes}).
3426 @item -Wunused-value
3427 @opindex Wunused-value
3428 @opindex Wno-unused-value
3429 Warn whenever a statement computes a result that is explicitly not
3430 used. To suppress this warning cast the unused expression to
3431 @samp{void}. This includes an expression-statement or the left-hand
3432 side of a comma expression that contains no side effects. For example,
3433 an expression such as @samp{x[i,j]} will cause a warning, while
3434 @samp{x[(void)i,j]} will not.
3436 This warning is enabled by @option{-Wall}.
3438 @item -Wunused
3439 @opindex Wunused
3440 @opindex Wno-unused
3441 All the above @option{-Wunused} options combined.
3443 In order to get a warning about an unused function parameter, you must
3444 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3445 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3447 @item -Wuninitialized
3448 @opindex Wuninitialized
3449 @opindex Wno-uninitialized
3450 Warn if an automatic variable is used without first being initialized
3451 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3452 warn if a non-static reference or non-static @samp{const} member
3453 appears in a class without constructors.
3455 If you want to warn about code which uses the uninitialized value of the
3456 variable in its own initializer, use the @option{-Winit-self} option.
3458 These warnings occur for individual uninitialized or clobbered
3459 elements of structure, union or array variables as well as for
3460 variables which are uninitialized or clobbered as a whole.  They do
3461 not occur for variables or elements declared @code{volatile}.  Because
3462 these warnings depend on optimization, the exact variables or elements
3463 for which there are warnings will depend on the precise optimization
3464 options and version of GCC used.
3466 Note that there may be no warning about a variable that is used only
3467 to compute a value that itself is never used, because such
3468 computations may be deleted by data flow analysis before the warnings
3469 are printed.
3471 These warnings are made optional because GCC is not smart
3472 enough to see all the reasons why the code might be correct
3473 despite appearing to have an error.  Here is one example of how
3474 this can happen:
3476 @smallexample
3477 @group
3479   int x;
3480   switch (y)
3481     @{
3482     case 1: x = 1;
3483       break;
3484     case 2: x = 4;
3485       break;
3486     case 3: x = 5;
3487     @}
3488   foo (x);
3490 @end group
3491 @end smallexample
3493 @noindent
3494 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3495 always initialized, but GCC doesn't know this.  Here is
3496 another common case:
3498 @smallexample
3500   int save_y;
3501   if (change_y) save_y = y, y = new_y;
3502   @dots{}
3503   if (change_y) y = save_y;
3505 @end smallexample
3507 @noindent
3508 This has no bug because @code{save_y} is used only if it is set.
3510 @cindex @code{longjmp} warnings
3511 This option also warns when a non-volatile automatic variable might be
3512 changed by a call to @code{longjmp}.  These warnings as well are possible
3513 only in optimizing compilation.
3515 The compiler sees only the calls to @code{setjmp}.  It cannot know
3516 where @code{longjmp} will be called; in fact, a signal handler could
3517 call it at any point in the code.  As a result, you may get a warning
3518 even when there is in fact no problem because @code{longjmp} cannot
3519 in fact be called at the place which would cause a problem.
3521 Some spurious warnings can be avoided if you declare all the functions
3522 you use that never return as @code{noreturn}.  @xref{Function
3523 Attributes}.
3525 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3527 @item -Wunknown-pragmas
3528 @opindex Wunknown-pragmas
3529 @opindex Wno-unknown-pragmas
3530 @cindex warning for unknown pragmas
3531 @cindex unknown pragmas, warning
3532 @cindex pragmas, warning of unknown
3533 Warn when a #pragma directive is encountered which is not understood by
3534 GCC@.  If this command line option is used, warnings will even be issued
3535 for unknown pragmas in system header files.  This is not the case if
3536 the warnings were only enabled by the @option{-Wall} command line option.
3538 @item -Wno-pragmas
3539 @opindex Wno-pragmas
3540 @opindex Wpragmas
3541 Do not warn about misuses of pragmas, such as incorrect parameters,
3542 invalid syntax, or conflicts between pragmas.  See also
3543 @samp{-Wunknown-pragmas}.
3545 @item -Wstrict-aliasing
3546 @opindex Wstrict-aliasing
3547 @opindex Wno-strict-aliasing
3548 This option is only active when @option{-fstrict-aliasing} is active.
3549 It warns about code which might break the strict aliasing rules that the
3550 compiler is using for optimization.  The warning does not catch all
3551 cases, but does attempt to catch the more common pitfalls.  It is
3552 included in @option{-Wall}.
3553 It is equivalent to @option{-Wstrict-aliasing=3}
3555 @item -Wstrict-aliasing=n
3556 @opindex Wstrict-aliasing=n
3557 @opindex Wno-strict-aliasing=n
3558 This option is only active when @option{-fstrict-aliasing} is active.
3559 It warns about code which might break the strict aliasing rules that the
3560 compiler is using for optimization.
3561 Higher levels correspond to higher accuracy (fewer false positives).
3562 Higher levels also correspond to more effort, similar to the way -O works.
3563 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3564 with n=3.
3566 Level 1: Most aggressive, quick, least accurate.
3567 Possibly useful when higher levels
3568 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3569 false negatives.  However, it has many false positives.
3570 Warns for all pointer conversions between possibly incompatible types,
3571 even if never dereferenced.  Runs in the frontend only.
3573 Level 2: Aggressive, quick, not too precise.
3574 May still have many false positives (not as many as level 1 though),
3575 and few false negatives (but possibly more than level 1).
3576 Unlike level 1, it only warns when an address is taken.  Warns about
3577 incomplete types.  Runs in the frontend only.
3579 Level 3 (default for @option{-Wstrict-aliasing}):
3580 Should have very few false positives and few false
3581 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3582 Takes care of the common pun+dereference pattern in the frontend:
3583 @code{*(int*)&some_float}.
3584 If optimization is enabled, it also runs in the backend, where it deals
3585 with multiple statement cases using flow-sensitive points-to information.
3586 Only warns when the converted pointer is dereferenced.
3587 Does not warn about incomplete types.
3589 @item -Wstrict-overflow
3590 @itemx -Wstrict-overflow=@var{n}
3591 @opindex Wstrict-overflow
3592 @opindex Wno-strict-overflow
3593 This option is only active when @option{-fstrict-overflow} is active.
3594 It warns about cases where the compiler optimizes based on the
3595 assumption that signed overflow does not occur.  Note that it does not
3596 warn about all cases where the code might overflow: it only warns
3597 about cases where the compiler implements some optimization.  Thus
3598 this warning depends on the optimization level.
3600 An optimization which assumes that signed overflow does not occur is
3601 perfectly safe if the values of the variables involved are such that
3602 overflow never does, in fact, occur.  Therefore this warning can
3603 easily give a false positive: a warning about code which is not
3604 actually a problem.  To help focus on important issues, several
3605 warning levels are defined.  No warnings are issued for the use of
3606 undefined signed overflow when estimating how many iterations a loop
3607 will require, in particular when determining whether a loop will be
3608 executed at all.
3610 @table @gcctabopt
3611 @item -Wstrict-overflow=1
3612 Warn about cases which are both questionable and easy to avoid.  For
3613 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3614 compiler will simplify this to @code{1}.  This level of
3615 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3616 are not, and must be explicitly requested.
3618 @item -Wstrict-overflow=2
3619 Also warn about other cases where a comparison is simplified to a
3620 constant.  For example: @code{abs (x) >= 0}.  This can only be
3621 simplified when @option{-fstrict-overflow} is in effect, because
3622 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3623 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3624 @option{-Wstrict-overflow=2}.
3626 @item -Wstrict-overflow=3
3627 Also warn about other cases where a comparison is simplified.  For
3628 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3630 @item -Wstrict-overflow=4
3631 Also warn about other simplifications not covered by the above cases.
3632 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3634 @item -Wstrict-overflow=5
3635 Also warn about cases where the compiler reduces the magnitude of a
3636 constant involved in a comparison.  For example: @code{x + 2 > y} will
3637 be simplified to @code{x + 1 >= y}.  This is reported only at the
3638 highest warning level because this simplification applies to many
3639 comparisons, so this warning level will give a very large number of
3640 false positives.
3641 @end table
3643 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]}
3644 @opindex Wsuggest-attribute=
3645 @opindex Wno-suggest-attribute=
3646 Warn for cases where adding an attribute may be beneficial. The
3647 attributes currently supported are listed below.
3649 @table @gcctabopt
3650 @item -Wsuggest-attribute=pure
3651 @itemx -Wsuggest-attribute=const
3652 @itemx -Wsuggest-attribute=noreturn
3653 @opindex Wsuggest-attribute=pure
3654 @opindex Wno-suggest-attribute=pure
3655 @opindex Wsuggest-attribute=const
3656 @opindex Wno-suggest-attribute=const
3657 @opindex Wsuggest-attribute=noreturn
3658 @opindex Wno-suggest-attribute=noreturn
3660 Warn about functions which might be candidates for attributes
3661 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3662 functions visible in other compilation units or (in the case of @code{pure} and
3663 @code{const}) if it cannot prove that the function returns normally. A function
3664 returns normally if it doesn't contain an infinite loop nor returns abnormally
3665 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3666 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3667 higher.  Higher optimization levels improve the accuracy of the analysis.
3668 @end table
3670 @item -Warray-bounds
3671 @opindex Wno-array-bounds
3672 @opindex Warray-bounds
3673 This option is only active when @option{-ftree-vrp} is active
3674 (default for @option{-O2} and above). It warns about subscripts to arrays
3675 that are always out of bounds. This warning is enabled by @option{-Wall}.
3677 @item -Wno-div-by-zero
3678 @opindex Wno-div-by-zero
3679 @opindex Wdiv-by-zero
3680 Do not warn about compile-time integer division by zero.  Floating point
3681 division by zero is not warned about, as it can be a legitimate way of
3682 obtaining infinities and NaNs.
3684 @item -Wsystem-headers
3685 @opindex Wsystem-headers
3686 @opindex Wno-system-headers
3687 @cindex warnings from system headers
3688 @cindex system headers, warnings from
3689 Print warning messages for constructs found in system header files.
3690 Warnings from system headers are normally suppressed, on the assumption
3691 that they usually do not indicate real problems and would only make the
3692 compiler output harder to read.  Using this command line option tells
3693 GCC to emit warnings from system headers as if they occurred in user
3694 code.  However, note that using @option{-Wall} in conjunction with this
3695 option will @emph{not} warn about unknown pragmas in system
3696 headers---for that, @option{-Wunknown-pragmas} must also be used.
3698 @item -Wtrampolines
3699 @opindex Wtrampolines
3700 @opindex Wno-trampolines
3701  Warn about trampolines generated for pointers to nested functions.
3703  A trampoline is a small piece of data or code that is created at run
3704  time on the stack when the address of a nested function is taken, and
3705  is used to call the nested function indirectly.  For some targets, it
3706  is made up of data only and thus requires no special treatment.  But,
3707  for most targets, it is made up of code and thus requires the stack
3708  to be made executable in order for the program to work properly.
3710 @item -Wfloat-equal
3711 @opindex Wfloat-equal
3712 @opindex Wno-float-equal
3713 Warn if floating point values are used in equality comparisons.
3715 The idea behind this is that sometimes it is convenient (for the
3716 programmer) to consider floating-point values as approximations to
3717 infinitely precise real numbers.  If you are doing this, then you need
3718 to compute (by analyzing the code, or in some other way) the maximum or
3719 likely maximum error that the computation introduces, and allow for it
3720 when performing comparisons (and when producing output, but that's a
3721 different problem).  In particular, instead of testing for equality, you
3722 would check to see whether the two values have ranges that overlap; and
3723 this is done with the relational operators, so equality comparisons are
3724 probably mistaken.
3726 @item -Wtraditional @r{(C and Objective-C only)}
3727 @opindex Wtraditional
3728 @opindex Wno-traditional
3729 Warn about certain constructs that behave differently in traditional and
3730 ISO C@.  Also warn about ISO C constructs that have no traditional C
3731 equivalent, and/or problematic constructs which should be avoided.
3733 @itemize @bullet
3734 @item
3735 Macro parameters that appear within string literals in the macro body.
3736 In traditional C macro replacement takes place within string literals,
3737 but does not in ISO C@.
3739 @item
3740 In traditional C, some preprocessor directives did not exist.
3741 Traditional preprocessors would only consider a line to be a directive
3742 if the @samp{#} appeared in column 1 on the line.  Therefore
3743 @option{-Wtraditional} warns about directives that traditional C
3744 understands but would ignore because the @samp{#} does not appear as the
3745 first character on the line.  It also suggests you hide directives like
3746 @samp{#pragma} not understood by traditional C by indenting them.  Some
3747 traditional implementations would not recognize @samp{#elif}, so it
3748 suggests avoiding it altogether.
3750 @item
3751 A function-like macro that appears without arguments.
3753 @item
3754 The unary plus operator.
3756 @item
3757 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3758 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3759 constants.)  Note, these suffixes appear in macros defined in the system
3760 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3761 Use of these macros in user code might normally lead to spurious
3762 warnings, however GCC's integrated preprocessor has enough context to
3763 avoid warning in these cases.
3765 @item
3766 A function declared external in one block and then used after the end of
3767 the block.
3769 @item
3770 A @code{switch} statement has an operand of type @code{long}.
3772 @item
3773 A non-@code{static} function declaration follows a @code{static} one.
3774 This construct is not accepted by some traditional C compilers.
3776 @item
3777 The ISO type of an integer constant has a different width or
3778 signedness from its traditional type.  This warning is only issued if
3779 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3780 typically represent bit patterns, are not warned about.
3782 @item
3783 Usage of ISO string concatenation is detected.
3785 @item
3786 Initialization of automatic aggregates.
3788 @item
3789 Identifier conflicts with labels.  Traditional C lacks a separate
3790 namespace for labels.
3792 @item
3793 Initialization of unions.  If the initializer is zero, the warning is
3794 omitted.  This is done under the assumption that the zero initializer in
3795 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3796 initializer warnings and relies on default initialization to zero in the
3797 traditional C case.
3799 @item
3800 Conversions by prototypes between fixed/floating point values and vice
3801 versa.  The absence of these prototypes when compiling with traditional
3802 C would cause serious problems.  This is a subset of the possible
3803 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3805 @item
3806 Use of ISO C style function definitions.  This warning intentionally is
3807 @emph{not} issued for prototype declarations or variadic functions
3808 because these ISO C features will appear in your code when using
3809 libiberty's traditional C compatibility macros, @code{PARAMS} and
3810 @code{VPARAMS}.  This warning is also bypassed for nested functions
3811 because that feature is already a GCC extension and thus not relevant to
3812 traditional C compatibility.
3813 @end itemize
3815 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3816 @opindex Wtraditional-conversion
3817 @opindex Wno-traditional-conversion
3818 Warn if a prototype causes a type conversion that is different from what
3819 would happen to the same argument in the absence of a prototype.  This
3820 includes conversions of fixed point to floating and vice versa, and
3821 conversions changing the width or signedness of a fixed point argument
3822 except when the same as the default promotion.
3824 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3825 @opindex Wdeclaration-after-statement
3826 @opindex Wno-declaration-after-statement
3827 Warn when a declaration is found after a statement in a block.  This
3828 construct, known from C++, was introduced with ISO C99 and is by default
3829 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3830 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3832 @item -Wundef
3833 @opindex Wundef
3834 @opindex Wno-undef
3835 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3837 @item -Wno-endif-labels
3838 @opindex Wno-endif-labels
3839 @opindex Wendif-labels
3840 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3842 @item -Wshadow
3843 @opindex Wshadow
3844 @opindex Wno-shadow
3845 Warn whenever a local variable or type declaration shadows another variable,
3846 parameter, type, or class member (in C++), or whenever a built-in function
3847 is shadowed. Note that in C++, the compiler will not warn if a local variable
3848 shadows a struct/class/enum, but will warn if it shadows an explicit typedef.
3850 @item -Wlarger-than=@var{len}
3851 @opindex Wlarger-than=@var{len}
3852 @opindex Wlarger-than-@var{len}
3853 Warn whenever an object of larger than @var{len} bytes is defined.
3855 @item -Wframe-larger-than=@var{len}
3856 @opindex Wframe-larger-than
3857 Warn if the size of a function frame is larger than @var{len} bytes.
3858 The computation done to determine the stack frame size is approximate
3859 and not conservative.
3860 The actual requirements may be somewhat greater than @var{len}
3861 even if you do not get a warning.  In addition, any space allocated
3862 via @code{alloca}, variable-length arrays, or related constructs
3863 is not included by the compiler when determining
3864 whether or not to issue a warning.
3866 @item -Wunsafe-loop-optimizations
3867 @opindex Wunsafe-loop-optimizations
3868 @opindex Wno-unsafe-loop-optimizations
3869 Warn if the loop cannot be optimized because the compiler could not
3870 assume anything on the bounds of the loop indices.  With
3871 @option{-funsafe-loop-optimizations} warn if the compiler made
3872 such assumptions.
3874 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3875 @opindex Wno-pedantic-ms-format
3876 @opindex Wpedantic-ms-format
3877 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3878 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3879 depending on the MS runtime, when you are using the options @option{-Wformat}
3880 and @option{-pedantic} without gnu-extensions.
3882 @item -Wpointer-arith
3883 @opindex Wpointer-arith
3884 @opindex Wno-pointer-arith
3885 Warn about anything that depends on the ``size of'' a function type or
3886 of @code{void}.  GNU C assigns these types a size of 1, for
3887 convenience in calculations with @code{void *} pointers and pointers
3888 to functions.  In C++, warn also when an arithmetic operation involves
3889 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3891 @item -Wtype-limits
3892 @opindex Wtype-limits
3893 @opindex Wno-type-limits
3894 Warn if a comparison is always true or always false due to the limited
3895 range of the data type, but do not warn for constant expressions.  For
3896 example, warn if an unsigned variable is compared against zero with
3897 @samp{<} or @samp{>=}.  This warning is also enabled by
3898 @option{-Wextra}.
3900 @item -Wbad-function-cast @r{(C and Objective-C only)}
3901 @opindex Wbad-function-cast
3902 @opindex Wno-bad-function-cast
3903 Warn whenever a function call is cast to a non-matching type.
3904 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3906 @item -Wc++-compat @r{(C and Objective-C only)}
3907 Warn about ISO C constructs that are outside of the common subset of
3908 ISO C and ISO C++, e.g.@: request for implicit conversion from
3909 @code{void *} to a pointer to non-@code{void} type.
3911 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3912 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3913 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3914 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3916 @item -Wcast-qual
3917 @opindex Wcast-qual
3918 @opindex Wno-cast-qual
3919 Warn whenever a pointer is cast so as to remove a type qualifier from
3920 the target type.  For example, warn if a @code{const char *} is cast
3921 to an ordinary @code{char *}.
3923 Also warn when making a cast which introduces a type qualifier in an
3924 unsafe way.  For example, casting @code{char **} to @code{const char **}
3925 is unsafe, as in this example:
3927 @smallexample
3928   /* p is char ** value.  */
3929   const char **q = (const char **) p;
3930   /* Assignment of readonly string to const char * is OK.  */
3931   *q = "string";
3932   /* Now char** pointer points to read-only memory.  */
3933   **p = 'b';
3934 @end smallexample
3936 @item -Wcast-align
3937 @opindex Wcast-align
3938 @opindex Wno-cast-align
3939 Warn whenever a pointer is cast such that the required alignment of the
3940 target is increased.  For example, warn if a @code{char *} is cast to
3941 an @code{int *} on machines where integers can only be accessed at
3942 two- or four-byte boundaries.
3944 @item -Wwrite-strings
3945 @opindex Wwrite-strings
3946 @opindex Wno-write-strings
3947 When compiling C, give string constants the type @code{const
3948 char[@var{length}]} so that copying the address of one into a
3949 non-@code{const} @code{char *} pointer will get a warning.  These
3950 warnings will help you find at compile time code that can try to write
3951 into a string constant, but only if you have been very careful about
3952 using @code{const} in declarations and prototypes.  Otherwise, it will
3953 just be a nuisance. This is why we did not make @option{-Wall} request
3954 these warnings.
3956 When compiling C++, warn about the deprecated conversion from string
3957 literals to @code{char *}.  This warning is enabled by default for C++
3958 programs.
3960 @item -Wclobbered
3961 @opindex Wclobbered
3962 @opindex Wno-clobbered
3963 Warn for variables that might be changed by @samp{longjmp} or
3964 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3966 @item -Wconversion
3967 @opindex Wconversion
3968 @opindex Wno-conversion
3969 Warn for implicit conversions that may alter a value. This includes
3970 conversions between real and integer, like @code{abs (x)} when
3971 @code{x} is @code{double}; conversions between signed and unsigned,
3972 like @code{unsigned ui = -1}; and conversions to smaller types, like
3973 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3974 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3975 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3976 conversions between signed and unsigned integers can be disabled by
3977 using @option{-Wno-sign-conversion}.
3979 For C++, also warn for confusing overload resolution for user-defined
3980 conversions; and conversions that will never use a type conversion
3981 operator: conversions to @code{void}, the same type, a base class or a
3982 reference to them. Warnings about conversions between signed and
3983 unsigned integers are disabled by default in C++ unless
3984 @option{-Wsign-conversion} is explicitly enabled.
3986 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
3987 @opindex Wconversion-null
3988 @opindex Wno-conversion-null
3989 Do not warn for conversions between @code{NULL} and non-pointer
3990 types. @option{-Wconversion-null} is enabled by default.
3992 @item -Wempty-body
3993 @opindex Wempty-body
3994 @opindex Wno-empty-body
3995 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3996 while} statement.  This warning is also enabled by @option{-Wextra}.
3998 @item -Wenum-compare
3999 @opindex Wenum-compare
4000 @opindex Wno-enum-compare
4001 Warn about a comparison between values of different enum types. In C++
4002 this warning is enabled by default.  In C this warning is enabled by
4003 @option{-Wall}.
4005 @item -Wjump-misses-init @r{(C, Objective-C only)}
4006 @opindex Wjump-misses-init
4007 @opindex Wno-jump-misses-init
4008 Warn if a @code{goto} statement or a @code{switch} statement jumps
4009 forward across the initialization of a variable, or jumps backward to a
4010 label after the variable has been initialized.  This only warns about
4011 variables which are initialized when they are declared.  This warning is
4012 only supported for C and Objective C; in C++ this sort of branch is an
4013 error in any case.
4015 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4016 can be disabled with the @option{-Wno-jump-misses-init} option.
4018 @item -Wsign-compare
4019 @opindex Wsign-compare
4020 @opindex Wno-sign-compare
4021 @cindex warning for comparison of signed and unsigned values
4022 @cindex comparison of signed and unsigned values, warning
4023 @cindex signed and unsigned values, comparison warning
4024 Warn when a comparison between signed and unsigned values could produce
4025 an incorrect result when the signed value is converted to unsigned.
4026 This warning is also enabled by @option{-Wextra}; to get the other warnings
4027 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
4029 @item -Wsign-conversion
4030 @opindex Wsign-conversion
4031 @opindex Wno-sign-conversion
4032 Warn for implicit conversions that may change the sign of an integer
4033 value, like assigning a signed integer expression to an unsigned
4034 integer variable. An explicit cast silences the warning. In C, this
4035 option is enabled also by @option{-Wconversion}.
4037 @item -Waddress
4038 @opindex Waddress
4039 @opindex Wno-address
4040 Warn about suspicious uses of memory addresses. These include using
4041 the address of a function in a conditional expression, such as
4042 @code{void func(void); if (func)}, and comparisons against the memory
4043 address of a string literal, such as @code{if (x == "abc")}.  Such
4044 uses typically indicate a programmer error: the address of a function
4045 always evaluates to true, so their use in a conditional usually
4046 indicate that the programmer forgot the parentheses in a function
4047 call; and comparisons against string literals result in unspecified
4048 behavior and are not portable in C, so they usually indicate that the
4049 programmer intended to use @code{strcmp}.  This warning is enabled by
4050 @option{-Wall}.
4052 @item -Wlogical-op
4053 @opindex Wlogical-op
4054 @opindex Wno-logical-op
4055 Warn about suspicious uses of logical operators in expressions.
4056 This includes using logical operators in contexts where a
4057 bit-wise operator is likely to be expected.
4059 @item -Waggregate-return
4060 @opindex Waggregate-return
4061 @opindex Wno-aggregate-return
4062 Warn if any functions that return structures or unions are defined or
4063 called.  (In languages where you can return an array, this also elicits
4064 a warning.)
4066 @item -Wno-attributes
4067 @opindex Wno-attributes
4068 @opindex Wattributes
4069 Do not warn if an unexpected @code{__attribute__} is used, such as
4070 unrecognized attributes, function attributes applied to variables,
4071 etc.  This will not stop errors for incorrect use of supported
4072 attributes.
4074 @item -Wno-builtin-macro-redefined
4075 @opindex Wno-builtin-macro-redefined
4076 @opindex Wbuiltin-macro-redefined
4077 Do not warn if certain built-in macros are redefined.  This suppresses
4078 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4079 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4081 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4082 @opindex Wstrict-prototypes
4083 @opindex Wno-strict-prototypes
4084 Warn if a function is declared or defined without specifying the
4085 argument types.  (An old-style function definition is permitted without
4086 a warning if preceded by a declaration which specifies the argument
4087 types.)
4089 @item -Wold-style-declaration @r{(C and Objective-C only)}
4090 @opindex Wold-style-declaration
4091 @opindex Wno-old-style-declaration
4092 Warn for obsolescent usages, according to the C Standard, in a
4093 declaration. For example, warn if storage-class specifiers like
4094 @code{static} are not the first things in a declaration.  This warning
4095 is also enabled by @option{-Wextra}.
4097 @item -Wold-style-definition @r{(C and Objective-C only)}
4098 @opindex Wold-style-definition
4099 @opindex Wno-old-style-definition
4100 Warn if an old-style function definition is used.  A warning is given
4101 even if there is a previous prototype.
4103 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4104 @opindex Wmissing-parameter-type
4105 @opindex Wno-missing-parameter-type
4106 A function parameter is declared without a type specifier in K&R-style
4107 functions:
4109 @smallexample
4110 void foo(bar) @{ @}
4111 @end smallexample
4113 This warning is also enabled by @option{-Wextra}.
4115 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4116 @opindex Wmissing-prototypes
4117 @opindex Wno-missing-prototypes
4118 Warn if a global function is defined without a previous prototype
4119 declaration.  This warning is issued even if the definition itself
4120 provides a prototype.  The aim is to detect global functions that fail
4121 to be declared in header files.
4123 @item -Wmissing-declarations
4124 @opindex Wmissing-declarations
4125 @opindex Wno-missing-declarations
4126 Warn if a global function is defined without a previous declaration.
4127 Do so even if the definition itself provides a prototype.
4128 Use this option to detect global functions that are not declared in
4129 header files.  In C++, no warnings are issued for function templates,
4130 or for inline functions, or for functions in anonymous namespaces.
4132 @item -Wmissing-field-initializers
4133 @opindex Wmissing-field-initializers
4134 @opindex Wno-missing-field-initializers
4135 @opindex W
4136 @opindex Wextra
4137 @opindex Wno-extra
4138 Warn if a structure's initializer has some fields missing.  For
4139 example, the following code would cause such a warning, because
4140 @code{x.h} is implicitly zero:
4142 @smallexample
4143 struct s @{ int f, g, h; @};
4144 struct s x = @{ 3, 4 @};
4145 @end smallexample
4147 This option does not warn about designated initializers, so the following
4148 modification would not trigger a warning:
4150 @smallexample
4151 struct s @{ int f, g, h; @};
4152 struct s x = @{ .f = 3, .g = 4 @};
4153 @end smallexample
4155 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4156 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4158 @item -Wmissing-format-attribute
4159 @opindex Wmissing-format-attribute
4160 @opindex Wno-missing-format-attribute
4161 @opindex Wformat
4162 @opindex Wno-format
4163 Warn about function pointers which might be candidates for @code{format}
4164 attributes.  Note these are only possible candidates, not absolute ones.
4165 GCC will guess that function pointers with @code{format} attributes that
4166 are used in assignment, initialization, parameter passing or return
4167 statements should have a corresponding @code{format} attribute in the
4168 resulting type.  I.e.@: the left-hand side of the assignment or
4169 initialization, the type of the parameter variable, or the return type
4170 of the containing function respectively should also have a @code{format}
4171 attribute to avoid the warning.
4173 GCC will also warn about function definitions which might be
4174 candidates for @code{format} attributes.  Again, these are only
4175 possible candidates.  GCC will guess that @code{format} attributes
4176 might be appropriate for any function that calls a function like
4177 @code{vprintf} or @code{vscanf}, but this might not always be the
4178 case, and some functions for which @code{format} attributes are
4179 appropriate may not be detected.
4181 @item -Wno-multichar
4182 @opindex Wno-multichar
4183 @opindex Wmultichar
4184 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4185 Usually they indicate a typo in the user's code, as they have
4186 implementation-defined values, and should not be used in portable code.
4188 @item -Wnormalized=<none|id|nfc|nfkc>
4189 @opindex Wnormalized=
4190 @cindex NFC
4191 @cindex NFKC
4192 @cindex character set, input normalization
4193 In ISO C and ISO C++, two identifiers are different if they are
4194 different sequences of characters.  However, sometimes when characters
4195 outside the basic ASCII character set are used, you can have two
4196 different character sequences that look the same.  To avoid confusion,
4197 the ISO 10646 standard sets out some @dfn{normalization rules} which
4198 when applied ensure that two sequences that look the same are turned into
4199 the same sequence.  GCC can warn you if you are using identifiers which
4200 have not been normalized; this option controls that warning.
4202 There are four levels of warning that GCC supports.  The default is
4203 @option{-Wnormalized=nfc}, which warns about any identifier which is
4204 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4205 recommended form for most uses.
4207 Unfortunately, there are some characters which ISO C and ISO C++ allow
4208 in identifiers that when turned into NFC aren't allowable as
4209 identifiers.  That is, there's no way to use these symbols in portable
4210 ISO C or C++ and have all your identifiers in NFC@.
4211 @option{-Wnormalized=id} suppresses the warning for these characters.
4212 It is hoped that future versions of the standards involved will correct
4213 this, which is why this option is not the default.
4215 You can switch the warning off for all characters by writing
4216 @option{-Wnormalized=none}.  You would only want to do this if you
4217 were using some other normalization scheme (like ``D''), because
4218 otherwise you can easily create bugs that are literally impossible to see.
4220 Some characters in ISO 10646 have distinct meanings but look identical
4221 in some fonts or display methodologies, especially once formatting has
4222 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4223 LETTER N'', will display just like a regular @code{n} which has been
4224 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4225 normalization scheme to convert all these into a standard form as
4226 well, and GCC will warn if your code is not in NFKC if you use
4227 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4228 about every identifier that contains the letter O because it might be
4229 confused with the digit 0, and so is not the default, but may be
4230 useful as a local coding convention if the programming environment is
4231 unable to be fixed to display these characters distinctly.
4233 @item -Wno-deprecated
4234 @opindex Wno-deprecated
4235 @opindex Wdeprecated
4236 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4238 @item -Wno-deprecated-declarations
4239 @opindex Wno-deprecated-declarations
4240 @opindex Wdeprecated-declarations
4241 Do not warn about uses of functions (@pxref{Function Attributes}),
4242 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4243 Attributes}) marked as deprecated by using the @code{deprecated}
4244 attribute.
4246 @item -Wno-overflow
4247 @opindex Wno-overflow
4248 @opindex Woverflow
4249 Do not warn about compile-time overflow in constant expressions.
4251 @item -Woverride-init @r{(C and Objective-C only)}
4252 @opindex Woverride-init
4253 @opindex Wno-override-init
4254 @opindex W
4255 @opindex Wextra
4256 @opindex Wno-extra
4257 Warn if an initialized field without side effects is overridden when
4258 using designated initializers (@pxref{Designated Inits, , Designated
4259 Initializers}).
4261 This warning is included in @option{-Wextra}.  To get other
4262 @option{-Wextra} warnings without this one, use @samp{-Wextra
4263 -Wno-override-init}.
4265 @item -Wpacked
4266 @opindex Wpacked
4267 @opindex Wno-packed
4268 Warn if a structure is given the packed attribute, but the packed
4269 attribute has no effect on the layout or size of the structure.
4270 Such structures may be mis-aligned for little benefit.  For
4271 instance, in this code, the variable @code{f.x} in @code{struct bar}
4272 will be misaligned even though @code{struct bar} does not itself
4273 have the packed attribute:
4275 @smallexample
4276 @group
4277 struct foo @{
4278   int x;
4279   char a, b, c, d;
4280 @} __attribute__((packed));
4281 struct bar @{
4282   char z;
4283   struct foo f;
4285 @end group
4286 @end smallexample
4288 @item -Wpacked-bitfield-compat
4289 @opindex Wpacked-bitfield-compat
4290 @opindex Wno-packed-bitfield-compat
4291 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4292 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4293 the change can lead to differences in the structure layout.  GCC
4294 informs you when the offset of such a field has changed in GCC 4.4.
4295 For example there is no longer a 4-bit padding between field @code{a}
4296 and @code{b} in this structure:
4298 @smallexample
4299 struct foo
4301   char a:4;
4302   char b:8;
4303 @} __attribute__ ((packed));
4304 @end smallexample
4306 This warning is enabled by default.  Use
4307 @option{-Wno-packed-bitfield-compat} to disable this warning.
4309 @item -Wpadded
4310 @opindex Wpadded
4311 @opindex Wno-padded
4312 Warn if padding is included in a structure, either to align an element
4313 of the structure or to align the whole structure.  Sometimes when this
4314 happens it is possible to rearrange the fields of the structure to
4315 reduce the padding and so make the structure smaller.
4317 @item -Wredundant-decls
4318 @opindex Wredundant-decls
4319 @opindex Wno-redundant-decls
4320 Warn if anything is declared more than once in the same scope, even in
4321 cases where multiple declaration is valid and changes nothing.
4323 @item -Wnested-externs @r{(C and Objective-C only)}
4324 @opindex Wnested-externs
4325 @opindex Wno-nested-externs
4326 Warn if an @code{extern} declaration is encountered within a function.
4328 @item -Winline
4329 @opindex Winline
4330 @opindex Wno-inline
4331 Warn if a function can not be inlined and it was declared as inline.
4332 Even with this option, the compiler will not warn about failures to
4333 inline functions declared in system headers.
4335 The compiler uses a variety of heuristics to determine whether or not
4336 to inline a function.  For example, the compiler takes into account
4337 the size of the function being inlined and the amount of inlining
4338 that has already been done in the current function.  Therefore,
4339 seemingly insignificant changes in the source program can cause the
4340 warnings produced by @option{-Winline} to appear or disappear.
4342 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4343 @opindex Wno-invalid-offsetof
4344 @opindex Winvalid-offsetof
4345 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4346 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4347 to a non-POD type is undefined.  In existing C++ implementations,
4348 however, @samp{offsetof} typically gives meaningful results even when
4349 applied to certain kinds of non-POD types. (Such as a simple
4350 @samp{struct} that fails to be a POD type only by virtue of having a
4351 constructor.)  This flag is for users who are aware that they are
4352 writing nonportable code and who have deliberately chosen to ignore the
4353 warning about it.
4355 The restrictions on @samp{offsetof} may be relaxed in a future version
4356 of the C++ standard.
4358 @item -Wno-int-to-pointer-cast
4359 @opindex Wno-int-to-pointer-cast
4360 @opindex Wint-to-pointer-cast
4361 Suppress warnings from casts to pointer type of an integer of a
4362 different size. In C++, casting to a pointer type of smaller size is
4363 an error. @option{Wint-to-pointer-cast} is enabled by default.
4366 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4367 @opindex Wno-pointer-to-int-cast
4368 @opindex Wpointer-to-int-cast
4369 Suppress warnings from casts from a pointer to an integer type of a
4370 different size.
4372 @item -Winvalid-pch
4373 @opindex Winvalid-pch
4374 @opindex Wno-invalid-pch
4375 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4376 the search path but can't be used.
4378 @item -Wlong-long
4379 @opindex Wlong-long
4380 @opindex Wno-long-long
4381 Warn if @samp{long long} type is used.  This is enabled by either
4382 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4383 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4385 @item -Wvariadic-macros
4386 @opindex Wvariadic-macros
4387 @opindex Wno-variadic-macros
4388 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4389 alternate syntax when in pedantic ISO C99 mode.  This is default.
4390 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4392 @item -Wvla
4393 @opindex Wvla
4394 @opindex Wno-vla
4395 Warn if variable length array is used in the code.
4396 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4397 the variable length array.
4399 @item -Wvolatile-register-var
4400 @opindex Wvolatile-register-var
4401 @opindex Wno-volatile-register-var
4402 Warn if a register variable is declared volatile.  The volatile
4403 modifier does not inhibit all optimizations that may eliminate reads
4404 and/or writes to register variables.  This warning is enabled by
4405 @option{-Wall}.
4407 @item -Wdisabled-optimization
4408 @opindex Wdisabled-optimization
4409 @opindex Wno-disabled-optimization
4410 Warn if a requested optimization pass is disabled.  This warning does
4411 not generally indicate that there is anything wrong with your code; it
4412 merely indicates that GCC's optimizers were unable to handle the code
4413 effectively.  Often, the problem is that your code is too big or too
4414 complex; GCC will refuse to optimize programs when the optimization
4415 itself is likely to take inordinate amounts of time.
4417 @item -Wpointer-sign @r{(C and Objective-C only)}
4418 @opindex Wpointer-sign
4419 @opindex Wno-pointer-sign
4420 Warn for pointer argument passing or assignment with different signedness.
4421 This option is only supported for C and Objective-C@.  It is implied by
4422 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4423 @option{-Wno-pointer-sign}.
4425 @item -Wstack-protector
4426 @opindex Wstack-protector
4427 @opindex Wno-stack-protector
4428 This option is only active when @option{-fstack-protector} is active.  It
4429 warns about functions that will not be protected against stack smashing.
4431 @item -Wno-mudflap
4432 @opindex Wno-mudflap
4433 Suppress warnings about constructs that cannot be instrumented by
4434 @option{-fmudflap}.
4436 @item -Woverlength-strings
4437 @opindex Woverlength-strings
4438 @opindex Wno-overlength-strings
4439 Warn about string constants which are longer than the ``minimum
4440 maximum'' length specified in the C standard.  Modern compilers
4441 generally allow string constants which are much longer than the
4442 standard's minimum limit, but very portable programs should avoid
4443 using longer strings.
4445 The limit applies @emph{after} string constant concatenation, and does
4446 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4447 C99, it was raised to 4095.  C++98 does not specify a normative
4448 minimum maximum, so we do not diagnose overlength strings in C++@.
4450 This option is implied by @option{-pedantic}, and can be disabled with
4451 @option{-Wno-overlength-strings}.
4453 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4454 @opindex Wunsuffixed-float-constants
4456 GCC will issue a warning for any floating constant that does not have
4457 a suffix.  When used together with @option{-Wsystem-headers} it will
4458 warn about such constants in system header files.  This can be useful
4459 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4460 from the decimal floating-point extension to C99.
4461 @end table
4463 @node Debugging Options
4464 @section Options for Debugging Your Program or GCC
4465 @cindex options, debugging
4466 @cindex debugging information options
4468 GCC has various special options that are used for debugging
4469 either your program or GCC:
4471 @table @gcctabopt
4472 @item -g
4473 @opindex g
4474 Produce debugging information in the operating system's native format
4475 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4476 information.
4478 On most systems that use stabs format, @option{-g} enables use of extra
4479 debugging information that only GDB can use; this extra information
4480 makes debugging work better in GDB but will probably make other debuggers
4481 crash or
4482 refuse to read the program.  If you want to control for certain whether
4483 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4484 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4486 GCC allows you to use @option{-g} with
4487 @option{-O}.  The shortcuts taken by optimized code may occasionally
4488 produce surprising results: some variables you declared may not exist
4489 at all; flow of control may briefly move where you did not expect it;
4490 some statements may not be executed because they compute constant
4491 results or their values were already at hand; some statements may
4492 execute in different places because they were moved out of loops.
4494 Nevertheless it proves possible to debug optimized output.  This makes
4495 it reasonable to use the optimizer for programs that might have bugs.
4497 The following options are useful when GCC is generated with the
4498 capability for more than one debugging format.
4500 @item -ggdb
4501 @opindex ggdb
4502 Produce debugging information for use by GDB@.  This means to use the
4503 most expressive format available (DWARF 2, stabs, or the native format
4504 if neither of those are supported), including GDB extensions if at all
4505 possible.
4507 @item -gstabs
4508 @opindex gstabs
4509 Produce debugging information in stabs format (if that is supported),
4510 without GDB extensions.  This is the format used by DBX on most BSD
4511 systems.  On MIPS, Alpha and System V Release 4 systems this option
4512 produces stabs debugging output which is not understood by DBX or SDB@.
4513 On System V Release 4 systems this option requires the GNU assembler.
4515 @item -feliminate-unused-debug-symbols
4516 @opindex feliminate-unused-debug-symbols
4517 Produce debugging information in stabs format (if that is supported),
4518 for only symbols that are actually used.
4520 @item -femit-class-debug-always
4521 Instead of emitting debugging information for a C++ class in only one
4522 object file, emit it in all object files using the class.  This option
4523 should be used only with debuggers that are unable to handle the way GCC
4524 normally emits debugging information for classes because using this
4525 option will increase the size of debugging information by as much as a
4526 factor of two.
4528 @item -gstabs+
4529 @opindex gstabs+
4530 Produce debugging information in stabs format (if that is supported),
4531 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4532 use of these extensions is likely to make other debuggers crash or
4533 refuse to read the program.
4535 @item -gcoff
4536 @opindex gcoff
4537 Produce debugging information in COFF format (if that is supported).
4538 This is the format used by SDB on most System V systems prior to
4539 System V Release 4.
4541 @item -gxcoff
4542 @opindex gxcoff
4543 Produce debugging information in XCOFF format (if that is supported).
4544 This is the format used by the DBX debugger on IBM RS/6000 systems.
4546 @item -gxcoff+
4547 @opindex gxcoff+
4548 Produce debugging information in XCOFF format (if that is supported),
4549 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4550 use of these extensions is likely to make other debuggers crash or
4551 refuse to read the program, and may cause assemblers other than the GNU
4552 assembler (GAS) to fail with an error.
4554 @item -gdwarf-@var{version}
4555 @opindex gdwarf-@var{version}
4556 Produce debugging information in DWARF format (if that is
4557 supported).  This is the format used by DBX on IRIX 6.  The value
4558 of @var{version} may be either 2, 3 or 4; the default version is 2.
4560 Note that with DWARF version 2 some ports require, and will always
4561 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4563 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4564 for maximum benefit.
4566 @item -gstrict-dwarf
4567 @opindex gstrict-dwarf
4568 Disallow using extensions of later DWARF standard version than selected
4569 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4570 DWARF extensions from later standard versions is allowed.
4572 @item -gno-strict-dwarf
4573 @opindex gno-strict-dwarf
4574 Allow using extensions of later DWARF standard version than selected with
4575 @option{-gdwarf-@var{version}}.
4577 @item -gvms
4578 @opindex gvms
4579 Produce debugging information in VMS debug format (if that is
4580 supported).  This is the format used by DEBUG on VMS systems.
4582 @item -g@var{level}
4583 @itemx -ggdb@var{level}
4584 @itemx -gstabs@var{level}
4585 @itemx -gcoff@var{level}
4586 @itemx -gxcoff@var{level}
4587 @itemx -gvms@var{level}
4588 Request debugging information and also use @var{level} to specify how
4589 much information.  The default level is 2.
4591 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4592 @option{-g}.
4594 Level 1 produces minimal information, enough for making backtraces in
4595 parts of the program that you don't plan to debug.  This includes
4596 descriptions of functions and external variables, but no information
4597 about local variables and no line numbers.
4599 Level 3 includes extra information, such as all the macro definitions
4600 present in the program.  Some debuggers support macro expansion when
4601 you use @option{-g3}.
4603 @option{-gdwarf-2} does not accept a concatenated debug level, because
4604 GCC used to support an option @option{-gdwarf} that meant to generate
4605 debug information in version 1 of the DWARF format (which is very
4606 different from version 2), and it would have been too confusing.  That
4607 debug format is long obsolete, but the option cannot be changed now.
4608 Instead use an additional @option{-g@var{level}} option to change the
4609 debug level for DWARF.
4611 @item -gtoggle
4612 @opindex gtoggle
4613 Turn off generation of debug info, if leaving out this option would have
4614 generated it, or turn it on at level 2 otherwise.  The position of this
4615 argument in the command line does not matter, it takes effect after all
4616 other options are processed, and it does so only once, no matter how
4617 many times it is given.  This is mainly intended to be used with
4618 @option{-fcompare-debug}.
4620 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4621 @opindex fdump-final-insns
4622 Dump the final internal representation (RTL) to @var{file}.  If the
4623 optional argument is omitted (or if @var{file} is @code{.}), the name
4624 of the dump file will be determined by appending @code{.gkd} to the
4625 compilation output file name.
4627 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4628 @opindex fcompare-debug
4629 @opindex fno-compare-debug
4630 If no error occurs during compilation, run the compiler a second time,
4631 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4632 passed to the second compilation.  Dump the final internal
4633 representation in both compilations, and print an error if they differ.
4635 If the equal sign is omitted, the default @option{-gtoggle} is used.
4637 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4638 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4639 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4640 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4641 is used.
4643 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4644 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4645 of the final representation and the second compilation, preventing even
4646 @env{GCC_COMPARE_DEBUG} from taking effect.
4648 To verify full coverage during @option{-fcompare-debug} testing, set
4649 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4650 which GCC will reject as an invalid option in any actual compilation
4651 (rather than preprocessing, assembly or linking).  To get just a
4652 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4653 not overridden} will do.
4655 @item -fcompare-debug-second
4656 @opindex fcompare-debug-second
4657 This option is implicitly passed to the compiler for the second
4658 compilation requested by @option{-fcompare-debug}, along with options to
4659 silence warnings, and omitting other options that would cause
4660 side-effect compiler outputs to files or to the standard output.  Dump
4661 files and preserved temporary files are renamed so as to contain the
4662 @code{.gk} additional extension during the second compilation, to avoid
4663 overwriting those generated by the first.
4665 When this option is passed to the compiler driver, it causes the
4666 @emph{first} compilation to be skipped, which makes it useful for little
4667 other than debugging the compiler proper.
4669 @item -feliminate-dwarf2-dups
4670 @opindex feliminate-dwarf2-dups
4671 Compress DWARF2 debugging information by eliminating duplicated
4672 information about each symbol.  This option only makes sense when
4673 generating DWARF2 debugging information with @option{-gdwarf-2}.
4675 @item -femit-struct-debug-baseonly
4676 Emit debug information for struct-like types
4677 only when the base name of the compilation source file
4678 matches the base name of file in which the struct was defined.
4680 This option substantially reduces the size of debugging information,
4681 but at significant potential loss in type information to the debugger.
4682 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4683 See @option{-femit-struct-debug-detailed} for more detailed control.
4685 This option works only with DWARF 2.
4687 @item -femit-struct-debug-reduced
4688 Emit debug information for struct-like types
4689 only when the base name of the compilation source file
4690 matches the base name of file in which the type was defined,
4691 unless the struct is a template or defined in a system header.
4693 This option significantly reduces the size of debugging information,
4694 with some potential loss in type information to the debugger.
4695 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4696 See @option{-femit-struct-debug-detailed} for more detailed control.
4698 This option works only with DWARF 2.
4700 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4701 Specify the struct-like types
4702 for which the compiler will generate debug information.
4703 The intent is to reduce duplicate struct debug information
4704 between different object files within the same program.
4706 This option is a detailed version of
4707 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4708 which will serve for most needs.
4710 A specification has the syntax@*
4711 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4713 The optional first word limits the specification to
4714 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4715 A struct type is used directly when it is the type of a variable, member.
4716 Indirect uses arise through pointers to structs.
4717 That is, when use of an incomplete struct would be legal, the use is indirect.
4718 An example is
4719 @samp{struct one direct; struct two * indirect;}.
4721 The optional second word limits the specification to
4722 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4723 Generic structs are a bit complicated to explain.
4724 For C++, these are non-explicit specializations of template classes,
4725 or non-template classes within the above.
4726 Other programming languages have generics,
4727 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4729 The third word specifies the source files for those
4730 structs for which the compiler will emit debug information.
4731 The values @samp{none} and @samp{any} have the normal meaning.
4732 The value @samp{base} means that
4733 the base of name of the file in which the type declaration appears
4734 must match the base of the name of the main compilation file.
4735 In practice, this means that
4736 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4737 but types declared in other header will not.
4738 The value @samp{sys} means those types satisfying @samp{base}
4739 or declared in system or compiler headers.
4741 You may need to experiment to determine the best settings for your application.
4743 The default is @samp{-femit-struct-debug-detailed=all}.
4745 This option works only with DWARF 2.
4747 @item -fenable-icf-debug
4748 @opindex fenable-icf-debug
4749 Generate additional debug information to support identical code folding (ICF).
4750 This option only works with DWARF version 2 or higher.
4752 @item -fno-merge-debug-strings
4753 @opindex fmerge-debug-strings
4754 @opindex fno-merge-debug-strings
4755 Direct the linker to not merge together strings in the debugging
4756 information which are identical in different object files.  Merging is
4757 not supported by all assemblers or linkers.  Merging decreases the size
4758 of the debug information in the output file at the cost of increasing
4759 link processing time.  Merging is enabled by default.
4761 @item -fdebug-prefix-map=@var{old}=@var{new}
4762 @opindex fdebug-prefix-map
4763 When compiling files in directory @file{@var{old}}, record debugging
4764 information describing them as in @file{@var{new}} instead.
4766 @item -fno-dwarf2-cfi-asm
4767 @opindex fdwarf2-cfi-asm
4768 @opindex fno-dwarf2-cfi-asm
4769 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4770 instead of using GAS @code{.cfi_*} directives.
4772 @cindex @command{prof}
4773 @item -p
4774 @opindex p
4775 Generate extra code to write profile information suitable for the
4776 analysis program @command{prof}.  You must use this option when compiling
4777 the source files you want data about, and you must also use it when
4778 linking.
4780 @cindex @command{gprof}
4781 @item -pg
4782 @opindex pg
4783 Generate extra code to write profile information suitable for the
4784 analysis program @command{gprof}.  You must use this option when compiling
4785 the source files you want data about, and you must also use it when
4786 linking.
4788 @item -Q
4789 @opindex Q
4790 Makes the compiler print out each function name as it is compiled, and
4791 print some statistics about each pass when it finishes.
4793 @item -ftime-report
4794 @opindex ftime-report
4795 Makes the compiler print some statistics about the time consumed by each
4796 pass when it finishes.
4798 @item -fmem-report
4799 @opindex fmem-report
4800 Makes the compiler print some statistics about permanent memory
4801 allocation when it finishes.
4803 @item -fpre-ipa-mem-report
4804 @opindex fpre-ipa-mem-report
4805 @item -fpost-ipa-mem-report
4806 @opindex fpost-ipa-mem-report
4807 Makes the compiler print some statistics about permanent memory
4808 allocation before or after interprocedural optimization.
4810 @item -fstack-usage
4811 @opindex fstack-usage
4812 Makes the compiler output stack usage information for the program, on a
4813 per-function basis.  The filename for the dump is made by appending
4814 @file{.su} to the AUXNAME.  AUXNAME is generated from the name of
4815 the output file, if explicitly specified and it is not an executable,
4816 otherwise it is the basename of the source file.  An entry is made up
4817 of three fields:
4819 @itemize
4820 @item
4821 The name of the function.
4822 @item
4823 A number of bytes.
4824 @item
4825 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
4826 @end itemize
4828 The qualifier @code{static} means that the function manipulates the stack
4829 statically: a fixed number of bytes are allocated for the frame on function
4830 entry and released on function exit; no stack adjustments are otherwise made
4831 in the function.  The second field is this fixed number of bytes.
4833 The qualifier @code{dynamic} means that the function manipulates the stack
4834 dynamically: in addition to the static allocation described above, stack
4835 adjustments are made in the body of the function, for example to push/pop
4836 arguments around function calls.  If the qualifier @code{bounded} is also
4837 present, the amount of these adjustments is bounded at compile-time and
4838 the second field is an upper bound of the total amount of stack used by
4839 the function.  If it is not present, the amount of these adjustments is
4840 not bounded at compile-time and the second field only represents the
4841 bounded part.
4843 @item -fprofile-arcs
4844 @opindex fprofile-arcs
4845 Add code so that program flow @dfn{arcs} are instrumented.  During
4846 execution the program records how many times each branch and call is
4847 executed and how many times it is taken or returns.  When the compiled
4848 program exits it saves this data to a file called
4849 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4850 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4851 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4852 @var{auxname} is generated from the name of the output file, if
4853 explicitly specified and it is not the final executable, otherwise it is
4854 the basename of the source file.  In both cases any suffix is removed
4855 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4856 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4857 @xref{Cross-profiling}.
4859 @cindex @command{gcov}
4860 @item --coverage
4861 @opindex coverage
4863 This option is used to compile and link code instrumented for coverage
4864 analysis.  The option is a synonym for @option{-fprofile-arcs}
4865 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4866 linking).  See the documentation for those options for more details.
4868 @itemize
4870 @item
4871 Compile the source files with @option{-fprofile-arcs} plus optimization
4872 and code generation options.  For test coverage analysis, use the
4873 additional @option{-ftest-coverage} option.  You do not need to profile
4874 every source file in a program.
4876 @item
4877 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4878 (the latter implies the former).
4880 @item
4881 Run the program on a representative workload to generate the arc profile
4882 information.  This may be repeated any number of times.  You can run
4883 concurrent instances of your program, and provided that the file system
4884 supports locking, the data files will be correctly updated.  Also
4885 @code{fork} calls are detected and correctly handled (double counting
4886 will not happen).
4888 @item
4889 For profile-directed optimizations, compile the source files again with
4890 the same optimization and code generation options plus
4891 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4892 Control Optimization}).
4894 @item
4895 For test coverage analysis, use @command{gcov} to produce human readable
4896 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4897 @command{gcov} documentation for further information.
4899 @end itemize
4901 With @option{-fprofile-arcs}, for each function of your program GCC
4902 creates a program flow graph, then finds a spanning tree for the graph.
4903 Only arcs that are not on the spanning tree have to be instrumented: the
4904 compiler adds code to count the number of times that these arcs are
4905 executed.  When an arc is the only exit or only entrance to a block, the
4906 instrumentation code can be added to the block; otherwise, a new basic
4907 block must be created to hold the instrumentation code.
4909 @need 2000
4910 @item -ftest-coverage
4911 @opindex ftest-coverage
4912 Produce a notes file that the @command{gcov} code-coverage utility
4913 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4914 show program coverage.  Each source file's note file is called
4915 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4916 above for a description of @var{auxname} and instructions on how to
4917 generate test coverage data.  Coverage data will match the source files
4918 more closely, if you do not optimize.
4920 @item -fdbg-cnt-list
4921 @opindex fdbg-cnt-list
4922 Print the name and the counter upperbound for all debug counters.
4924 @item -fdbg-cnt=@var{counter-value-list}
4925 @opindex fdbg-cnt
4926 Set the internal debug counter upperbound. @var{counter-value-list}
4927 is a comma-separated list of @var{name}:@var{value} pairs
4928 which sets the upperbound of each debug counter @var{name} to @var{value}.
4929 All debug counters have the initial upperbound of @var{UINT_MAX},
4930 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4931 e.g. With -fdbg-cnt=dce:10,tail_call:0
4932 dbg_cnt(dce) will return true only for first 10 invocations
4933 and dbg_cnt(tail_call) will return false always.
4935 @item -d@var{letters}
4936 @itemx -fdump-rtl-@var{pass}
4937 @opindex d
4938 Says to make debugging dumps during compilation at times specified by
4939 @var{letters}.  This is used for debugging the RTL-based passes of the
4940 compiler.  The file names for most of the dumps are made by appending
4941 a pass number and a word to the @var{dumpname}, and the files are
4942 created in the directory of the output file.  @var{dumpname} is
4943 generated from the name of the output file, if explicitly specified
4944 and it is not an executable, otherwise it is the basename of the
4945 source file. These switches may have different effects when
4946 @option{-E} is used for preprocessing.
4948 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4949 @option{-d} option @var{letters}.  Here are the possible
4950 letters for use in @var{pass} and @var{letters}, and their meanings:
4952 @table @gcctabopt
4954 @item -fdump-rtl-alignments
4955 @opindex fdump-rtl-alignments
4956 Dump after branch alignments have been computed.
4958 @item -fdump-rtl-asmcons
4959 @opindex fdump-rtl-asmcons
4960 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4962 @item -fdump-rtl-auto_inc_dec
4963 @opindex fdump-rtl-auto_inc_dec
4964 Dump after auto-inc-dec discovery.  This pass is only run on
4965 architectures that have auto inc or auto dec instructions.
4967 @item -fdump-rtl-barriers
4968 @opindex fdump-rtl-barriers
4969 Dump after cleaning up the barrier instructions.
4971 @item -fdump-rtl-bbpart
4972 @opindex fdump-rtl-bbpart
4973 Dump after partitioning hot and cold basic blocks.
4975 @item -fdump-rtl-bbro
4976 @opindex fdump-rtl-bbro
4977 Dump after block reordering.
4979 @item -fdump-rtl-btl1
4980 @itemx -fdump-rtl-btl2
4981 @opindex fdump-rtl-btl2
4982 @opindex fdump-rtl-btl2
4983 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4984 after the two branch
4985 target load optimization passes.
4987 @item -fdump-rtl-bypass
4988 @opindex fdump-rtl-bypass
4989 Dump after jump bypassing and control flow optimizations.
4991 @item -fdump-rtl-combine
4992 @opindex fdump-rtl-combine
4993 Dump after the RTL instruction combination pass.
4995 @item -fdump-rtl-compgotos
4996 @opindex fdump-rtl-compgotos
4997 Dump after duplicating the computed gotos.
4999 @item -fdump-rtl-ce1
5000 @itemx -fdump-rtl-ce2
5001 @itemx -fdump-rtl-ce3
5002 @opindex fdump-rtl-ce1
5003 @opindex fdump-rtl-ce2
5004 @opindex fdump-rtl-ce3
5005 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5006 @option{-fdump-rtl-ce3} enable dumping after the three
5007 if conversion passes.
5009 @itemx -fdump-rtl-cprop_hardreg
5010 @opindex fdump-rtl-cprop_hardreg
5011 Dump after hard register copy propagation.
5013 @itemx -fdump-rtl-csa
5014 @opindex fdump-rtl-csa
5015 Dump after combining stack adjustments.
5017 @item -fdump-rtl-cse1
5018 @itemx -fdump-rtl-cse2
5019 @opindex fdump-rtl-cse1
5020 @opindex fdump-rtl-cse2
5021 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5022 the two common sub-expression elimination passes.
5024 @itemx -fdump-rtl-dce
5025 @opindex fdump-rtl-dce
5026 Dump after the standalone dead code elimination passes.
5028 @itemx -fdump-rtl-dbr
5029 @opindex fdump-rtl-dbr
5030 Dump after delayed branch scheduling.
5032 @item -fdump-rtl-dce1
5033 @itemx -fdump-rtl-dce2
5034 @opindex fdump-rtl-dce1
5035 @opindex fdump-rtl-dce2
5036 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5037 the two dead store elimination passes.
5039 @item -fdump-rtl-eh
5040 @opindex fdump-rtl-eh
5041 Dump after finalization of EH handling code.
5043 @item -fdump-rtl-eh_ranges
5044 @opindex fdump-rtl-eh_ranges
5045 Dump after conversion of EH handling range regions.
5047 @item -fdump-rtl-expand
5048 @opindex fdump-rtl-expand
5049 Dump after RTL generation.
5051 @item -fdump-rtl-fwprop1
5052 @itemx -fdump-rtl-fwprop2
5053 @opindex fdump-rtl-fwprop1
5054 @opindex fdump-rtl-fwprop2
5055 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5056 dumping after the two forward propagation passes.
5058 @item -fdump-rtl-gcse1
5059 @itemx -fdump-rtl-gcse2
5060 @opindex fdump-rtl-gcse1
5061 @opindex fdump-rtl-gcse2
5062 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5063 after global common subexpression elimination.
5065 @item -fdump-rtl-init-regs
5066 @opindex fdump-rtl-init-regs
5067 Dump after the initialization of the registers.
5069 @item -fdump-rtl-initvals
5070 @opindex fdump-rtl-initvals
5071 Dump after the computation of the initial value sets.
5073 @itemx -fdump-rtl-into_cfglayout
5074 @opindex fdump-rtl-into_cfglayout
5075 Dump after converting to cfglayout mode.
5077 @item -fdump-rtl-ira
5078 @opindex fdump-rtl-ira
5079 Dump after iterated register allocation.
5081 @item -fdump-rtl-jump
5082 @opindex fdump-rtl-jump
5083 Dump after the second jump optimization.
5085 @item -fdump-rtl-loop2
5086 @opindex fdump-rtl-loop2
5087 @option{-fdump-rtl-loop2} enables dumping after the rtl
5088 loop optimization passes.
5090 @item -fdump-rtl-mach
5091 @opindex fdump-rtl-mach
5092 Dump after performing the machine dependent reorganization pass, if that
5093 pass exists.
5095 @item -fdump-rtl-mode_sw
5096 @opindex fdump-rtl-mode_sw
5097 Dump after removing redundant mode switches.
5099 @item -fdump-rtl-rnreg
5100 @opindex fdump-rtl-rnreg
5101 Dump after register renumbering.
5103 @itemx -fdump-rtl-outof_cfglayout
5104 @opindex fdump-rtl-outof_cfglayout
5105 Dump after converting from cfglayout mode.
5107 @item -fdump-rtl-peephole2
5108 @opindex fdump-rtl-peephole2
5109 Dump after the peephole pass.
5111 @item -fdump-rtl-postreload
5112 @opindex fdump-rtl-postreload
5113 Dump after post-reload optimizations.
5115 @itemx -fdump-rtl-pro_and_epilogue
5116 @opindex fdump-rtl-pro_and_epilogue
5117 Dump after generating the function pro and epilogues.
5119 @item -fdump-rtl-regmove
5120 @opindex fdump-rtl-regmove
5121 Dump after the register move pass.
5123 @item -fdump-rtl-sched1
5124 @itemx -fdump-rtl-sched2
5125 @opindex fdump-rtl-sched1
5126 @opindex fdump-rtl-sched2
5127 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5128 after the basic block scheduling passes.
5130 @item -fdump-rtl-see
5131 @opindex fdump-rtl-see
5132 Dump after sign extension elimination.
5134 @item -fdump-rtl-seqabstr
5135 @opindex fdump-rtl-seqabstr
5136 Dump after common sequence discovery.
5138 @item -fdump-rtl-shorten
5139 @opindex fdump-rtl-shorten
5140 Dump after shortening branches.
5142 @item -fdump-rtl-sibling
5143 @opindex fdump-rtl-sibling
5144 Dump after sibling call optimizations.
5146 @item -fdump-rtl-split1
5147 @itemx -fdump-rtl-split2
5148 @itemx -fdump-rtl-split3
5149 @itemx -fdump-rtl-split4
5150 @itemx -fdump-rtl-split5
5151 @opindex fdump-rtl-split1
5152 @opindex fdump-rtl-split2
5153 @opindex fdump-rtl-split3
5154 @opindex fdump-rtl-split4
5155 @opindex fdump-rtl-split5
5156 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5157 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5158 @option{-fdump-rtl-split5} enable dumping after five rounds of
5159 instruction splitting.
5161 @item -fdump-rtl-sms
5162 @opindex fdump-rtl-sms
5163 Dump after modulo scheduling.  This pass is only run on some
5164 architectures.
5166 @item -fdump-rtl-stack
5167 @opindex fdump-rtl-stack
5168 Dump after conversion from GCC's "flat register file" registers to the
5169 x87's stack-like registers.  This pass is only run on x86 variants.
5171 @item -fdump-rtl-subreg1
5172 @itemx -fdump-rtl-subreg2
5173 @opindex fdump-rtl-subreg1
5174 @opindex fdump-rtl-subreg2
5175 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5176 the two subreg expansion passes.
5178 @item -fdump-rtl-unshare
5179 @opindex fdump-rtl-unshare
5180 Dump after all rtl has been unshared.
5182 @item -fdump-rtl-vartrack
5183 @opindex fdump-rtl-vartrack
5184 Dump after variable tracking.
5186 @item -fdump-rtl-vregs
5187 @opindex fdump-rtl-vregs
5188 Dump after converting virtual registers to hard registers.
5190 @item -fdump-rtl-web
5191 @opindex fdump-rtl-web
5192 Dump after live range splitting.
5194 @item -fdump-rtl-regclass
5195 @itemx -fdump-rtl-subregs_of_mode_init
5196 @itemx -fdump-rtl-subregs_of_mode_finish
5197 @itemx -fdump-rtl-dfinit
5198 @itemx -fdump-rtl-dfinish
5199 @opindex fdump-rtl-regclass
5200 @opindex fdump-rtl-subregs_of_mode_init
5201 @opindex fdump-rtl-subregs_of_mode_finish
5202 @opindex fdump-rtl-dfinit
5203 @opindex fdump-rtl-dfinish
5204 These dumps are defined but always produce empty files.
5206 @item -fdump-rtl-all
5207 @opindex fdump-rtl-all
5208 Produce all the dumps listed above.
5210 @item -dA
5211 @opindex dA
5212 Annotate the assembler output with miscellaneous debugging information.
5214 @item -dD
5215 @opindex dD
5216 Dump all macro definitions, at the end of preprocessing, in addition to
5217 normal output.
5219 @item -dH
5220 @opindex dH
5221 Produce a core dump whenever an error occurs.
5223 @item -dm
5224 @opindex dm
5225 Print statistics on memory usage, at the end of the run, to
5226 standard error.
5228 @item -dp
5229 @opindex dp
5230 Annotate the assembler output with a comment indicating which
5231 pattern and alternative was used.  The length of each instruction is
5232 also printed.
5234 @item -dP
5235 @opindex dP
5236 Dump the RTL in the assembler output as a comment before each instruction.
5237 Also turns on @option{-dp} annotation.
5239 @item -dv
5240 @opindex dv
5241 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5242 dump a representation of the control flow graph suitable for viewing with VCG
5243 to @file{@var{file}.@var{pass}.vcg}.
5245 @item -dx
5246 @opindex dx
5247 Just generate RTL for a function instead of compiling it.  Usually used
5248 with @option{-fdump-rtl-expand}.
5250 @item -dy
5251 @opindex dy
5252 Dump debugging information during parsing, to standard error.
5253 @end table
5255 @item -fdump-noaddr
5256 @opindex fdump-noaddr
5257 When doing debugging dumps, suppress address output.  This makes it more
5258 feasible to use diff on debugging dumps for compiler invocations with
5259 different compiler binaries and/or different
5260 text / bss / data / heap / stack / dso start locations.
5262 @item -fdump-unnumbered
5263 @opindex fdump-unnumbered
5264 When doing debugging dumps, suppress instruction numbers and address output.
5265 This makes it more feasible to use diff on debugging dumps for compiler
5266 invocations with different options, in particular with and without
5267 @option{-g}.
5269 @item -fdump-unnumbered-links
5270 @opindex fdump-unnumbered-links
5271 When doing debugging dumps (see @option{-d} option above), suppress
5272 instruction numbers for the links to the previous and next instructions
5273 in a sequence.
5275 @item -fdump-translation-unit @r{(C++ only)}
5276 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5277 @opindex fdump-translation-unit
5278 Dump a representation of the tree structure for the entire translation
5279 unit to a file.  The file name is made by appending @file{.tu} to the
5280 source file name, and the file is created in the same directory as the
5281 output file.  If the @samp{-@var{options}} form is used, @var{options}
5282 controls the details of the dump as described for the
5283 @option{-fdump-tree} options.
5285 @item -fdump-class-hierarchy @r{(C++ only)}
5286 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5287 @opindex fdump-class-hierarchy
5288 Dump a representation of each class's hierarchy and virtual function
5289 table layout to a file.  The file name is made by appending
5290 @file{.class} to the source file name, and the file is created in the
5291 same directory as the output file.  If the @samp{-@var{options}} form
5292 is used, @var{options} controls the details of the dump as described
5293 for the @option{-fdump-tree} options.
5295 @item -fdump-ipa-@var{switch}
5296 @opindex fdump-ipa
5297 Control the dumping at various stages of inter-procedural analysis
5298 language tree to a file.  The file name is generated by appending a
5299 switch specific suffix to the source file name, and the file is created
5300 in the same directory as the output file.  The following dumps are
5301 possible:
5303 @table @samp
5304 @item all
5305 Enables all inter-procedural analysis dumps.
5307 @item cgraph
5308 Dumps information about call-graph optimization, unused function removal,
5309 and inlining decisions.
5311 @item inline
5312 Dump after function inlining.
5314 @end table
5316 @item -fdump-statistics-@var{option}
5317 @opindex fdump-statistics
5318 Enable and control dumping of pass statistics in a separate file.  The
5319 file name is generated by appending a suffix ending in
5320 @samp{.statistics} to the source file name, and the file is created in
5321 the same directory as the output file.  If the @samp{-@var{option}}
5322 form is used, @samp{-stats} will cause counters to be summed over the
5323 whole compilation unit while @samp{-details} will dump every event as
5324 the passes generate them.  The default with no option is to sum
5325 counters for each function compiled.
5327 @item -fdump-tree-@var{switch}
5328 @itemx -fdump-tree-@var{switch}-@var{options}
5329 @opindex fdump-tree
5330 Control the dumping at various stages of processing the intermediate
5331 language tree to a file.  The file name is generated by appending a
5332 switch specific suffix to the source file name, and the file is
5333 created in the same directory as the output file.  If the
5334 @samp{-@var{options}} form is used, @var{options} is a list of
5335 @samp{-} separated options that control the details of the dump.  Not
5336 all options are applicable to all dumps, those which are not
5337 meaningful will be ignored.  The following options are available
5339 @table @samp
5340 @item address
5341 Print the address of each node.  Usually this is not meaningful as it
5342 changes according to the environment and source file.  Its primary use
5343 is for tying up a dump file with a debug environment.
5344 @item asmname
5345 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5346 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5347 use working backward from mangled names in the assembly file.
5348 @item slim
5349 Inhibit dumping of members of a scope or body of a function merely
5350 because that scope has been reached.  Only dump such items when they
5351 are directly reachable by some other path.  When dumping pretty-printed
5352 trees, this option inhibits dumping the bodies of control structures.
5353 @item raw
5354 Print a raw representation of the tree.  By default, trees are
5355 pretty-printed into a C-like representation.
5356 @item details
5357 Enable more detailed dumps (not honored by every dump option).
5358 @item stats
5359 Enable dumping various statistics about the pass (not honored by every dump
5360 option).
5361 @item blocks
5362 Enable showing basic block boundaries (disabled in raw dumps).
5363 @item vops
5364 Enable showing virtual operands for every statement.
5365 @item lineno
5366 Enable showing line numbers for statements.
5367 @item uid
5368 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5369 @item verbose
5370 Enable showing the tree dump for each statement.
5371 @item eh
5372 Enable showing the EH region number holding each statement.
5373 @item all
5374 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5375 and @option{lineno}.
5376 @end table
5378 The following tree dumps are possible:
5379 @table @samp
5381 @item original
5382 @opindex fdump-tree-original
5383 Dump before any tree based optimization, to @file{@var{file}.original}.
5385 @item optimized
5386 @opindex fdump-tree-optimized
5387 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5389 @item gimple
5390 @opindex fdump-tree-gimple
5391 Dump each function before and after the gimplification pass to a file.  The
5392 file name is made by appending @file{.gimple} to the source file name.
5394 @item cfg
5395 @opindex fdump-tree-cfg
5396 Dump the control flow graph of each function to a file.  The file name is
5397 made by appending @file{.cfg} to the source file name.
5399 @item vcg
5400 @opindex fdump-tree-vcg
5401 Dump the control flow graph of each function to a file in VCG format.  The
5402 file name is made by appending @file{.vcg} to the source file name.  Note
5403 that if the file contains more than one function, the generated file cannot
5404 be used directly by VCG@.  You will need to cut and paste each function's
5405 graph into its own separate file first.
5407 @item ch
5408 @opindex fdump-tree-ch
5409 Dump each function after copying loop headers.  The file name is made by
5410 appending @file{.ch} to the source file name.
5412 @item ssa
5413 @opindex fdump-tree-ssa
5414 Dump SSA related information to a file.  The file name is made by appending
5415 @file{.ssa} to the source file name.
5417 @item alias
5418 @opindex fdump-tree-alias
5419 Dump aliasing information for each function.  The file name is made by
5420 appending @file{.alias} to the source file name.
5422 @item ccp
5423 @opindex fdump-tree-ccp
5424 Dump each function after CCP@.  The file name is made by appending
5425 @file{.ccp} to the source file name.
5427 @item storeccp
5428 @opindex fdump-tree-storeccp
5429 Dump each function after STORE-CCP@.  The file name is made by appending
5430 @file{.storeccp} to the source file name.
5432 @item pre
5433 @opindex fdump-tree-pre
5434 Dump trees after partial redundancy elimination.  The file name is made
5435 by appending @file{.pre} to the source file name.
5437 @item fre
5438 @opindex fdump-tree-fre
5439 Dump trees after full redundancy elimination.  The file name is made
5440 by appending @file{.fre} to the source file name.
5442 @item copyprop
5443 @opindex fdump-tree-copyprop
5444 Dump trees after copy propagation.  The file name is made
5445 by appending @file{.copyprop} to the source file name.
5447 @item store_copyprop
5448 @opindex fdump-tree-store_copyprop
5449 Dump trees after store copy-propagation.  The file name is made
5450 by appending @file{.store_copyprop} to the source file name.
5452 @item dce
5453 @opindex fdump-tree-dce
5454 Dump each function after dead code elimination.  The file name is made by
5455 appending @file{.dce} to the source file name.
5457 @item mudflap
5458 @opindex fdump-tree-mudflap
5459 Dump each function after adding mudflap instrumentation.  The file name is
5460 made by appending @file{.mudflap} to the source file name.
5462 @item sra
5463 @opindex fdump-tree-sra
5464 Dump each function after performing scalar replacement of aggregates.  The
5465 file name is made by appending @file{.sra} to the source file name.
5467 @item sink
5468 @opindex fdump-tree-sink
5469 Dump each function after performing code sinking.  The file name is made
5470 by appending @file{.sink} to the source file name.
5472 @item dom
5473 @opindex fdump-tree-dom
5474 Dump each function after applying dominator tree optimizations.  The file
5475 name is made by appending @file{.dom} to the source file name.
5477 @item dse
5478 @opindex fdump-tree-dse
5479 Dump each function after applying dead store elimination.  The file
5480 name is made by appending @file{.dse} to the source file name.
5482 @item phiopt
5483 @opindex fdump-tree-phiopt
5484 Dump each function after optimizing PHI nodes into straightline code.  The file
5485 name is made by appending @file{.phiopt} to the source file name.
5487 @item forwprop
5488 @opindex fdump-tree-forwprop
5489 Dump each function after forward propagating single use variables.  The file
5490 name is made by appending @file{.forwprop} to the source file name.
5492 @item copyrename
5493 @opindex fdump-tree-copyrename
5494 Dump each function after applying the copy rename optimization.  The file
5495 name is made by appending @file{.copyrename} to the source file name.
5497 @item nrv
5498 @opindex fdump-tree-nrv
5499 Dump each function after applying the named return value optimization on
5500 generic trees.  The file name is made by appending @file{.nrv} to the source
5501 file name.
5503 @item vect
5504 @opindex fdump-tree-vect
5505 Dump each function after applying vectorization of loops.  The file name is
5506 made by appending @file{.vect} to the source file name.
5508 @item slp
5509 @opindex fdump-tree-slp
5510 Dump each function after applying vectorization of basic blocks.  The file name
5511 is made by appending @file{.slp} to the source file name.
5513 @item vrp
5514 @opindex fdump-tree-vrp
5515 Dump each function after Value Range Propagation (VRP).  The file name
5516 is made by appending @file{.vrp} to the source file name.
5518 @item all
5519 @opindex fdump-tree-all
5520 Enable all the available tree dumps with the flags provided in this option.
5521 @end table
5523 @item -ftree-vectorizer-verbose=@var{n}
5524 @opindex ftree-vectorizer-verbose
5525 This option controls the amount of debugging output the vectorizer prints.
5526 This information is written to standard error, unless
5527 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5528 in which case it is output to the usual dump listing file, @file{.vect}.
5529 For @var{n}=0 no diagnostic information is reported.
5530 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5531 and the total number of loops that got vectorized.
5532 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5533 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5534 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5535 level that @option{-fdump-tree-vect-stats} uses.
5536 Higher verbosity levels mean either more information dumped for each
5537 reported loop, or same amount of information reported for more loops:
5538 if @var{n}=3, vectorizer cost model information is reported.
5539 If @var{n}=4, alignment related information is added to the reports.
5540 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5541 memory access-patterns) is added to the reports.
5542 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5543 that did not pass the first analysis phase (i.e., may not be countable, or
5544 may have complicated control-flow).
5545 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5546 If @var{n}=8, SLP related information is added to the reports.
5547 For @var{n}=9, all the information the vectorizer generates during its
5548 analysis and transformation is reported.  This is the same verbosity level
5549 that @option{-fdump-tree-vect-details} uses.
5551 @item -frandom-seed=@var{string}
5552 @opindex frandom-seed
5553 This option provides a seed that GCC uses when it would otherwise use
5554 random numbers.  It is used to generate certain symbol names
5555 that have to be different in every compiled file.  It is also used to
5556 place unique stamps in coverage data files and the object files that
5557 produce them.  You can use the @option{-frandom-seed} option to produce
5558 reproducibly identical object files.
5560 The @var{string} should be different for every file you compile.
5562 @item -fsched-verbose=@var{n}
5563 @opindex fsched-verbose
5564 On targets that use instruction scheduling, this option controls the
5565 amount of debugging output the scheduler prints.  This information is
5566 written to standard error, unless @option{-fdump-rtl-sched1} or
5567 @option{-fdump-rtl-sched2} is specified, in which case it is output
5568 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5569 respectively.  However for @var{n} greater than nine, the output is
5570 always printed to standard error.
5572 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5573 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5574 For @var{n} greater than one, it also output basic block probabilities,
5575 detailed ready list information and unit/insn info.  For @var{n} greater
5576 than two, it includes RTL at abort point, control-flow and regions info.
5577 And for @var{n} over four, @option{-fsched-verbose} also includes
5578 dependence info.
5580 @item -save-temps
5581 @itemx -save-temps=cwd
5582 @opindex save-temps
5583 Store the usual ``temporary'' intermediate files permanently; place them
5584 in the current directory and name them based on the source file.  Thus,
5585 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5586 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5587 preprocessed @file{foo.i} output file even though the compiler now
5588 normally uses an integrated preprocessor.
5590 When used in combination with the @option{-x} command line option,
5591 @option{-save-temps} is sensible enough to avoid over writing an
5592 input source file with the same extension as an intermediate file.
5593 The corresponding intermediate file may be obtained by renaming the
5594 source file before using @option{-save-temps}.
5596 If you invoke GCC in parallel, compiling several different source
5597 files that share a common base name in different subdirectories or the
5598 same source file compiled for multiple output destinations, it is
5599 likely that the different parallel compilers will interfere with each
5600 other, and overwrite the temporary files.  For instance:
5602 @smallexample
5603 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5604 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5605 @end smallexample
5607 may result in @file{foo.i} and @file{foo.o} being written to
5608 simultaneously by both compilers.
5610 @item -save-temps=obj
5611 @opindex save-temps=obj
5612 Store the usual ``temporary'' intermediate files permanently.  If the
5613 @option{-o} option is used, the temporary files are based on the
5614 object file.  If the @option{-o} option is not used, the
5615 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5617 For example:
5619 @smallexample
5620 gcc -save-temps=obj -c foo.c
5621 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5622 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5623 @end smallexample
5625 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5626 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5627 @file{dir2/yfoobar.o}.
5629 @item -time@r{[}=@var{file}@r{]}
5630 @opindex time
5631 Report the CPU time taken by each subprocess in the compilation
5632 sequence.  For C source files, this is the compiler proper and assembler
5633 (plus the linker if linking is done).
5635 Without the specification of an output file, the output looks like this:
5637 @smallexample
5638 # cc1 0.12 0.01
5639 # as 0.00 0.01
5640 @end smallexample
5642 The first number on each line is the ``user time'', that is time spent
5643 executing the program itself.  The second number is ``system time'',
5644 time spent executing operating system routines on behalf of the program.
5645 Both numbers are in seconds.
5647 With the specification of an output file, the output is appended to the
5648 named file, and it looks like this:
5650 @smallexample
5651 0.12 0.01 cc1 @var{options}
5652 0.00 0.01 as @var{options}
5653 @end smallexample
5655 The ``user time'' and the ``system time'' are moved before the program
5656 name, and the options passed to the program are displayed, so that one
5657 can later tell what file was being compiled, and with which options.
5659 @item -fvar-tracking
5660 @opindex fvar-tracking
5661 Run variable tracking pass.  It computes where variables are stored at each
5662 position in code.  Better debugging information is then generated
5663 (if the debugging information format supports this information).
5665 It is enabled by default when compiling with optimization (@option{-Os},
5666 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5667 the debug info format supports it.
5669 @item -fvar-tracking-assignments
5670 @opindex fvar-tracking-assignments
5671 @opindex fno-var-tracking-assignments
5672 Annotate assignments to user variables early in the compilation and
5673 attempt to carry the annotations over throughout the compilation all the
5674 way to the end, in an attempt to improve debug information while
5675 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5677 It can be enabled even if var-tracking is disabled, in which case
5678 annotations will be created and maintained, but discarded at the end.
5680 @item -fvar-tracking-assignments-toggle
5681 @opindex fvar-tracking-assignments-toggle
5682 @opindex fno-var-tracking-assignments-toggle
5683 Toggle @option{-fvar-tracking-assignments}, in the same way that
5684 @option{-gtoggle} toggles @option{-g}.
5686 @item -print-file-name=@var{library}
5687 @opindex print-file-name
5688 Print the full absolute name of the library file @var{library} that
5689 would be used when linking---and don't do anything else.  With this
5690 option, GCC does not compile or link anything; it just prints the
5691 file name.
5693 @item -print-multi-directory
5694 @opindex print-multi-directory
5695 Print the directory name corresponding to the multilib selected by any
5696 other switches present in the command line.  This directory is supposed
5697 to exist in @env{GCC_EXEC_PREFIX}.
5699 @item -print-multi-lib
5700 @opindex print-multi-lib
5701 Print the mapping from multilib directory names to compiler switches
5702 that enable them.  The directory name is separated from the switches by
5703 @samp{;}, and each switch starts with an @samp{@@} instead of the
5704 @samp{-}, without spaces between multiple switches.  This is supposed to
5705 ease shell-processing.
5707 @item -print-multi-os-directory
5708 @opindex print-multi-os-directory
5709 Print the path to OS libraries for the selected
5710 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
5711 present in the @file{lib} subdirectory and no multilibs are used, this is
5712 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5713 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5714 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5715 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5717 @item -print-prog-name=@var{program}
5718 @opindex print-prog-name
5719 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5721 @item -print-libgcc-file-name
5722 @opindex print-libgcc-file-name
5723 Same as @option{-print-file-name=libgcc.a}.
5725 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5726 but you do want to link with @file{libgcc.a}.  You can do
5728 @smallexample
5729 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5730 @end smallexample
5732 @item -print-search-dirs
5733 @opindex print-search-dirs
5734 Print the name of the configured installation directory and a list of
5735 program and library directories @command{gcc} will search---and don't do anything else.
5737 This is useful when @command{gcc} prints the error message
5738 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5739 To resolve this you either need to put @file{cpp0} and the other compiler
5740 components where @command{gcc} expects to find them, or you can set the environment
5741 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5742 Don't forget the trailing @samp{/}.
5743 @xref{Environment Variables}.
5745 @item -print-sysroot
5746 @opindex print-sysroot
5747 Print the target sysroot directory that will be used during
5748 compilation.  This is the target sysroot specified either at configure
5749 time or using the @option{--sysroot} option, possibly with an extra
5750 suffix that depends on compilation options.  If no target sysroot is
5751 specified, the option prints nothing.
5753 @item -print-sysroot-headers-suffix
5754 @opindex print-sysroot-headers-suffix
5755 Print the suffix added to the target sysroot when searching for
5756 headers, or give an error if the compiler is not configured with such
5757 a suffix---and don't do anything else.
5759 @item -dumpmachine
5760 @opindex dumpmachine
5761 Print the compiler's target machine (for example,
5762 @samp{i686-pc-linux-gnu})---and don't do anything else.
5764 @item -dumpversion
5765 @opindex dumpversion
5766 Print the compiler version (for example, @samp{3.0})---and don't do
5767 anything else.
5769 @item -dumpspecs
5770 @opindex dumpspecs
5771 Print the compiler's built-in specs---and don't do anything else.  (This
5772 is used when GCC itself is being built.)  @xref{Spec Files}.
5774 @item -feliminate-unused-debug-types
5775 @opindex feliminate-unused-debug-types
5776 Normally, when producing DWARF2 output, GCC will emit debugging
5777 information for all types declared in a compilation
5778 unit, regardless of whether or not they are actually used
5779 in that compilation unit.  Sometimes this is useful, such as
5780 if, in the debugger, you want to cast a value to a type that is
5781 not actually used in your program (but is declared).  More often,
5782 however, this results in a significant amount of wasted space.
5783 With this option, GCC will avoid producing debug symbol output
5784 for types that are nowhere used in the source file being compiled.
5785 @end table
5787 @node Optimize Options
5788 @section Options That Control Optimization
5789 @cindex optimize options
5790 @cindex options, optimization
5792 These options control various sorts of optimizations.
5794 Without any optimization option, the compiler's goal is to reduce the
5795 cost of compilation and to make debugging produce the expected
5796 results.  Statements are independent: if you stop the program with a
5797 breakpoint between statements, you can then assign a new value to any
5798 variable or change the program counter to any other statement in the
5799 function and get exactly the results you would expect from the source
5800 code.
5802 Turning on optimization flags makes the compiler attempt to improve
5803 the performance and/or code size at the expense of compilation time
5804 and possibly the ability to debug the program.
5806 The compiler performs optimization based on the knowledge it has of the
5807 program.  Compiling multiple files at once to a single output file mode allows
5808 the compiler to use information gained from all of the files when compiling
5809 each of them.
5811 Not all optimizations are controlled directly by a flag.  Only
5812 optimizations that have a flag are listed in this section.
5814 Most optimizations are only enabled if an @option{-O} level is set on
5815 the command line.  Otherwise they are disabled, even if individual             
5816 optimization flags are specified.
5818 Depending on the target and how GCC was configured, a slightly different
5819 set of optimizations may be enabled at each @option{-O} level than
5820 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5821 to find out the exact set of optimizations that are enabled at each level.
5822 @xref{Overall Options}, for examples.
5824 @table @gcctabopt
5825 @item -O
5826 @itemx -O1
5827 @opindex O
5828 @opindex O1
5829 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5830 more memory for a large function.
5832 With @option{-O}, the compiler tries to reduce code size and execution
5833 time, without performing any optimizations that take a great deal of
5834 compilation time.
5836 @option{-O} turns on the following optimization flags:
5837 @gccoptlist{
5838 -fauto-inc-dec @gol
5839 -fcprop-registers @gol
5840 -fdce @gol
5841 -fdefer-pop @gol
5842 -fdelayed-branch @gol
5843 -fdse @gol
5844 -fguess-branch-probability @gol
5845 -fif-conversion2 @gol
5846 -fif-conversion @gol
5847 -fipa-pure-const @gol
5848 -fipa-profile @gol
5849 -fipa-reference @gol
5850 -fmerge-constants
5851 -fsplit-wide-types @gol
5852 -ftree-bit-ccp @gol
5853 -ftree-builtin-call-dce @gol
5854 -ftree-ccp @gol
5855 -ftree-ch @gol
5856 -ftree-copyrename @gol
5857 -ftree-dce @gol
5858 -ftree-dominator-opts @gol
5859 -ftree-dse @gol
5860 -ftree-forwprop @gol
5861 -ftree-fre @gol
5862 -ftree-phiprop @gol
5863 -ftree-sra @gol
5864 -ftree-pta @gol
5865 -ftree-ter @gol
5866 -funit-at-a-time}
5868 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5869 where doing so does not interfere with debugging.
5871 @item -O2
5872 @opindex O2
5873 Optimize even more.  GCC performs nearly all supported optimizations
5874 that do not involve a space-speed tradeoff.
5875 As compared to @option{-O}, this option increases both compilation time
5876 and the performance of the generated code.
5878 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5879 also turns on the following optimization flags:
5880 @gccoptlist{-fthread-jumps @gol
5881 -falign-functions  -falign-jumps @gol
5882 -falign-loops  -falign-labels @gol
5883 -fcaller-saves @gol
5884 -fcrossjumping @gol
5885 -fcse-follow-jumps  -fcse-skip-blocks @gol
5886 -fdelete-null-pointer-checks @gol
5887 -fexpensive-optimizations @gol
5888 -fgcse  -fgcse-lm  @gol
5889 -finline-small-functions @gol
5890 -findirect-inlining @gol
5891 -fipa-sra @gol
5892 -foptimize-sibling-calls @gol
5893 -fpartial-inlining @gol
5894 -fpeephole2 @gol
5895 -fregmove @gol
5896 -freorder-blocks  -freorder-functions @gol
5897 -frerun-cse-after-loop  @gol
5898 -fsched-interblock  -fsched-spec @gol
5899 -fschedule-insns  -fschedule-insns2 @gol
5900 -fstrict-aliasing -fstrict-overflow @gol
5901 -ftree-switch-conversion @gol
5902 -ftree-pre @gol
5903 -ftree-vrp}
5905 Please note the warning under @option{-fgcse} about
5906 invoking @option{-O2} on programs that use computed gotos.
5908 @item -O3
5909 @opindex O3
5910 Optimize yet more.  @option{-O3} turns on all optimizations specified
5911 by @option{-O2} and also turns on the @option{-finline-functions},
5912 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5913 @option{-fgcse-after-reload}, @option{-ftree-vectorize} and
5914 @option{-fipa-cp-clone} options.
5916 @item -O0
5917 @opindex O0
5918 Reduce compilation time and make debugging produce the expected
5919 results.  This is the default.
5921 @item -Os
5922 @opindex Os
5923 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5924 do not typically increase code size.  It also performs further
5925 optimizations designed to reduce code size.
5927 @option{-Os} disables the following optimization flags:
5928 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5929 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5930 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5932 @item -Ofast
5933 @opindex Ofast
5934 Disregard strict standards compliance.  @option{-Ofast} enables all
5935 @option{-O3} optimizations.  It also enables optimizations that are not
5936 valid for all standard compliant programs.
5937 It turns on @option{-ffast-math}.
5939 If you use multiple @option{-O} options, with or without level numbers,
5940 the last such option is the one that is effective.
5941 @end table
5943 Options of the form @option{-f@var{flag}} specify machine-independent
5944 flags.  Most flags have both positive and negative forms; the negative
5945 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5946 below, only one of the forms is listed---the one you typically will
5947 use.  You can figure out the other form by either removing @samp{no-}
5948 or adding it.
5950 The following options control specific optimizations.  They are either
5951 activated by @option{-O} options or are related to ones that are.  You
5952 can use the following flags in the rare cases when ``fine-tuning'' of
5953 optimizations to be performed is desired.
5955 @table @gcctabopt
5956 @item -fno-default-inline
5957 @opindex fno-default-inline
5958 Do not make member functions inline by default merely because they are
5959 defined inside the class scope (C++ only).  Otherwise, when you specify
5960 @w{@option{-O}}, member functions defined inside class scope are compiled
5961 inline by default; i.e., you don't need to add @samp{inline} in front of
5962 the member function name.
5964 @item -fno-defer-pop
5965 @opindex fno-defer-pop
5966 Always pop the arguments to each function call as soon as that function
5967 returns.  For machines which must pop arguments after a function call,
5968 the compiler normally lets arguments accumulate on the stack for several
5969 function calls and pops them all at once.
5971 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5973 @item -fforward-propagate
5974 @opindex fforward-propagate
5975 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5976 instructions and checks if the result can be simplified.  If loop unrolling
5977 is active, two passes are performed and the second is scheduled after
5978 loop unrolling.
5980 This option is enabled by default at optimization levels @option{-O},
5981 @option{-O2}, @option{-O3}, @option{-Os}.
5983 @item -fomit-frame-pointer
5984 @opindex fomit-frame-pointer
5985 Don't keep the frame pointer in a register for functions that
5986 don't need one.  This avoids the instructions to save, set up and
5987 restore frame pointers; it also makes an extra register available
5988 in many functions.  @strong{It also makes debugging impossible on
5989 some machines.}
5991 On some machines, such as the VAX, this flag has no effect, because
5992 the standard calling sequence automatically handles the frame pointer
5993 and nothing is saved by pretending it doesn't exist.  The
5994 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5995 whether a target machine supports this flag.  @xref{Registers,,Register
5996 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5998 Starting with GCC version 4.6, the default setting (when not optimizing for
5999 size) for 32-bit Linux x86 and 32-bit Darwin x86 targets has been changed to
6000 @option{-fomit-frame-pointer}.  The default can be reverted to
6001 @option{-fno-omit-frame-pointer} by configuring GCC with the
6002 @option{--enable-frame-pointer} configure option.
6004 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6006 @item -foptimize-sibling-calls
6007 @opindex foptimize-sibling-calls
6008 Optimize sibling and tail recursive calls.
6010 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6012 @item -fno-inline
6013 @opindex fno-inline
6014 Don't pay attention to the @code{inline} keyword.  Normally this option
6015 is used to keep the compiler from expanding any functions inline.
6016 Note that if you are not optimizing, no functions can be expanded inline.
6018 @item -finline-small-functions
6019 @opindex finline-small-functions
6020 Integrate functions into their callers when their body is smaller than expected
6021 function call code (so overall size of program gets smaller).  The compiler
6022 heuristically decides which functions are simple enough to be worth integrating
6023 in this way.
6025 Enabled at level @option{-O2}.
6027 @item -findirect-inlining
6028 @opindex findirect-inlining
6029 Inline also indirect calls that are discovered to be known at compile
6030 time thanks to previous inlining.  This option has any effect only
6031 when inlining itself is turned on by the @option{-finline-functions}
6032 or @option{-finline-small-functions} options.
6034 Enabled at level @option{-O2}.
6036 @item -finline-functions
6037 @opindex finline-functions
6038 Integrate all simple functions into their callers.  The compiler
6039 heuristically decides which functions are simple enough to be worth
6040 integrating in this way.
6042 If all calls to a given function are integrated, and the function is
6043 declared @code{static}, then the function is normally not output as
6044 assembler code in its own right.
6046 Enabled at level @option{-O3}.
6048 @item -finline-functions-called-once
6049 @opindex finline-functions-called-once
6050 Consider all @code{static} functions called once for inlining into their
6051 caller even if they are not marked @code{inline}.  If a call to a given
6052 function is integrated, then the function is not output as assembler code
6053 in its own right.
6055 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6057 @item -fearly-inlining
6058 @opindex fearly-inlining
6059 Inline functions marked by @code{always_inline} and functions whose body seems
6060 smaller than the function call overhead early before doing
6061 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6062 makes profiling significantly cheaper and usually inlining faster on programs
6063 having large chains of nested wrapper functions.
6065 Enabled by default.
6067 @item -fipa-sra
6068 @opindex fipa-sra
6069 Perform interprocedural scalar replacement of aggregates, removal of
6070 unused parameters and replacement of parameters passed by reference
6071 by parameters passed by value.
6073 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6075 @item -finline-limit=@var{n}
6076 @opindex finline-limit
6077 By default, GCC limits the size of functions that can be inlined.  This flag
6078 allows coarse control of this limit.  @var{n} is the size of functions that
6079 can be inlined in number of pseudo instructions.
6081 Inlining is actually controlled by a number of parameters, which may be
6082 specified individually by using @option{--param @var{name}=@var{value}}.
6083 The @option{-finline-limit=@var{n}} option sets some of these parameters
6084 as follows:
6086 @table @gcctabopt
6087 @item max-inline-insns-single
6088 is set to @var{n}/2.
6089 @item max-inline-insns-auto
6090 is set to @var{n}/2.
6091 @end table
6093 See below for a documentation of the individual
6094 parameters controlling inlining and for the defaults of these parameters.
6096 @emph{Note:} there may be no value to @option{-finline-limit} that results
6097 in default behavior.
6099 @emph{Note:} pseudo instruction represents, in this particular context, an
6100 abstract measurement of function's size.  In no way does it represent a count
6101 of assembly instructions and as such its exact meaning might change from one
6102 release to an another.
6104 @item -fkeep-inline-functions
6105 @opindex fkeep-inline-functions
6106 In C, emit @code{static} functions that are declared @code{inline}
6107 into the object file, even if the function has been inlined into all
6108 of its callers.  This switch does not affect functions using the
6109 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6110 inline functions into the object file.
6112 @item -fkeep-static-consts
6113 @opindex fkeep-static-consts
6114 Emit variables declared @code{static const} when optimization isn't turned
6115 on, even if the variables aren't referenced.
6117 GCC enables this option by default.  If you want to force the compiler to
6118 check if the variable was referenced, regardless of whether or not
6119 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6121 @item -fmerge-constants
6122 @opindex fmerge-constants
6123 Attempt to merge identical constants (string constants and floating point
6124 constants) across compilation units.
6126 This option is the default for optimized compilation if the assembler and
6127 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6128 behavior.
6130 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6132 @item -fmerge-all-constants
6133 @opindex fmerge-all-constants
6134 Attempt to merge identical constants and identical variables.
6136 This option implies @option{-fmerge-constants}.  In addition to
6137 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6138 arrays or initialized constant variables with integral or floating point
6139 types.  Languages like C or C++ require each variable, including multiple
6140 instances of the same variable in recursive calls, to have distinct locations,
6141 so using this option will result in non-conforming
6142 behavior.
6144 @item -fmodulo-sched
6145 @opindex fmodulo-sched
6146 Perform swing modulo scheduling immediately before the first scheduling
6147 pass.  This pass looks at innermost loops and reorders their
6148 instructions by overlapping different iterations.
6150 @item -fmodulo-sched-allow-regmoves
6151 @opindex fmodulo-sched-allow-regmoves
6152 Perform more aggressive SMS based modulo scheduling with register moves
6153 allowed.  By setting this flag certain anti-dependences edges will be
6154 deleted which will trigger the generation of reg-moves based on the
6155 life-range analysis.  This option is effective only with
6156 @option{-fmodulo-sched} enabled.
6158 @item -fno-branch-count-reg
6159 @opindex fno-branch-count-reg
6160 Do not use ``decrement and branch'' instructions on a count register,
6161 but instead generate a sequence of instructions that decrement a
6162 register, compare it against zero, then branch based upon the result.
6163 This option is only meaningful on architectures that support such
6164 instructions, which include x86, PowerPC, IA-64 and S/390.
6166 The default is @option{-fbranch-count-reg}.
6168 @item -fno-function-cse
6169 @opindex fno-function-cse
6170 Do not put function addresses in registers; make each instruction that
6171 calls a constant function contain the function's address explicitly.
6173 This option results in less efficient code, but some strange hacks
6174 that alter the assembler output may be confused by the optimizations
6175 performed when this option is not used.
6177 The default is @option{-ffunction-cse}
6179 @item -fno-zero-initialized-in-bss
6180 @opindex fno-zero-initialized-in-bss
6181 If the target supports a BSS section, GCC by default puts variables that
6182 are initialized to zero into BSS@.  This can save space in the resulting
6183 code.
6185 This option turns off this behavior because some programs explicitly
6186 rely on variables going to the data section.  E.g., so that the
6187 resulting executable can find the beginning of that section and/or make
6188 assumptions based on that.
6190 The default is @option{-fzero-initialized-in-bss}.
6192 @item -fmudflap -fmudflapth -fmudflapir
6193 @opindex fmudflap
6194 @opindex fmudflapth
6195 @opindex fmudflapir
6196 @cindex bounds checking
6197 @cindex mudflap
6198 For front-ends that support it (C and C++), instrument all risky
6199 pointer/array dereferencing operations, some standard library
6200 string/heap functions, and some other associated constructs with
6201 range/validity tests.  Modules so instrumented should be immune to
6202 buffer overflows, invalid heap use, and some other classes of C/C++
6203 programming errors.  The instrumentation relies on a separate runtime
6204 library (@file{libmudflap}), which will be linked into a program if
6205 @option{-fmudflap} is given at link time.  Run-time behavior of the
6206 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6207 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6208 for its options.
6210 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6211 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6212 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6213 instrumentation should ignore pointer reads.  This produces less
6214 instrumentation (and therefore faster execution) and still provides
6215 some protection against outright memory corrupting writes, but allows
6216 erroneously read data to propagate within a program.
6218 @item -fthread-jumps
6219 @opindex fthread-jumps
6220 Perform optimizations where we check to see if a jump branches to a
6221 location where another comparison subsumed by the first is found.  If
6222 so, the first branch is redirected to either the destination of the
6223 second branch or a point immediately following it, depending on whether
6224 the condition is known to be true or false.
6226 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6228 @item -fsplit-wide-types
6229 @opindex fsplit-wide-types
6230 When using a type that occupies multiple registers, such as @code{long
6231 long} on a 32-bit system, split the registers apart and allocate them
6232 independently.  This normally generates better code for those types,
6233 but may make debugging more difficult.
6235 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6236 @option{-Os}.
6238 @item -fcse-follow-jumps
6239 @opindex fcse-follow-jumps
6240 In common subexpression elimination (CSE), scan through jump instructions
6241 when the target of the jump is not reached by any other path.  For
6242 example, when CSE encounters an @code{if} statement with an
6243 @code{else} clause, CSE will follow the jump when the condition
6244 tested is false.
6246 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6248 @item -fcse-skip-blocks
6249 @opindex fcse-skip-blocks
6250 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6251 follow jumps which conditionally skip over blocks.  When CSE
6252 encounters a simple @code{if} statement with no else clause,
6253 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6254 body of the @code{if}.
6256 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6258 @item -frerun-cse-after-loop
6259 @opindex frerun-cse-after-loop
6260 Re-run common subexpression elimination after loop optimizations has been
6261 performed.
6263 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6265 @item -fgcse
6266 @opindex fgcse
6267 Perform a global common subexpression elimination pass.
6268 This pass also performs global constant and copy propagation.
6270 @emph{Note:} When compiling a program using computed gotos, a GCC
6271 extension, you may get better runtime performance if you disable
6272 the global common subexpression elimination pass by adding
6273 @option{-fno-gcse} to the command line.
6275 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6277 @item -fgcse-lm
6278 @opindex fgcse-lm
6279 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6280 attempt to move loads which are only killed by stores into themselves.  This
6281 allows a loop containing a load/store sequence to be changed to a load outside
6282 the loop, and a copy/store within the loop.
6284 Enabled by default when gcse is enabled.
6286 @item -fgcse-sm
6287 @opindex fgcse-sm
6288 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6289 global common subexpression elimination.  This pass will attempt to move
6290 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6291 loops containing a load/store sequence can be changed to a load before
6292 the loop and a store after the loop.
6294 Not enabled at any optimization level.
6296 @item -fgcse-las
6297 @opindex fgcse-las
6298 When @option{-fgcse-las} is enabled, the global common subexpression
6299 elimination pass eliminates redundant loads that come after stores to the
6300 same memory location (both partial and full redundancies).
6302 Not enabled at any optimization level.
6304 @item -fgcse-after-reload
6305 @opindex fgcse-after-reload
6306 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6307 pass is performed after reload.  The purpose of this pass is to cleanup
6308 redundant spilling.
6310 @item -funsafe-loop-optimizations
6311 @opindex funsafe-loop-optimizations
6312 If given, the loop optimizer will assume that loop indices do not
6313 overflow, and that the loops with nontrivial exit condition are not
6314 infinite.  This enables a wider range of loop optimizations even if
6315 the loop optimizer itself cannot prove that these assumptions are valid.
6316 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6317 if it finds this kind of loop.
6319 @item -fcrossjumping
6320 @opindex fcrossjumping
6321 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6322 resulting code may or may not perform better than without cross-jumping.
6324 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6326 @item -fauto-inc-dec
6327 @opindex fauto-inc-dec
6328 Combine increments or decrements of addresses with memory accesses.
6329 This pass is always skipped on architectures that do not have
6330 instructions to support this.  Enabled by default at @option{-O} and
6331 higher on architectures that support this.
6333 @item -fdce
6334 @opindex fdce
6335 Perform dead code elimination (DCE) on RTL@.
6336 Enabled by default at @option{-O} and higher.
6338 @item -fdse
6339 @opindex fdse
6340 Perform dead store elimination (DSE) on RTL@.
6341 Enabled by default at @option{-O} and higher.
6343 @item -fif-conversion
6344 @opindex fif-conversion
6345 Attempt to transform conditional jumps into branch-less equivalents.  This
6346 include use of conditional moves, min, max, set flags and abs instructions, and
6347 some tricks doable by standard arithmetics.  The use of conditional execution
6348 on chips where it is available is controlled by @code{if-conversion2}.
6350 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6352 @item -fif-conversion2
6353 @opindex fif-conversion2
6354 Use conditional execution (where available) to transform conditional jumps into
6355 branch-less equivalents.
6357 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6359 @item -fdelete-null-pointer-checks
6360 @opindex fdelete-null-pointer-checks
6361 Assume that programs cannot safely dereference null pointers, and that
6362 no code or data element resides there.  This enables simple constant
6363 folding optimizations at all optimization levels.  In addition, other
6364 optimization passes in GCC use this flag to control global dataflow
6365 analyses that eliminate useless checks for null pointers; these assume
6366 that if a pointer is checked after it has already been dereferenced,
6367 it cannot be null.
6369 Note however that in some environments this assumption is not true.
6370 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6371 for programs which depend on that behavior.
6373 Some targets, especially embedded ones, disable this option at all levels.
6374 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6375 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6376 are enabled independently at different optimization levels.
6378 @item -fexpensive-optimizations
6379 @opindex fexpensive-optimizations
6380 Perform a number of minor optimizations that are relatively expensive.
6382 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6384 @item -foptimize-register-move
6385 @itemx -fregmove
6386 @opindex foptimize-register-move
6387 @opindex fregmove
6388 Attempt to reassign register numbers in move instructions and as
6389 operands of other simple instructions in order to maximize the amount of
6390 register tying.  This is especially helpful on machines with two-operand
6391 instructions.
6393 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6394 optimization.
6396 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6398 @item -fira-algorithm=@var{algorithm}
6399 Use specified coloring algorithm for the integrated register
6400 allocator.  The @var{algorithm} argument should be @code{priority} or
6401 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6402 the second one specifies Chaitin-Briggs coloring.  The second
6403 algorithm can be unimplemented for some architectures.  If it is
6404 implemented, it is the default because Chaitin-Briggs coloring as a
6405 rule generates a better code.
6407 @item -fira-region=@var{region}
6408 Use specified regions for the integrated register allocator.  The
6409 @var{region} argument should be one of @code{all}, @code{mixed}, or
6410 @code{one}.  The first value means using all loops as register
6411 allocation regions, the second value which is the default means using
6412 all loops except for loops with small register pressure as the
6413 regions, and third one means using all function as a single region.
6414 The first value can give best result for machines with small size and
6415 irregular register set, the third one results in faster and generates
6416 decent code and the smallest size code, and the default value usually
6417 give the best results in most cases and for most architectures.
6419 @item -fira-loop-pressure
6420 @opindex fira-loop-pressure
6421 Use IRA to evaluate register pressure in loops for decision to move
6422 loop invariants.  Usage of this option usually results in generation
6423 of faster and smaller code on machines with big register files (>= 32
6424 registers) but it can slow compiler down.
6426 This option is enabled at level @option{-O3} for some targets.
6428 @item -fno-ira-share-save-slots
6429 @opindex fno-ira-share-save-slots
6430 Switch off sharing stack slots used for saving call used hard
6431 registers living through a call.  Each hard register will get a
6432 separate stack slot and as a result function stack frame will be
6433 bigger.
6435 @item -fno-ira-share-spill-slots
6436 @opindex fno-ira-share-spill-slots
6437 Switch off sharing stack slots allocated for pseudo-registers.  Each
6438 pseudo-register which did not get a hard register will get a separate
6439 stack slot and as a result function stack frame will be bigger.
6441 @item -fira-verbose=@var{n}
6442 @opindex fira-verbose
6443 Set up how verbose dump file for the integrated register allocator
6444 will be.  Default value is 5.  If the value is greater or equal to 10,
6445 the dump file will be stderr as if the value were @var{n} minus 10.
6447 @item -fdelayed-branch
6448 @opindex fdelayed-branch
6449 If supported for the target machine, attempt to reorder instructions
6450 to exploit instruction slots available after delayed branch
6451 instructions.
6453 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6455 @item -fschedule-insns
6456 @opindex fschedule-insns
6457 If supported for the target machine, attempt to reorder instructions to
6458 eliminate execution stalls due to required data being unavailable.  This
6459 helps machines that have slow floating point or memory load instructions
6460 by allowing other instructions to be issued until the result of the load
6461 or floating point instruction is required.
6463 Enabled at levels @option{-O2}, @option{-O3}.
6465 @item -fschedule-insns2
6466 @opindex fschedule-insns2
6467 Similar to @option{-fschedule-insns}, but requests an additional pass of
6468 instruction scheduling after register allocation has been done.  This is
6469 especially useful on machines with a relatively small number of
6470 registers and where memory load instructions take more than one cycle.
6472 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6474 @item -fno-sched-interblock
6475 @opindex fno-sched-interblock
6476 Don't schedule instructions across basic blocks.  This is normally
6477 enabled by default when scheduling before register allocation, i.e.@:
6478 with @option{-fschedule-insns} or at @option{-O2} or higher.
6480 @item -fno-sched-spec
6481 @opindex fno-sched-spec
6482 Don't allow speculative motion of non-load instructions.  This is normally
6483 enabled by default when scheduling before register allocation, i.e.@:
6484 with @option{-fschedule-insns} or at @option{-O2} or higher.
6486 @item -fsched-pressure
6487 @opindex fsched-pressure
6488 Enable register pressure sensitive insn scheduling before the register
6489 allocation.  This only makes sense when scheduling before register
6490 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6491 @option{-O2} or higher.  Usage of this option can improve the
6492 generated code and decrease its size by preventing register pressure
6493 increase above the number of available hard registers and as a
6494 consequence register spills in the register allocation.
6496 @item -fsched-spec-load
6497 @opindex fsched-spec-load
6498 Allow speculative motion of some load instructions.  This only makes
6499 sense when scheduling before register allocation, i.e.@: with
6500 @option{-fschedule-insns} or at @option{-O2} or higher.
6502 @item -fsched-spec-load-dangerous
6503 @opindex fsched-spec-load-dangerous
6504 Allow speculative motion of more load instructions.  This only makes
6505 sense when scheduling before register allocation, i.e.@: with
6506 @option{-fschedule-insns} or at @option{-O2} or higher.
6508 @item -fsched-stalled-insns
6509 @itemx -fsched-stalled-insns=@var{n}
6510 @opindex fsched-stalled-insns
6511 Define how many insns (if any) can be moved prematurely from the queue
6512 of stalled insns into the ready list, during the second scheduling pass.
6513 @option{-fno-sched-stalled-insns} means that no insns will be moved
6514 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6515 on how many queued insns can be moved prematurely.
6516 @option{-fsched-stalled-insns} without a value is equivalent to
6517 @option{-fsched-stalled-insns=1}.
6519 @item -fsched-stalled-insns-dep
6520 @itemx -fsched-stalled-insns-dep=@var{n}
6521 @opindex fsched-stalled-insns-dep
6522 Define how many insn groups (cycles) will be examined for a dependency
6523 on a stalled insn that is candidate for premature removal from the queue
6524 of stalled insns.  This has an effect only during the second scheduling pass,
6525 and only if @option{-fsched-stalled-insns} is used.
6526 @option{-fno-sched-stalled-insns-dep} is equivalent to
6527 @option{-fsched-stalled-insns-dep=0}.
6528 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6529 @option{-fsched-stalled-insns-dep=1}.
6531 @item -fsched2-use-superblocks
6532 @opindex fsched2-use-superblocks
6533 When scheduling after register allocation, do use superblock scheduling
6534 algorithm.  Superblock scheduling allows motion across basic block boundaries
6535 resulting on faster schedules.  This option is experimental, as not all machine
6536 descriptions used by GCC model the CPU closely enough to avoid unreliable
6537 results from the algorithm.
6539 This only makes sense when scheduling after register allocation, i.e.@: with
6540 @option{-fschedule-insns2} or at @option{-O2} or higher.
6542 @item -fsched-group-heuristic
6543 @opindex fsched-group-heuristic
6544 Enable the group heuristic in the scheduler.  This heuristic favors 
6545 the instruction that belongs to a schedule group.  This is enabled 
6546 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6547 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6549 @item -fsched-critical-path-heuristic
6550 @opindex fsched-critical-path-heuristic
6551 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6552 instructions on the critical path.  This is enabled by default when 
6553 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6554 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6556 @item -fsched-spec-insn-heuristic
6557 @opindex fsched-spec-insn-heuristic
6558 Enable the speculative instruction heuristic in the scheduler.  This 
6559 heuristic favors speculative instructions with greater dependency weakness.  
6560 This is enabled by default when scheduling is enabled, i.e.@: 
6561 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6562 or at @option{-O2} or higher.
6564 @item -fsched-rank-heuristic
6565 @opindex fsched-rank-heuristic
6566 Enable the rank heuristic in the scheduler.  This heuristic favors 
6567 the instruction belonging to a basic block with greater size or frequency.  
6568 This is enabled by default when scheduling is enabled, i.e.@: 
6569 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6570 at @option{-O2} or higher.
6572 @item -fsched-last-insn-heuristic
6573 @opindex fsched-last-insn-heuristic
6574 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6575 favors the instruction that is less dependent on the last instruction
6576 scheduled.  This is enabled by default when scheduling is enabled, 
6577 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6578 at @option{-O2} or higher.
6580 @item -fsched-dep-count-heuristic
6581 @opindex fsched-dep-count-heuristic
6582 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6583 favors the instruction that has more instructions depending on it.  
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 -freschedule-modulo-scheduled-loops
6589 @opindex freschedule-modulo-scheduled-loops
6590 The modulo scheduling comes before the traditional scheduling, if a loop
6591 was modulo scheduled we may want to prevent the later scheduling passes
6592 from changing its schedule, we use this option to control that.
6594 @item -fselective-scheduling
6595 @opindex fselective-scheduling
6596 Schedule instructions using selective scheduling algorithm.  Selective
6597 scheduling runs instead of the first scheduler pass.
6599 @item -fselective-scheduling2
6600 @opindex fselective-scheduling2
6601 Schedule instructions using selective scheduling algorithm.  Selective
6602 scheduling runs instead of the second scheduler pass.
6604 @item -fsel-sched-pipelining
6605 @opindex fsel-sched-pipelining
6606 Enable software pipelining of innermost loops during selective scheduling.
6607 This option has no effect until one of @option{-fselective-scheduling} or
6608 @option{-fselective-scheduling2} is turned on.
6610 @item -fsel-sched-pipelining-outer-loops
6611 @opindex fsel-sched-pipelining-outer-loops
6612 When pipelining loops during selective scheduling, also pipeline outer loops.
6613 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6615 @item -fcaller-saves
6616 @opindex fcaller-saves
6617 Enable values to be allocated in registers that will be clobbered by
6618 function calls, by emitting extra instructions to save and restore the
6619 registers around such calls.  Such allocation is done only when it
6620 seems to result in better code than would otherwise be produced.
6622 This option is always enabled by default on certain machines, usually
6623 those which have no call-preserved registers to use instead.
6625 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6627 @item -fcombine-stack-adjustments
6628 @opindex fcombine-stack-adjustments
6629 Tracks stack adjustments (pushes and pops) and stack memory references
6630 and then tries to find ways to combine them.
6632 Enabled by default at @option{-O1} and higher.
6634 @item -fconserve-stack
6635 @opindex fconserve-stack
6636 Attempt to minimize stack usage.  The compiler will attempt to use less
6637 stack space, even if that makes the program slower.  This option
6638 implies setting the @option{large-stack-frame} parameter to 100
6639 and the @option{large-stack-frame-growth} parameter to 400.
6641 @item -ftree-reassoc
6642 @opindex ftree-reassoc
6643 Perform reassociation on trees.  This flag is enabled by default
6644 at @option{-O} and higher.
6646 @item -ftree-pre
6647 @opindex ftree-pre
6648 Perform partial redundancy elimination (PRE) on trees.  This flag is
6649 enabled by default at @option{-O2} and @option{-O3}.
6651 @item -ftree-forwprop
6652 @opindex ftree-forwprop
6653 Perform forward propagation on trees.  This flag is enabled by default
6654 at @option{-O} and higher.
6656 @item -ftree-fre
6657 @opindex ftree-fre
6658 Perform full redundancy elimination (FRE) on trees.  The difference
6659 between FRE and PRE is that FRE only considers expressions
6660 that are computed on all paths leading to the redundant computation.
6661 This analysis is faster than PRE, though it exposes fewer redundancies.
6662 This flag is enabled by default at @option{-O} and higher.
6664 @item -ftree-phiprop
6665 @opindex ftree-phiprop
6666 Perform hoisting of loads from conditional pointers on trees.  This
6667 pass is enabled by default at @option{-O} and higher.
6669 @item -ftree-copy-prop
6670 @opindex ftree-copy-prop
6671 Perform copy propagation on trees.  This pass eliminates unnecessary
6672 copy operations.  This flag is enabled by default at @option{-O} and
6673 higher.
6675 @item -fipa-pure-const
6676 @opindex fipa-pure-const
6677 Discover which functions are pure or constant.
6678 Enabled by default at @option{-O} and higher.
6680 @item -fipa-reference
6681 @opindex fipa-reference
6682 Discover which static variables do not escape cannot escape the
6683 compilation unit.
6684 Enabled by default at @option{-O} and higher.
6686 @item -fipa-struct-reorg
6687 @opindex fipa-struct-reorg
6688 Perform structure reorganization optimization, that change C-like structures
6689 layout in order to better utilize spatial locality.  This transformation is
6690 affective for programs containing arrays of structures.  Available in two
6691 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6692 or static (which uses built-in heuristics).  It works only in whole program
6693 mode, so it requires @option{-fwhole-program} to be
6694 enabled.  Structures considered @samp{cold} by this transformation are not
6695 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6697 With this flag, the program debug info reflects a new structure layout.
6699 @item -fipa-pta
6700 @opindex fipa-pta
6701 Perform interprocedural pointer analysis and interprocedural modification
6702 and reference analysis.  This option can cause excessive memory and
6703 compile-time usage on large compilation units.  It is not enabled by
6704 default at any optimization level.
6706 @item -fipa-profile
6707 @opindex fipa-profile
6708 Perform interprocedural profile propagation.  The functions called only from
6709 cold functions are marked as cold. Also functions executed once (such as
6710 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
6711 functions and loop less parts of functions executed once are then optimized for
6712 size.
6713 Enabled by default at @option{-O} and higher.
6715 @item -fipa-cp
6716 @opindex fipa-cp
6717 Perform interprocedural constant propagation.
6718 This optimization analyzes the program to determine when values passed
6719 to functions are constants and then optimizes accordingly.
6720 This optimization can substantially increase performance
6721 if the application has constants passed to functions.
6722 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6724 @item -fipa-cp-clone
6725 @opindex fipa-cp-clone
6726 Perform function cloning to make interprocedural constant propagation stronger.
6727 When enabled, interprocedural constant propagation will perform function cloning
6728 when externally visible function can be called with constant arguments.
6729 Because this optimization can create multiple copies of functions,
6730 it may significantly increase code size
6731 (see @option{--param ipcp-unit-growth=@var{value}}).
6732 This flag is enabled by default at @option{-O3}.
6734 @item -fipa-matrix-reorg
6735 @opindex fipa-matrix-reorg
6736 Perform matrix flattening and transposing.
6737 Matrix flattening tries to replace an @math{m}-dimensional matrix
6738 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6739 This reduces the level of indirection needed for accessing the elements
6740 of the matrix. The second optimization is matrix transposing that
6741 attempts to change the order of the matrix's dimensions in order to
6742 improve cache locality.
6743 Both optimizations need the @option{-fwhole-program} flag.
6744 Transposing is enabled only if profiling information is available.
6746 @item -ftree-sink
6747 @opindex ftree-sink
6748 Perform forward store motion  on trees.  This flag is
6749 enabled by default at @option{-O} and higher.
6751 @item -ftree-bit-ccp
6752 @opindex ftree-bit-ccp
6753 Perform sparse conditional bit constant propagation on trees and propagate
6754 pointer alignment information.
6755 This pass only operates on local scalar variables and is enabled by default
6756 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
6758 @item -ftree-ccp
6759 @opindex ftree-ccp
6760 Perform sparse conditional constant propagation (CCP) on trees.  This
6761 pass only operates on local scalar variables and is enabled by default
6762 at @option{-O} and higher.
6764 @item -ftree-switch-conversion
6765 Perform conversion of simple initializations in a switch to
6766 initializations from a scalar array.  This flag is enabled by default
6767 at @option{-O2} and higher.
6769 @item -ftree-dce
6770 @opindex ftree-dce
6771 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6772 default at @option{-O} and higher.
6774 @item -ftree-builtin-call-dce
6775 @opindex ftree-builtin-call-dce
6776 Perform conditional dead code elimination (DCE) for calls to builtin functions
6777 that may set @code{errno} but are otherwise side-effect free.  This flag is
6778 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6779 specified.
6781 @item -ftree-dominator-opts
6782 @opindex ftree-dominator-opts
6783 Perform a variety of simple scalar cleanups (constant/copy
6784 propagation, redundancy elimination, range propagation and expression
6785 simplification) based on a dominator tree traversal.  This also
6786 performs jump threading (to reduce jumps to jumps). This flag is
6787 enabled by default at @option{-O} and higher.
6789 @item -ftree-dse
6790 @opindex ftree-dse
6791 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6792 a memory location which will later be overwritten by another store without
6793 any intervening loads.  In this case the earlier store can be deleted.  This
6794 flag is enabled by default at @option{-O} and higher.
6796 @item -ftree-ch
6797 @opindex ftree-ch
6798 Perform loop header copying on trees.  This is beneficial since it increases
6799 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6800 is enabled by default at @option{-O} and higher.  It is not enabled
6801 for @option{-Os}, since it usually increases code size.
6803 @item -ftree-loop-optimize
6804 @opindex ftree-loop-optimize
6805 Perform loop optimizations on trees.  This flag is enabled by default
6806 at @option{-O} and higher.
6808 @item -ftree-loop-linear
6809 @opindex ftree-loop-linear
6810 Perform linear loop transformations on tree.  This flag can improve cache
6811 performance and allow further loop optimizations to take place.
6813 @item -floop-interchange
6814 @opindex floop-interchange
6815 Perform loop interchange transformations on loops.  Interchanging two
6816 nested loops switches the inner and outer loops.  For example, given a
6817 loop like:
6818 @smallexample
6819 DO J = 1, M
6820   DO I = 1, N
6821     A(J, I) = A(J, I) * C
6822   ENDDO
6823 ENDDO
6824 @end smallexample
6825 loop interchange will transform the loop as if the user had written:
6826 @smallexample
6827 DO I = 1, N
6828   DO J = 1, M
6829     A(J, I) = A(J, I) * C
6830   ENDDO
6831 ENDDO
6832 @end smallexample
6833 which can be beneficial when @code{N} is larger than the caches,
6834 because in Fortran, the elements of an array are stored in memory
6835 contiguously by column, and the original loop iterates over rows,
6836 potentially creating at each access a cache miss.  This optimization
6837 applies to all the languages supported by GCC and is not limited to
6838 Fortran.  To use this code transformation, GCC has to be configured
6839 with @option{--with-ppl} and @option{--with-cloog} to enable the
6840 Graphite loop transformation infrastructure.
6842 @item -floop-strip-mine
6843 @opindex floop-strip-mine
6844 Perform loop strip mining transformations on loops.  Strip mining
6845 splits a loop into two nested loops.  The outer loop has strides
6846 equal to the strip size and the inner loop has strides of the
6847 original loop within a strip.  The strip length can be changed
6848 using the @option{loop-block-tile-size} parameter.  For example,
6849 given a loop like:
6850 @smallexample
6851 DO I = 1, N
6852   A(I) = A(I) + C
6853 ENDDO
6854 @end smallexample
6855 loop strip mining will transform the loop as if the user had written:
6856 @smallexample
6857 DO II = 1, N, 51
6858   DO I = II, min (II + 50, N)
6859     A(I) = A(I) + C
6860   ENDDO
6861 ENDDO
6862 @end smallexample
6863 This optimization applies to all the languages supported by GCC and is
6864 not limited to Fortran.  To use this code transformation, GCC has to
6865 be configured with @option{--with-ppl} and @option{--with-cloog} to
6866 enable the Graphite loop transformation infrastructure.
6868 @item -floop-block
6869 @opindex floop-block
6870 Perform loop blocking transformations on loops.  Blocking strip mines
6871 each loop in the loop nest such that the memory accesses of the
6872 element loops fit inside caches.  The strip length can be changed
6873 using the @option{loop-block-tile-size} parameter.  For example, given
6874 a loop like:
6875 @smallexample
6876 DO I = 1, N
6877   DO J = 1, M
6878     A(J, I) = B(I) + C(J)
6879   ENDDO
6880 ENDDO
6881 @end smallexample
6882 loop blocking will transform the loop as if the user had written:
6883 @smallexample
6884 DO II = 1, N, 51
6885   DO JJ = 1, M, 51
6886     DO I = II, min (II + 50, N)
6887       DO J = JJ, min (JJ + 50, M)
6888         A(J, I) = B(I) + C(J)
6889       ENDDO
6890     ENDDO
6891   ENDDO
6892 ENDDO
6893 @end smallexample
6894 which can be beneficial when @code{M} is larger than the caches,
6895 because the innermost loop will iterate over a smaller amount of data
6896 that can be kept in the caches.  This optimization applies to all the
6897 languages supported by GCC and is not limited to Fortran.  To use this
6898 code transformation, GCC has to be configured with @option{--with-ppl}
6899 and @option{--with-cloog} to enable the Graphite loop transformation
6900 infrastructure.
6902 @item -fgraphite-identity
6903 @opindex fgraphite-identity
6904 Enable the identity transformation for graphite.  For every SCoP we generate
6905 the polyhedral representation and transform it back to gimple.  Using
6906 @option{-fgraphite-identity} we can check the costs or benefits of the
6907 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
6908 are also performed by the code generator CLooG, like index splitting and
6909 dead code elimination in loops.
6911 @item -floop-flatten
6912 @opindex floop-flatten
6913 Removes the loop nesting structure: transforms the loop nest into a
6914 single loop.  This transformation can be useful to vectorize all the
6915 levels of the loop nest.
6917 @item -floop-parallelize-all
6918 @opindex floop-parallelize-all
6919 Use the Graphite data dependence analysis to identify loops that can
6920 be parallelized.  Parallelize all the loops that can be analyzed to
6921 not contain loop carried dependences without checking that it is
6922 profitable to parallelize the loops.
6924 @item -fcheck-data-deps
6925 @opindex fcheck-data-deps
6926 Compare the results of several data dependence analyzers.  This option
6927 is used for debugging the data dependence analyzers.
6929 @item -ftree-loop-if-convert
6930 Attempt to transform conditional jumps in the innermost loops to
6931 branch-less equivalents.  The intent is to remove control-flow from
6932 the innermost loops in order to improve the ability of the
6933 vectorization pass to handle these loops.  This is enabled by default
6934 if vectorization is enabled.
6936 @item -ftree-loop-if-convert-stores
6937 Attempt to also if-convert conditional jumps containing memory writes.
6938 This transformation can be unsafe for multi-threaded programs as it
6939 transforms conditional memory writes into unconditional memory writes.
6940 For example,
6941 @smallexample
6942 for (i = 0; i < N; i++)
6943   if (cond)
6944     A[i] = expr;
6945 @end smallexample
6946 would be transformed to
6947 @smallexample
6948 for (i = 0; i < N; i++)
6949   A[i] = cond ? expr : A[i];
6950 @end smallexample
6951 potentially producing data races.
6953 @item -ftree-loop-distribution
6954 Perform loop distribution.  This flag can improve cache performance on
6955 big loop bodies and allow further loop optimizations, like
6956 parallelization or vectorization, to take place.  For example, the loop
6957 @smallexample
6958 DO I = 1, N
6959   A(I) = B(I) + C
6960   D(I) = E(I) * F
6961 ENDDO
6962 @end smallexample
6963 is transformed to
6964 @smallexample
6965 DO I = 1, N
6966    A(I) = B(I) + C
6967 ENDDO
6968 DO I = 1, N
6969    D(I) = E(I) * F
6970 ENDDO
6971 @end smallexample
6973 @item -ftree-loop-distribute-patterns
6974 Perform loop distribution of patterns that can be code generated with
6975 calls to a library.  This flag is enabled by default at @option{-O3}.
6977 This pass distributes the initialization loops and generates a call to
6978 memset zero.  For example, the loop
6979 @smallexample
6980 DO I = 1, N
6981   A(I) = 0
6982   B(I) = A(I) + I
6983 ENDDO
6984 @end smallexample
6985 is transformed to
6986 @smallexample
6987 DO I = 1, N
6988    A(I) = 0
6989 ENDDO
6990 DO I = 1, N
6991    B(I) = A(I) + I
6992 ENDDO
6993 @end smallexample
6994 and the initialization loop is transformed into a call to memset zero.
6996 @item -ftree-loop-im
6997 @opindex ftree-loop-im
6998 Perform loop invariant motion on trees.  This pass moves only invariants that
6999 would be hard to handle at RTL level (function calls, operations that expand to
7000 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7001 operands of conditions that are invariant out of the loop, so that we can use
7002 just trivial invariantness analysis in loop unswitching.  The pass also includes
7003 store motion.
7005 @item -ftree-loop-ivcanon
7006 @opindex ftree-loop-ivcanon
7007 Create a canonical counter for number of iterations in the loop for that
7008 determining number of iterations requires complicated analysis.  Later
7009 optimizations then may determine the number easily.  Useful especially
7010 in connection with unrolling.
7012 @item -fivopts
7013 @opindex fivopts
7014 Perform induction variable optimizations (strength reduction, induction
7015 variable merging and induction variable elimination) on trees.
7017 @item -ftree-parallelize-loops=n
7018 @opindex ftree-parallelize-loops
7019 Parallelize loops, i.e., split their iteration space to run in n threads.
7020 This is only possible for loops whose iterations are independent
7021 and can be arbitrarily reordered.  The optimization is only
7022 profitable on multiprocessor machines, for loops that are CPU-intensive,
7023 rather than constrained e.g.@: by memory bandwidth.  This option
7024 implies @option{-pthread}, and thus is only supported on targets
7025 that have support for @option{-pthread}.
7027 @item -ftree-pta
7028 @opindex ftree-pta
7029 Perform function-local points-to analysis on trees.  This flag is
7030 enabled by default at @option{-O} and higher.
7032 @item -ftree-sra
7033 @opindex ftree-sra
7034 Perform scalar replacement of aggregates.  This pass replaces structure
7035 references with scalars to prevent committing structures to memory too
7036 early.  This flag is enabled by default at @option{-O} and higher.
7038 @item -ftree-copyrename
7039 @opindex ftree-copyrename
7040 Perform copy renaming on trees.  This pass attempts to rename compiler
7041 temporaries to other variables at copy locations, usually resulting in
7042 variable names which more closely resemble the original variables.  This flag
7043 is enabled by default at @option{-O} and higher.
7045 @item -ftree-ter
7046 @opindex ftree-ter
7047 Perform temporary expression replacement during the SSA->normal phase.  Single
7048 use/single def temporaries are replaced at their use location with their
7049 defining expression.  This results in non-GIMPLE code, but gives the expanders
7050 much more complex trees to work on resulting in better RTL generation.  This is
7051 enabled by default at @option{-O} and higher.
7053 @item -ftree-vectorize
7054 @opindex ftree-vectorize
7055 Perform loop vectorization on trees. This flag is enabled by default at
7056 @option{-O3}.
7058 @item -ftree-slp-vectorize
7059 @opindex ftree-slp-vectorize
7060 Perform basic block vectorization on trees. This flag is enabled by default at
7061 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7063 @item -ftree-vect-loop-version
7064 @opindex ftree-vect-loop-version
7065 Perform loop versioning when doing loop vectorization on trees.  When a loop
7066 appears to be vectorizable except that data alignment or data dependence cannot
7067 be determined at compile time then vectorized and non-vectorized versions of
7068 the loop are generated along with runtime checks for alignment or dependence
7069 to control which version is executed.  This option is enabled by default
7070 except at level @option{-Os} where it is disabled.
7072 @item -fvect-cost-model
7073 @opindex fvect-cost-model
7074 Enable cost model for vectorization.
7076 @item -ftree-vrp
7077 @opindex ftree-vrp
7078 Perform Value Range Propagation on trees.  This is similar to the
7079 constant propagation pass, but instead of values, ranges of values are
7080 propagated.  This allows the optimizers to remove unnecessary range
7081 checks like array bound checks and null pointer checks.  This is
7082 enabled by default at @option{-O2} and higher.  Null pointer check
7083 elimination is only done if @option{-fdelete-null-pointer-checks} is
7084 enabled.
7086 @item -ftracer
7087 @opindex ftracer
7088 Perform tail duplication to enlarge superblock size.  This transformation
7089 simplifies the control flow of the function allowing other optimizations to do
7090 better job.
7092 @item -funroll-loops
7093 @opindex funroll-loops
7094 Unroll loops whose number of iterations can be determined at compile
7095 time or upon entry to the loop.  @option{-funroll-loops} implies
7096 @option{-frerun-cse-after-loop}.  This option makes code larger,
7097 and may or may not make it run faster.
7099 @item -funroll-all-loops
7100 @opindex funroll-all-loops
7101 Unroll all loops, even if their number of iterations is uncertain when
7102 the loop is entered.  This usually makes programs run more slowly.
7103 @option{-funroll-all-loops} implies the same options as
7104 @option{-funroll-loops},
7106 @item -fsplit-ivs-in-unroller
7107 @opindex fsplit-ivs-in-unroller
7108 Enables expressing of values of induction variables in later iterations
7109 of the unrolled loop using the value in the first iteration.  This breaks
7110 long dependency chains, thus improving efficiency of the scheduling passes.
7112 Combination of @option{-fweb} and CSE is often sufficient to obtain the
7113 same effect.  However in cases the loop body is more complicated than
7114 a single basic block, this is not reliable.  It also does not work at all
7115 on some of the architectures due to restrictions in the CSE pass.
7117 This optimization is enabled by default.
7119 @item -fvariable-expansion-in-unroller
7120 @opindex fvariable-expansion-in-unroller
7121 With this option, the compiler will create multiple copies of some
7122 local variables when unrolling a loop which can result in superior code.
7124 @item -fpartial-inlining
7125 @opindex fpartial-inlining
7126 Inline parts of functions.  This option has any effect only
7127 when inlining itself is turned on by the @option{-finline-functions}
7128 or @option{-finline-small-functions} options.
7130 Enabled at level @option{-O2}.
7132 @item -fpredictive-commoning
7133 @opindex fpredictive-commoning
7134 Perform predictive commoning optimization, i.e., reusing computations
7135 (especially memory loads and stores) performed in previous
7136 iterations of loops.
7138 This option is enabled at level @option{-O3}.
7140 @item -fprefetch-loop-arrays
7141 @opindex fprefetch-loop-arrays
7142 If supported by the target machine, generate instructions to prefetch
7143 memory to improve the performance of loops that access large arrays.
7145 This option may generate better or worse code; results are highly
7146 dependent on the structure of loops within the source code.
7148 Disabled at level @option{-Os}.
7150 @item -fno-peephole
7151 @itemx -fno-peephole2
7152 @opindex fno-peephole
7153 @opindex fno-peephole2
7154 Disable any machine-specific peephole optimizations.  The difference
7155 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7156 are implemented in the compiler; some targets use one, some use the
7157 other, a few use both.
7159 @option{-fpeephole} is enabled by default.
7160 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7162 @item -fno-guess-branch-probability
7163 @opindex fno-guess-branch-probability
7164 Do not guess branch probabilities using heuristics.
7166 GCC will use heuristics to guess branch probabilities if they are
7167 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7168 heuristics are based on the control flow graph.  If some branch probabilities
7169 are specified by @samp{__builtin_expect}, then the heuristics will be
7170 used to guess branch probabilities for the rest of the control flow graph,
7171 taking the @samp{__builtin_expect} info into account.  The interactions
7172 between the heuristics and @samp{__builtin_expect} can be complex, and in
7173 some cases, it may be useful to disable the heuristics so that the effects
7174 of @samp{__builtin_expect} are easier to understand.
7176 The default is @option{-fguess-branch-probability} at levels
7177 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7179 @item -freorder-blocks
7180 @opindex freorder-blocks
7181 Reorder basic blocks in the compiled function in order to reduce number of
7182 taken branches and improve code locality.
7184 Enabled at levels @option{-O2}, @option{-O3}.
7186 @item -freorder-blocks-and-partition
7187 @opindex freorder-blocks-and-partition
7188 In addition to reordering basic blocks in the compiled function, in order
7189 to reduce number of taken branches, partitions hot and cold basic blocks
7190 into separate sections of the assembly and .o files, to improve
7191 paging and cache locality performance.
7193 This optimization is automatically turned off in the presence of
7194 exception handling, for linkonce sections, for functions with a user-defined
7195 section attribute and on any architecture that does not support named
7196 sections.
7198 @item -freorder-functions
7199 @opindex freorder-functions
7200 Reorder functions in the object file in order to
7201 improve code locality.  This is implemented by using special
7202 subsections @code{.text.hot} for most frequently executed functions and
7203 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7204 the linker so object file format must support named sections and linker must
7205 place them in a reasonable way.
7207 Also profile feedback must be available in to make this option effective.  See
7208 @option{-fprofile-arcs} for details.
7210 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7212 @item -fstrict-aliasing
7213 @opindex fstrict-aliasing
7214 Allow the compiler to assume the strictest aliasing rules applicable to
7215 the language being compiled.  For C (and C++), this activates
7216 optimizations based on the type of expressions.  In particular, an
7217 object of one type is assumed never to reside at the same address as an
7218 object of a different type, unless the types are almost the same.  For
7219 example, an @code{unsigned int} can alias an @code{int}, but not a
7220 @code{void*} or a @code{double}.  A character type may alias any other
7221 type.
7223 @anchor{Type-punning}Pay special attention to code like this:
7224 @smallexample
7225 union a_union @{
7226   int i;
7227   double d;
7230 int f() @{
7231   union a_union t;
7232   t.d = 3.0;
7233   return t.i;
7235 @end smallexample
7236 The practice of reading from a different union member than the one most
7237 recently written to (called ``type-punning'') is common.  Even with
7238 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7239 is accessed through the union type.  So, the code above will work as
7240 expected.  @xref{Structures unions enumerations and bit-fields
7241 implementation}.  However, this code might not:
7242 @smallexample
7243 int f() @{
7244   union a_union t;
7245   int* ip;
7246   t.d = 3.0;
7247   ip = &t.i;
7248   return *ip;
7250 @end smallexample
7252 Similarly, access by taking the address, casting the resulting pointer
7253 and dereferencing the result has undefined behavior, even if the cast
7254 uses a union type, e.g.:
7255 @smallexample
7256 int f() @{
7257   double d = 3.0;
7258   return ((union a_union *) &d)->i;
7260 @end smallexample
7262 The @option{-fstrict-aliasing} option is enabled at levels
7263 @option{-O2}, @option{-O3}, @option{-Os}.
7265 @item -fstrict-overflow
7266 @opindex fstrict-overflow
7267 Allow the compiler to assume strict signed overflow rules, depending
7268 on the language being compiled.  For C (and C++) this means that
7269 overflow when doing arithmetic with signed numbers is undefined, which
7270 means that the compiler may assume that it will not happen.  This
7271 permits various optimizations.  For example, the compiler will assume
7272 that an expression like @code{i + 10 > i} will always be true for
7273 signed @code{i}.  This assumption is only valid if signed overflow is
7274 undefined, as the expression is false if @code{i + 10} overflows when
7275 using twos complement arithmetic.  When this option is in effect any
7276 attempt to determine whether an operation on signed numbers will
7277 overflow must be written carefully to not actually involve overflow.
7279 This option also allows the compiler to assume strict pointer
7280 semantics: given a pointer to an object, if adding an offset to that
7281 pointer does not produce a pointer to the same object, the addition is
7282 undefined.  This permits the compiler to conclude that @code{p + u >
7283 p} is always true for a pointer @code{p} and unsigned integer
7284 @code{u}.  This assumption is only valid because pointer wraparound is
7285 undefined, as the expression is false if @code{p + u} overflows using
7286 twos complement arithmetic.
7288 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7289 that integer signed overflow is fully defined: it wraps.  When
7290 @option{-fwrapv} is used, there is no difference between
7291 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7292 integers.  With @option{-fwrapv} certain types of overflow are
7293 permitted.  For example, if the compiler gets an overflow when doing
7294 arithmetic on constants, the overflowed value can still be used with
7295 @option{-fwrapv}, but not otherwise.
7297 The @option{-fstrict-overflow} option is enabled at levels
7298 @option{-O2}, @option{-O3}, @option{-Os}.
7300 @item -falign-functions
7301 @itemx -falign-functions=@var{n}
7302 @opindex falign-functions
7303 Align the start of functions to the next power-of-two greater than
7304 @var{n}, skipping up to @var{n} bytes.  For instance,
7305 @option{-falign-functions=32} aligns functions to the next 32-byte
7306 boundary, but @option{-falign-functions=24} would align to the next
7307 32-byte boundary only if this can be done by skipping 23 bytes or less.
7309 @option{-fno-align-functions} and @option{-falign-functions=1} are
7310 equivalent and mean that functions will not be aligned.
7312 Some assemblers only support this flag when @var{n} is a power of two;
7313 in that case, it is rounded up.
7315 If @var{n} is not specified or is zero, use a machine-dependent default.
7317 Enabled at levels @option{-O2}, @option{-O3}.
7319 @item -falign-labels
7320 @itemx -falign-labels=@var{n}
7321 @opindex falign-labels
7322 Align all branch targets to a power-of-two boundary, skipping up to
7323 @var{n} bytes like @option{-falign-functions}.  This option can easily
7324 make code slower, because it must insert dummy operations for when the
7325 branch target is reached in the usual flow of the code.
7327 @option{-fno-align-labels} and @option{-falign-labels=1} are
7328 equivalent and mean that labels will not be aligned.
7330 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7331 are greater than this value, then their values are used instead.
7333 If @var{n} is not specified or is zero, use a machine-dependent default
7334 which is very likely to be @samp{1}, meaning no alignment.
7336 Enabled at levels @option{-O2}, @option{-O3}.
7338 @item -falign-loops
7339 @itemx -falign-loops=@var{n}
7340 @opindex falign-loops
7341 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7342 like @option{-falign-functions}.  The hope is that the loop will be
7343 executed many times, which will make up for any execution of the dummy
7344 operations.
7346 @option{-fno-align-loops} and @option{-falign-loops=1} are
7347 equivalent and mean that loops will not be aligned.
7349 If @var{n} is not specified or is zero, use a machine-dependent default.
7351 Enabled at levels @option{-O2}, @option{-O3}.
7353 @item -falign-jumps
7354 @itemx -falign-jumps=@var{n}
7355 @opindex falign-jumps
7356 Align branch targets to a power-of-two boundary, for branch targets
7357 where the targets can only be reached by jumping, skipping up to @var{n}
7358 bytes like @option{-falign-functions}.  In this case, no dummy operations
7359 need be executed.
7361 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7362 equivalent and mean that loops will not be aligned.
7364 If @var{n} is not specified or is zero, use a machine-dependent default.
7366 Enabled at levels @option{-O2}, @option{-O3}.
7368 @item -funit-at-a-time
7369 @opindex funit-at-a-time
7370 This option is left for compatibility reasons. @option{-funit-at-a-time}
7371 has no effect, while @option{-fno-unit-at-a-time} implies
7372 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7374 Enabled by default.
7376 @item -fno-toplevel-reorder
7377 @opindex fno-toplevel-reorder
7378 Do not reorder top-level functions, variables, and @code{asm}
7379 statements.  Output them in the same order that they appear in the
7380 input file.  When this option is used, unreferenced static variables
7381 will not be removed.  This option is intended to support existing code
7382 which relies on a particular ordering.  For new code, it is better to
7383 use attributes.
7385 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7386 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7387 targets.
7389 @item -fweb
7390 @opindex fweb
7391 Constructs webs as commonly used for register allocation purposes and assign
7392 each web individual pseudo register.  This allows the register allocation pass
7393 to operate on pseudos directly, but also strengthens several other optimization
7394 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7395 however, make debugging impossible, since variables will no longer stay in a
7396 ``home register''.
7398 Enabled by default with @option{-funroll-loops}.
7400 @item -fwhole-program
7401 @opindex fwhole-program
7402 Assume that the current compilation unit represents the whole program being
7403 compiled.  All public functions and variables with the exception of @code{main}
7404 and those merged by attribute @code{externally_visible} become static functions
7405 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.
7406 While this option is equivalent to proper use of the @code{static} keyword for
7407 programs consisting of a single file, in combination with option
7408 @option{-flto} or @option{-fwhopr} this flag can be used to
7409 compile many smaller scale programs since the functions and variables become
7410 local for the whole combined compilation unit, not for the single source file
7411 itself.
7413 This option implies @option{-fwhole-file} for Fortran programs.
7415 @item -flto
7416 @opindex flto
7417 This option runs the standard link-time optimizer.  When invoked
7418 with source code, it generates GIMPLE (one of GCC's internal
7419 representations) and writes it to special ELF sections in the object
7420 file.  When the object files are linked together, all the function
7421 bodies are read from these ELF sections and instantiated as if they
7422 had been part of the same translation unit.
7424 To use the link-timer optimizer, @option{-flto} needs to be specified at
7425 compile time and during the final link.  For example,
7427 @smallexample
7428 gcc -c -O2 -flto foo.c
7429 gcc -c -O2 -flto bar.c
7430 gcc -o myprog -flto -O2 foo.o bar.o
7431 @end smallexample
7433 The first two invocations to GCC will save a bytecode representation
7434 of GIMPLE into special ELF sections inside @file{foo.o} and
7435 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7436 @file{foo.o} and @file{bar.o}, merge the two files into a single
7437 internal image, and compile the result as usual.  Since both
7438 @file{foo.o} and @file{bar.o} are merged into a single image, this
7439 causes all the inter-procedural analyses and optimizations in GCC to
7440 work across the two files as if they were a single one.  This means,
7441 for example, that the inliner will be able to inline functions in
7442 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7444 Another (simpler) way to enable link-time optimization is,
7446 @smallexample
7447 gcc -o myprog -flto -O2 foo.c bar.c
7448 @end smallexample
7450 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7451 merge them together into a single GIMPLE representation and optimize
7452 them as usual to produce @file{myprog}.
7454 The only important thing to keep in mind is that to enable link-time
7455 optimizations the @option{-flto} flag needs to be passed to both the
7456 compile and the link commands.
7458 Note that when a file is compiled with @option{-flto}, the generated
7459 object file will be larger than a regular object file because it will
7460 contain GIMPLE bytecodes and the usual final code.  This means that
7461 object files with LTO information can be linked as a normal object
7462 file.  So, in the previous example, if the final link is done with
7464 @smallexample
7465 gcc -o myprog foo.o bar.o
7466 @end smallexample
7468 The only difference will be that no inter-procedural optimizations
7469 will be applied to produce @file{myprog}.  The two object files
7470 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7471 linker.
7473 Additionally, the optimization flags used to compile individual files
7474 are not necessarily related to those used at link-time.  For instance,
7476 @smallexample
7477 gcc -c -O0 -flto foo.c
7478 gcc -c -O0 -flto bar.c
7479 gcc -o myprog -flto -O3 foo.o bar.o
7480 @end smallexample
7482 This will produce individual object files with unoptimized assembler
7483 code, but the resulting binary @file{myprog} will be optimized at
7484 @option{-O3}.  Now, if the final binary is generated without
7485 @option{-flto}, then @file{myprog} will not be optimized.
7487 When producing the final binary with @option{-flto}, GCC will only
7488 apply link-time optimizations to those files that contain bytecode.
7489 Therefore, you can mix and match object files and libraries with
7490 GIMPLE bytecodes and final object code.  GCC will automatically select
7491 which files to optimize in LTO mode and which files to link without
7492 further processing.
7494 There are some code generation flags that GCC will preserve when
7495 generating bytecodes, as they need to be used during the final link
7496 stage.  Currently, the following options are saved into the GIMPLE
7497 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7498 @option{-m} target flags.
7500 At link time, these options are read-in and reapplied.  Note that the
7501 current implementation makes no attempt at recognizing conflicting
7502 values for these options.  If two or more files have a conflicting
7503 value (e.g., one file is compiled with @option{-fPIC} and another
7504 isn't), the compiler will simply use the last value read from the
7505 bytecode files.  It is recommended, then, that all the files
7506 participating in the same link be compiled with the same options.
7508 Another feature of LTO is that it is possible to apply interprocedural
7509 optimizations on files written in different languages.  This requires
7510 some support in the language front end.  Currently, the C, C++ and
7511 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7512 something like this should work
7514 @smallexample
7515 gcc -c -flto foo.c
7516 g++ -c -flto bar.cc
7517 gfortran -c -flto baz.f90
7518 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7519 @end smallexample
7521 Notice that the final link is done with @command{g++} to get the C++
7522 runtime libraries and @option{-lgfortran} is added to get the Fortran
7523 runtime libraries.  In general, when mixing languages in LTO mode, you
7524 should use the same link command used when mixing languages in a
7525 regular (non-LTO) compilation.  This means that if your build process
7526 was mixing languages before, all you need to add is @option{-flto} to
7527 all the compile and link commands.
7529 If LTO encounters objects with C linkage declared with incompatible
7530 types in separate translation units to be linked together (undefined
7531 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
7532 issued.  The behavior is still undefined at runtime.
7534 If object files containing GIMPLE bytecode are stored in a library
7535 archive, say @file{libfoo.a}, it is possible to extract and use them
7536 in an LTO link if you are using @command{gold} as the linker (which,
7537 in turn requires GCC to be configured with @option{--enable-gold}).
7538 To enable this feature, use the flag @option{-fuse-linker-plugin} at
7539 link-time:
7541 @smallexample
7542 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7543 @end smallexample
7545 With the linker plugin enabled, @command{gold} will extract the needed
7546 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7547 to make them part of the aggregated GIMPLE image to be optimized.
7549 If you are not using @command{gold} and/or do not specify
7550 @option{-fuse-linker-plugin} then the objects inside @file{libfoo.a}
7551 will be extracted and linked as usual, but they will not participate
7552 in the LTO optimization process.
7554 Link time optimizations do not require the presence of the whole
7555 program to operate.  If the program does not require any symbols to
7556 be exported, it is possible to combine @option{-flto} and
7557 @option{-fwhopr} with @option{-fwhole-program} to allow the
7558 interprocedural optimizers to use more aggressive assumptions which
7559 may lead to improved optimization opportunities.
7561 Regarding portability: the current implementation of LTO makes no
7562 attempt at generating bytecode that can be ported between different
7563 types of hosts.  The bytecode files are versioned and there is a
7564 strict version check, so bytecode files generated in one version of
7565 GCC will not work with an older/newer version of GCC.
7567 Link time optimization does not play well with generating debugging
7568 information.  Combining @option{-flto} or @option{-fwhopr} with
7569 @option{-g} is experimental.
7571 This option is disabled by default.
7573 @item -fwhopr[=@var{n}]
7574 @opindex fwhopr
7575 This option is identical in functionality to @option{-flto} but it
7576 differs in how the final link stage is executed.  Instead of loading
7577 all the function bodies in memory, the callgraph is analyzed and
7578 optimization decisions are made (whole program analysis or WPA). Once
7579 optimization decisions are made, the callgraph is partitioned and the
7580 different sections are compiled separately (local transformations or
7581 LTRANS)@.  This process allows optimizations on very large programs
7582 that otherwise would not fit in memory.  This option enables
7583 @option{-fwpa} and @option{-fltrans} automatically.
7585 If you specify the optional @var{n} the link stage is executed in
7586 parallel using @var{n} parallel jobs by utilizing an installed
7587 @command{make} program.  The environment variable @env{MAKE} may be
7588 used to override the program used.
7590 You can also specify @option{-fwhopr=jobserver} to use GNU make's 
7591 job server mode to determine the number of parallel jobs. This 
7592 is useful when the Makefile calling GCC is already parallel.
7593 The parent Makefile will need a @samp{+} prepended to the command recipe
7594 for this to work. This will likely only work if @env{MAKE} is 
7595 GNU make.
7597 Disabled by default.
7599 @item -flto-partition=@var{alg}
7600 @opindex flto-partition
7601 Specify partitioning algorithm used by @option{-fwhopr} mode.  The value is
7602 either @code{1to1} to specify partitioning corresponding to source files
7603 or @code{balanced} to specify partitioning into, if possible, equally sized
7604 chunks.  The default value is @code{balanced}.
7606 @item -fwpa
7607 @opindex fwpa
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 whole-program-analysis
7612 (WPA) mode, which reads in summary information from all inputs and
7613 performs a whole-program analysis based on summary information only.
7614 It generates object files for subsequent runs of the link-time
7615 optimizer where individual object files are optimized using both
7616 summary information from the WPA mode and the actual function bodies.
7617 It then drives the LTRANS phase.
7619 Disabled by default.
7621 @item -fltrans
7622 @opindex fltrans
7623 This is an internal option used by GCC when compiling with
7624 @option{-fwhopr}.  You should never need to use it.
7626 This option runs the link-time optimizer in the local-transformation (LTRANS)
7627 mode, which reads in output from a previous run of the LTO in WPA mode.
7628 In the LTRANS mode, LTO optimizes an object and produces the final assembly.
7630 Disabled by default.
7632 @item -fltrans-output-list=@var{file}
7633 @opindex fltrans-output-list
7634 This is an internal option used by GCC when compiling with
7635 @option{-fwhopr}.  You should never need to use it.
7637 This option specifies a file to which the names of LTRANS output files are
7638 written.  This option is only meaningful in conjunction with @option{-fwpa}.
7640 Disabled by default.
7642 @item -flto-compression-level=@var{n}
7643 This option specifies the level of compression used for intermediate
7644 language written to LTO object files, and is only meaningful in
7645 conjunction with LTO mode (@option{-fwhopr}, @option{-flto}).  Valid
7646 values are 0 (no compression) to 9 (maximum compression).  Values
7647 outside this range are clamped to either 0 or 9.  If the option is not
7648 given, a default balanced compression setting is used.
7650 @item -flto-report
7651 Prints a report with internal details on the workings of the link-time
7652 optimizer.  The contents of this report vary from version to version,
7653 it is meant to be useful to GCC developers when processing object
7654 files in LTO mode (via @option{-fwhopr} or @option{-flto}).
7656 Disabled by default.
7658 @item -fuse-linker-plugin
7659 Enables the extraction of objects with GIMPLE bytecode information
7660 from library archives.  This option relies on features available only
7661 in @command{gold}, so to use this you must configure GCC with
7662 @option{--enable-gold}.  See @option{-flto} for a description on the
7663 effect of this flag and how to use it.
7665 Disabled by default.
7667 @item -fcprop-registers
7668 @opindex fcprop-registers
7669 After register allocation and post-register allocation instruction splitting,
7670 we perform a copy-propagation pass to try to reduce scheduling dependencies
7671 and occasionally eliminate the copy.
7673 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7675 @item -fprofile-correction
7676 @opindex fprofile-correction
7677 Profiles collected using an instrumented binary for multi-threaded programs may
7678 be inconsistent due to missed counter updates. When this option is specified,
7679 GCC will use heuristics to correct or smooth out such inconsistencies. By
7680 default, GCC will emit an error message when an inconsistent profile is detected.
7682 @item -fprofile-dir=@var{path}
7683 @opindex fprofile-dir
7685 Set the directory to search the profile data files in to @var{path}.
7686 This option affects only the profile data generated by
7687 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7688 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7689 and its related options.
7690 By default, GCC will use the current directory as @var{path}
7691 thus the profile data file will appear in the same directory as the object file.
7693 @item -fprofile-generate
7694 @itemx -fprofile-generate=@var{path}
7695 @opindex fprofile-generate
7697 Enable options usually used for instrumenting application to produce
7698 profile useful for later recompilation with profile feedback based
7699 optimization.  You must use @option{-fprofile-generate} both when
7700 compiling and when linking your program.
7702 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7704 If @var{path} is specified, GCC will look at the @var{path} to find
7705 the profile feedback data files. See @option{-fprofile-dir}.
7707 @item -fprofile-use
7708 @itemx -fprofile-use=@var{path}
7709 @opindex fprofile-use
7710 Enable profile feedback directed optimizations, and optimizations
7711 generally profitable only with profile feedback available.
7713 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7714 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7716 By default, GCC emits an error message if the feedback profiles do not
7717 match the source code.  This error can be turned into a warning by using
7718 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7719 code.
7721 If @var{path} is specified, GCC will look at the @var{path} to find
7722 the profile feedback data files. See @option{-fprofile-dir}.
7723 @end table
7725 The following options control compiler behavior regarding floating
7726 point arithmetic.  These options trade off between speed and
7727 correctness.  All must be specifically enabled.
7729 @table @gcctabopt
7730 @item -ffloat-store
7731 @opindex ffloat-store
7732 Do not store floating point variables in registers, and inhibit other
7733 options that might change whether a floating point value is taken from a
7734 register or memory.
7736 @cindex floating point precision
7737 This option prevents undesirable excess precision on machines such as
7738 the 68000 where the floating registers (of the 68881) keep more
7739 precision than a @code{double} is supposed to have.  Similarly for the
7740 x86 architecture.  For most programs, the excess precision does only
7741 good, but a few programs rely on the precise definition of IEEE floating
7742 point.  Use @option{-ffloat-store} for such programs, after modifying
7743 them to store all pertinent intermediate computations into variables.
7745 @item -fexcess-precision=@var{style}
7746 @opindex fexcess-precision
7747 This option allows further control over excess precision on machines
7748 where floating-point registers have more precision than the IEEE
7749 @code{float} and @code{double} types and the processor does not
7750 support operations rounding to those types.  By default,
7751 @option{-fexcess-precision=fast} is in effect; this means that
7752 operations are carried out in the precision of the registers and that
7753 it is unpredictable when rounding to the types specified in the source
7754 code takes place.  When compiling C, if
7755 @option{-fexcess-precision=standard} is specified then excess
7756 precision will follow the rules specified in ISO C99; in particular,
7757 both casts and assignments cause values to be rounded to their
7758 semantic types (whereas @option{-ffloat-store} only affects
7759 assignments).  This option is enabled by default for C if a strict
7760 conformance option such as @option{-std=c99} is used.
7762 @opindex mfpmath
7763 @option{-fexcess-precision=standard} is not implemented for languages
7764 other than C, and has no effect if
7765 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7766 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7767 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7768 semantics apply without excess precision, and in the latter, rounding
7769 is unpredictable.
7771 @item -ffast-math
7772 @opindex ffast-math
7773 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7774 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7775 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7777 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7779 This option is not turned on by any @option{-O} option since
7780 it can result in incorrect output for programs which depend on
7781 an exact implementation of IEEE or ISO rules/specifications for
7782 math functions. It may, however, yield faster code for programs
7783 that do not require the guarantees of these specifications.
7785 @item -fno-math-errno
7786 @opindex fno-math-errno
7787 Do not set ERRNO after calling math functions that are executed
7788 with a single instruction, e.g., sqrt.  A program that relies on
7789 IEEE exceptions for math error handling may want to use this flag
7790 for speed while maintaining IEEE arithmetic compatibility.
7792 This option is not turned on by any @option{-O} option since
7793 it can result in incorrect output for programs which depend on
7794 an exact implementation of IEEE or ISO rules/specifications for
7795 math functions. It may, however, yield faster code for programs
7796 that do not require the guarantees of these specifications.
7798 The default is @option{-fmath-errno}.
7800 On Darwin systems, the math library never sets @code{errno}.  There is
7801 therefore no reason for the compiler to consider the possibility that
7802 it might, and @option{-fno-math-errno} is the default.
7804 @item -funsafe-math-optimizations
7805 @opindex funsafe-math-optimizations
7807 Allow optimizations for floating-point arithmetic that (a) assume
7808 that arguments and results are valid and (b) may violate IEEE or
7809 ANSI standards.  When used at link-time, it may include libraries
7810 or startup files that change the default FPU control word or other
7811 similar optimizations.
7813 This option is not turned on by any @option{-O} option since
7814 it can result in incorrect output for programs which depend on
7815 an exact implementation of IEEE or ISO rules/specifications for
7816 math functions. It may, however, yield faster code for programs
7817 that do not require the guarantees of these specifications.
7818 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7819 @option{-fassociative-math} and @option{-freciprocal-math}.
7821 The default is @option{-fno-unsafe-math-optimizations}.
7823 @item -fassociative-math
7824 @opindex fassociative-math
7826 Allow re-association of operands in series of floating-point operations.
7827 This violates the ISO C and C++ language standard by possibly changing
7828 computation result.  NOTE: re-ordering may change the sign of zero as
7829 well as ignore NaNs and inhibit or create underflow or overflow (and
7830 thus cannot be used on a code which relies on rounding behavior like
7831 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7832 and thus may not be used when ordered comparisons are required.
7833 This option requires that both @option{-fno-signed-zeros} and
7834 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7835 much sense with @option{-frounding-math}. For Fortran the option
7836 is automatically enabled when both @option{-fno-signed-zeros} and
7837 @option{-fno-trapping-math} are in effect.
7839 The default is @option{-fno-associative-math}.
7841 @item -freciprocal-math
7842 @opindex freciprocal-math
7844 Allow the reciprocal of a value to be used instead of dividing by
7845 the value if this enables optimizations.  For example @code{x / y}
7846 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7847 is subject to common subexpression elimination.  Note that this loses
7848 precision and increases the number of flops operating on the value.
7850 The default is @option{-fno-reciprocal-math}.
7852 @item -ffinite-math-only
7853 @opindex ffinite-math-only
7854 Allow optimizations for floating-point arithmetic that assume
7855 that arguments and results are not NaNs or +-Infs.
7857 This option is not turned on by any @option{-O} option since
7858 it can result in incorrect output for programs which depend on
7859 an exact implementation of IEEE or ISO rules/specifications for
7860 math functions. It may, however, yield faster code for programs
7861 that do not require the guarantees of these specifications.
7863 The default is @option{-fno-finite-math-only}.
7865 @item -fno-signed-zeros
7866 @opindex fno-signed-zeros
7867 Allow optimizations for floating point arithmetic that ignore the
7868 signedness of zero.  IEEE arithmetic specifies the behavior of
7869 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7870 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7871 This option implies that the sign of a zero result isn't significant.
7873 The default is @option{-fsigned-zeros}.
7875 @item -fno-trapping-math
7876 @opindex fno-trapping-math
7877 Compile code assuming that floating-point operations cannot generate
7878 user-visible traps.  These traps include division by zero, overflow,
7879 underflow, inexact result and invalid operation.  This option requires
7880 that @option{-fno-signaling-nans} be in effect.  Setting this option may
7881 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7883 This option should never be turned on by any @option{-O} option since
7884 it can result in incorrect output for programs which depend on
7885 an exact implementation of IEEE or ISO rules/specifications for
7886 math functions.
7888 The default is @option{-ftrapping-math}.
7890 @item -frounding-math
7891 @opindex frounding-math
7892 Disable transformations and optimizations that assume default floating
7893 point rounding behavior.  This is round-to-zero for all floating point
7894 to integer conversions, and round-to-nearest for all other arithmetic
7895 truncations.  This option should be specified for programs that change
7896 the FP rounding mode dynamically, or that may be executed with a
7897 non-default rounding mode.  This option disables constant folding of
7898 floating point expressions at compile-time (which may be affected by
7899 rounding mode) and arithmetic transformations that are unsafe in the
7900 presence of sign-dependent rounding modes.
7902 The default is @option{-fno-rounding-math}.
7904 This option is experimental and does not currently guarantee to
7905 disable all GCC optimizations that are affected by rounding mode.
7906 Future versions of GCC may provide finer control of this setting
7907 using C99's @code{FENV_ACCESS} pragma.  This command line option
7908 will be used to specify the default state for @code{FENV_ACCESS}.
7910 @item -fsignaling-nans
7911 @opindex fsignaling-nans
7912 Compile code assuming that IEEE signaling NaNs may generate user-visible
7913 traps during floating-point operations.  Setting this option disables
7914 optimizations that may change the number of exceptions visible with
7915 signaling NaNs.  This option implies @option{-ftrapping-math}.
7917 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7918 be defined.
7920 The default is @option{-fno-signaling-nans}.
7922 This option is experimental and does not currently guarantee to
7923 disable all GCC optimizations that affect signaling NaN behavior.
7925 @item -fsingle-precision-constant
7926 @opindex fsingle-precision-constant
7927 Treat floating point constant as single precision constant instead of
7928 implicitly converting it to double precision constant.
7930 @item -fcx-limited-range
7931 @opindex fcx-limited-range
7932 When enabled, this option states that a range reduction step is not
7933 needed when performing complex division.  Also, there is no checking
7934 whether the result of a complex multiplication or division is @code{NaN
7935 + I*NaN}, with an attempt to rescue the situation in that case.  The
7936 default is @option{-fno-cx-limited-range}, but is enabled by
7937 @option{-ffast-math}.
7939 This option controls the default setting of the ISO C99
7940 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
7941 all languages.
7943 @item -fcx-fortran-rules
7944 @opindex fcx-fortran-rules
7945 Complex multiplication and division follow Fortran rules.  Range
7946 reduction is done as part of complex division, but there is no checking
7947 whether the result of a complex multiplication or division is @code{NaN
7948 + I*NaN}, with an attempt to rescue the situation in that case.
7950 The default is @option{-fno-cx-fortran-rules}.
7952 @end table
7954 The following options control optimizations that may improve
7955 performance, but are not enabled by any @option{-O} options.  This
7956 section includes experimental options that may produce broken code.
7958 @table @gcctabopt
7959 @item -fbranch-probabilities
7960 @opindex fbranch-probabilities
7961 After running a program compiled with @option{-fprofile-arcs}
7962 (@pxref{Debugging Options,, Options for Debugging Your Program or
7963 @command{gcc}}), you can compile it a second time using
7964 @option{-fbranch-probabilities}, to improve optimizations based on
7965 the number of times each branch was taken.  When the program
7966 compiled with @option{-fprofile-arcs} exits it saves arc execution
7967 counts to a file called @file{@var{sourcename}.gcda} for each source
7968 file.  The information in this data file is very dependent on the
7969 structure of the generated code, so you must use the same source code
7970 and the same optimization options for both compilations.
7972 With @option{-fbranch-probabilities}, GCC puts a
7973 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7974 These can be used to improve optimization.  Currently, they are only
7975 used in one place: in @file{reorg.c}, instead of guessing which path a
7976 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
7977 exactly determine which path is taken more often.
7979 @item -fprofile-values
7980 @opindex fprofile-values
7981 If combined with @option{-fprofile-arcs}, it adds code so that some
7982 data about values of expressions in the program is gathered.
7984 With @option{-fbranch-probabilities}, it reads back the data gathered
7985 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
7986 notes to instructions for their later usage in optimizations.
7988 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
7990 @item -fvpt
7991 @opindex fvpt
7992 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7993 a code to gather information about values of expressions.
7995 With @option{-fbranch-probabilities}, it reads back the data gathered
7996 and actually performs the optimizations based on them.
7997 Currently the optimizations include specialization of division operation
7998 using the knowledge about the value of the denominator.
8000 @item -frename-registers
8001 @opindex frename-registers
8002 Attempt to avoid false dependencies in scheduled code by making use
8003 of registers left over after register allocation.  This optimization
8004 will most benefit processors with lots of registers.  Depending on the
8005 debug information format adopted by the target, however, it can
8006 make debugging impossible, since variables will no longer stay in
8007 a ``home register''.
8009 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8011 @item -ftracer
8012 @opindex ftracer
8013 Perform tail duplication to enlarge superblock size.  This transformation
8014 simplifies the control flow of the function allowing other optimizations to do
8015 better job.
8017 Enabled with @option{-fprofile-use}.
8019 @item -funroll-loops
8020 @opindex funroll-loops
8021 Unroll loops whose number of iterations can be determined at compile time or
8022 upon entry to the loop.  @option{-funroll-loops} implies
8023 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8024 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8025 small constant number of iterations).  This option makes code larger, and may
8026 or may not make it run faster.
8028 Enabled with @option{-fprofile-use}.
8030 @item -funroll-all-loops
8031 @opindex funroll-all-loops
8032 Unroll all loops, even if their number of iterations is uncertain when
8033 the loop is entered.  This usually makes programs run more slowly.
8034 @option{-funroll-all-loops} implies the same options as
8035 @option{-funroll-loops}.
8037 @item -fpeel-loops
8038 @opindex fpeel-loops
8039 Peels the loops for that there is enough information that they do not
8040 roll much (from profile feedback).  It also turns on complete loop peeling
8041 (i.e.@: complete removal of loops with small constant number of iterations).
8043 Enabled with @option{-fprofile-use}.
8045 @item -fmove-loop-invariants
8046 @opindex fmove-loop-invariants
8047 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8048 at level @option{-O1}
8050 @item -funswitch-loops
8051 @opindex funswitch-loops
8052 Move branches with loop invariant conditions out of the loop, with duplicates
8053 of the loop on both branches (modified according to result of the condition).
8055 @item -ffunction-sections
8056 @itemx -fdata-sections
8057 @opindex ffunction-sections
8058 @opindex fdata-sections
8059 Place each function or data item into its own section in the output
8060 file if the target supports arbitrary sections.  The name of the
8061 function or the name of the data item determines the section's name
8062 in the output file.
8064 Use these options on systems where the linker can perform optimizations
8065 to improve locality of reference in the instruction space.  Most systems
8066 using the ELF object format and SPARC processors running Solaris 2 have
8067 linkers with such optimizations.  AIX may have these optimizations in
8068 the future.
8070 Only use these options when there are significant benefits from doing
8071 so.  When you specify these options, the assembler and linker will
8072 create larger object and executable files and will also be slower.
8073 You will not be able to use @code{gprof} on all systems if you
8074 specify this option and you may have problems with debugging if
8075 you specify both this option and @option{-g}.
8077 @item -fbranch-target-load-optimize
8078 @opindex fbranch-target-load-optimize
8079 Perform branch target register load optimization before prologue / epilogue
8080 threading.
8081 The use of target registers can typically be exposed only during reload,
8082 thus hoisting loads out of loops and doing inter-block scheduling needs
8083 a separate optimization pass.
8085 @item -fbranch-target-load-optimize2
8086 @opindex fbranch-target-load-optimize2
8087 Perform branch target register load optimization after prologue / epilogue
8088 threading.
8090 @item -fbtr-bb-exclusive
8091 @opindex fbtr-bb-exclusive
8092 When performing branch target register load optimization, don't reuse
8093 branch target registers in within any basic block.
8095 @item -fstack-protector
8096 @opindex fstack-protector
8097 Emit extra code to check for buffer overflows, such as stack smashing
8098 attacks.  This is done by adding a guard variable to functions with
8099 vulnerable objects.  This includes functions that call alloca, and
8100 functions with buffers larger than 8 bytes.  The guards are initialized
8101 when a function is entered and then checked when the function exits.
8102 If a guard check fails, an error message is printed and the program exits.
8104 @item -fstack-protector-all
8105 @opindex fstack-protector-all
8106 Like @option{-fstack-protector} except that all functions are protected.
8108 @item -fsection-anchors
8109 @opindex fsection-anchors
8110 Try to reduce the number of symbolic address calculations by using
8111 shared ``anchor'' symbols to address nearby objects.  This transformation
8112 can help to reduce the number of GOT entries and GOT accesses on some
8113 targets.
8115 For example, the implementation of the following function @code{foo}:
8117 @smallexample
8118 static int a, b, c;
8119 int foo (void) @{ return a + b + c; @}
8120 @end smallexample
8122 would usually calculate the addresses of all three variables, but if you
8123 compile it with @option{-fsection-anchors}, it will access the variables
8124 from a common anchor point instead.  The effect is similar to the
8125 following pseudocode (which isn't valid C):
8127 @smallexample
8128 int foo (void)
8130   register int *xr = &x;
8131   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8133 @end smallexample
8135 Not all targets support this option.
8137 @item --param @var{name}=@var{value}
8138 @opindex param
8139 In some places, GCC uses various constants to control the amount of
8140 optimization that is done.  For example, GCC will not inline functions
8141 that contain more that a certain number of instructions.  You can
8142 control some of these constants on the command-line using the
8143 @option{--param} option.
8145 The names of specific parameters, and the meaning of the values, are
8146 tied to the internals of the compiler, and are subject to change
8147 without notice in future releases.
8149 In each case, the @var{value} is an integer.  The allowable choices for
8150 @var{name} are given in the following table:
8152 @table @gcctabopt
8153 @item struct-reorg-cold-struct-ratio
8154 The threshold ratio (as a percentage) between a structure frequency
8155 and the frequency of the hottest structure in the program.  This parameter
8156 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
8157 We say that if the ratio of a structure frequency, calculated by profiling,
8158 to the hottest structure frequency in the program is less than this
8159 parameter, then structure reorganization is not applied to this structure.
8160 The default is 10.
8162 @item predictable-branch-outcome
8163 When branch is predicted to be taken with probability lower than this threshold
8164 (in percent), then it is considered well predictable. The default is 10.
8166 @item max-crossjump-edges
8167 The maximum number of incoming edges to consider for crossjumping.
8168 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8169 the number of edges incoming to each block.  Increasing values mean
8170 more aggressive optimization, making the compile time increase with
8171 probably small improvement in executable size.
8173 @item min-crossjump-insns
8174 The minimum number of instructions which must be matched at the end
8175 of two blocks before crossjumping will be performed on them.  This
8176 value is ignored in the case where all instructions in the block being
8177 crossjumped from are matched.  The default value is 5.
8179 @item max-grow-copy-bb-insns
8180 The maximum code size expansion factor when copying basic blocks
8181 instead of jumping.  The expansion is relative to a jump instruction.
8182 The default value is 8.
8184 @item max-goto-duplication-insns
8185 The maximum number of instructions to duplicate to a block that jumps
8186 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8187 passes, GCC factors computed gotos early in the compilation process,
8188 and unfactors them as late as possible.  Only computed jumps at the
8189 end of a basic blocks with no more than max-goto-duplication-insns are
8190 unfactored.  The default value is 8.
8192 @item max-delay-slot-insn-search
8193 The maximum number of instructions to consider when looking for an
8194 instruction to fill a delay slot.  If more than this arbitrary number of
8195 instructions is searched, the time savings from filling the delay slot
8196 will be minimal so stop searching.  Increasing values mean more
8197 aggressive optimization, making the compile time increase with probably
8198 small improvement in executable run time.
8200 @item max-delay-slot-live-search
8201 When trying to fill delay slots, the maximum number of instructions to
8202 consider when searching for a block with valid live register
8203 information.  Increasing this arbitrarily chosen value means more
8204 aggressive optimization, increasing the compile time.  This parameter
8205 should be removed when the delay slot code is rewritten to maintain the
8206 control-flow graph.
8208 @item max-gcse-memory
8209 The approximate maximum amount of memory that will be allocated in
8210 order to perform the global common subexpression elimination
8211 optimization.  If more memory than specified is required, the
8212 optimization will not be done.
8214 @item max-pending-list-length
8215 The maximum number of pending dependencies scheduling will allow
8216 before flushing the current state and starting over.  Large functions
8217 with few branches or calls can create excessively large lists which
8218 needlessly consume memory and resources.
8220 @item max-inline-insns-single
8221 Several parameters control the tree inliner used in gcc.
8222 This number sets the maximum number of instructions (counted in GCC's
8223 internal representation) in a single function that the tree inliner
8224 will consider for inlining.  This only affects functions declared
8225 inline and methods implemented in a class declaration (C++).
8226 The default value is 300.
8228 @item max-inline-insns-auto
8229 When you use @option{-finline-functions} (included in @option{-O3}),
8230 a lot of functions that would otherwise not be considered for inlining
8231 by the compiler will be investigated.  To those functions, a different
8232 (more restrictive) limit compared to functions declared inline can
8233 be applied.
8234 The default value is 40.
8236 @item large-function-insns
8237 The limit specifying really large functions.  For functions larger than this
8238 limit after inlining, inlining is constrained by
8239 @option{--param large-function-growth}.  This parameter is useful primarily
8240 to avoid extreme compilation time caused by non-linear algorithms used by the
8241 backend.
8242 The default value is 2700.
8244 @item large-function-growth
8245 Specifies maximal growth of large function caused by inlining in percents.
8246 The default value is 100 which limits large function growth to 2.0 times
8247 the original size.
8249 @item large-unit-insns
8250 The limit specifying large translation unit.  Growth caused by inlining of
8251 units larger than this limit is limited by @option{--param inline-unit-growth}.
8252 For small units this might be too tight (consider unit consisting of function A
8253 that is inline and B that just calls A three time.  If B is small relative to
8254 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8255 large units consisting of small inlineable functions however the overall unit
8256 growth limit is needed to avoid exponential explosion of code size.  Thus for
8257 smaller units, the size is increased to @option{--param large-unit-insns}
8258 before applying @option{--param inline-unit-growth}.  The default is 10000
8260 @item inline-unit-growth
8261 Specifies maximal overall growth of the compilation unit caused by inlining.
8262 The default value is 30 which limits unit growth to 1.3 times the original
8263 size.
8265 @item ipcp-unit-growth
8266 Specifies maximal overall growth of the compilation unit caused by
8267 interprocedural constant propagation.  The default value is 10 which limits
8268 unit growth to 1.1 times the original size.
8270 @item large-stack-frame
8271 The limit specifying large stack frames.  While inlining the algorithm is trying
8272 to not grow past this limit too much.  Default value is 256 bytes.
8274 @item large-stack-frame-growth
8275 Specifies maximal growth of large stack frames caused by inlining in percents.
8276 The default value is 1000 which limits large stack frame growth to 11 times
8277 the original size.
8279 @item max-inline-insns-recursive
8280 @itemx max-inline-insns-recursive-auto
8281 Specifies maximum number of instructions out-of-line copy of self recursive inline
8282 function can grow into by performing recursive inlining.
8284 For functions declared inline @option{--param max-inline-insns-recursive} is
8285 taken into account.  For function not declared inline, recursive inlining
8286 happens only when @option{-finline-functions} (included in @option{-O3}) is
8287 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8288 default value is 450.
8290 @item max-inline-recursive-depth
8291 @itemx max-inline-recursive-depth-auto
8292 Specifies maximum recursion depth used by the recursive inlining.
8294 For functions declared inline @option{--param max-inline-recursive-depth} is
8295 taken into account.  For function not declared inline, recursive inlining
8296 happens only when @option{-finline-functions} (included in @option{-O3}) is
8297 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8298 default value is 8.
8300 @item min-inline-recursive-probability
8301 Recursive inlining is profitable only for function having deep recursion
8302 in average and can hurt for function having little recursion depth by
8303 increasing the prologue size or complexity of function body to other
8304 optimizers.
8306 When profile feedback is available (see @option{-fprofile-generate}) the actual
8307 recursion depth can be guessed from probability that function will recurse via
8308 given call expression.  This parameter limits inlining only to call expression
8309 whose probability exceeds given threshold (in percents).  The default value is
8312 @item early-inlining-insns
8313 Specify growth that early inliner can make.  In effect it increases amount of
8314 inlining for code having large abstraction penalty.  The default value is 8.
8316 @item max-early-inliner-iterations
8317 @itemx max-early-inliner-iterations
8318 Limit of iterations of early inliner.  This basically bounds number of nested
8319 indirect calls early inliner can resolve.  Deeper chains are still handled by
8320 late inlining.
8322 @item min-vect-loop-bound
8323 The minimum number of iterations under which a loop will not get vectorized
8324 when @option{-ftree-vectorize} is used.  The number of iterations after
8325 vectorization needs to be greater than the value specified by this option
8326 to allow vectorization.  The default value is 0.
8328 @item gcse-cost-distance-ratio
8329 Scaling factor in calculation of maximum distance an expression
8330 can be moved by GCSE optimizations.  This is currently supported only in
8331 code hoisting pass.  The bigger the ratio, the more agressive code hoisting
8332 will be with simple expressions, i.e., the expressions which have cost
8333 less than @option{gcse-unrestricted-cost}.  Specifying 0 will disable
8334 hoisting of simple expressions.  The default value is 10.
8336 @item gcse-unrestricted-cost
8337 Cost, roughly measured as the cost of a single typical machine
8338 instruction, at which GCSE optimizations will not constrain
8339 the distance an expression can travel.  This is currently
8340 supported only in code hoisting pass.  The lesser the cost,
8341 the more aggressive code hoisting will be.  Specifying 0 will
8342 allow all expressions to travel unrestricted distances.
8343 The default value is 3.
8345 @item max-hoist-depth
8346 The depth of search in the dominator tree for expressions to hoist.
8347 This is used to avoid quadratic behavior in hoisting algorithm.
8348 The value of 0 will avoid limiting the search, but may slow down compilation
8349 of huge functions.  The default value is 30.
8351 @item max-unrolled-insns
8352 The maximum number of instructions that a loop should have if that loop
8353 is unrolled, and if the loop is unrolled, it determines how many times
8354 the loop code is unrolled.
8356 @item max-average-unrolled-insns
8357 The maximum number of instructions biased by probabilities of their execution
8358 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8359 it determines how many times the loop code is unrolled.
8361 @item max-unroll-times
8362 The maximum number of unrollings of a single loop.
8364 @item max-peeled-insns
8365 The maximum number of instructions that a loop should have if that loop
8366 is peeled, and if the loop is peeled, it determines how many times
8367 the loop code is peeled.
8369 @item max-peel-times
8370 The maximum number of peelings of a single loop.
8372 @item max-completely-peeled-insns
8373 The maximum number of insns of a completely peeled loop.
8375 @item max-completely-peel-times
8376 The maximum number of iterations of a loop to be suitable for complete peeling.
8378 @item max-completely-peel-loop-nest-depth
8379 The maximum depth of a loop nest suitable for complete peeling.
8381 @item max-unswitch-insns
8382 The maximum number of insns of an unswitched loop.
8384 @item max-unswitch-level
8385 The maximum number of branches unswitched in a single loop.
8387 @item lim-expensive
8388 The minimum cost of an expensive expression in the loop invariant motion.
8390 @item iv-consider-all-candidates-bound
8391 Bound on number of candidates for induction variables below that
8392 all candidates are considered for each use in induction variable
8393 optimizations.  Only the most relevant candidates are considered
8394 if there are more candidates, to avoid quadratic time complexity.
8396 @item iv-max-considered-uses
8397 The induction variable optimizations give up on loops that contain more
8398 induction variable uses.
8400 @item iv-always-prune-cand-set-bound
8401 If number of candidates in the set is smaller than this value,
8402 we always try to remove unnecessary ivs from the set during its
8403 optimization when a new iv is added to the set.
8405 @item scev-max-expr-size
8406 Bound on size of expressions used in the scalar evolutions analyzer.
8407 Large expressions slow the analyzer.
8409 @item omega-max-vars
8410 The maximum number of variables in an Omega constraint system.
8411 The default value is 128.
8413 @item omega-max-geqs
8414 The maximum number of inequalities in an Omega constraint system.
8415 The default value is 256.
8417 @item omega-max-eqs
8418 The maximum number of equalities in an Omega constraint system.
8419 The default value is 128.
8421 @item omega-max-wild-cards
8422 The maximum number of wildcard variables that the Omega solver will
8423 be able to insert.  The default value is 18.
8425 @item omega-hash-table-size
8426 The size of the hash table in the Omega solver.  The default value is
8427 550.
8429 @item omega-max-keys
8430 The maximal number of keys used by the Omega solver.  The default
8431 value is 500.
8433 @item omega-eliminate-redundant-constraints
8434 When set to 1, use expensive methods to eliminate all redundant
8435 constraints.  The default value is 0.
8437 @item vect-max-version-for-alignment-checks
8438 The maximum number of runtime checks that can be performed when
8439 doing loop versioning for alignment in the vectorizer.  See option
8440 ftree-vect-loop-version for more information.
8442 @item vect-max-version-for-alias-checks
8443 The maximum number of runtime checks that can be performed when
8444 doing loop versioning for alias in the vectorizer.  See option
8445 ftree-vect-loop-version for more information.
8447 @item max-iterations-to-track
8449 The maximum number of iterations of a loop the brute force algorithm
8450 for analysis of # of iterations of the loop tries to evaluate.
8452 @item hot-bb-count-fraction
8453 Select fraction of the maximal count of repetitions of basic block in program
8454 given basic block needs to have to be considered hot.
8456 @item hot-bb-frequency-fraction
8457 Select fraction of the maximal frequency of executions of basic block in
8458 function given basic block needs to have to be considered hot
8460 @item max-predicted-iterations
8461 The maximum number of loop iterations we predict statically.  This is useful
8462 in cases where function contain single loop with known bound and other loop
8463 with unknown.  We predict the known number of iterations correctly, while
8464 the unknown number of iterations average to roughly 10.  This means that the
8465 loop without bounds would appear artificially cold relative to the other one.
8467 @item align-threshold
8469 Select fraction of the maximal frequency of executions of basic block in
8470 function given basic block will get aligned.
8472 @item align-loop-iterations
8474 A loop expected to iterate at lest the selected number of iterations will get
8475 aligned.
8477 @item tracer-dynamic-coverage
8478 @itemx tracer-dynamic-coverage-feedback
8480 This value is used to limit superblock formation once the given percentage of
8481 executed instructions is covered.  This limits unnecessary code size
8482 expansion.
8484 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8485 feedback is available.  The real profiles (as opposed to statically estimated
8486 ones) are much less balanced allowing the threshold to be larger value.
8488 @item tracer-max-code-growth
8489 Stop tail duplication once code growth has reached given percentage.  This is
8490 rather hokey argument, as most of the duplicates will be eliminated later in
8491 cross jumping, so it may be set to much higher values than is the desired code
8492 growth.
8494 @item tracer-min-branch-ratio
8496 Stop reverse growth when the reverse probability of best edge is less than this
8497 threshold (in percent).
8499 @item tracer-min-branch-ratio
8500 @itemx tracer-min-branch-ratio-feedback
8502 Stop forward growth if the best edge do have probability lower than this
8503 threshold.
8505 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8506 compilation for profile feedback and one for compilation without.  The value
8507 for compilation with profile feedback needs to be more conservative (higher) in
8508 order to make tracer effective.
8510 @item max-cse-path-length
8512 Maximum number of basic blocks on path that cse considers.  The default is 10.
8514 @item max-cse-insns
8515 The maximum instructions CSE process before flushing. The default is 1000.
8517 @item ggc-min-expand
8519 GCC uses a garbage collector to manage its own memory allocation.  This
8520 parameter specifies the minimum percentage by which the garbage
8521 collector's heap should be allowed to expand between collections.
8522 Tuning this may improve compilation speed; it has no effect on code
8523 generation.
8525 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8526 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8527 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8528 GCC is not able to calculate RAM on a particular platform, the lower
8529 bound of 30% is used.  Setting this parameter and
8530 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8531 every opportunity.  This is extremely slow, but can be useful for
8532 debugging.
8534 @item ggc-min-heapsize
8536 Minimum size of the garbage collector's heap before it begins bothering
8537 to collect garbage.  The first collection occurs after the heap expands
8538 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8539 tuning this may improve compilation speed, and has no effect on code
8540 generation.
8542 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8543 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8544 with a lower bound of 4096 (four megabytes) and an upper bound of
8545 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8546 particular platform, the lower bound is used.  Setting this parameter
8547 very large effectively disables garbage collection.  Setting this
8548 parameter and @option{ggc-min-expand} to zero causes a full collection
8549 to occur at every opportunity.
8551 @item max-reload-search-insns
8552 The maximum number of instruction reload should look backward for equivalent
8553 register.  Increasing values mean more aggressive optimization, making the
8554 compile time increase with probably slightly better performance.  The default
8555 value is 100.
8557 @item max-cselib-memory-locations
8558 The maximum number of memory locations cselib should take into account.
8559 Increasing values mean more aggressive optimization, making the compile time
8560 increase with probably slightly better performance.  The default value is 500.
8562 @item reorder-blocks-duplicate
8563 @itemx reorder-blocks-duplicate-feedback
8565 Used by basic block reordering pass to decide whether to use unconditional
8566 branch or duplicate the code on its destination.  Code is duplicated when its
8567 estimated size is smaller than this value multiplied by the estimated size of
8568 unconditional jump in the hot spots of the program.
8570 The @option{reorder-block-duplicate-feedback} is used only when profile
8571 feedback is available and may be set to higher values than
8572 @option{reorder-block-duplicate} since information about the hot spots is more
8573 accurate.
8575 @item max-sched-ready-insns
8576 The maximum number of instructions ready to be issued the scheduler should
8577 consider at any given time during the first scheduling pass.  Increasing
8578 values mean more thorough searches, making the compilation time increase
8579 with probably little benefit.  The default value is 100.
8581 @item max-sched-region-blocks
8582 The maximum number of blocks in a region to be considered for
8583 interblock scheduling.  The default value is 10.
8585 @item max-pipeline-region-blocks
8586 The maximum number of blocks in a region to be considered for
8587 pipelining in the selective scheduler.  The default value is 15.
8589 @item max-sched-region-insns
8590 The maximum number of insns in a region to be considered for
8591 interblock scheduling.  The default value is 100.
8593 @item max-pipeline-region-insns
8594 The maximum number of insns in a region to be considered for
8595 pipelining in the selective scheduler.  The default value is 200.
8597 @item min-spec-prob
8598 The minimum probability (in percents) of reaching a source block
8599 for interblock speculative scheduling.  The default value is 40.
8601 @item max-sched-extend-regions-iters
8602 The maximum number of iterations through CFG to extend regions.
8603 0 - disable region extension,
8604 N - do at most N iterations.
8605 The default value is 0.
8607 @item max-sched-insn-conflict-delay
8608 The maximum conflict delay for an insn to be considered for speculative motion.
8609 The default value is 3.
8611 @item sched-spec-prob-cutoff
8612 The minimal probability of speculation success (in percents), so that
8613 speculative insn will be scheduled.
8614 The default value is 40.
8616 @item sched-mem-true-dep-cost
8617 Minimal distance (in CPU cycles) between store and load targeting same
8618 memory locations.  The default value is 1.
8620 @item selsched-max-lookahead
8621 The maximum size of the lookahead window of selective scheduling.  It is a
8622 depth of search for available instructions.
8623 The default value is 50.
8625 @item selsched-max-sched-times
8626 The maximum number of times that an instruction will be scheduled during
8627 selective scheduling.  This is the limit on the number of iterations
8628 through which the instruction may be pipelined.  The default value is 2.
8630 @item selsched-max-insns-to-rename
8631 The maximum number of best instructions in the ready list that are considered
8632 for renaming in the selective scheduler.  The default value is 2.
8634 @item max-last-value-rtl
8635 The maximum size measured as number of RTLs that can be recorded in an expression
8636 in combiner for a pseudo register as last known value of that register.  The default
8637 is 10000.
8639 @item integer-share-limit
8640 Small integer constants can use a shared data structure, reducing the
8641 compiler's memory usage and increasing its speed.  This sets the maximum
8642 value of a shared integer constant.  The default value is 256.
8644 @item min-virtual-mappings
8645 Specifies the minimum number of virtual mappings in the incremental
8646 SSA updater that should be registered to trigger the virtual mappings
8647 heuristic defined by virtual-mappings-ratio.  The default value is
8648 100.
8650 @item virtual-mappings-ratio
8651 If the number of virtual mappings is virtual-mappings-ratio bigger
8652 than the number of virtual symbols to be updated, then the incremental
8653 SSA updater switches to a full update for those symbols.  The default
8654 ratio is 3.
8656 @item ssp-buffer-size
8657 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8658 protection when @option{-fstack-protection} is used.
8660 @item max-jump-thread-duplication-stmts
8661 Maximum number of statements allowed in a block that needs to be
8662 duplicated when threading jumps.
8664 @item max-fields-for-field-sensitive
8665 Maximum number of fields in a structure we will treat in
8666 a field sensitive manner during pointer analysis.  The default is zero
8667 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8669 @item prefetch-latency
8670 Estimate on average number of instructions that are executed before
8671 prefetch finishes.  The distance we prefetch ahead is proportional
8672 to this constant.  Increasing this number may also lead to less
8673 streams being prefetched (see @option{simultaneous-prefetches}).
8675 @item simultaneous-prefetches
8676 Maximum number of prefetches that can run at the same time.
8678 @item l1-cache-line-size
8679 The size of cache line in L1 cache, in bytes.
8681 @item l1-cache-size
8682 The size of L1 cache, in kilobytes.
8684 @item l2-cache-size
8685 The size of L2 cache, in kilobytes.
8687 @item min-insn-to-prefetch-ratio
8688 The minimum ratio between the number of instructions and the
8689 number of prefetches to enable prefetching in a loop.
8691 @item prefetch-min-insn-to-mem-ratio
8692 The minimum ratio between the number of instructions and the
8693 number of memory references to enable prefetching in a loop.
8695 @item use-canonical-types
8696 Whether the compiler should use the ``canonical'' type system.  By
8697 default, this should always be 1, which uses a more efficient internal
8698 mechanism for comparing types in C++ and Objective-C++.  However, if
8699 bugs in the canonical type system are causing compilation failures,
8700 set this value to 0 to disable canonical types.
8702 @item switch-conversion-max-branch-ratio
8703 Switch initialization conversion will refuse to create arrays that are
8704 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8705 branches in the switch.
8707 @item max-partial-antic-length
8708 Maximum length of the partial antic set computed during the tree
8709 partial redundancy elimination optimization (@option{-ftree-pre}) when
8710 optimizing at @option{-O3} and above.  For some sorts of source code
8711 the enhanced partial redundancy elimination optimization can run away,
8712 consuming all of the memory available on the host machine.  This
8713 parameter sets a limit on the length of the sets that are computed,
8714 which prevents the runaway behavior.  Setting a value of 0 for
8715 this parameter will allow an unlimited set length.
8717 @item sccvn-max-scc-size
8718 Maximum size of a strongly connected component (SCC) during SCCVN
8719 processing.  If this limit is hit, SCCVN processing for the whole
8720 function will not be done and optimizations depending on it will
8721 be disabled.  The default maximum SCC size is 10000.
8723 @item ira-max-loops-num
8724 IRA uses a regional register allocation by default.  If a function
8725 contains loops more than number given by the parameter, only at most
8726 given number of the most frequently executed loops will form regions
8727 for the regional register allocation.  The default value of the
8728 parameter is 100.
8730 @item ira-max-conflict-table-size
8731 Although IRA uses a sophisticated algorithm of compression conflict
8732 table, the table can be still big for huge functions.  If the conflict
8733 table for a function could be more than size in MB given by the
8734 parameter, the conflict table is not built and faster, simpler, and
8735 lower quality register allocation algorithm will be used.  The
8736 algorithm do not use pseudo-register conflicts.  The default value of
8737 the parameter is 2000.
8739 @item ira-loop-reserved-regs
8740 IRA can be used to evaluate more accurate register pressure in loops
8741 for decision to move loop invariants (see @option{-O3}).  The number
8742 of available registers reserved for some other purposes is described
8743 by this parameter.  The default value of the parameter is 2 which is
8744 minimal number of registers needed for execution of typical
8745 instruction.  This value is the best found from numerous experiments.
8747 @item loop-invariant-max-bbs-in-loop
8748 Loop invariant motion can be very expensive, both in compile time and
8749 in amount of needed compile time memory, with very large loops.  Loops
8750 with more basic blocks than this parameter won't have loop invariant
8751 motion optimization performed on them.  The default value of the
8752 parameter is 1000 for -O1 and 10000 for -O2 and above.
8754 @item max-vartrack-size
8755 Sets a maximum number of hash table slots to use during variable
8756 tracking dataflow analysis of any function.  If this limit is exceeded
8757 with variable tracking at assignments enabled, analysis for that
8758 function is retried without it, after removing all debug insns from
8759 the function.  If the limit is exceeded even without debug insns, var
8760 tracking analysis is completely disabled for the function.  Setting
8761 the parameter to zero makes it unlimited.
8763 @item min-nondebug-insn-uid
8764 Use uids starting at this parameter for nondebug insns.  The range below
8765 the parameter is reserved exclusively for debug insns created by
8766 @option{-fvar-tracking-assignments}, but debug insns may get
8767 (non-overlapping) uids above it if the reserved range is exhausted.
8769 @item ipa-sra-ptr-growth-factor
8770 IPA-SRA will replace a pointer to an aggregate with one or more new
8771 parameters only when their cumulative size is less or equal to
8772 @option{ipa-sra-ptr-growth-factor} times the size of the original
8773 pointer parameter.
8775 @item graphite-max-nb-scop-params
8776 To avoid exponential effects in the Graphite loop transforms, the
8777 number of parameters in a Static Control Part (SCoP) is bounded.  The
8778 default value is 10 parameters.  A variable whose value is unknown at
8779 compile time and defined outside a SCoP is a parameter of the SCoP.
8781 @item graphite-max-bbs-per-function
8782 To avoid exponential effects in the detection of SCoPs, the size of
8783 the functions analyzed by Graphite is bounded.  The default value is
8784 100 basic blocks.
8786 @item loop-block-tile-size
8787 Loop blocking or strip mining transforms, enabled with
8788 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
8789 loop in the loop nest by a given number of iterations.  The strip
8790 length can be changed using the @option{loop-block-tile-size}
8791 parameter.  The default value is 51 iterations.
8793 @item devirt-type-list-size
8794 IPA-CP attempts to track all possible types passed to a function's
8795 parameter in order to perform devirtualization.
8796 @option{devirt-type-list-size} is the maximum number of types it
8797 stores per a single formal parameter of a function.
8799 @item lto-partitions
8800 Specify desired nuber of partitions produced during WHOPR copmilation.
8801 Number of partitions should exceed number of CPUs used for compilatoin.
8802 Default value is 32.
8804 @item lto-minpartition
8805 Size of minimal paritition for WHOPR (in estimated instructions).
8806 This prevents expenses of splitting very small programs into too many
8807 partitions.
8809 @end table
8810 @end table
8812 @node Preprocessor Options
8813 @section Options Controlling the Preprocessor
8814 @cindex preprocessor options
8815 @cindex options, preprocessor
8817 These options control the C preprocessor, which is run on each C source
8818 file before actual compilation.
8820 If you use the @option{-E} option, nothing is done except preprocessing.
8821 Some of these options make sense only together with @option{-E} because
8822 they cause the preprocessor output to be unsuitable for actual
8823 compilation.
8825 @table @gcctabopt
8826 @item -Wp,@var{option}
8827 @opindex Wp
8828 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8829 and pass @var{option} directly through to the preprocessor.  If
8830 @var{option} contains commas, it is split into multiple options at the
8831 commas.  However, many options are modified, translated or interpreted
8832 by the compiler driver before being passed to the preprocessor, and
8833 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8834 interface is undocumented and subject to change, so whenever possible
8835 you should avoid using @option{-Wp} and let the driver handle the
8836 options instead.
8838 @item -Xpreprocessor @var{option}
8839 @opindex Xpreprocessor
8840 Pass @var{option} as an option to the preprocessor.  You can use this to
8841 supply system-specific preprocessor options which GCC does not know how to
8842 recognize.
8844 If you want to pass an option that takes an argument, you must use
8845 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8846 @end table
8848 @include cppopts.texi
8850 @node Assembler Options
8851 @section Passing Options to the Assembler
8853 @c prevent bad page break with this line
8854 You can pass options to the assembler.
8856 @table @gcctabopt
8857 @item -Wa,@var{option}
8858 @opindex Wa
8859 Pass @var{option} as an option to the assembler.  If @var{option}
8860 contains commas, it is split into multiple options at the commas.
8862 @item -Xassembler @var{option}
8863 @opindex Xassembler
8864 Pass @var{option} as an option to the assembler.  You can use this to
8865 supply system-specific assembler options which GCC does not know how to
8866 recognize.
8868 If you want to pass an option that takes an argument, you must use
8869 @option{-Xassembler} twice, once for the option and once for the argument.
8871 @end table
8873 @node Link Options
8874 @section Options for Linking
8875 @cindex link options
8876 @cindex options, linking
8878 These options come into play when the compiler links object files into
8879 an executable output file.  They are meaningless if the compiler is
8880 not doing a link step.
8882 @table @gcctabopt
8883 @cindex file names
8884 @item @var{object-file-name}
8885 A file name that does not end in a special recognized suffix is
8886 considered to name an object file or library.  (Object files are
8887 distinguished from libraries by the linker according to the file
8888 contents.)  If linking is done, these object files are used as input
8889 to the linker.
8891 @item -c
8892 @itemx -S
8893 @itemx -E
8894 @opindex c
8895 @opindex S
8896 @opindex E
8897 If any of these options is used, then the linker is not run, and
8898 object file names should not be used as arguments.  @xref{Overall
8899 Options}.
8901 @cindex Libraries
8902 @item -l@var{library}
8903 @itemx -l @var{library}
8904 @opindex l
8905 Search the library named @var{library} when linking.  (The second
8906 alternative with the library as a separate argument is only for
8907 POSIX compliance and is not recommended.)
8909 It makes a difference where in the command you write this option; the
8910 linker searches and processes libraries and object files in the order they
8911 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8912 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8913 to functions in @samp{z}, those functions may not be loaded.
8915 The linker searches a standard list of directories for the library,
8916 which is actually a file named @file{lib@var{library}.a}.  The linker
8917 then uses this file as if it had been specified precisely by name.
8919 The directories searched include several standard system directories
8920 plus any that you specify with @option{-L}.
8922 Normally the files found this way are library files---archive files
8923 whose members are object files.  The linker handles an archive file by
8924 scanning through it for members which define symbols that have so far
8925 been referenced but not defined.  But if the file that is found is an
8926 ordinary object file, it is linked in the usual fashion.  The only
8927 difference between using an @option{-l} option and specifying a file name
8928 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8929 and searches several directories.
8931 @item -lobjc
8932 @opindex lobjc
8933 You need this special case of the @option{-l} option in order to
8934 link an Objective-C or Objective-C++ program.
8936 @item -nostartfiles
8937 @opindex nostartfiles
8938 Do not use the standard system startup files when linking.
8939 The standard system libraries are used normally, unless @option{-nostdlib}
8940 or @option{-nodefaultlibs} is used.
8942 @item -nodefaultlibs
8943 @opindex nodefaultlibs
8944 Do not use the standard system libraries when linking.
8945 Only the libraries you specify will be passed to the linker, options
8946 specifying linkage of the system libraries, such as @code{-static-libgcc}
8947 or @code{-shared-libgcc}, will be ignored.
8948 The standard startup files are used normally, unless @option{-nostartfiles}
8949 is used.  The compiler may generate calls to @code{memcmp},
8950 @code{memset}, @code{memcpy} and @code{memmove}.
8951 These entries are usually resolved by entries in
8952 libc.  These entry points should be supplied through some other
8953 mechanism when this option is specified.
8955 @item -nostdlib
8956 @opindex nostdlib
8957 Do not use the standard system startup files or libraries when linking.
8958 No startup files and only the libraries you specify will be passed to
8959 the linker, options specifying linkage of the system libraries, such as
8960 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8961 The compiler may generate calls to @code{memcmp}, @code{memset},
8962 @code{memcpy} and @code{memmove}.
8963 These entries are usually resolved by entries in
8964 libc.  These entry points should be supplied through some other
8965 mechanism when this option is specified.
8967 @cindex @option{-lgcc}, use with @option{-nostdlib}
8968 @cindex @option{-nostdlib} and unresolved references
8969 @cindex unresolved references and @option{-nostdlib}
8970 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8971 @cindex @option{-nodefaultlibs} and unresolved references
8972 @cindex unresolved references and @option{-nodefaultlibs}
8973 One of the standard libraries bypassed by @option{-nostdlib} and
8974 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8975 that GCC uses to overcome shortcomings of particular machines, or special
8976 needs for some languages.
8977 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8978 Collection (GCC) Internals},
8979 for more discussion of @file{libgcc.a}.)
8980 In most cases, you need @file{libgcc.a} even when you want to avoid
8981 other standard libraries.  In other words, when you specify @option{-nostdlib}
8982 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8983 This ensures that you have no unresolved references to internal GCC
8984 library subroutines.  (For example, @samp{__main}, used to ensure C++
8985 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8986 GNU Compiler Collection (GCC) Internals}.)
8988 @item -pie
8989 @opindex pie
8990 Produce a position independent executable on targets which support it.
8991 For predictable results, you must also specify the same set of options
8992 that were used to generate code (@option{-fpie}, @option{-fPIE},
8993 or model suboptions) when you specify this option.
8995 @item -rdynamic
8996 @opindex rdynamic
8997 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8998 that support it. This instructs the linker to add all symbols, not
8999 only used ones, to the dynamic symbol table. This option is needed
9000 for some uses of @code{dlopen} or to allow obtaining backtraces
9001 from within a program.
9003 @item -s
9004 @opindex s
9005 Remove all symbol table and relocation information from the executable.
9007 @item -static
9008 @opindex static
9009 On systems that support dynamic linking, this prevents linking with the shared
9010 libraries.  On other systems, this option has no effect.
9012 @item -shared
9013 @opindex shared
9014 Produce a shared object which can then be linked with other objects to
9015 form an executable.  Not all systems support this option.  For predictable
9016 results, you must also specify the same set of options that were used to
9017 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
9018 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
9019 needs to build supplementary stub code for constructors to work.  On
9020 multi-libbed systems, @samp{gcc -shared} must select the correct support
9021 libraries to link against.  Failing to supply the correct flags may lead
9022 to subtle defects.  Supplying them in cases where they are not necessary
9023 is innocuous.}
9025 @item -shared-libgcc
9026 @itemx -static-libgcc
9027 @opindex shared-libgcc
9028 @opindex static-libgcc
9029 On systems that provide @file{libgcc} as a shared library, these options
9030 force the use of either the shared or static version respectively.
9031 If no shared version of @file{libgcc} was built when the compiler was
9032 configured, these options have no effect.
9034 There are several situations in which an application should use the
9035 shared @file{libgcc} instead of the static version.  The most common
9036 of these is when the application wishes to throw and catch exceptions
9037 across different shared libraries.  In that case, each of the libraries
9038 as well as the application itself should use the shared @file{libgcc}.
9040 Therefore, the G++ and GCJ drivers automatically add
9041 @option{-shared-libgcc} whenever you build a shared library or a main
9042 executable, because C++ and Java programs typically use exceptions, so
9043 this is the right thing to do.
9045 If, instead, you use the GCC driver to create shared libraries, you may
9046 find that they will not always be linked with the shared @file{libgcc}.
9047 If GCC finds, at its configuration time, that you have a non-GNU linker
9048 or a GNU linker that does not support option @option{--eh-frame-hdr},
9049 it will link the shared version of @file{libgcc} into shared libraries
9050 by default.  Otherwise, it will take advantage of the linker and optimize
9051 away the linking with the shared version of @file{libgcc}, linking with
9052 the static version of libgcc by default.  This allows exceptions to
9053 propagate through such shared libraries, without incurring relocation
9054 costs at library load time.
9056 However, if a library or main executable is supposed to throw or catch
9057 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9058 for the languages used in the program, or using the option
9059 @option{-shared-libgcc}, such that it is linked with the shared
9060 @file{libgcc}.
9062 @item -static-libstdc++
9063 When the @command{g++} program is used to link a C++ program, it will
9064 normally automatically link against @option{libstdc++}.  If
9065 @file{libstdc++} is available as a shared library, and the
9066 @option{-static} option is not used, then this will link against the
9067 shared version of @file{libstdc++}.  That is normally fine.  However, it
9068 is sometimes useful to freeze the version of @file{libstdc++} used by
9069 the program without going all the way to a fully static link.  The
9070 @option{-static-libstdc++} option directs the @command{g++} driver to
9071 link @file{libstdc++} statically, without necessarily linking other
9072 libraries statically.
9074 @item -symbolic
9075 @opindex symbolic
9076 Bind references to global symbols when building a shared object.  Warn
9077 about any unresolved references (unless overridden by the link editor
9078 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
9079 this option.
9081 @item -T @var{script}
9082 @opindex T
9083 @cindex linker script
9084 Use @var{script} as the linker script.  This option is supported by most
9085 systems using the GNU linker.  On some targets, such as bare-board
9086 targets without an operating system, the @option{-T} option may be required
9087 when linking to avoid references to undefined symbols.
9089 @item -Xlinker @var{option}
9090 @opindex Xlinker
9091 Pass @var{option} as an option to the linker.  You can use this to
9092 supply system-specific linker options which GCC does not know how to
9093 recognize.
9095 If you want to pass an option that takes a separate argument, you must use
9096 @option{-Xlinker} twice, once for the option and once for the argument.
9097 For example, to pass @option{-assert definitions}, you must write
9098 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
9099 @option{-Xlinker "-assert definitions"}, because this passes the entire
9100 string as a single argument, which is not what the linker expects.
9102 When using the GNU linker, it is usually more convenient to pass
9103 arguments to linker options using the @option{@var{option}=@var{value}}
9104 syntax than as separate arguments.  For example, you can specify
9105 @samp{-Xlinker -Map=output.map} rather than
9106 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
9107 this syntax for command-line options.
9109 @item -Wl,@var{option}
9110 @opindex Wl
9111 Pass @var{option} as an option to the linker.  If @var{option} contains
9112 commas, it is split into multiple options at the commas.  You can use this
9113 syntax to pass an argument to the option.
9114 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
9115 linker.  When using the GNU linker, you can also get the same effect with
9116 @samp{-Wl,-Map=output.map}.
9118 @item -u @var{symbol}
9119 @opindex u
9120 Pretend the symbol @var{symbol} is undefined, to force linking of
9121 library modules to define it.  You can use @option{-u} multiple times with
9122 different symbols to force loading of additional library modules.
9123 @end table
9125 @node Directory Options
9126 @section Options for Directory Search
9127 @cindex directory options
9128 @cindex options, directory search
9129 @cindex search path
9131 These options specify directories to search for header files, for
9132 libraries and for parts of the compiler:
9134 @table @gcctabopt
9135 @item -I@var{dir}
9136 @opindex I
9137 Add the directory @var{dir} to the head of the list of directories to be
9138 searched for header files.  This can be used to override a system header
9139 file, substituting your own version, since these directories are
9140 searched before the system header file directories.  However, you should
9141 not use this option to add directories that contain vendor-supplied
9142 system header files (use @option{-isystem} for that).  If you use more than
9143 one @option{-I} option, the directories are scanned in left-to-right
9144 order; the standard system directories come after.
9146 If a standard system include directory, or a directory specified with
9147 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9148 option will be ignored.  The directory will still be searched but as a
9149 system directory at its normal position in the system include chain.
9150 This is to ensure that GCC's procedure to fix buggy system headers and
9151 the ordering for the include_next directive are not inadvertently changed.
9152 If you really need to change the search order for system directories,
9153 use the @option{-nostdinc} and/or @option{-isystem} options.
9155 @item -iplugindir=@var{dir}
9156 Set the directory to search for plugins which are passed
9157 by @option{-fplugin=@var{name}} instead of
9158 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
9159 to be used by the user, but only passed by the driver.
9161 @item -iquote@var{dir}
9162 @opindex iquote
9163 Add the directory @var{dir} to the head of the list of directories to
9164 be searched for header files only for the case of @samp{#include
9165 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9166 otherwise just like @option{-I}.
9168 @item -L@var{dir}
9169 @opindex L
9170 Add directory @var{dir} to the list of directories to be searched
9171 for @option{-l}.
9173 @item -B@var{prefix}
9174 @opindex B
9175 This option specifies where to find the executables, libraries,
9176 include files, and data files of the compiler itself.
9178 The compiler driver program runs one or more of the subprograms
9179 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
9180 @var{prefix} as a prefix for each program it tries to run, both with and
9181 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9183 For each subprogram to be run, the compiler driver first tries the
9184 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
9185 was not specified, the driver tries two standard prefixes, which are
9186 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
9187 those results in a file name that is found, the unmodified program
9188 name is searched for using the directories specified in your
9189 @env{PATH} environment variable.
9191 The compiler will check to see if the path provided by the @option{-B}
9192 refers to a directory, and if necessary it will add a directory
9193 separator character at the end of the path.
9195 @option{-B} prefixes that effectively specify directory names also apply
9196 to libraries in the linker, because the compiler translates these
9197 options into @option{-L} options for the linker.  They also apply to
9198 includes files in the preprocessor, because the compiler translates these
9199 options into @option{-isystem} options for the preprocessor.  In this case,
9200 the compiler appends @samp{include} to the prefix.
9202 The run-time support file @file{libgcc.a} can also be searched for using
9203 the @option{-B} prefix, if needed.  If it is not found there, the two
9204 standard prefixes above are tried, and that is all.  The file is left
9205 out of the link if it is not found by those means.
9207 Another way to specify a prefix much like the @option{-B} prefix is to use
9208 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9209 Variables}.
9211 As a special kludge, if the path provided by @option{-B} is
9212 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9213 9, then it will be replaced by @file{[dir/]include}.  This is to help
9214 with boot-strapping the compiler.
9216 @item -specs=@var{file}
9217 @opindex specs
9218 Process @var{file} after the compiler reads in the standard @file{specs}
9219 file, in order to override the defaults that the @file{gcc} driver
9220 program uses when determining what switches to pass to @file{cc1},
9221 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
9222 @option{-specs=@var{file}} can be specified on the command line, and they
9223 are processed in order, from left to right.
9225 @item --sysroot=@var{dir}
9226 @opindex sysroot
9227 Use @var{dir} as the logical root directory for headers and libraries.
9228 For example, if the compiler would normally search for headers in
9229 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
9230 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9232 If you use both this option and the @option{-isysroot} option, then
9233 the @option{--sysroot} option will apply to libraries, but the
9234 @option{-isysroot} option will apply to header files.
9236 The GNU linker (beginning with version 2.16) has the necessary support
9237 for this option.  If your linker does not support this option, the
9238 header file aspect of @option{--sysroot} will still work, but the
9239 library aspect will not.
9241 @item -I-
9242 @opindex I-
9243 This option has been deprecated.  Please use @option{-iquote} instead for
9244 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9245 Any directories you specify with @option{-I} options before the @option{-I-}
9246 option are searched only for the case of @samp{#include "@var{file}"};
9247 they are not searched for @samp{#include <@var{file}>}.
9249 If additional directories are specified with @option{-I} options after
9250 the @option{-I-}, these directories are searched for all @samp{#include}
9251 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9252 this way.)
9254 In addition, the @option{-I-} option inhibits the use of the current
9255 directory (where the current input file came from) as the first search
9256 directory for @samp{#include "@var{file}"}.  There is no way to
9257 override this effect of @option{-I-}.  With @option{-I.} you can specify
9258 searching the directory which was current when the compiler was
9259 invoked.  That is not exactly the same as what the preprocessor does
9260 by default, but it is often satisfactory.
9262 @option{-I-} does not inhibit the use of the standard system directories
9263 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9264 independent.
9265 @end table
9267 @c man end
9269 @node Spec Files
9270 @section Specifying subprocesses and the switches to pass to them
9271 @cindex Spec Files
9273 @command{gcc} is a driver program.  It performs its job by invoking a
9274 sequence of other programs to do the work of compiling, assembling and
9275 linking.  GCC interprets its command-line parameters and uses these to
9276 deduce which programs it should invoke, and which command-line options
9277 it ought to place on their command lines.  This behavior is controlled
9278 by @dfn{spec strings}.  In most cases there is one spec string for each
9279 program that GCC can invoke, but a few programs have multiple spec
9280 strings to control their behavior.  The spec strings built into GCC can
9281 be overridden by using the @option{-specs=} command-line switch to specify
9282 a spec file.
9284 @dfn{Spec files} are plaintext files that are used to construct spec
9285 strings.  They consist of a sequence of directives separated by blank
9286 lines.  The type of directive is determined by the first non-whitespace
9287 character on the line and it can be one of the following:
9289 @table @code
9290 @item %@var{command}
9291 Issues a @var{command} to the spec file processor.  The commands that can
9292 appear here are:
9294 @table @code
9295 @item %include <@var{file}>
9296 @cindex @code{%include}
9297 Search for @var{file} and insert its text at the current point in the
9298 specs file.
9300 @item %include_noerr <@var{file}>
9301 @cindex @code{%include_noerr}
9302 Just like @samp{%include}, but do not generate an error message if the include
9303 file cannot be found.
9305 @item %rename @var{old_name} @var{new_name}
9306 @cindex @code{%rename}
9307 Rename the spec string @var{old_name} to @var{new_name}.
9309 @end table
9311 @item *[@var{spec_name}]:
9312 This tells the compiler to create, override or delete the named spec
9313 string.  All lines after this directive up to the next directive or
9314 blank line are considered to be the text for the spec string.  If this
9315 results in an empty string then the spec will be deleted.  (Or, if the
9316 spec did not exist, then nothing will happened.)  Otherwise, if the spec
9317 does not currently exist a new spec will be created.  If the spec does
9318 exist then its contents will be overridden by the text of this
9319 directive, unless the first character of that text is the @samp{+}
9320 character, in which case the text will be appended to the spec.
9322 @item [@var{suffix}]:
9323 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9324 and up to the next directive or blank line are considered to make up the
9325 spec string for the indicated suffix.  When the compiler encounters an
9326 input file with the named suffix, it will processes the spec string in
9327 order to work out how to compile that file.  For example:
9329 @smallexample
9330 .ZZ:
9331 z-compile -input %i
9332 @end smallexample
9334 This says that any input file whose name ends in @samp{.ZZ} should be
9335 passed to the program @samp{z-compile}, which should be invoked with the
9336 command-line switch @option{-input} and with the result of performing the
9337 @samp{%i} substitution.  (See below.)
9339 As an alternative to providing a spec string, the text that follows a
9340 suffix directive can be one of the following:
9342 @table @code
9343 @item @@@var{language}
9344 This says that the suffix is an alias for a known @var{language}.  This is
9345 similar to using the @option{-x} command-line switch to GCC to specify a
9346 language explicitly.  For example:
9348 @smallexample
9349 .ZZ:
9350 @@c++
9351 @end smallexample
9353 Says that .ZZ files are, in fact, C++ source files.
9355 @item #@var{name}
9356 This causes an error messages saying:
9358 @smallexample
9359 @var{name} compiler not installed on this system.
9360 @end smallexample
9361 @end table
9363 GCC already has an extensive list of suffixes built into it.
9364 This directive will add an entry to the end of the list of suffixes, but
9365 since the list is searched from the end backwards, it is effectively
9366 possible to override earlier entries using this technique.
9368 @end table
9370 GCC has the following spec strings built into it.  Spec files can
9371 override these strings or create their own.  Note that individual
9372 targets can also add their own spec strings to this list.
9374 @smallexample
9375 asm          Options to pass to the assembler
9376 asm_final    Options to pass to the assembler post-processor
9377 cpp          Options to pass to the C preprocessor
9378 cc1          Options to pass to the C compiler
9379 cc1plus      Options to pass to the C++ compiler
9380 endfile      Object files to include at the end of the link
9381 link         Options to pass to the linker
9382 lib          Libraries to include on the command line to the linker
9383 libgcc       Decides which GCC support library to pass to the linker
9384 linker       Sets the name of the linker
9385 predefines   Defines to be passed to the C preprocessor
9386 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9387              by default
9388 startfile    Object files to include at the start of the link
9389 @end smallexample
9391 Here is a small example of a spec file:
9393 @smallexample
9394 %rename lib                 old_lib
9396 *lib:
9397 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9398 @end smallexample
9400 This example renames the spec called @samp{lib} to @samp{old_lib} and
9401 then overrides the previous definition of @samp{lib} with a new one.
9402 The new definition adds in some extra command-line options before
9403 including the text of the old definition.
9405 @dfn{Spec strings} are a list of command-line options to be passed to their
9406 corresponding program.  In addition, the spec strings can contain
9407 @samp{%}-prefixed sequences to substitute variable text or to
9408 conditionally insert text into the command line.  Using these constructs
9409 it is possible to generate quite complex command lines.
9411 Here is a table of all defined @samp{%}-sequences for spec
9412 strings.  Note that spaces are not generated automatically around the
9413 results of expanding these sequences.  Therefore you can concatenate them
9414 together or combine them with constant text in a single argument.
9416 @table @code
9417 @item %%
9418 Substitute one @samp{%} into the program name or argument.
9420 @item %i
9421 Substitute the name of the input file being processed.
9423 @item %b
9424 Substitute the basename of the input file being processed.
9425 This is the substring up to (and not including) the last period
9426 and not including the directory.
9428 @item %B
9429 This is the same as @samp{%b}, but include the file suffix (text after
9430 the last period).
9432 @item %d
9433 Marks the argument containing or following the @samp{%d} as a
9434 temporary file name, so that that file will be deleted if GCC exits
9435 successfully.  Unlike @samp{%g}, this contributes no text to the
9436 argument.
9438 @item %g@var{suffix}
9439 Substitute a file name that has suffix @var{suffix} and is chosen
9440 once per compilation, and mark the argument in the same way as
9441 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9442 name is now chosen in a way that is hard to predict even when previously
9443 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9444 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9445 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9446 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9447 was simply substituted with a file name chosen once per compilation,
9448 without regard to any appended suffix (which was therefore treated
9449 just like ordinary text), making such attacks more likely to succeed.
9451 @item %u@var{suffix}
9452 Like @samp{%g}, but generates a new temporary file name even if
9453 @samp{%u@var{suffix}} was already seen.
9455 @item %U@var{suffix}
9456 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9457 new one if there is no such last file name.  In the absence of any
9458 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9459 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9460 would involve the generation of two distinct file names, one
9461 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9462 simply substituted with a file name chosen for the previous @samp{%u},
9463 without regard to any appended suffix.
9465 @item %j@var{suffix}
9466 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9467 writable, and if save-temps is off; otherwise, substitute the name
9468 of a temporary file, just like @samp{%u}.  This temporary file is not
9469 meant for communication between processes, but rather as a junk
9470 disposal mechanism.
9472 @item %|@var{suffix}
9473 @itemx %m@var{suffix}
9474 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9475 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9476 all.  These are the two most common ways to instruct a program that it
9477 should read from standard input or write to standard output.  If you
9478 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9479 construct: see for example @file{f/lang-specs.h}.
9481 @item %.@var{SUFFIX}
9482 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9483 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9484 terminated by the next space or %.
9486 @item %w
9487 Marks the argument containing or following the @samp{%w} as the
9488 designated output file of this compilation.  This puts the argument
9489 into the sequence of arguments that @samp{%o} will substitute later.
9491 @item %o
9492 Substitutes the names of all the output files, with spaces
9493 automatically placed around them.  You should write spaces
9494 around the @samp{%o} as well or the results are undefined.
9495 @samp{%o} is for use in the specs for running the linker.
9496 Input files whose names have no recognized suffix are not compiled
9497 at all, but they are included among the output files, so they will
9498 be linked.
9500 @item %O
9501 Substitutes the suffix for object files.  Note that this is
9502 handled specially when it immediately follows @samp{%g, %u, or %U},
9503 because of the need for those to form complete file names.  The
9504 handling is such that @samp{%O} is treated exactly as if it had already
9505 been substituted, except that @samp{%g, %u, and %U} do not currently
9506 support additional @var{suffix} characters following @samp{%O} as they would
9507 following, for example, @samp{.o}.
9509 @item %p
9510 Substitutes the standard macro predefinitions for the
9511 current target machine.  Use this when running @code{cpp}.
9513 @item %P
9514 Like @samp{%p}, but puts @samp{__} before and after the name of each
9515 predefined macro, except for macros that start with @samp{__} or with
9516 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9519 @item %I
9520 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9521 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9522 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9523 and @option{-imultilib} as necessary.
9525 @item %s
9526 Current argument is the name of a library or startup file of some sort.
9527 Search for that file in a standard list of directories and substitute
9528 the full name found.  The current working directory is included in the
9529 list of directories scanned.
9531 @item %T
9532 Current argument is the name of a linker script.  Search for that file
9533 in the current list of directories to scan for libraries. If the file
9534 is located insert a @option{--script} option into the command line
9535 followed by the full path name found.  If the file is not found then
9536 generate an error message.  Note: the current working directory is not
9537 searched.
9539 @item %e@var{str}
9540 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9541 Use this when inconsistent options are detected.
9543 @item %(@var{name})
9544 Substitute the contents of spec string @var{name} at this point.
9546 @item %[@var{name}]
9547 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9549 @item %x@{@var{option}@}
9550 Accumulate an option for @samp{%X}.
9552 @item %X
9553 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9554 spec string.
9556 @item %Y
9557 Output the accumulated assembler options specified by @option{-Wa}.
9559 @item %Z
9560 Output the accumulated preprocessor options specified by @option{-Wp}.
9562 @item %a
9563 Process the @code{asm} spec.  This is used to compute the
9564 switches to be passed to the assembler.
9566 @item %A
9567 Process the @code{asm_final} spec.  This is a spec string for
9568 passing switches to an assembler post-processor, if such a program is
9569 needed.
9571 @item %l
9572 Process the @code{link} spec.  This is the spec for computing the
9573 command line passed to the linker.  Typically it will make use of the
9574 @samp{%L %G %S %D and %E} sequences.
9576 @item %D
9577 Dump out a @option{-L} option for each directory that GCC believes might
9578 contain startup files.  If the target supports multilibs then the
9579 current multilib directory will be prepended to each of these paths.
9581 @item %L
9582 Process the @code{lib} spec.  This is a spec string for deciding which
9583 libraries should be included on the command line to the linker.
9585 @item %G
9586 Process the @code{libgcc} spec.  This is a spec string for deciding
9587 which GCC support library should be included on the command line to the linker.
9589 @item %S
9590 Process the @code{startfile} spec.  This is a spec for deciding which
9591 object files should be the first ones passed to the linker.  Typically
9592 this might be a file named @file{crt0.o}.
9594 @item %E
9595 Process the @code{endfile} spec.  This is a spec string that specifies
9596 the last object files that will be passed to the linker.
9598 @item %C
9599 Process the @code{cpp} spec.  This is used to construct the arguments
9600 to be passed to the C preprocessor.
9602 @item %1
9603 Process the @code{cc1} spec.  This is used to construct the options to be
9604 passed to the actual C compiler (@samp{cc1}).
9606 @item %2
9607 Process the @code{cc1plus} spec.  This is used to construct the options to be
9608 passed to the actual C++ compiler (@samp{cc1plus}).
9610 @item %*
9611 Substitute the variable part of a matched option.  See below.
9612 Note that each comma in the substituted string is replaced by
9613 a single space.
9615 @item %<@code{S}
9616 Remove all occurrences of @code{-S} from the command line.  Note---this
9617 command is position dependent.  @samp{%} commands in the spec string
9618 before this one will see @code{-S}, @samp{%} commands in the spec string
9619 after this one will not.
9621 @item %:@var{function}(@var{args})
9622 Call the named function @var{function}, passing it @var{args}.
9623 @var{args} is first processed as a nested spec string, then split
9624 into an argument vector in the usual fashion.  The function returns
9625 a string which is processed as if it had appeared literally as part
9626 of the current spec.
9628 The following built-in spec functions are provided:
9630 @table @code
9631 @item @code{getenv}
9632 The @code{getenv} spec function takes two arguments: an environment
9633 variable name and a string.  If the environment variable is not
9634 defined, a fatal error is issued.  Otherwise, the return value is the
9635 value of the environment variable concatenated with the string.  For
9636 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9638 @smallexample
9639 %:getenv(TOPDIR /include)
9640 @end smallexample
9642 expands to @file{/path/to/top/include}.
9644 @item @code{if-exists}
9645 The @code{if-exists} spec function takes one argument, an absolute
9646 pathname to a file.  If the file exists, @code{if-exists} returns the
9647 pathname.  Here is a small example of its usage:
9649 @smallexample
9650 *startfile:
9651 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9652 @end smallexample
9654 @item @code{if-exists-else}
9655 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9656 spec function, except that it takes two arguments.  The first argument is
9657 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9658 returns the pathname.  If it does not exist, it returns the second argument.
9659 This way, @code{if-exists-else} can be used to select one file or another,
9660 based on the existence of the first.  Here is a small example of its usage:
9662 @smallexample
9663 *startfile:
9664 crt0%O%s %:if-exists(crti%O%s) \
9665 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9666 @end smallexample
9668 @item @code{replace-outfile}
9669 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9670 first argument in the outfiles array and replaces it with the second argument.  Here
9671 is a small example of its usage:
9673 @smallexample
9674 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9675 @end smallexample
9677 @item @code{remove-outfile}
9678 The @code{remove-outfile} spec function takes one argument.  It looks for the
9679 first argument in the outfiles array and removes it.  Here is a small example
9680 its usage:
9682 @smallexample
9683 %:remove-outfile(-lm)
9684 @end smallexample
9686 @item @code{print-asm-header}
9687 The @code{print-asm-header} function takes no arguments and simply
9688 prints a banner like:
9690 @smallexample
9691 Assembler options
9692 =================
9694 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9695 @end smallexample
9697 It is used to separate compiler options from assembler options
9698 in the @option{--target-help} output.
9699 @end table
9701 @item %@{@code{S}@}
9702 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9703 If that switch was not specified, this substitutes nothing.  Note that
9704 the leading dash is omitted when specifying this option, and it is
9705 automatically inserted if the substitution is performed.  Thus the spec
9706 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9707 and would output the command line option @option{-foo}.
9709 @item %W@{@code{S}@}
9710 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9711 deleted on failure.
9713 @item %@{@code{S}*@}
9714 Substitutes all the switches specified to GCC whose names start
9715 with @code{-S}, but which also take an argument.  This is used for
9716 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9717 GCC considers @option{-o foo} as being
9718 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9719 text, including the space.  Thus two arguments would be generated.
9721 @item %@{@code{S}*&@code{T}*@}
9722 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9723 (the order of @code{S} and @code{T} in the spec is not significant).
9724 There can be any number of ampersand-separated variables; for each the
9725 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9727 @item %@{@code{S}:@code{X}@}
9728 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9730 @item %@{!@code{S}:@code{X}@}
9731 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9733 @item %@{@code{S}*:@code{X}@}
9734 Substitutes @code{X} if one or more switches whose names start with
9735 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9736 once, no matter how many such switches appeared.  However, if @code{%*}
9737 appears somewhere in @code{X}, then @code{X} will be substituted once
9738 for each matching switch, with the @code{%*} replaced by the part of
9739 that switch that matched the @code{*}.
9741 @item %@{.@code{S}:@code{X}@}
9742 Substitutes @code{X}, if processing a file with suffix @code{S}.
9744 @item %@{!.@code{S}:@code{X}@}
9745 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9747 @item %@{,@code{S}:@code{X}@}
9748 Substitutes @code{X}, if processing a file for language @code{S}.
9750 @item %@{!,@code{S}:@code{X}@}
9751 Substitutes @code{X}, if not processing a file for language @code{S}.
9753 @item %@{@code{S}|@code{P}:@code{X}@}
9754 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9755 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9756 @code{*} sequences as well, although they have a stronger binding than
9757 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9758 alternatives must be starred, and only the first matching alternative
9759 is substituted.
9761 For example, a spec string like this:
9763 @smallexample
9764 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9765 @end smallexample
9767 will output the following command-line options from the following input
9768 command-line options:
9770 @smallexample
9771 fred.c        -foo -baz
9772 jim.d         -bar -boggle
9773 -d fred.c     -foo -baz -boggle
9774 -d jim.d      -bar -baz -boggle
9775 @end smallexample
9777 @item %@{S:X; T:Y; :D@}
9779 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9780 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9781 be as many clauses as you need.  This may be combined with @code{.},
9782 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9785 @end table
9787 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9788 construct may contain other nested @samp{%} constructs or spaces, or
9789 even newlines.  They are processed as usual, as described above.
9790 Trailing white space in @code{X} is ignored.  White space may also
9791 appear anywhere on the left side of the colon in these constructs,
9792 except between @code{.} or @code{*} and the corresponding word.
9794 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9795 handled specifically in these constructs.  If another value of
9796 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9797 @option{-W} switch is found later in the command line, the earlier
9798 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9799 just one letter, which passes all matching options.
9801 The character @samp{|} at the beginning of the predicate text is used to
9802 indicate that a command should be piped to the following command, but
9803 only if @option{-pipe} is specified.
9805 It is built into GCC which switches take arguments and which do not.
9806 (You might think it would be useful to generalize this to allow each
9807 compiler's spec to say which switches take arguments.  But this cannot
9808 be done in a consistent fashion.  GCC cannot even decide which input
9809 files have been specified without knowing which switches take arguments,
9810 and it must know which input files to compile in order to tell which
9811 compilers to run).
9813 GCC also knows implicitly that arguments starting in @option{-l} are to be
9814 treated as compiler output files, and passed to the linker in their
9815 proper position among the other output files.
9817 @c man begin OPTIONS
9819 @node Target Options
9820 @section Specifying Target Machine and Compiler Version
9821 @cindex target options
9822 @cindex cross compiling
9823 @cindex specifying machine version
9824 @cindex specifying compiler version and target machine
9825 @cindex compiler version, specifying
9826 @cindex target machine, specifying
9828 The usual way to run GCC is to run the executable called @file{gcc}, or
9829 @file{<machine>-gcc} when cross-compiling, or
9830 @file{<machine>-gcc-<version>} to run a version other than the one that
9831 was installed last.
9833 @node Submodel Options
9834 @section Hardware Models and Configurations
9835 @cindex submodel options
9836 @cindex specifying hardware config
9837 @cindex hardware models and configurations, specifying
9838 @cindex machine dependent options
9840 Each target machine types can have its own
9841 special options, starting with @samp{-m}, to choose among various
9842 hardware models or configurations---for example, 68010 vs 68020,
9843 floating coprocessor or none.  A single installed version of the
9844 compiler can compile for any model or configuration, according to the
9845 options specified.
9847 Some configurations of the compiler also support additional special
9848 options, usually for compatibility with other compilers on the same
9849 platform.
9851 @c This list is ordered alphanumerically by subsection name.
9852 @c It should be the same order and spelling as these options are listed
9853 @c in Machine Dependent Options
9855 @menu
9856 * ARC Options::
9857 * ARM Options::
9858 * AVR Options::
9859 * Blackfin Options::
9860 * CRIS Options::
9861 * CRX Options::
9862 * Darwin Options::
9863 * DEC Alpha Options::
9864 * DEC Alpha/VMS Options::
9865 * FR30 Options::
9866 * FRV Options::
9867 * GNU/Linux Options::
9868 * H8/300 Options::
9869 * HPPA Options::
9870 * i386 and x86-64 Options::
9871 * i386 and x86-64 Windows Options::
9872 * IA-64 Options::
9873 * IA-64/VMS Options::
9874 * LM32 Options::
9875 * M32C Options::
9876 * M32R/D Options::
9877 * M680x0 Options::
9878 * M68hc1x Options::
9879 * MCore Options::
9880 * MeP Options::
9881 * MicroBlaze Options::
9882 * MIPS Options::
9883 * MMIX Options::
9884 * MN10300 Options::
9885 * PDP-11 Options::
9886 * picoChip Options::
9887 * PowerPC Options::
9888 * RS/6000 and PowerPC Options::
9889 * RX Options::
9890 * S/390 and zSeries Options::
9891 * Score Options::
9892 * SH Options::
9893 * Solaris 2 Options::
9894 * SPARC Options::
9895 * SPU Options::
9896 * System V Options::
9897 * V850 Options::
9898 * VAX Options::
9899 * VxWorks Options::
9900 * x86-64 Options::
9901 * Xstormy16 Options::
9902 * Xtensa Options::
9903 * zSeries Options::
9904 @end menu
9906 @node ARC Options
9907 @subsection ARC Options
9908 @cindex ARC Options
9910 These options are defined for ARC implementations:
9912 @table @gcctabopt
9913 @item -EL
9914 @opindex EL
9915 Compile code for little endian mode.  This is the default.
9917 @item -EB
9918 @opindex EB
9919 Compile code for big endian mode.
9921 @item -mmangle-cpu
9922 @opindex mmangle-cpu
9923 Prepend the name of the cpu to all public symbol names.
9924 In multiple-processor systems, there are many ARC variants with different
9925 instruction and register set characteristics.  This flag prevents code
9926 compiled for one cpu to be linked with code compiled for another.
9927 No facility exists for handling variants that are ``almost identical''.
9928 This is an all or nothing option.
9930 @item -mcpu=@var{cpu}
9931 @opindex mcpu
9932 Compile code for ARC variant @var{cpu}.
9933 Which variants are supported depend on the configuration.
9934 All variants support @option{-mcpu=base}, this is the default.
9936 @item -mtext=@var{text-section}
9937 @itemx -mdata=@var{data-section}
9938 @itemx -mrodata=@var{readonly-data-section}
9939 @opindex mtext
9940 @opindex mdata
9941 @opindex mrodata
9942 Put functions, data, and readonly data in @var{text-section},
9943 @var{data-section}, and @var{readonly-data-section} respectively
9944 by default.  This can be overridden with the @code{section} attribute.
9945 @xref{Variable Attributes}.
9947 @end table
9949 @node ARM Options
9950 @subsection ARM Options
9951 @cindex ARM options
9953 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9954 architectures:
9956 @table @gcctabopt
9957 @item -mabi=@var{name}
9958 @opindex mabi
9959 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9960 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9962 @item -mapcs-frame
9963 @opindex mapcs-frame
9964 Generate a stack frame that is compliant with the ARM Procedure Call
9965 Standard for all functions, even if this is not strictly necessary for
9966 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9967 with this option will cause the stack frames not to be generated for
9968 leaf functions.  The default is @option{-mno-apcs-frame}.
9970 @item -mapcs
9971 @opindex mapcs
9972 This is a synonym for @option{-mapcs-frame}.
9974 @ignore
9975 @c not currently implemented
9976 @item -mapcs-stack-check
9977 @opindex mapcs-stack-check
9978 Generate code to check the amount of stack space available upon entry to
9979 every function (that actually uses some stack space).  If there is
9980 insufficient space available then either the function
9981 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9982 called, depending upon the amount of stack space required.  The run time
9983 system is required to provide these functions.  The default is
9984 @option{-mno-apcs-stack-check}, since this produces smaller code.
9986 @c not currently implemented
9987 @item -mapcs-float
9988 @opindex mapcs-float
9989 Pass floating point arguments using the float point registers.  This is
9990 one of the variants of the APCS@.  This option is recommended if the
9991 target hardware has a floating point unit or if a lot of floating point
9992 arithmetic is going to be performed by the code.  The default is
9993 @option{-mno-apcs-float}, since integer only code is slightly increased in
9994 size if @option{-mapcs-float} is used.
9996 @c not currently implemented
9997 @item -mapcs-reentrant
9998 @opindex mapcs-reentrant
9999 Generate reentrant, position independent code.  The default is
10000 @option{-mno-apcs-reentrant}.
10001 @end ignore
10003 @item -mthumb-interwork
10004 @opindex mthumb-interwork
10005 Generate code which supports calling between the ARM and Thumb
10006 instruction sets.  Without this option the two instruction sets cannot
10007 be reliably used inside one program.  The default is
10008 @option{-mno-thumb-interwork}, since slightly larger code is generated
10009 when @option{-mthumb-interwork} is specified.
10011 @item -mno-sched-prolog
10012 @opindex mno-sched-prolog
10013 Prevent the reordering of instructions in the function prolog, or the
10014 merging of those instruction with the instructions in the function's
10015 body.  This means that all functions will start with a recognizable set
10016 of instructions (or in fact one of a choice from a small set of
10017 different function prologues), and this information can be used to
10018 locate the start if functions inside an executable piece of code.  The
10019 default is @option{-msched-prolog}.
10021 @item -mfloat-abi=@var{name}
10022 @opindex mfloat-abi
10023 Specifies which floating-point ABI to use.  Permissible values
10024 are: @samp{soft}, @samp{softfp} and @samp{hard}.
10026 Specifying @samp{soft} causes GCC to generate output containing
10027 library calls for floating-point operations.
10028 @samp{softfp} allows the generation of code using hardware floating-point
10029 instructions, but still uses the soft-float calling conventions.
10030 @samp{hard} allows generation of floating-point instructions
10031 and uses FPU-specific calling conventions.
10033 The default depends on the specific target configuration.  Note that
10034 the hard-float and soft-float ABIs are not link-compatible; you must
10035 compile your entire program with the same ABI, and link with a
10036 compatible set of libraries.
10038 @item -mhard-float
10039 @opindex mhard-float
10040 Equivalent to @option{-mfloat-abi=hard}.
10042 @item -msoft-float
10043 @opindex msoft-float
10044 Equivalent to @option{-mfloat-abi=soft}.
10046 @item -mlittle-endian
10047 @opindex mlittle-endian
10048 Generate code for a processor running in little-endian mode.  This is
10049 the default for all standard configurations.
10051 @item -mbig-endian
10052 @opindex mbig-endian
10053 Generate code for a processor running in big-endian mode; the default is
10054 to compile code for a little-endian processor.
10056 @item -mwords-little-endian
10057 @opindex mwords-little-endian
10058 This option only applies when generating code for big-endian processors.
10059 Generate code for a little-endian word order but a big-endian byte
10060 order.  That is, a byte order of the form @samp{32107654}.  Note: this
10061 option should only be used if you require compatibility with code for
10062 big-endian ARM processors generated by versions of the compiler prior to
10063 2.8.
10065 @item -mcpu=@var{name}
10066 @opindex mcpu
10067 This specifies the name of the target ARM processor.  GCC uses this name
10068 to determine what kind of instructions it can emit when generating
10069 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
10070 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
10071 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
10072 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
10073 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
10074 @samp{arm720},
10075 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
10076 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
10077 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
10078 @samp{strongarm1110},
10079 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
10080 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
10081 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
10082 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
10083 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
10084 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
10085 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
10086 @samp{cortex-a5}, @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a15},
10087 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m4}, @samp{cortex-m3},
10088 @samp{cortex-m1},
10089 @samp{cortex-m0},
10090 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10092 @item -mtune=@var{name}
10093 @opindex mtune
10094 This option is very similar to the @option{-mcpu=} option, except that
10095 instead of specifying the actual target processor type, and hence
10096 restricting which instructions can be used, it specifies that GCC should
10097 tune the performance of the code as if the target were of the type
10098 specified in this option, but still choosing the instructions that it
10099 will generate based on the cpu specified by a @option{-mcpu=} option.
10100 For some ARM implementations better performance can be obtained by using
10101 this option.
10103 @item -march=@var{name}
10104 @opindex march
10105 This specifies the name of the target ARM architecture.  GCC uses this
10106 name to determine what kind of instructions it can emit when generating
10107 assembly code.  This option can be used in conjunction with or instead
10108 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
10109 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
10110 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
10111 @samp{armv6}, @samp{armv6j},
10112 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
10113 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
10114 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10116 @item -mfpu=@var{name}
10117 @itemx -mfpe=@var{number}
10118 @itemx -mfp=@var{number}
10119 @opindex mfpu
10120 @opindex mfpe
10121 @opindex mfp
10122 This specifies what floating point hardware (or hardware emulation) is
10123 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
10124 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
10125 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
10126 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
10127 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
10128 @option{-mfp} and @option{-mfpe} are synonyms for
10129 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
10130 of GCC@.
10132 If @option{-msoft-float} is specified this specifies the format of
10133 floating point values.
10135 If the selected floating-point hardware includes the NEON extension
10136 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
10137 operations will not be used by GCC's auto-vectorization pass unless
10138 @option{-funsafe-math-optimizations} is also specified.  This is
10139 because NEON hardware does not fully implement the IEEE 754 standard for
10140 floating-point arithmetic (in particular denormal values are treated as
10141 zero), so the use of NEON instructions may lead to a loss of precision.
10143 @item -mfp16-format=@var{name}
10144 @opindex mfp16-format
10145 Specify the format of the @code{__fp16} half-precision floating-point type.
10146 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
10147 the default is @samp{none}, in which case the @code{__fp16} type is not
10148 defined.  @xref{Half-Precision}, for more information.
10150 @item -mstructure-size-boundary=@var{n}
10151 @opindex mstructure-size-boundary
10152 The size of all structures and unions will be rounded up to a multiple
10153 of the number of bits set by this option.  Permissible values are 8, 32
10154 and 64.  The default value varies for different toolchains.  For the COFF
10155 targeted toolchain the default value is 8.  A value of 64 is only allowed
10156 if the underlying ABI supports it.
10158 Specifying the larger number can produce faster, more efficient code, but
10159 can also increase the size of the program.  Different values are potentially
10160 incompatible.  Code compiled with one value cannot necessarily expect to
10161 work with code or libraries compiled with another value, if they exchange
10162 information using structures or unions.
10164 @item -mabort-on-noreturn
10165 @opindex mabort-on-noreturn
10166 Generate a call to the function @code{abort} at the end of a
10167 @code{noreturn} function.  It will be executed if the function tries to
10168 return.
10170 @item -mlong-calls
10171 @itemx -mno-long-calls
10172 @opindex mlong-calls
10173 @opindex mno-long-calls
10174 Tells the compiler to perform function calls by first loading the
10175 address of the function into a register and then performing a subroutine
10176 call on this register.  This switch is needed if the target function
10177 will lie outside of the 64 megabyte addressing range of the offset based
10178 version of subroutine call instruction.
10180 Even if this switch is enabled, not all function calls will be turned
10181 into long calls.  The heuristic is that static functions, functions
10182 which have the @samp{short-call} attribute, functions that are inside
10183 the scope of a @samp{#pragma no_long_calls} directive and functions whose
10184 definitions have already been compiled within the current compilation
10185 unit, will not be turned into long calls.  The exception to this rule is
10186 that weak function definitions, functions with the @samp{long-call}
10187 attribute or the @samp{section} attribute, and functions that are within
10188 the scope of a @samp{#pragma long_calls} directive, will always be
10189 turned into long calls.
10191 This feature is not enabled by default.  Specifying
10192 @option{-mno-long-calls} will restore the default behavior, as will
10193 placing the function calls within the scope of a @samp{#pragma
10194 long_calls_off} directive.  Note these switches have no effect on how
10195 the compiler generates code to handle function calls via function
10196 pointers.
10198 @item -msingle-pic-base
10199 @opindex msingle-pic-base
10200 Treat the register used for PIC addressing as read-only, rather than
10201 loading it in the prologue for each function.  The run-time system is
10202 responsible for initializing this register with an appropriate value
10203 before execution begins.
10205 @item -mpic-register=@var{reg}
10206 @opindex mpic-register
10207 Specify the register to be used for PIC addressing.  The default is R10
10208 unless stack-checking is enabled, when R9 is used.
10210 @item -mcirrus-fix-invalid-insns
10211 @opindex mcirrus-fix-invalid-insns
10212 @opindex mno-cirrus-fix-invalid-insns
10213 Insert NOPs into the instruction stream to in order to work around
10214 problems with invalid Maverick instruction combinations.  This option
10215 is only valid if the @option{-mcpu=ep9312} option has been used to
10216 enable generation of instructions for the Cirrus Maverick floating
10217 point co-processor.  This option is not enabled by default, since the
10218 problem is only present in older Maverick implementations.  The default
10219 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10220 switch.
10222 @item -mpoke-function-name
10223 @opindex mpoke-function-name
10224 Write the name of each function into the text section, directly
10225 preceding the function prologue.  The generated code is similar to this:
10227 @smallexample
10228      t0
10229          .ascii "arm_poke_function_name", 0
10230          .align
10231      t1
10232          .word 0xff000000 + (t1 - t0)
10233      arm_poke_function_name
10234          mov     ip, sp
10235          stmfd   sp!, @{fp, ip, lr, pc@}
10236          sub     fp, ip, #4
10237 @end smallexample
10239 When performing a stack backtrace, code can inspect the value of
10240 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
10241 location @code{pc - 12} and the top 8 bits are set, then we know that
10242 there is a function name embedded immediately preceding this location
10243 and has length @code{((pc[-3]) & 0xff000000)}.
10245 @item -mthumb
10246 @opindex mthumb
10247 Generate code for the Thumb instruction set.  The default is to
10248 use the 32-bit ARM instruction set.
10249 This option automatically enables either 16-bit Thumb-1 or
10250 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
10251 and @option{-march=@var{name}} options.  This option is not passed to the
10252 assembler. If you want to force assembler files to be interpreted as Thumb code,
10253 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
10254 option directly to the assembler by prefixing it with @option{-Wa}.
10256 @item -mtpcs-frame
10257 @opindex mtpcs-frame
10258 Generate a stack frame that is compliant with the Thumb Procedure Call
10259 Standard for all non-leaf functions.  (A leaf function is one that does
10260 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
10262 @item -mtpcs-leaf-frame
10263 @opindex mtpcs-leaf-frame
10264 Generate a stack frame that is compliant with the Thumb Procedure Call
10265 Standard for all leaf functions.  (A leaf function is one that does
10266 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
10268 @item -mcallee-super-interworking
10269 @opindex mcallee-super-interworking
10270 Gives all externally visible functions in the file being compiled an ARM
10271 instruction set header which switches to Thumb mode before executing the
10272 rest of the function.  This allows these functions to be called from
10273 non-interworking code.  This option is not valid in AAPCS configurations
10274 because interworking is enabled by default.
10276 @item -mcaller-super-interworking
10277 @opindex mcaller-super-interworking
10278 Allows calls via function pointers (including virtual functions) to
10279 execute correctly regardless of whether the target code has been
10280 compiled for interworking or not.  There is a small overhead in the cost
10281 of executing a function pointer if this option is enabled.  This option
10282 is not valid in AAPCS configurations because interworking is enabled
10283 by default.
10285 @item -mtp=@var{name}
10286 @opindex mtp
10287 Specify the access model for the thread local storage pointer.  The valid
10288 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
10289 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
10290 (supported in the arm6k architecture), and @option{auto}, which uses the
10291 best available method for the selected processor.  The default setting is
10292 @option{auto}.
10294 @item -mword-relocations
10295 @opindex mword-relocations
10296 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
10297 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
10298 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
10299 is specified.
10301 @item -mfix-cortex-m3-ldrd
10302 @opindex mfix-cortex-m3-ldrd
10303 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
10304 with overlapping destination and base registers are used.  This option avoids
10305 generating these instructions.  This option is enabled by default when
10306 @option{-mcpu=cortex-m3} is specified.
10308 @end table
10310 @node AVR Options
10311 @subsection AVR Options
10312 @cindex AVR Options
10314 These options are defined for AVR implementations:
10316 @table @gcctabopt
10317 @item -mmcu=@var{mcu}
10318 @opindex mmcu
10319 Specify ATMEL AVR instruction set or MCU type.
10321 Instruction set avr1 is for the minimal AVR core, not supported by the C
10322 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10323 attiny11, attiny12, attiny15, attiny28).
10325 Instruction set avr2 (default) is for the classic AVR core with up to
10326 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10327 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10328 at90c8534, at90s8535).
10330 Instruction set avr3 is for the classic AVR core with up to 128K program
10331 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10333 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10334 memory space (MCU types: atmega8, atmega83, atmega85).
10336 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10337 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10338 atmega64, atmega128, at43usb355, at94k).
10340 @item -mno-interrupts
10341 @opindex mno-interrupts
10342 Generated code is not compatible with hardware interrupts.
10343 Code size will be smaller.
10345 @item -mcall-prologues
10346 @opindex mcall-prologues
10347 Functions prologues/epilogues expanded as call to appropriate
10348 subroutines.  Code size will be smaller.
10350 @item -mtiny-stack
10351 @opindex mtiny-stack
10352 Change only the low 8 bits of the stack pointer.
10354 @item -mint8
10355 @opindex mint8
10356 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10357 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10358 and long long will be 4 bytes.  Please note that this option does not
10359 comply to the C standards, but it will provide you with smaller code
10360 size.
10361 @end table
10363 @node Blackfin Options
10364 @subsection Blackfin Options
10365 @cindex Blackfin Options
10367 @table @gcctabopt
10368 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10369 @opindex mcpu=
10370 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
10371 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10372 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10373 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10374 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10375 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10376 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10377 @samp{bf561}.
10378 The optional @var{sirevision} specifies the silicon revision of the target
10379 Blackfin processor.  Any workarounds available for the targeted silicon revision
10380 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
10381 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10382 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
10383 hexadecimal digits representing the major and minor numbers in the silicon
10384 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10385 is not defined.  If @var{sirevision} is @samp{any}, the
10386 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10387 If this optional @var{sirevision} is not used, GCC assumes the latest known
10388 silicon revision of the targeted Blackfin processor.
10390 Support for @samp{bf561} is incomplete.  For @samp{bf561},
10391 Only the processor macro is defined.
10392 Without this option, @samp{bf532} is used as the processor by default.
10393 The corresponding predefined processor macros for @var{cpu} is to
10394 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10395 provided by libgloss to be linked in if @option{-msim} is not given.
10397 @item -msim
10398 @opindex msim
10399 Specifies that the program will be run on the simulator.  This causes
10400 the simulator BSP provided by libgloss to be linked in.  This option
10401 has effect only for @samp{bfin-elf} toolchain.
10402 Certain other options, such as @option{-mid-shared-library} and
10403 @option{-mfdpic}, imply @option{-msim}.
10405 @item -momit-leaf-frame-pointer
10406 @opindex momit-leaf-frame-pointer
10407 Don't keep the frame pointer in a register for leaf functions.  This
10408 avoids the instructions to save, set up and restore frame pointers and
10409 makes an extra register available in leaf functions.  The option
10410 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10411 which might make debugging harder.
10413 @item -mspecld-anomaly
10414 @opindex mspecld-anomaly
10415 When enabled, the compiler will ensure that the generated code does not
10416 contain speculative loads after jump instructions. If this option is used,
10417 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10419 @item -mno-specld-anomaly
10420 @opindex mno-specld-anomaly
10421 Don't generate extra code to prevent speculative loads from occurring.
10423 @item -mcsync-anomaly
10424 @opindex mcsync-anomaly
10425 When enabled, the compiler will ensure that the generated code does not
10426 contain CSYNC or SSYNC instructions too soon after conditional branches.
10427 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10429 @item -mno-csync-anomaly
10430 @opindex mno-csync-anomaly
10431 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10432 occurring too soon after a conditional branch.
10434 @item -mlow-64k
10435 @opindex mlow-64k
10436 When enabled, the compiler is free to take advantage of the knowledge that
10437 the entire program fits into the low 64k of memory.
10439 @item -mno-low-64k
10440 @opindex mno-low-64k
10441 Assume that the program is arbitrarily large.  This is the default.
10443 @item -mstack-check-l1
10444 @opindex mstack-check-l1
10445 Do stack checking using information placed into L1 scratchpad memory by the
10446 uClinux kernel.
10448 @item -mid-shared-library
10449 @opindex mid-shared-library
10450 Generate code that supports shared libraries via the library ID method.
10451 This allows for execute in place and shared libraries in an environment
10452 without virtual memory management.  This option implies @option{-fPIC}.
10453 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10455 @item -mno-id-shared-library
10456 @opindex mno-id-shared-library
10457 Generate code that doesn't assume ID based shared libraries are being used.
10458 This is the default.
10460 @item -mleaf-id-shared-library
10461 @opindex mleaf-id-shared-library
10462 Generate code that supports shared libraries via the library ID method,
10463 but assumes that this library or executable won't link against any other
10464 ID shared libraries.  That allows the compiler to use faster code for jumps
10465 and calls.
10467 @item -mno-leaf-id-shared-library
10468 @opindex mno-leaf-id-shared-library
10469 Do not assume that the code being compiled won't link against any ID shared
10470 libraries.  Slower code will be generated for jump and call insns.
10472 @item -mshared-library-id=n
10473 @opindex mshared-library-id
10474 Specified the identification number of the ID based shared library being
10475 compiled.  Specifying a value of 0 will generate more compact code, specifying
10476 other values will force the allocation of that number to the current
10477 library but is no more space or time efficient than omitting this option.
10479 @item -msep-data
10480 @opindex msep-data
10481 Generate code that allows the data segment to be located in a different
10482 area of memory from the text segment.  This allows for execute in place in
10483 an environment without virtual memory management by eliminating relocations
10484 against the text section.
10486 @item -mno-sep-data
10487 @opindex mno-sep-data
10488 Generate code that assumes that the data segment follows the text segment.
10489 This is the default.
10491 @item -mlong-calls
10492 @itemx -mno-long-calls
10493 @opindex mlong-calls
10494 @opindex mno-long-calls
10495 Tells the compiler to perform function calls by first loading the
10496 address of the function into a register and then performing a subroutine
10497 call on this register.  This switch is needed if the target function
10498 will lie outside of the 24 bit addressing range of the offset based
10499 version of subroutine call instruction.
10501 This feature is not enabled by default.  Specifying
10502 @option{-mno-long-calls} will restore the default behavior.  Note these
10503 switches have no effect on how the compiler generates code to handle
10504 function calls via function pointers.
10506 @item -mfast-fp
10507 @opindex mfast-fp
10508 Link with the fast floating-point library. This library relaxes some of
10509 the IEEE floating-point standard's rules for checking inputs against
10510 Not-a-Number (NAN), in the interest of performance.
10512 @item -minline-plt
10513 @opindex minline-plt
10514 Enable inlining of PLT entries in function calls to functions that are
10515 not known to bind locally.  It has no effect without @option{-mfdpic}.
10517 @item -mmulticore
10518 @opindex mmulticore
10519 Build standalone application for multicore Blackfin processor. Proper
10520 start files and link scripts will be used to support multicore.
10521 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10522 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10523 @option{-mcorea} or @option{-mcoreb}. If it's used without
10524 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10525 programming model is used. In this model, the main function of Core B
10526 should be named as coreb_main. If it's used with @option{-mcorea} or
10527 @option{-mcoreb}, one application per core programming model is used.
10528 If this option is not used, single core application programming
10529 model is used.
10531 @item -mcorea
10532 @opindex mcorea
10533 Build standalone application for Core A of BF561 when using
10534 one application per core programming model. Proper start files
10535 and link scripts will be used to support Core A. This option
10536 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10538 @item -mcoreb
10539 @opindex mcoreb
10540 Build standalone application for Core B of BF561 when using
10541 one application per core programming model. Proper start files
10542 and link scripts will be used to support Core B. This option
10543 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10544 should be used instead of main. It must be used with
10545 @option{-mmulticore}.
10547 @item -msdram
10548 @opindex msdram
10549 Build standalone application for SDRAM. Proper start files and
10550 link scripts will be used to put the application into SDRAM.
10551 Loader should initialize SDRAM before loading the application
10552 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10554 @item -micplb
10555 @opindex micplb
10556 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
10557 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
10558 are enabled; for standalone applications the default is off.
10559 @end table
10561 @node CRIS Options
10562 @subsection CRIS Options
10563 @cindex CRIS Options
10565 These options are defined specifically for the CRIS ports.
10567 @table @gcctabopt
10568 @item -march=@var{architecture-type}
10569 @itemx -mcpu=@var{architecture-type}
10570 @opindex march
10571 @opindex mcpu
10572 Generate code for the specified architecture.  The choices for
10573 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10574 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10575 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10576 @samp{v10}.
10578 @item -mtune=@var{architecture-type}
10579 @opindex mtune
10580 Tune to @var{architecture-type} everything applicable about the generated
10581 code, except for the ABI and the set of available instructions.  The
10582 choices for @var{architecture-type} are the same as for
10583 @option{-march=@var{architecture-type}}.
10585 @item -mmax-stack-frame=@var{n}
10586 @opindex mmax-stack-frame
10587 Warn when the stack frame of a function exceeds @var{n} bytes.
10589 @item -metrax4
10590 @itemx -metrax100
10591 @opindex metrax4
10592 @opindex metrax100
10593 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10594 @option{-march=v3} and @option{-march=v8} respectively.
10596 @item -mmul-bug-workaround
10597 @itemx -mno-mul-bug-workaround
10598 @opindex mmul-bug-workaround
10599 @opindex mno-mul-bug-workaround
10600 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10601 models where it applies.  This option is active by default.
10603 @item -mpdebug
10604 @opindex mpdebug
10605 Enable CRIS-specific verbose debug-related information in the assembly
10606 code.  This option also has the effect to turn off the @samp{#NO_APP}
10607 formatted-code indicator to the assembler at the beginning of the
10608 assembly file.
10610 @item -mcc-init
10611 @opindex mcc-init
10612 Do not use condition-code results from previous instruction; always emit
10613 compare and test instructions before use of condition codes.
10615 @item -mno-side-effects
10616 @opindex mno-side-effects
10617 Do not emit instructions with side-effects in addressing modes other than
10618 post-increment.
10620 @item -mstack-align
10621 @itemx -mno-stack-align
10622 @itemx -mdata-align
10623 @itemx -mno-data-align
10624 @itemx -mconst-align
10625 @itemx -mno-const-align
10626 @opindex mstack-align
10627 @opindex mno-stack-align
10628 @opindex mdata-align
10629 @opindex mno-data-align
10630 @opindex mconst-align
10631 @opindex mno-const-align
10632 These options (no-options) arranges (eliminate arrangements) for the
10633 stack-frame, individual data and constants to be aligned for the maximum
10634 single data access size for the chosen CPU model.  The default is to
10635 arrange for 32-bit alignment.  ABI details such as structure layout are
10636 not affected by these options.
10638 @item -m32-bit
10639 @itemx -m16-bit
10640 @itemx -m8-bit
10641 @opindex m32-bit
10642 @opindex m16-bit
10643 @opindex m8-bit
10644 Similar to the stack- data- and const-align options above, these options
10645 arrange for stack-frame, writable data and constants to all be 32-bit,
10646 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10648 @item -mno-prologue-epilogue
10649 @itemx -mprologue-epilogue
10650 @opindex mno-prologue-epilogue
10651 @opindex mprologue-epilogue
10652 With @option{-mno-prologue-epilogue}, the normal function prologue and
10653 epilogue that sets up the stack-frame are omitted and no return
10654 instructions or return sequences are generated in the code.  Use this
10655 option only together with visual inspection of the compiled code: no
10656 warnings or errors are generated when call-saved registers must be saved,
10657 or storage for local variable needs to be allocated.
10659 @item -mno-gotplt
10660 @itemx -mgotplt
10661 @opindex mno-gotplt
10662 @opindex mgotplt
10663 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10664 instruction sequences that load addresses for functions from the PLT part
10665 of the GOT rather than (traditional on other architectures) calls to the
10666 PLT@.  The default is @option{-mgotplt}.
10668 @item -melf
10669 @opindex melf
10670 Legacy no-op option only recognized with the cris-axis-elf and
10671 cris-axis-linux-gnu targets.
10673 @item -mlinux
10674 @opindex mlinux
10675 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10677 @item -sim
10678 @opindex sim
10679 This option, recognized for the cris-axis-elf arranges
10680 to link with input-output functions from a simulator library.  Code,
10681 initialized data and zero-initialized data are allocated consecutively.
10683 @item -sim2
10684 @opindex sim2
10685 Like @option{-sim}, but pass linker options to locate initialized data at
10686 0x40000000 and zero-initialized data at 0x80000000.
10687 @end table
10689 @node CRX Options
10690 @subsection CRX Options
10691 @cindex CRX Options
10693 These options are defined specifically for the CRX ports.
10695 @table @gcctabopt
10697 @item -mmac
10698 @opindex mmac
10699 Enable the use of multiply-accumulate instructions. Disabled by default.
10701 @item -mpush-args
10702 @opindex mpush-args
10703 Push instructions will be used to pass outgoing arguments when functions
10704 are called. Enabled by default.
10705 @end table
10707 @node Darwin Options
10708 @subsection Darwin Options
10709 @cindex Darwin options
10711 These options are defined for all architectures running the Darwin operating
10712 system.
10714 FSF GCC on Darwin does not create ``fat'' object files; it will create
10715 an object file for the single architecture that it was built to
10716 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10717 @option{-arch} options are used; it does so by running the compiler or
10718 linker multiple times and joining the results together with
10719 @file{lipo}.
10721 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10722 @samp{i686}) is determined by the flags that specify the ISA
10723 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10724 @option{-force_cpusubtype_ALL} option can be used to override this.
10726 The Darwin tools vary in their behavior when presented with an ISA
10727 mismatch.  The assembler, @file{as}, will only permit instructions to
10728 be used that are valid for the subtype of the file it is generating,
10729 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10730 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10731 and print an error if asked to create a shared library with a less
10732 restrictive subtype than its input files (for instance, trying to put
10733 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10734 for executables, @file{ld}, will quietly give the executable the most
10735 restrictive subtype of any of its input files.
10737 @table @gcctabopt
10738 @item -F@var{dir}
10739 @opindex F
10740 Add the framework directory @var{dir} to the head of the list of
10741 directories to be searched for header files.  These directories are
10742 interleaved with those specified by @option{-I} options and are
10743 scanned in a left-to-right order.
10745 A framework directory is a directory with frameworks in it.  A
10746 framework is a directory with a @samp{"Headers"} and/or
10747 @samp{"PrivateHeaders"} directory contained directly in it that ends
10748 in @samp{".framework"}.  The name of a framework is the name of this
10749 directory excluding the @samp{".framework"}.  Headers associated with
10750 the framework are found in one of those two directories, with
10751 @samp{"Headers"} being searched first.  A subframework is a framework
10752 directory that is in a framework's @samp{"Frameworks"} directory.
10753 Includes of subframework headers can only appear in a header of a
10754 framework that contains the subframework, or in a sibling subframework
10755 header.  Two subframeworks are siblings if they occur in the same
10756 framework.  A subframework should not have the same name as a
10757 framework, a warning will be issued if this is violated.  Currently a
10758 subframework cannot have subframeworks, in the future, the mechanism
10759 may be extended to support this.  The standard frameworks can be found
10760 in @samp{"/System/Library/Frameworks"} and
10761 @samp{"/Library/Frameworks"}.  An example include looks like
10762 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10763 the name of the framework and header.h is found in the
10764 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10766 @item -iframework@var{dir}
10767 @opindex iframework
10768 Like @option{-F} except the directory is a treated as a system
10769 directory.  The main difference between this @option{-iframework} and
10770 @option{-F} is that with @option{-iframework} the compiler does not
10771 warn about constructs contained within header files found via
10772 @var{dir}.  This option is valid only for the C family of languages.
10774 @item -gused
10775 @opindex gused
10776 Emit debugging information for symbols that are used.  For STABS
10777 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10778 This is by default ON@.
10780 @item -gfull
10781 @opindex gfull
10782 Emit debugging information for all symbols and types.
10784 @item -mmacosx-version-min=@var{version}
10785 The earliest version of MacOS X that this executable will run on
10786 is @var{version}.  Typical values of @var{version} include @code{10.1},
10787 @code{10.2}, and @code{10.3.9}.
10789 If the compiler was built to use the system's headers by default,
10790 then the default for this option is the system version on which the
10791 compiler is running, otherwise the default is to make choices which
10792 are compatible with as many systems and code bases as possible.
10794 @item -mkernel
10795 @opindex mkernel
10796 Enable kernel development mode.  The @option{-mkernel} option sets
10797 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10798 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10799 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10800 applicable.  This mode also sets @option{-mno-altivec},
10801 @option{-msoft-float}, @option{-fno-builtin} and
10802 @option{-mlong-branch} for PowerPC targets.
10804 @item -mone-byte-bool
10805 @opindex mone-byte-bool
10806 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10807 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10808 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10809 option has no effect on x86.
10811 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10812 to generate code that is not binary compatible with code generated
10813 without that switch.  Using this switch may require recompiling all
10814 other modules in a program, including system libraries.  Use this
10815 switch to conform to a non-default data model.
10817 @item -mfix-and-continue
10818 @itemx -ffix-and-continue
10819 @itemx -findirect-data
10820 @opindex mfix-and-continue
10821 @opindex ffix-and-continue
10822 @opindex findirect-data
10823 Generate code suitable for fast turn around development.  Needed to
10824 enable gdb to dynamically load @code{.o} files into already running
10825 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10826 are provided for backwards compatibility.
10828 @item -all_load
10829 @opindex all_load
10830 Loads all members of static archive libraries.
10831 See man ld(1) for more information.
10833 @item -arch_errors_fatal
10834 @opindex arch_errors_fatal
10835 Cause the errors having to do with files that have the wrong architecture
10836 to be fatal.
10838 @item -bind_at_load
10839 @opindex bind_at_load
10840 Causes the output file to be marked such that the dynamic linker will
10841 bind all undefined references when the file is loaded or launched.
10843 @item -bundle
10844 @opindex bundle
10845 Produce a Mach-o bundle format file.
10846 See man ld(1) for more information.
10848 @item -bundle_loader @var{executable}
10849 @opindex bundle_loader
10850 This option specifies the @var{executable} that will be loading the build
10851 output file being linked.  See man ld(1) for more information.
10853 @item -dynamiclib
10854 @opindex dynamiclib
10855 When passed this option, GCC will produce a dynamic library instead of
10856 an executable when linking, using the Darwin @file{libtool} command.
10858 @item -force_cpusubtype_ALL
10859 @opindex force_cpusubtype_ALL
10860 This causes GCC's output file to have the @var{ALL} subtype, instead of
10861 one controlled by the @option{-mcpu} or @option{-march} option.
10863 @item -allowable_client  @var{client_name}
10864 @itemx -client_name
10865 @itemx -compatibility_version
10866 @itemx -current_version
10867 @itemx -dead_strip
10868 @itemx -dependency-file
10869 @itemx -dylib_file
10870 @itemx -dylinker_install_name
10871 @itemx -dynamic
10872 @itemx -exported_symbols_list
10873 @itemx -filelist
10874 @need 800
10875 @itemx -flat_namespace
10876 @itemx -force_flat_namespace
10877 @itemx -headerpad_max_install_names
10878 @itemx -image_base
10879 @itemx -init
10880 @itemx -install_name
10881 @itemx -keep_private_externs
10882 @itemx -multi_module
10883 @itemx -multiply_defined
10884 @itemx -multiply_defined_unused
10885 @need 800
10886 @itemx -noall_load
10887 @itemx -no_dead_strip_inits_and_terms
10888 @itemx -nofixprebinding
10889 @itemx -nomultidefs
10890 @itemx -noprebind
10891 @itemx -noseglinkedit
10892 @itemx -pagezero_size
10893 @itemx -prebind
10894 @itemx -prebind_all_twolevel_modules
10895 @itemx -private_bundle
10896 @need 800
10897 @itemx -read_only_relocs
10898 @itemx -sectalign
10899 @itemx -sectobjectsymbols
10900 @itemx -whyload
10901 @itemx -seg1addr
10902 @itemx -sectcreate
10903 @itemx -sectobjectsymbols
10904 @itemx -sectorder
10905 @itemx -segaddr
10906 @itemx -segs_read_only_addr
10907 @need 800
10908 @itemx -segs_read_write_addr
10909 @itemx -seg_addr_table
10910 @itemx -seg_addr_table_filename
10911 @itemx -seglinkedit
10912 @itemx -segprot
10913 @itemx -segs_read_only_addr
10914 @itemx -segs_read_write_addr
10915 @itemx -single_module
10916 @itemx -static
10917 @itemx -sub_library
10918 @need 800
10919 @itemx -sub_umbrella
10920 @itemx -twolevel_namespace
10921 @itemx -umbrella
10922 @itemx -undefined
10923 @itemx -unexported_symbols_list
10924 @itemx -weak_reference_mismatches
10925 @itemx -whatsloaded
10926 @opindex allowable_client
10927 @opindex client_name
10928 @opindex compatibility_version
10929 @opindex current_version
10930 @opindex dead_strip
10931 @opindex dependency-file
10932 @opindex dylib_file
10933 @opindex dylinker_install_name
10934 @opindex dynamic
10935 @opindex exported_symbols_list
10936 @opindex filelist
10937 @opindex flat_namespace
10938 @opindex force_flat_namespace
10939 @opindex headerpad_max_install_names
10940 @opindex image_base
10941 @opindex init
10942 @opindex install_name
10943 @opindex keep_private_externs
10944 @opindex multi_module
10945 @opindex multiply_defined
10946 @opindex multiply_defined_unused
10947 @opindex noall_load
10948 @opindex no_dead_strip_inits_and_terms
10949 @opindex nofixprebinding
10950 @opindex nomultidefs
10951 @opindex noprebind
10952 @opindex noseglinkedit
10953 @opindex pagezero_size
10954 @opindex prebind
10955 @opindex prebind_all_twolevel_modules
10956 @opindex private_bundle
10957 @opindex read_only_relocs
10958 @opindex sectalign
10959 @opindex sectobjectsymbols
10960 @opindex whyload
10961 @opindex seg1addr
10962 @opindex sectcreate
10963 @opindex sectobjectsymbols
10964 @opindex sectorder
10965 @opindex segaddr
10966 @opindex segs_read_only_addr
10967 @opindex segs_read_write_addr
10968 @opindex seg_addr_table
10969 @opindex seg_addr_table_filename
10970 @opindex seglinkedit
10971 @opindex segprot
10972 @opindex segs_read_only_addr
10973 @opindex segs_read_write_addr
10974 @opindex single_module
10975 @opindex static
10976 @opindex sub_library
10977 @opindex sub_umbrella
10978 @opindex twolevel_namespace
10979 @opindex umbrella
10980 @opindex undefined
10981 @opindex unexported_symbols_list
10982 @opindex weak_reference_mismatches
10983 @opindex whatsloaded
10984 These options are passed to the Darwin linker.  The Darwin linker man page
10985 describes them in detail.
10986 @end table
10988 @node DEC Alpha Options
10989 @subsection DEC Alpha Options
10991 These @samp{-m} options are defined for the DEC Alpha implementations:
10993 @table @gcctabopt
10994 @item -mno-soft-float
10995 @itemx -msoft-float
10996 @opindex mno-soft-float
10997 @opindex msoft-float
10998 Use (do not use) the hardware floating-point instructions for
10999 floating-point operations.  When @option{-msoft-float} is specified,
11000 functions in @file{libgcc.a} will be used to perform floating-point
11001 operations.  Unless they are replaced by routines that emulate the
11002 floating-point operations, or compiled in such a way as to call such
11003 emulations routines, these routines will issue floating-point
11004 operations.   If you are compiling for an Alpha without floating-point
11005 operations, you must ensure that the library is built so as not to call
11006 them.
11008 Note that Alpha implementations without floating-point operations are
11009 required to have floating-point registers.
11011 @item -mfp-reg
11012 @itemx -mno-fp-regs
11013 @opindex mfp-reg
11014 @opindex mno-fp-regs
11015 Generate code that uses (does not use) the floating-point register set.
11016 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
11017 register set is not used, floating point operands are passed in integer
11018 registers as if they were integers and floating-point results are passed
11019 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
11020 so any function with a floating-point argument or return value called by code
11021 compiled with @option{-mno-fp-regs} must also be compiled with that
11022 option.
11024 A typical use of this option is building a kernel that does not use,
11025 and hence need not save and restore, any floating-point registers.
11027 @item -mieee
11028 @opindex mieee
11029 The Alpha architecture implements floating-point hardware optimized for
11030 maximum performance.  It is mostly compliant with the IEEE floating
11031 point standard.  However, for full compliance, software assistance is
11032 required.  This option generates code fully IEEE compliant code
11033 @emph{except} that the @var{inexact-flag} is not maintained (see below).
11034 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
11035 defined during compilation.  The resulting code is less efficient but is
11036 able to correctly support denormalized numbers and exceptional IEEE
11037 values such as not-a-number and plus/minus infinity.  Other Alpha
11038 compilers call this option @option{-ieee_with_no_inexact}.
11040 @item -mieee-with-inexact
11041 @opindex mieee-with-inexact
11042 This is like @option{-mieee} except the generated code also maintains
11043 the IEEE @var{inexact-flag}.  Turning on this option causes the
11044 generated code to implement fully-compliant IEEE math.  In addition to
11045 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
11046 macro.  On some Alpha implementations the resulting code may execute
11047 significantly slower than the code generated by default.  Since there is
11048 very little code that depends on the @var{inexact-flag}, you should
11049 normally not specify this option.  Other Alpha compilers call this
11050 option @option{-ieee_with_inexact}.
11052 @item -mfp-trap-mode=@var{trap-mode}
11053 @opindex mfp-trap-mode
11054 This option controls what floating-point related traps are enabled.
11055 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
11056 The trap mode can be set to one of four values:
11058 @table @samp
11059 @item n
11060 This is the default (normal) setting.  The only traps that are enabled
11061 are the ones that cannot be disabled in software (e.g., division by zero
11062 trap).
11064 @item u
11065 In addition to the traps enabled by @samp{n}, underflow traps are enabled
11066 as well.
11068 @item su
11069 Like @samp{u}, but the instructions are marked to be safe for software
11070 completion (see Alpha architecture manual for details).
11072 @item sui
11073 Like @samp{su}, but inexact traps are enabled as well.
11074 @end table
11076 @item -mfp-rounding-mode=@var{rounding-mode}
11077 @opindex mfp-rounding-mode
11078 Selects the IEEE rounding mode.  Other Alpha compilers call this option
11079 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
11082 @table @samp
11083 @item n
11084 Normal IEEE rounding mode.  Floating point numbers are rounded towards
11085 the nearest machine number or towards the even machine number in case
11086 of a tie.
11088 @item m
11089 Round towards minus infinity.
11091 @item c
11092 Chopped rounding mode.  Floating point numbers are rounded towards zero.
11094 @item d
11095 Dynamic rounding mode.  A field in the floating point control register
11096 (@var{fpcr}, see Alpha architecture reference manual) controls the
11097 rounding mode in effect.  The C library initializes this register for
11098 rounding towards plus infinity.  Thus, unless your program modifies the
11099 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
11100 @end table
11102 @item -mtrap-precision=@var{trap-precision}
11103 @opindex mtrap-precision
11104 In the Alpha architecture, floating point traps are imprecise.  This
11105 means without software assistance it is impossible to recover from a
11106 floating trap and program execution normally needs to be terminated.
11107 GCC can generate code that can assist operating system trap handlers
11108 in determining the exact location that caused a floating point trap.
11109 Depending on the requirements of an application, different levels of
11110 precisions can be selected:
11112 @table @samp
11113 @item p
11114 Program precision.  This option is the default and means a trap handler
11115 can only identify which program caused a floating point exception.
11117 @item f
11118 Function precision.  The trap handler can determine the function that
11119 caused a floating point exception.
11121 @item i
11122 Instruction precision.  The trap handler can determine the exact
11123 instruction that caused a floating point exception.
11124 @end table
11126 Other Alpha compilers provide the equivalent options called
11127 @option{-scope_safe} and @option{-resumption_safe}.
11129 @item -mieee-conformant
11130 @opindex mieee-conformant
11131 This option marks the generated code as IEEE conformant.  You must not
11132 use this option unless you also specify @option{-mtrap-precision=i} and either
11133 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
11134 is to emit the line @samp{.eflag 48} in the function prologue of the
11135 generated assembly file.  Under DEC Unix, this has the effect that
11136 IEEE-conformant math library routines will be linked in.
11138 @item -mbuild-constants
11139 @opindex mbuild-constants
11140 Normally GCC examines a 32- or 64-bit integer constant to
11141 see if it can construct it from smaller constants in two or three
11142 instructions.  If it cannot, it will output the constant as a literal and
11143 generate code to load it from the data segment at runtime.
11145 Use this option to require GCC to construct @emph{all} integer constants
11146 using code, even if it takes more instructions (the maximum is six).
11148 You would typically use this option to build a shared library dynamic
11149 loader.  Itself a shared library, it must relocate itself in memory
11150 before it can find the variables and constants in its own data segment.
11152 @item -malpha-as
11153 @itemx -mgas
11154 @opindex malpha-as
11155 @opindex mgas
11156 Select whether to generate code to be assembled by the vendor-supplied
11157 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
11159 @item -mbwx
11160 @itemx -mno-bwx
11161 @itemx -mcix
11162 @itemx -mno-cix
11163 @itemx -mfix
11164 @itemx -mno-fix
11165 @itemx -mmax
11166 @itemx -mno-max
11167 @opindex mbwx
11168 @opindex mno-bwx
11169 @opindex mcix
11170 @opindex mno-cix
11171 @opindex mfix
11172 @opindex mno-fix
11173 @opindex mmax
11174 @opindex mno-max
11175 Indicate whether GCC should generate code to use the optional BWX,
11176 CIX, FIX and MAX instruction sets.  The default is to use the instruction
11177 sets supported by the CPU type specified via @option{-mcpu=} option or that
11178 of the CPU on which GCC was built if none was specified.
11180 @item -mfloat-vax
11181 @itemx -mfloat-ieee
11182 @opindex mfloat-vax
11183 @opindex mfloat-ieee
11184 Generate code that uses (does not use) VAX F and G floating point
11185 arithmetic instead of IEEE single and double precision.
11187 @item -mexplicit-relocs
11188 @itemx -mno-explicit-relocs
11189 @opindex mexplicit-relocs
11190 @opindex mno-explicit-relocs
11191 Older Alpha assemblers provided no way to generate symbol relocations
11192 except via assembler macros.  Use of these macros does not allow
11193 optimal instruction scheduling.  GNU binutils as of version 2.12
11194 supports a new syntax that allows the compiler to explicitly mark
11195 which relocations should apply to which instructions.  This option
11196 is mostly useful for debugging, as GCC detects the capabilities of
11197 the assembler when it is built and sets the default accordingly.
11199 @item -msmall-data
11200 @itemx -mlarge-data
11201 @opindex msmall-data
11202 @opindex mlarge-data
11203 When @option{-mexplicit-relocs} is in effect, static data is
11204 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
11205 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
11206 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
11207 16-bit relocations off of the @code{$gp} register.  This limits the
11208 size of the small data area to 64KB, but allows the variables to be
11209 directly accessed via a single instruction.
11211 The default is @option{-mlarge-data}.  With this option the data area
11212 is limited to just below 2GB@.  Programs that require more than 2GB of
11213 data must use @code{malloc} or @code{mmap} to allocate the data in the
11214 heap instead of in the program's data segment.
11216 When generating code for shared libraries, @option{-fpic} implies
11217 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
11219 @item -msmall-text
11220 @itemx -mlarge-text
11221 @opindex msmall-text
11222 @opindex mlarge-text
11223 When @option{-msmall-text} is used, the compiler assumes that the
11224 code of the entire program (or shared library) fits in 4MB, and is
11225 thus reachable with a branch instruction.  When @option{-msmall-data}
11226 is used, the compiler can assume that all local symbols share the
11227 same @code{$gp} value, and thus reduce the number of instructions
11228 required for a function call from 4 to 1.
11230 The default is @option{-mlarge-text}.
11232 @item -mcpu=@var{cpu_type}
11233 @opindex mcpu
11234 Set the instruction set and instruction scheduling parameters for
11235 machine type @var{cpu_type}.  You can specify either the @samp{EV}
11236 style name or the corresponding chip number.  GCC supports scheduling
11237 parameters for the EV4, EV5 and EV6 family of processors and will
11238 choose the default values for the instruction set from the processor
11239 you specify.  If you do not specify a processor type, GCC will default
11240 to the processor on which the compiler was built.
11242 Supported values for @var{cpu_type} are
11244 @table @samp
11245 @item ev4
11246 @itemx ev45
11247 @itemx 21064
11248 Schedules as an EV4 and has no instruction set extensions.
11250 @item ev5
11251 @itemx 21164
11252 Schedules as an EV5 and has no instruction set extensions.
11254 @item ev56
11255 @itemx 21164a
11256 Schedules as an EV5 and supports the BWX extension.
11258 @item pca56
11259 @itemx 21164pc
11260 @itemx 21164PC
11261 Schedules as an EV5 and supports the BWX and MAX extensions.
11263 @item ev6
11264 @itemx 21264
11265 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
11267 @item ev67
11268 @itemx 21264a
11269 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
11270 @end table
11272 Native Linux/GNU toolchains also support the value @samp{native},
11273 which selects the best architecture option for the host processor.
11274 @option{-mcpu=native} has no effect if GCC does not recognize
11275 the processor.
11277 @item -mtune=@var{cpu_type}
11278 @opindex mtune
11279 Set only the instruction scheduling parameters for machine type
11280 @var{cpu_type}.  The instruction set is not changed.
11282 Native Linux/GNU toolchains also support the value @samp{native},
11283 which selects the best architecture option for the host processor.
11284 @option{-mtune=native} has no effect if GCC does not recognize
11285 the processor.
11287 @item -mmemory-latency=@var{time}
11288 @opindex mmemory-latency
11289 Sets the latency the scheduler should assume for typical memory
11290 references as seen by the application.  This number is highly
11291 dependent on the memory access patterns used by the application
11292 and the size of the external cache on the machine.
11294 Valid options for @var{time} are
11296 @table @samp
11297 @item @var{number}
11298 A decimal number representing clock cycles.
11300 @item L1
11301 @itemx L2
11302 @itemx L3
11303 @itemx main
11304 The compiler contains estimates of the number of clock cycles for
11305 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
11306 (also called Dcache, Scache, and Bcache), as well as to main memory.
11307 Note that L3 is only valid for EV5.
11309 @end table
11310 @end table
11312 @node DEC Alpha/VMS Options
11313 @subsection DEC Alpha/VMS Options
11315 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
11317 @table @gcctabopt
11318 @item -mvms-return-codes
11319 @opindex mvms-return-codes
11320 Return VMS condition codes from main.  The default is to return POSIX
11321 style condition (e.g.@: error) codes.
11323 @item -mdebug-main=@var{prefix}
11324 @opindex mdebug-main=@var{prefix}
11325 Flag the first routine whose name starts with @var{prefix} as the main
11326 routine for the debugger.
11328 @item -mmalloc64
11329 @opindex mmalloc64
11330 Default to 64bit memory allocation routines.
11331 @end table
11333 @node FR30 Options
11334 @subsection FR30 Options
11335 @cindex FR30 Options
11337 These options are defined specifically for the FR30 port.
11339 @table @gcctabopt
11341 @item -msmall-model
11342 @opindex msmall-model
11343 Use the small address space model.  This can produce smaller code, but
11344 it does assume that all symbolic values and addresses will fit into a
11345 20-bit range.
11347 @item -mno-lsim
11348 @opindex mno-lsim
11349 Assume that run-time support has been provided and so there is no need
11350 to include the simulator library (@file{libsim.a}) on the linker
11351 command line.
11353 @end table
11355 @node FRV Options
11356 @subsection FRV Options
11357 @cindex FRV Options
11359 @table @gcctabopt
11360 @item -mgpr-32
11361 @opindex mgpr-32
11363 Only use the first 32 general purpose registers.
11365 @item -mgpr-64
11366 @opindex mgpr-64
11368 Use all 64 general purpose registers.
11370 @item -mfpr-32
11371 @opindex mfpr-32
11373 Use only the first 32 floating point registers.
11375 @item -mfpr-64
11376 @opindex mfpr-64
11378 Use all 64 floating point registers
11380 @item -mhard-float
11381 @opindex mhard-float
11383 Use hardware instructions for floating point operations.
11385 @item -msoft-float
11386 @opindex msoft-float
11388 Use library routines for floating point operations.
11390 @item -malloc-cc
11391 @opindex malloc-cc
11393 Dynamically allocate condition code registers.
11395 @item -mfixed-cc
11396 @opindex mfixed-cc
11398 Do not try to dynamically allocate condition code registers, only
11399 use @code{icc0} and @code{fcc0}.
11401 @item -mdword
11402 @opindex mdword
11404 Change ABI to use double word insns.
11406 @item -mno-dword
11407 @opindex mno-dword
11409 Do not use double word instructions.
11411 @item -mdouble
11412 @opindex mdouble
11414 Use floating point double instructions.
11416 @item -mno-double
11417 @opindex mno-double
11419 Do not use floating point double instructions.
11421 @item -mmedia
11422 @opindex mmedia
11424 Use media instructions.
11426 @item -mno-media
11427 @opindex mno-media
11429 Do not use media instructions.
11431 @item -mmuladd
11432 @opindex mmuladd
11434 Use multiply and add/subtract instructions.
11436 @item -mno-muladd
11437 @opindex mno-muladd
11439 Do not use multiply and add/subtract instructions.
11441 @item -mfdpic
11442 @opindex mfdpic
11444 Select the FDPIC ABI, that uses function descriptors to represent
11445 pointers to functions.  Without any PIC/PIE-related options, it
11446 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
11447 assumes GOT entries and small data are within a 12-bit range from the
11448 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11449 are computed with 32 bits.
11450 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11452 @item -minline-plt
11453 @opindex minline-plt
11455 Enable inlining of PLT entries in function calls to functions that are
11456 not known to bind locally.  It has no effect without @option{-mfdpic}.
11457 It's enabled by default if optimizing for speed and compiling for
11458 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11459 optimization option such as @option{-O3} or above is present in the
11460 command line.
11462 @item -mTLS
11463 @opindex mTLS
11465 Assume a large TLS segment when generating thread-local code.
11467 @item -mtls
11468 @opindex mtls
11470 Do not assume a large TLS segment when generating thread-local code.
11472 @item -mgprel-ro
11473 @opindex mgprel-ro
11475 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11476 that is known to be in read-only sections.  It's enabled by default,
11477 except for @option{-fpic} or @option{-fpie}: even though it may help
11478 make the global offset table smaller, it trades 1 instruction for 4.
11479 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11480 one of which may be shared by multiple symbols, and it avoids the need
11481 for a GOT entry for the referenced symbol, so it's more likely to be a
11482 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
11484 @item -multilib-library-pic
11485 @opindex multilib-library-pic
11487 Link with the (library, not FD) pic libraries.  It's implied by
11488 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11489 @option{-fpic} without @option{-mfdpic}.  You should never have to use
11490 it explicitly.
11492 @item -mlinked-fp
11493 @opindex mlinked-fp
11495 Follow the EABI requirement of always creating a frame pointer whenever
11496 a stack frame is allocated.  This option is enabled by default and can
11497 be disabled with @option{-mno-linked-fp}.
11499 @item -mlong-calls
11500 @opindex mlong-calls
11502 Use indirect addressing to call functions outside the current
11503 compilation unit.  This allows the functions to be placed anywhere
11504 within the 32-bit address space.
11506 @item -malign-labels
11507 @opindex malign-labels
11509 Try to align labels to an 8-byte boundary by inserting nops into the
11510 previous packet.  This option only has an effect when VLIW packing
11511 is enabled.  It doesn't create new packets; it merely adds nops to
11512 existing ones.
11514 @item -mlibrary-pic
11515 @opindex mlibrary-pic
11517 Generate position-independent EABI code.
11519 @item -macc-4
11520 @opindex macc-4
11522 Use only the first four media accumulator registers.
11524 @item -macc-8
11525 @opindex macc-8
11527 Use all eight media accumulator registers.
11529 @item -mpack
11530 @opindex mpack
11532 Pack VLIW instructions.
11534 @item -mno-pack
11535 @opindex mno-pack
11537 Do not pack VLIW instructions.
11539 @item -mno-eflags
11540 @opindex mno-eflags
11542 Do not mark ABI switches in e_flags.
11544 @item -mcond-move
11545 @opindex mcond-move
11547 Enable the use of conditional-move instructions (default).
11549 This switch is mainly for debugging the compiler and will likely be removed
11550 in a future version.
11552 @item -mno-cond-move
11553 @opindex mno-cond-move
11555 Disable the use of conditional-move instructions.
11557 This switch is mainly for debugging the compiler and will likely be removed
11558 in a future version.
11560 @item -mscc
11561 @opindex mscc
11563 Enable the use of conditional set instructions (default).
11565 This switch is mainly for debugging the compiler and will likely be removed
11566 in a future version.
11568 @item -mno-scc
11569 @opindex mno-scc
11571 Disable the use of conditional set instructions.
11573 This switch is mainly for debugging the compiler and will likely be removed
11574 in a future version.
11576 @item -mcond-exec
11577 @opindex mcond-exec
11579 Enable the use of conditional execution (default).
11581 This switch is mainly for debugging the compiler and will likely be removed
11582 in a future version.
11584 @item -mno-cond-exec
11585 @opindex mno-cond-exec
11587 Disable the use of conditional execution.
11589 This switch is mainly for debugging the compiler and will likely be removed
11590 in a future version.
11592 @item -mvliw-branch
11593 @opindex mvliw-branch
11595 Run a pass to pack branches into VLIW instructions (default).
11597 This switch is mainly for debugging the compiler and will likely be removed
11598 in a future version.
11600 @item -mno-vliw-branch
11601 @opindex mno-vliw-branch
11603 Do not run a pass to pack branches into VLIW instructions.
11605 This switch is mainly for debugging the compiler and will likely be removed
11606 in a future version.
11608 @item -mmulti-cond-exec
11609 @opindex mmulti-cond-exec
11611 Enable optimization of @code{&&} and @code{||} in conditional execution
11612 (default).
11614 This switch is mainly for debugging the compiler and will likely be removed
11615 in a future version.
11617 @item -mno-multi-cond-exec
11618 @opindex mno-multi-cond-exec
11620 Disable optimization of @code{&&} and @code{||} in conditional execution.
11622 This switch is mainly for debugging the compiler and will likely be removed
11623 in a future version.
11625 @item -mnested-cond-exec
11626 @opindex mnested-cond-exec
11628 Enable nested conditional execution optimizations (default).
11630 This switch is mainly for debugging the compiler and will likely be removed
11631 in a future version.
11633 @item -mno-nested-cond-exec
11634 @opindex mno-nested-cond-exec
11636 Disable nested conditional execution optimizations.
11638 This switch is mainly for debugging the compiler and will likely be removed
11639 in a future version.
11641 @item -moptimize-membar
11642 @opindex moptimize-membar
11644 This switch removes redundant @code{membar} instructions from the
11645 compiler generated code.  It is enabled by default.
11647 @item -mno-optimize-membar
11648 @opindex mno-optimize-membar
11650 This switch disables the automatic removal of redundant @code{membar}
11651 instructions from the generated code.
11653 @item -mtomcat-stats
11654 @opindex mtomcat-stats
11656 Cause gas to print out tomcat statistics.
11658 @item -mcpu=@var{cpu}
11659 @opindex mcpu
11661 Select the processor type for which to generate code.  Possible values are
11662 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11663 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11665 @end table
11667 @node GNU/Linux Options
11668 @subsection GNU/Linux Options
11670 These @samp{-m} options are defined for GNU/Linux targets:
11672 @table @gcctabopt
11673 @item -mglibc
11674 @opindex mglibc
11675 Use the GNU C library.  This is the default except
11676 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
11678 @item -muclibc
11679 @opindex muclibc
11680 Use uClibc C library.  This is the default on
11681 @samp{*-*-linux-*uclibc*} targets.
11683 @item -mbionic
11684 @opindex mbionic
11685 Use Bionic C library.  This is the default on
11686 @samp{*-*-linux-*android*} targets.
11688 @item -mandroid
11689 @opindex mandroid
11690 Compile code compatible with Android platform.  This is the default on
11691 @samp{*-*-linux-*android*} targets.
11693 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
11694 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
11695 this option makes the GCC driver pass Android-specific options to the linker.
11696 Finally, this option causes the preprocessor macro @code{__ANDROID__}
11697 to be defined.
11699 @item -tno-android-cc
11700 @opindex tno-android-cc
11701 Disable compilation effects of @option{-mandroid}, i.e., do not enable
11702 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
11703 @option{-fno-rtti} by default.
11705 @item -tno-android-ld
11706 @opindex tno-android-ld
11707 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
11708 linking options to the linker.
11710 @end table
11712 @node H8/300 Options
11713 @subsection H8/300 Options
11715 These @samp{-m} options are defined for the H8/300 implementations:
11717 @table @gcctabopt
11718 @item -mrelax
11719 @opindex mrelax
11720 Shorten some address references at link time, when possible; uses the
11721 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11722 ld, Using ld}, for a fuller description.
11724 @item -mh
11725 @opindex mh
11726 Generate code for the H8/300H@.
11728 @item -ms
11729 @opindex ms
11730 Generate code for the H8S@.
11732 @item -mn
11733 @opindex mn
11734 Generate code for the H8S and H8/300H in the normal mode.  This switch
11735 must be used either with @option{-mh} or @option{-ms}.
11737 @item -ms2600
11738 @opindex ms2600
11739 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11741 @item -mint32
11742 @opindex mint32
11743 Make @code{int} data 32 bits by default.
11745 @item -malign-300
11746 @opindex malign-300
11747 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11748 The default for the H8/300H and H8S is to align longs and floats on 4
11749 byte boundaries.
11750 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11751 This option has no effect on the H8/300.
11752 @end table
11754 @node HPPA Options
11755 @subsection HPPA Options
11756 @cindex HPPA Options
11758 These @samp{-m} options are defined for the HPPA family of computers:
11760 @table @gcctabopt
11761 @item -march=@var{architecture-type}
11762 @opindex march
11763 Generate code for the specified architecture.  The choices for
11764 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11765 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11766 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11767 architecture option for your machine.  Code compiled for lower numbered
11768 architectures will run on higher numbered architectures, but not the
11769 other way around.
11771 @item -mpa-risc-1-0
11772 @itemx -mpa-risc-1-1
11773 @itemx -mpa-risc-2-0
11774 @opindex mpa-risc-1-0
11775 @opindex mpa-risc-1-1
11776 @opindex mpa-risc-2-0
11777 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11779 @item -mbig-switch
11780 @opindex mbig-switch
11781 Generate code suitable for big switch tables.  Use this option only if
11782 the assembler/linker complain about out of range branches within a switch
11783 table.
11785 @item -mjump-in-delay
11786 @opindex mjump-in-delay
11787 Fill delay slots of function calls with unconditional jump instructions
11788 by modifying the return pointer for the function call to be the target
11789 of the conditional jump.
11791 @item -mdisable-fpregs
11792 @opindex mdisable-fpregs
11793 Prevent floating point registers from being used in any manner.  This is
11794 necessary for compiling kernels which perform lazy context switching of
11795 floating point registers.  If you use this option and attempt to perform
11796 floating point operations, the compiler will abort.
11798 @item -mdisable-indexing
11799 @opindex mdisable-indexing
11800 Prevent the compiler from using indexing address modes.  This avoids some
11801 rather obscure problems when compiling MIG generated code under MACH@.
11803 @item -mno-space-regs
11804 @opindex mno-space-regs
11805 Generate code that assumes the target has no space registers.  This allows
11806 GCC to generate faster indirect calls and use unscaled index address modes.
11808 Such code is suitable for level 0 PA systems and kernels.
11810 @item -mfast-indirect-calls
11811 @opindex mfast-indirect-calls
11812 Generate code that assumes calls never cross space boundaries.  This
11813 allows GCC to emit code which performs faster indirect calls.
11815 This option will not work in the presence of shared libraries or nested
11816 functions.
11818 @item -mfixed-range=@var{register-range}
11819 @opindex mfixed-range
11820 Generate code treating the given register range as fixed registers.
11821 A fixed register is one that the register allocator can not use.  This is
11822 useful when compiling kernel code.  A register range is specified as
11823 two registers separated by a dash.  Multiple register ranges can be
11824 specified separated by a comma.
11826 @item -mlong-load-store
11827 @opindex mlong-load-store
11828 Generate 3-instruction load and store sequences as sometimes required by
11829 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11830 the HP compilers.
11832 @item -mportable-runtime
11833 @opindex mportable-runtime
11834 Use the portable calling conventions proposed by HP for ELF systems.
11836 @item -mgas
11837 @opindex mgas
11838 Enable the use of assembler directives only GAS understands.
11840 @item -mschedule=@var{cpu-type}
11841 @opindex mschedule
11842 Schedule code according to the constraints for the machine type
11843 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11844 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11845 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11846 proper scheduling option for your machine.  The default scheduling is
11847 @samp{8000}.
11849 @item -mlinker-opt
11850 @opindex mlinker-opt
11851 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11852 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11853 linkers in which they give bogus error messages when linking some programs.
11855 @item -msoft-float
11856 @opindex msoft-float
11857 Generate output containing library calls for floating point.
11858 @strong{Warning:} the requisite libraries are not available for all HPPA
11859 targets.  Normally the facilities of the machine's usual C compiler are
11860 used, but this cannot be done directly in cross-compilation.  You must make
11861 your own arrangements to provide suitable library functions for
11862 cross-compilation.
11864 @option{-msoft-float} changes the calling convention in the output file;
11865 therefore, it is only useful if you compile @emph{all} of a program with
11866 this option.  In particular, you need to compile @file{libgcc.a}, the
11867 library that comes with GCC, with @option{-msoft-float} in order for
11868 this to work.
11870 @item -msio
11871 @opindex msio
11872 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11873 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11874 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11875 options are available under HP-UX and HI-UX@.
11877 @item -mgnu-ld
11878 @opindex mgnu-ld
11879 Use GNU ld specific options.  This passes @option{-shared} to ld when
11880 building a shared library.  It is the default when GCC is configured,
11881 explicitly or implicitly, with the GNU linker.  This option does not
11882 have any affect on which ld is called, it only changes what parameters
11883 are passed to that ld.  The ld that is called is determined by the
11884 @option{--with-ld} configure option, GCC's program search path, and
11885 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11886 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11887 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11889 @item -mhp-ld
11890 @opindex mhp-ld
11891 Use HP ld specific options.  This passes @option{-b} to ld when building
11892 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11893 links.  It is the default when GCC is configured, explicitly or
11894 implicitly, with the HP linker.  This option does not have any affect on
11895 which ld is called, it only changes what parameters are passed to that
11896 ld.  The ld that is called is determined by the @option{--with-ld}
11897 configure option, GCC's program search path, and finally by the user's
11898 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11899 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11900 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11902 @item -mlong-calls
11903 @opindex mno-long-calls
11904 Generate code that uses long call sequences.  This ensures that a call
11905 is always able to reach linker generated stubs.  The default is to generate
11906 long calls only when the distance from the call site to the beginning
11907 of the function or translation unit, as the case may be, exceeds a
11908 predefined limit set by the branch type being used.  The limits for
11909 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11910 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11911 240,000 bytes.
11913 Distances are measured from the beginning of functions when using the
11914 @option{-ffunction-sections} option, or when using the @option{-mgas}
11915 and @option{-mno-portable-runtime} options together under HP-UX with
11916 the SOM linker.
11918 It is normally not desirable to use this option as it will degrade
11919 performance.  However, it may be useful in large applications,
11920 particularly when partial linking is used to build the application.
11922 The types of long calls used depends on the capabilities of the
11923 assembler and linker, and the type of code being generated.  The
11924 impact on systems that support long absolute calls, and long pic
11925 symbol-difference or pc-relative calls should be relatively small.
11926 However, an indirect call is used on 32-bit ELF systems in pic code
11927 and it is quite long.
11929 @item -munix=@var{unix-std}
11930 @opindex march
11931 Generate compiler predefines and select a startfile for the specified
11932 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11933 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11934 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11935 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11936 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11937 and later.
11939 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11940 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11941 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11942 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11943 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11944 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11946 It is @emph{important} to note that this option changes the interfaces
11947 for various library routines.  It also affects the operational behavior
11948 of the C library.  Thus, @emph{extreme} care is needed in using this
11949 option.
11951 Library code that is intended to operate with more than one UNIX
11952 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11953 as appropriate.  Most GNU software doesn't provide this capability.
11955 @item -nolibdld
11956 @opindex nolibdld
11957 Suppress the generation of link options to search libdld.sl when the
11958 @option{-static} option is specified on HP-UX 10 and later.
11960 @item -static
11961 @opindex static
11962 The HP-UX implementation of setlocale in libc has a dependency on
11963 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11964 when the @option{-static} option is specified, special link options
11965 are needed to resolve this dependency.
11967 On HP-UX 10 and later, the GCC driver adds the necessary options to
11968 link with libdld.sl when the @option{-static} option is specified.
11969 This causes the resulting binary to be dynamic.  On the 64-bit port,
11970 the linkers generate dynamic binaries by default in any case.  The
11971 @option{-nolibdld} option can be used to prevent the GCC driver from
11972 adding these link options.
11974 @item -threads
11975 @opindex threads
11976 Add support for multithreading with the @dfn{dce thread} library
11977 under HP-UX@.  This option sets flags for both the preprocessor and
11978 linker.
11979 @end table
11981 @node i386 and x86-64 Options
11982 @subsection Intel 386 and AMD x86-64 Options
11983 @cindex i386 Options
11984 @cindex x86-64 Options
11985 @cindex Intel 386 Options
11986 @cindex AMD x86-64 Options
11988 These @samp{-m} options are defined for the i386 and x86-64 family of
11989 computers:
11991 @table @gcctabopt
11992 @item -mtune=@var{cpu-type}
11993 @opindex mtune
11994 Tune to @var{cpu-type} everything applicable about the generated code, except
11995 for the ABI and the set of available instructions.  The choices for
11996 @var{cpu-type} are:
11997 @table @emph
11998 @item generic
11999 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
12000 If you know the CPU on which your code will run, then you should use
12001 the corresponding @option{-mtune} option instead of
12002 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
12003 of your application will have, then you should use this option.
12005 As new processors are deployed in the marketplace, the behavior of this
12006 option will change.  Therefore, if you upgrade to a newer version of
12007 GCC, the code generated option will change to reflect the processors
12008 that were most common when that version of GCC was released.
12010 There is no @option{-march=generic} option because @option{-march}
12011 indicates the instruction set the compiler can use, and there is no
12012 generic instruction set applicable to all processors.  In contrast,
12013 @option{-mtune} indicates the processor (or, in this case, collection of
12014 processors) for which the code is optimized.
12015 @item native
12016 This selects the CPU to tune for at compilation time by determining
12017 the processor type of the compiling machine.  Using @option{-mtune=native}
12018 will produce code optimized for the local machine under the constraints
12019 of the selected instruction set.  Using @option{-march=native} will
12020 enable all instruction subsets supported by the local machine (hence
12021 the result might not run on different machines).
12022 @item i386
12023 Original Intel's i386 CPU@.
12024 @item i486
12025 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
12026 @item i586, pentium
12027 Intel Pentium CPU with no MMX support.
12028 @item pentium-mmx
12029 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
12030 @item pentiumpro
12031 Intel PentiumPro CPU@.
12032 @item i686
12033 Same as @code{generic}, but when used as @code{march} option, PentiumPro
12034 instruction set will be used, so the code will run on all i686 family chips.
12035 @item pentium2
12036 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
12037 @item pentium3, pentium3m
12038 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
12039 support.
12040 @item pentium-m
12041 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
12042 support.  Used by Centrino notebooks.
12043 @item pentium4, pentium4m
12044 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
12045 @item prescott
12046 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
12047 set support.
12048 @item nocona
12049 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
12050 SSE2 and SSE3 instruction set support.
12051 @item core2
12052 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
12053 instruction set support.
12054 @item atom
12055 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
12056 instruction set support.
12057 @item k6
12058 AMD K6 CPU with MMX instruction set support.
12059 @item k6-2, k6-3
12060 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
12061 @item athlon, athlon-tbird
12062 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
12063 support.
12064 @item athlon-4, athlon-xp, athlon-mp
12065 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
12066 instruction set support.
12067 @item k8, opteron, athlon64, athlon-fx
12068 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
12069 MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit instruction set extensions.)
12070 @item k8-sse3, opteron-sse3, athlon64-sse3
12071 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
12072 @item amdfam10, barcelona
12073 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
12074 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
12075 instruction set extensions.)
12076 @item winchip-c6
12077 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
12078 set support.
12079 @item winchip2
12080 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
12081 instruction set support.
12082 @item c3
12083 Via C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
12084 implemented for this chip.)
12085 @item c3-2
12086 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
12087 implemented for this chip.)
12088 @item geode
12089 Embedded AMD CPU with MMX and 3DNow!@: instruction set support.
12090 @end table
12092 While picking a specific @var{cpu-type} will schedule things appropriately
12093 for that particular chip, the compiler will not generate any code that
12094 does not run on the i386 without the @option{-march=@var{cpu-type}} option
12095 being used.
12097 @item -march=@var{cpu-type}
12098 @opindex march
12099 Generate instructions for the machine type @var{cpu-type}.  The choices
12100 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
12101 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
12103 @item -mcpu=@var{cpu-type}
12104 @opindex mcpu
12105 A deprecated synonym for @option{-mtune}.
12107 @item -mfpmath=@var{unit}
12108 @opindex mfpmath
12109 Generate floating point arithmetics for selected unit @var{unit}.  The choices
12110 for @var{unit} are:
12112 @table @samp
12113 @item 387
12114 Use the standard 387 floating point coprocessor present majority of chips and
12115 emulated otherwise.  Code compiled with this option will run almost everywhere.
12116 The temporary results are computed in 80bit precision instead of precision
12117 specified by the type resulting in slightly different results compared to most
12118 of other chips.  See @option{-ffloat-store} for more detailed description.
12120 This is the default choice for i386 compiler.
12122 @item sse
12123 Use scalar floating point instructions present in the SSE instruction set.
12124 This instruction set is supported by Pentium3 and newer chips, in the AMD line
12125 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
12126 instruction set supports only single precision arithmetics, thus the double and
12127 extended precision arithmetics is still done using 387.  Later version, present
12128 only in Pentium4 and the future AMD x86-64 chips supports double precision
12129 arithmetics too.
12131 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
12132 or @option{-msse2} switches to enable SSE extensions and make this option
12133 effective.  For the x86-64 compiler, these extensions are enabled by default.
12135 The resulting code should be considerably faster in the majority of cases and avoid
12136 the numerical instability problems of 387 code, but may break some existing
12137 code that expects temporaries to be 80bit.
12139 This is the default choice for the x86-64 compiler.
12141 @item sse,387
12142 @itemx sse+387
12143 @itemx both
12144 Attempt to utilize both instruction sets at once.  This effectively double the
12145 amount of available registers and on chips with separate execution units for
12146 387 and SSE the execution resources too.  Use this option with care, as it is
12147 still experimental, because the GCC register allocator does not model separate
12148 functional units well resulting in instable performance.
12149 @end table
12151 @item -masm=@var{dialect}
12152 @opindex masm=@var{dialect}
12153 Output asm instructions using selected @var{dialect}.  Supported
12154 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
12155 not support @samp{intel}.
12157 @item -mieee-fp
12158 @itemx -mno-ieee-fp
12159 @opindex mieee-fp
12160 @opindex mno-ieee-fp
12161 Control whether or not the compiler uses IEEE floating point
12162 comparisons.  These handle correctly the case where the result of a
12163 comparison is unordered.
12165 @item -msoft-float
12166 @opindex msoft-float
12167 Generate output containing library calls for floating point.
12168 @strong{Warning:} the requisite libraries are not part of GCC@.
12169 Normally the facilities of the machine's usual C compiler are used, but
12170 this can't be done directly in cross-compilation.  You must make your
12171 own arrangements to provide suitable library functions for
12172 cross-compilation.
12174 On machines where a function returns floating point results in the 80387
12175 register stack, some floating point opcodes may be emitted even if
12176 @option{-msoft-float} is used.
12178 @item -mno-fp-ret-in-387
12179 @opindex mno-fp-ret-in-387
12180 Do not use the FPU registers for return values of functions.
12182 The usual calling convention has functions return values of types
12183 @code{float} and @code{double} in an FPU register, even if there
12184 is no FPU@.  The idea is that the operating system should emulate
12185 an FPU@.
12187 The option @option{-mno-fp-ret-in-387} causes such values to be returned
12188 in ordinary CPU registers instead.
12190 @item -mno-fancy-math-387
12191 @opindex mno-fancy-math-387
12192 Some 387 emulators do not support the @code{sin}, @code{cos} and
12193 @code{sqrt} instructions for the 387.  Specify this option to avoid
12194 generating those instructions.  This option is the default on FreeBSD,
12195 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
12196 indicates that the target cpu will always have an FPU and so the
12197 instruction will not need emulation.  As of revision 2.6.1, these
12198 instructions are not generated unless you also use the
12199 @option{-funsafe-math-optimizations} switch.
12201 @item -malign-double
12202 @itemx -mno-align-double
12203 @opindex malign-double
12204 @opindex mno-align-double
12205 Control whether GCC aligns @code{double}, @code{long double}, and
12206 @code{long long} variables on a two word boundary or a one word
12207 boundary.  Aligning @code{double} variables on a two word boundary will
12208 produce code that runs somewhat faster on a @samp{Pentium} at the
12209 expense of more memory.
12211 On x86-64, @option{-malign-double} is enabled by default.
12213 @strong{Warning:} if you use the @option{-malign-double} switch,
12214 structures containing the above types will be aligned differently than
12215 the published application binary interface specifications for the 386
12216 and will not be binary compatible with structures in code compiled
12217 without that switch.
12219 @item -m96bit-long-double
12220 @itemx -m128bit-long-double
12221 @opindex m96bit-long-double
12222 @opindex m128bit-long-double
12223 These switches control the size of @code{long double} type.  The i386
12224 application binary interface specifies the size to be 96 bits,
12225 so @option{-m96bit-long-double} is the default in 32 bit mode.
12227 Modern architectures (Pentium and newer) would prefer @code{long double}
12228 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
12229 conforming to the ABI, this would not be possible.  So specifying a
12230 @option{-m128bit-long-double} will align @code{long double}
12231 to a 16 byte boundary by padding the @code{long double} with an additional
12232 32 bit zero.
12234 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
12235 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
12237 Notice that neither of these options enable any extra precision over the x87
12238 standard of 80 bits for a @code{long double}.
12240 @strong{Warning:} if you override the default value for your target ABI, the
12241 structures and arrays containing @code{long double} variables will change
12242 their size as well as function calling convention for function taking
12243 @code{long double} will be modified.  Hence they will not be binary
12244 compatible with arrays or structures in code compiled without that switch.
12246 @item -mlarge-data-threshold=@var{number}
12247 @opindex mlarge-data-threshold=@var{number}
12248 When @option{-mcmodel=medium} is specified, the data greater than
12249 @var{threshold} are placed in large data section.  This value must be the
12250 same across all object linked into the binary and defaults to 65535.
12252 @item -mrtd
12253 @opindex mrtd
12254 Use a different function-calling convention, in which functions that
12255 take a fixed number of arguments return with the @code{ret} @var{num}
12256 instruction, which pops their arguments while returning.  This saves one
12257 instruction in the caller since there is no need to pop the arguments
12258 there.
12260 You can specify that an individual function is called with this calling
12261 sequence with the function attribute @samp{stdcall}.  You can also
12262 override the @option{-mrtd} option by using the function attribute
12263 @samp{cdecl}.  @xref{Function Attributes}.
12265 @strong{Warning:} this calling convention is incompatible with the one
12266 normally used on Unix, so you cannot use it if you need to call
12267 libraries compiled with the Unix compiler.
12269 Also, you must provide function prototypes for all functions that
12270 take variable numbers of arguments (including @code{printf});
12271 otherwise incorrect code will be generated for calls to those
12272 functions.
12274 In addition, seriously incorrect code will result if you call a
12275 function with too many arguments.  (Normally, extra arguments are
12276 harmlessly ignored.)
12278 @item -mregparm=@var{num}
12279 @opindex mregparm
12280 Control how many registers are used to pass integer arguments.  By
12281 default, no registers are used to pass arguments, and at most 3
12282 registers can be used.  You can control this behavior for a specific
12283 function by using the function attribute @samp{regparm}.
12284 @xref{Function Attributes}.
12286 @strong{Warning:} if you use this switch, and
12287 @var{num} is nonzero, then you must build all modules with the same
12288 value, including any libraries.  This includes the system libraries and
12289 startup modules.
12291 @item -msseregparm
12292 @opindex msseregparm
12293 Use SSE register passing conventions for float and double arguments
12294 and return values.  You can control this behavior for a specific
12295 function by using the function attribute @samp{sseregparm}.
12296 @xref{Function Attributes}.
12298 @strong{Warning:} if you use this switch then you must build all
12299 modules with the same value, including any libraries.  This includes
12300 the system libraries and startup modules.
12302 @item -mvect8-ret-in-mem
12303 @opindex mvect8-ret-in-mem
12304 Return 8-byte vectors in memory instead of MMX registers.  This is the
12305 default on Solaris~8 and 9 and VxWorks to match the ABI of the Sun
12306 Studio compilers until version 12.  Later compiler versions (starting
12307 with Studio 12 Update~1) follow the ABI used by other x86 targets, which
12308 is the default on Solaris~10 and later.  @emph{Only} use this option if
12309 you need to remain compatible with existing code produced by those
12310 previous compiler versions or older versions of GCC.
12312 @item -mpc32
12313 @itemx -mpc64
12314 @itemx -mpc80
12315 @opindex mpc32
12316 @opindex mpc64
12317 @opindex mpc80
12319 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
12320 is specified, the significands of results of floating-point operations are
12321 rounded to 24 bits (single precision); @option{-mpc64} rounds the
12322 significands of results of floating-point operations to 53 bits (double
12323 precision) and @option{-mpc80} rounds the significands of results of
12324 floating-point operations to 64 bits (extended double precision), which is
12325 the default.  When this option is used, floating-point operations in higher
12326 precisions are not available to the programmer without setting the FPU
12327 control word explicitly.
12329 Setting the rounding of floating-point operations to less than the default
12330 80 bits can speed some programs by 2% or more.  Note that some mathematical
12331 libraries assume that extended precision (80 bit) floating-point operations
12332 are enabled by default; routines in such libraries could suffer significant
12333 loss of accuracy, typically through so-called "catastrophic cancellation",
12334 when this option is used to set the precision to less than extended precision.
12336 @item -mstackrealign
12337 @opindex mstackrealign
12338 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
12339 option will generate an alternate prologue and epilogue that realigns the
12340 runtime stack if necessary.  This supports mixing legacy codes that keep
12341 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
12342 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
12343 applicable to individual functions.
12345 @item -mpreferred-stack-boundary=@var{num}
12346 @opindex mpreferred-stack-boundary
12347 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
12348 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
12349 the default is 4 (16 bytes or 128 bits).
12351 @item -mincoming-stack-boundary=@var{num}
12352 @opindex mincoming-stack-boundary
12353 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
12354 boundary.  If @option{-mincoming-stack-boundary} is not specified,
12355 the one specified by @option{-mpreferred-stack-boundary} will be used.
12357 On Pentium and PentiumPro, @code{double} and @code{long double} values
12358 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
12359 suffer significant run time performance penalties.  On Pentium III, the
12360 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
12361 properly if it is not 16 byte aligned.
12363 To ensure proper alignment of this values on the stack, the stack boundary
12364 must be as aligned as that required by any value stored on the stack.
12365 Further, every function must be generated such that it keeps the stack
12366 aligned.  Thus calling a function compiled with a higher preferred
12367 stack boundary from a function compiled with a lower preferred stack
12368 boundary will most likely misalign the stack.  It is recommended that
12369 libraries that use callbacks always use the default setting.
12371 This extra alignment does consume extra stack space, and generally
12372 increases code size.  Code that is sensitive to stack space usage, such
12373 as embedded systems and operating system kernels, may want to reduce the
12374 preferred alignment to @option{-mpreferred-stack-boundary=2}.
12376 @item -mmmx
12377 @itemx -mno-mmx
12378 @itemx -msse
12379 @itemx -mno-sse
12380 @itemx -msse2
12381 @itemx -mno-sse2
12382 @itemx -msse3
12383 @itemx -mno-sse3
12384 @itemx -mssse3
12385 @itemx -mno-ssse3
12386 @itemx -msse4.1
12387 @need 800
12388 @itemx -mno-sse4.1
12389 @itemx -msse4.2
12390 @itemx -mno-sse4.2
12391 @itemx -msse4
12392 @itemx -mno-sse4
12393 @itemx -mavx
12394 @itemx -mno-avx
12395 @itemx -maes
12396 @itemx -mno-aes
12397 @itemx -mpclmul
12398 @need 800
12399 @itemx -mno-pclmul
12400 @itemx -mfsgsbase
12401 @itemx -mno-fsgsbase
12402 @itemx -mrdrnd
12403 @itemx -mno-rdrnd
12404 @itemx -mf16c
12405 @itemx -mno-f16c
12406 @itemx -msse4a
12407 @itemx -mno-sse4a
12408 @itemx -mfma4
12409 @need 800
12410 @itemx -mno-fma4
12411 @itemx -mxop
12412 @itemx -mno-xop
12413 @itemx -mlwp
12414 @itemx -mno-lwp
12415 @itemx -m3dnow
12416 @itemx -mno-3dnow
12417 @itemx -mpopcnt
12418 @itemx -mno-popcnt
12419 @itemx -mabm
12420 @itemx -mno-abm
12421 @opindex mmmx
12422 @opindex mno-mmx
12423 @opindex msse
12424 @opindex mno-sse
12425 @opindex m3dnow
12426 @opindex mno-3dnow
12427 These switches enable or disable the use of instructions in the MMX,
12428 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, FSGSBASE, RDRND,
12429 F16C, SSE4A, FMA4, XOP, LWP, ABM or 3DNow!@: extended instruction sets.
12430 These extensions are also available as built-in functions: see
12431 @ref{X86 Built-in Functions}, for details of the functions enabled and
12432 disabled by these switches.
12434 To have SSE/SSE2 instructions generated automatically from floating-point
12435 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12437 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12438 generates new AVX instructions or AVX equivalence for all SSEx instructions
12439 when needed.
12441 These options will enable GCC to use these extended instructions in
12442 generated code, even without @option{-mfpmath=sse}.  Applications which
12443 perform runtime CPU detection must compile separate files for each
12444 supported architecture, using the appropriate flags.  In particular,
12445 the file containing the CPU detection code should be compiled without
12446 these options.
12448 @item -mfused-madd
12449 @itemx -mno-fused-madd
12450 @opindex mfused-madd
12451 @opindex mno-fused-madd
12452 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12453 instructions.  The default is to use these instructions.
12455 @item -mcld
12456 @opindex mcld
12457 This option instructs GCC to emit a @code{cld} instruction in the prologue
12458 of functions that use string instructions.  String instructions depend on
12459 the DF flag to select between autoincrement or autodecrement mode.  While the
12460 ABI specifies the DF flag to be cleared on function entry, some operating
12461 systems violate this specification by not clearing the DF flag in their
12462 exception dispatchers.  The exception handler can be invoked with the DF flag
12463 set which leads to wrong direction mode, when string instructions are used.
12464 This option can be enabled by default on 32-bit x86 targets by configuring
12465 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
12466 instructions can be suppressed with the @option{-mno-cld} compiler option
12467 in this case.
12469 @item -mcx16
12470 @opindex mcx16
12471 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12472 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12473 data types.  This is useful for high resolution counters that could be updated
12474 by multiple processors (or cores).  This instruction is generated as part of
12475 atomic built-in functions: see @ref{Atomic Builtins} for details.
12477 @item -msahf
12478 @opindex msahf
12479 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12480 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12481 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
12482 SAHF are load and store instructions, respectively, for certain status flags.
12483 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12484 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12486 @item -mmovbe
12487 @opindex mmovbe
12488 This option will enable GCC to use movbe instruction to implement
12489 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12491 @item -mcrc32
12492 @opindex mcrc32
12493 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12494 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12495 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12497 @item -mrecip
12498 @opindex mrecip
12499 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12500 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12501 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12502 variants) for single precision floating point arguments.  These instructions
12503 are generated only when @option{-funsafe-math-optimizations} is enabled
12504 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12505 Note that while the throughput of the sequence is higher than the throughput
12506 of the non-reciprocal instruction, the precision of the sequence can be
12507 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12509 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12510 already with @option{-ffast-math} (or the above option combination), and
12511 doesn't need @option{-mrecip}.
12513 @item -mveclibabi=@var{type}
12514 @opindex mveclibabi
12515 Specifies the ABI type to use for vectorizing intrinsics using an
12516 external library.  Supported types are @code{svml} for the Intel short
12517 vector math library and @code{acml} for the AMD math core library style
12518 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
12519 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12520 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12521 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12522 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12523 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12524 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12525 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12526 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12527 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12528 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12529 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12530 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12531 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12532 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12533 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12534 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12535 compatible library will have to be specified at link time.
12537 @item -mabi=@var{name}
12538 @opindex mabi
12539 Generate code for the specified calling convention.  Permissible values
12540 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12541 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
12542 ABI when targeting Windows.  On all other systems, the default is the
12543 SYSV ABI.  You can control this behavior for a specific function by
12544 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12545 @xref{Function Attributes}.
12547 @item -mpush-args
12548 @itemx -mno-push-args
12549 @opindex mpush-args
12550 @opindex mno-push-args
12551 Use PUSH operations to store outgoing parameters.  This method is shorter
12552 and usually equally fast as method using SUB/MOV operations and is enabled
12553 by default.  In some cases disabling it may improve performance because of
12554 improved scheduling and reduced dependencies.
12556 @item -maccumulate-outgoing-args
12557 @opindex maccumulate-outgoing-args
12558 If enabled, the maximum amount of space required for outgoing arguments will be
12559 computed in the function prologue.  This is faster on most modern CPUs
12560 because of reduced dependencies, improved scheduling and reduced stack usage
12561 when preferred stack boundary is not equal to 2.  The drawback is a notable
12562 increase in code size.  This switch implies @option{-mno-push-args}.
12564 @item -mthreads
12565 @opindex mthreads
12566 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
12567 on thread-safe exception handling must compile and link all code with the
12568 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
12569 @option{-D_MT}; when linking, it links in a special thread helper library
12570 @option{-lmingwthrd} which cleans up per thread exception handling data.
12572 @item -mno-align-stringops
12573 @opindex mno-align-stringops
12574 Do not align destination of inlined string operations.  This switch reduces
12575 code size and improves performance in case the destination is already aligned,
12576 but GCC doesn't know about it.
12578 @item -minline-all-stringops
12579 @opindex minline-all-stringops
12580 By default GCC inlines string operations only when destination is known to be
12581 aligned at least to 4 byte boundary.  This enables more inlining, increase code
12582 size, but may improve performance of code that depends on fast memcpy, strlen
12583 and memset for short lengths.
12585 @item -minline-stringops-dynamically
12586 @opindex minline-stringops-dynamically
12587 For string operation of unknown size, inline runtime checks so for small
12588 blocks inline code is used, while for large blocks library call is used.
12590 @item -mstringop-strategy=@var{alg}
12591 @opindex mstringop-strategy=@var{alg}
12592 Overwrite internal decision heuristic about particular algorithm to inline
12593 string operation with.  The allowed values are @code{rep_byte},
12594 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12595 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12596 expanding inline loop, @code{libcall} for always expanding library call.
12598 @item -momit-leaf-frame-pointer
12599 @opindex momit-leaf-frame-pointer
12600 Don't keep the frame pointer in a register for leaf functions.  This
12601 avoids the instructions to save, set up and restore frame pointers and
12602 makes an extra register available in leaf functions.  The option
12603 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12604 which might make debugging harder.
12606 @item -mtls-direct-seg-refs
12607 @itemx -mno-tls-direct-seg-refs
12608 @opindex mtls-direct-seg-refs
12609 Controls whether TLS variables may be accessed with offsets from the
12610 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12611 or whether the thread base pointer must be added.  Whether or not this
12612 is legal depends on the operating system, and whether it maps the
12613 segment to cover the entire TLS area.
12615 For systems that use GNU libc, the default is on.
12617 @item -msse2avx
12618 @itemx -mno-sse2avx
12619 @opindex msse2avx
12620 Specify that the assembler should encode SSE instructions with VEX
12621 prefix.  The option @option{-mavx} turns this on by default.
12623 @item -mfentry
12624 @itemx -mno-fentry
12625 @opindex mfentry
12626 If profiling is active @option{-pg} put the profiling
12627 counter call before prologue.
12628 Note: On x86 architectures the attribute @code{ms_hook_prologue}
12629 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
12631 @item -m8bit-idiv
12632 @itemx -mno-8bit-idiv
12633 @opindex 8bit-idiv
12634 On some processors, like Intel Atom, 8bit unsigned integer divide is
12635 much faster than 32bit/64bit integer divide.  This option will generate a
12636 runt-time check.  If both dividend and divisor are within range of 0
12637 to 255, 8bit unsigned integer divide will be used instead of
12638 32bit/64bit integer divide.
12640 @end table
12642 These @samp{-m} switches are supported in addition to the above
12643 on AMD x86-64 processors in 64-bit environments.
12645 @table @gcctabopt
12646 @item -m32
12647 @itemx -m64
12648 @opindex m32
12649 @opindex m64
12650 Generate code for a 32-bit or 64-bit environment.
12651 The 32-bit environment sets int, long and pointer to 32 bits and
12652 generates code that runs on any i386 system.
12653 The 64-bit environment sets int to 32 bits and long and pointer
12654 to 64 bits and generates code for AMD's x86-64 architecture. For
12655 darwin only the -m64 option turns off the @option{-fno-pic} and
12656 @option{-mdynamic-no-pic} options.
12658 @item -mno-red-zone
12659 @opindex mno-red-zone
12660 Do not use a so called red zone for x86-64 code.  The red zone is mandated
12661 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12662 stack pointer that will not be modified by signal or interrupt handlers
12663 and therefore can be used for temporary data without adjusting the stack
12664 pointer.  The flag @option{-mno-red-zone} disables this red zone.
12666 @item -mcmodel=small
12667 @opindex mcmodel=small
12668 Generate code for the small code model: the program and its symbols must
12669 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
12670 Programs can be statically or dynamically linked.  This is the default
12671 code model.
12673 @item -mcmodel=kernel
12674 @opindex mcmodel=kernel
12675 Generate code for the kernel code model.  The kernel runs in the
12676 negative 2 GB of the address space.
12677 This model has to be used for Linux kernel code.
12679 @item -mcmodel=medium
12680 @opindex mcmodel=medium
12681 Generate code for the medium model: The program is linked in the lower 2
12682 GB of the address space.  Small symbols are also placed there.  Symbols
12683 with sizes larger than @option{-mlarge-data-threshold} are put into
12684 large data or bss sections and can be located above 2GB.  Programs can
12685 be statically or dynamically linked.
12687 @item -mcmodel=large
12688 @opindex mcmodel=large
12689 Generate code for the large model: This model makes no assumptions
12690 about addresses and sizes of sections.
12691 @end table
12693 @node IA-64 Options
12694 @subsection IA-64 Options
12695 @cindex IA-64 Options
12697 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12699 @table @gcctabopt
12700 @item -mbig-endian
12701 @opindex mbig-endian
12702 Generate code for a big endian target.  This is the default for HP-UX@.
12704 @item -mlittle-endian
12705 @opindex mlittle-endian
12706 Generate code for a little endian target.  This is the default for AIX5
12707 and GNU/Linux.
12709 @item -mgnu-as
12710 @itemx -mno-gnu-as
12711 @opindex mgnu-as
12712 @opindex mno-gnu-as
12713 Generate (or don't) code for the GNU assembler.  This is the default.
12714 @c Also, this is the default if the configure option @option{--with-gnu-as}
12715 @c is used.
12717 @item -mgnu-ld
12718 @itemx -mno-gnu-ld
12719 @opindex mgnu-ld
12720 @opindex mno-gnu-ld
12721 Generate (or don't) code for the GNU linker.  This is the default.
12722 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12723 @c is used.
12725 @item -mno-pic
12726 @opindex mno-pic
12727 Generate code that does not use a global pointer register.  The result
12728 is not position independent code, and violates the IA-64 ABI@.
12730 @item -mvolatile-asm-stop
12731 @itemx -mno-volatile-asm-stop
12732 @opindex mvolatile-asm-stop
12733 @opindex mno-volatile-asm-stop
12734 Generate (or don't) a stop bit immediately before and after volatile asm
12735 statements.
12737 @item -mregister-names
12738 @itemx -mno-register-names
12739 @opindex mregister-names
12740 @opindex mno-register-names
12741 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12742 the stacked registers.  This may make assembler output more readable.
12744 @item -mno-sdata
12745 @itemx -msdata
12746 @opindex mno-sdata
12747 @opindex msdata
12748 Disable (or enable) optimizations that use the small data section.  This may
12749 be useful for working around optimizer bugs.
12751 @item -mconstant-gp
12752 @opindex mconstant-gp
12753 Generate code that uses a single constant global pointer value.  This is
12754 useful when compiling kernel code.
12756 @item -mauto-pic
12757 @opindex mauto-pic
12758 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
12759 This is useful when compiling firmware code.
12761 @item -minline-float-divide-min-latency
12762 @opindex minline-float-divide-min-latency
12763 Generate code for inline divides of floating point values
12764 using the minimum latency algorithm.
12766 @item -minline-float-divide-max-throughput
12767 @opindex minline-float-divide-max-throughput
12768 Generate code for inline divides of floating point values
12769 using the maximum throughput algorithm.
12771 @item -mno-inline-float-divide
12772 @opindex mno-inline-float-divide
12773 Do not generate inline code for divides of floating point values.
12775 @item -minline-int-divide-min-latency
12776 @opindex minline-int-divide-min-latency
12777 Generate code for inline divides of integer values
12778 using the minimum latency algorithm.
12780 @item -minline-int-divide-max-throughput
12781 @opindex minline-int-divide-max-throughput
12782 Generate code for inline divides of integer values
12783 using the maximum throughput algorithm.
12785 @item -mno-inline-int-divide
12786 @opindex mno-inline-int-divide
12787 Do not generate inline code for divides of integer values.
12789 @item -minline-sqrt-min-latency
12790 @opindex minline-sqrt-min-latency
12791 Generate code for inline square roots
12792 using the minimum latency algorithm.
12794 @item -minline-sqrt-max-throughput
12795 @opindex minline-sqrt-max-throughput
12796 Generate code for inline square roots
12797 using the maximum throughput algorithm.
12799 @item -mno-inline-sqrt
12800 @opindex mno-inline-sqrt
12801 Do not generate inline code for sqrt.
12803 @item -mfused-madd
12804 @itemx -mno-fused-madd
12805 @opindex mfused-madd
12806 @opindex mno-fused-madd
12807 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12808 instructions.  The default is to use these instructions.
12810 @item -mno-dwarf2-asm
12811 @itemx -mdwarf2-asm
12812 @opindex mno-dwarf2-asm
12813 @opindex mdwarf2-asm
12814 Don't (or do) generate assembler code for the DWARF2 line number debugging
12815 info.  This may be useful when not using the GNU assembler.
12817 @item -mearly-stop-bits
12818 @itemx -mno-early-stop-bits
12819 @opindex mearly-stop-bits
12820 @opindex mno-early-stop-bits
12821 Allow stop bits to be placed earlier than immediately preceding the
12822 instruction that triggered the stop bit.  This can improve instruction
12823 scheduling, but does not always do so.
12825 @item -mfixed-range=@var{register-range}
12826 @opindex mfixed-range
12827 Generate code treating the given register range as fixed registers.
12828 A fixed register is one that the register allocator can not use.  This is
12829 useful when compiling kernel code.  A register range is specified as
12830 two registers separated by a dash.  Multiple register ranges can be
12831 specified separated by a comma.
12833 @item -mtls-size=@var{tls-size}
12834 @opindex mtls-size
12835 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12838 @item -mtune=@var{cpu-type}
12839 @opindex mtune
12840 Tune the instruction scheduling for a particular CPU, Valid values are
12841 itanium, itanium1, merced, itanium2, and mckinley.
12843 @item -milp32
12844 @itemx -mlp64
12845 @opindex milp32
12846 @opindex mlp64
12847 Generate code for a 32-bit or 64-bit environment.
12848 The 32-bit environment sets int, long and pointer to 32 bits.
12849 The 64-bit environment sets int to 32 bits and long and pointer
12850 to 64 bits.  These are HP-UX specific flags.
12852 @item -mno-sched-br-data-spec
12853 @itemx -msched-br-data-spec
12854 @opindex mno-sched-br-data-spec
12855 @opindex msched-br-data-spec
12856 (Dis/En)able data speculative scheduling before reload.
12857 This will result in generation of the ld.a instructions and
12858 the corresponding check instructions (ld.c / chk.a).
12859 The default is 'disable'.
12861 @item -msched-ar-data-spec
12862 @itemx -mno-sched-ar-data-spec
12863 @opindex msched-ar-data-spec
12864 @opindex mno-sched-ar-data-spec
12865 (En/Dis)able data speculative scheduling after reload.
12866 This will result in generation of the ld.a instructions and
12867 the corresponding check instructions (ld.c / chk.a).
12868 The default is 'enable'.
12870 @item -mno-sched-control-spec
12871 @itemx -msched-control-spec
12872 @opindex mno-sched-control-spec
12873 @opindex msched-control-spec
12874 (Dis/En)able control speculative scheduling.  This feature is
12875 available only during region scheduling (i.e.@: before reload).
12876 This will result in generation of the ld.s instructions and
12877 the corresponding check instructions chk.s .
12878 The default is 'disable'.
12880 @item -msched-br-in-data-spec
12881 @itemx -mno-sched-br-in-data-spec
12882 @opindex msched-br-in-data-spec
12883 @opindex mno-sched-br-in-data-spec
12884 (En/Dis)able speculative scheduling of the instructions that
12885 are dependent on the data speculative loads before reload.
12886 This is effective only with @option{-msched-br-data-spec} enabled.
12887 The default is 'enable'.
12889 @item -msched-ar-in-data-spec
12890 @itemx -mno-sched-ar-in-data-spec
12891 @opindex msched-ar-in-data-spec
12892 @opindex mno-sched-ar-in-data-spec
12893 (En/Dis)able speculative scheduling of the instructions that
12894 are dependent on the data speculative loads after reload.
12895 This is effective only with @option{-msched-ar-data-spec} enabled.
12896 The default is 'enable'.
12898 @item -msched-in-control-spec
12899 @itemx -mno-sched-in-control-spec
12900 @opindex msched-in-control-spec
12901 @opindex mno-sched-in-control-spec
12902 (En/Dis)able speculative scheduling of the instructions that
12903 are dependent on the control speculative loads.
12904 This is effective only with @option{-msched-control-spec} enabled.
12905 The default is 'enable'.
12907 @item -mno-sched-prefer-non-data-spec-insns
12908 @itemx -msched-prefer-non-data-spec-insns
12909 @opindex mno-sched-prefer-non-data-spec-insns
12910 @opindex msched-prefer-non-data-spec-insns
12911 If enabled, data speculative instructions will be chosen for schedule
12912 only if there are no other choices at the moment.  This will make
12913 the use of the data speculation much more conservative.
12914 The default is 'disable'.
12916 @item -mno-sched-prefer-non-control-spec-insns
12917 @itemx -msched-prefer-non-control-spec-insns
12918 @opindex mno-sched-prefer-non-control-spec-insns
12919 @opindex msched-prefer-non-control-spec-insns
12920 If enabled, control speculative instructions will be chosen for schedule
12921 only if there are no other choices at the moment.  This will make
12922 the use of the control speculation much more conservative.
12923 The default is 'disable'.
12925 @item -mno-sched-count-spec-in-critical-path
12926 @itemx -msched-count-spec-in-critical-path
12927 @opindex mno-sched-count-spec-in-critical-path
12928 @opindex msched-count-spec-in-critical-path
12929 If enabled, speculative dependencies will be considered during
12930 computation of the instructions priorities.  This will make the use of the
12931 speculation a bit more conservative.
12932 The default is 'disable'.
12934 @item -msched-spec-ldc
12935 @opindex msched-spec-ldc
12936 Use a simple data speculation check.  This option is on by default.
12938 @item -msched-control-spec-ldc
12939 @opindex msched-spec-ldc
12940 Use a simple check for control speculation.  This option is on by default.
12942 @item -msched-stop-bits-after-every-cycle
12943 @opindex msched-stop-bits-after-every-cycle
12944 Place a stop bit after every cycle when scheduling.  This option is on
12945 by default.
12947 @item -msched-fp-mem-deps-zero-cost
12948 @opindex msched-fp-mem-deps-zero-cost
12949 Assume that floating-point stores and loads are not likely to cause a conflict
12950 when placed into the same instruction group.  This option is disabled by
12951 default.
12953 @item -msel-sched-dont-check-control-spec
12954 @opindex msel-sched-dont-check-control-spec
12955 Generate checks for control speculation in selective scheduling.
12956 This flag is disabled by default.
12958 @item -msched-max-memory-insns=@var{max-insns}
12959 @opindex msched-max-memory-insns
12960 Limit on the number of memory insns per instruction group, giving lower
12961 priority to subsequent memory insns attempting to schedule in the same
12962 instruction group. Frequently useful to prevent cache bank conflicts.
12963 The default value is 1.
12965 @item -msched-max-memory-insns-hard-limit
12966 @opindex msched-max-memory-insns-hard-limit
12967 Disallow more than `msched-max-memory-insns' in instruction group.
12968 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12969 when limit is reached but may still schedule memory operations.
12971 @end table
12973 @node IA-64/VMS Options
12974 @subsection IA-64/VMS Options
12976 These @samp{-m} options are defined for the IA-64/VMS implementations:
12978 @table @gcctabopt
12979 @item -mvms-return-codes
12980 @opindex mvms-return-codes
12981 Return VMS condition codes from main. The default is to return POSIX
12982 style condition (e.g.@ error) codes.
12984 @item -mdebug-main=@var{prefix}
12985 @opindex mdebug-main=@var{prefix}
12986 Flag the first routine whose name starts with @var{prefix} as the main
12987 routine for the debugger.
12989 @item -mmalloc64
12990 @opindex mmalloc64
12991 Default to 64bit memory allocation routines.
12992 @end table
12994 @node LM32 Options
12995 @subsection LM32 Options
12996 @cindex LM32 options
12998 These @option{-m} options are defined for the Lattice Mico32 architecture:
13000 @table @gcctabopt
13001 @item -mbarrel-shift-enabled
13002 @opindex mbarrel-shift-enabled
13003 Enable barrel-shift instructions.
13005 @item -mdivide-enabled
13006 @opindex mdivide-enabled
13007 Enable divide and modulus instructions.
13009 @item -mmultiply-enabled
13010 @opindex multiply-enabled
13011 Enable multiply instructions.
13013 @item -msign-extend-enabled
13014 @opindex msign-extend-enabled
13015 Enable sign extend instructions.
13017 @item -muser-enabled
13018 @opindex muser-enabled
13019 Enable user-defined instructions.
13021 @end table
13023 @node M32C Options
13024 @subsection M32C Options
13025 @cindex M32C options
13027 @table @gcctabopt
13028 @item -mcpu=@var{name}
13029 @opindex mcpu=
13030 Select the CPU for which code is generated.  @var{name} may be one of
13031 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
13032 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
13033 the M32C/80 series.
13035 @item -msim
13036 @opindex msim
13037 Specifies that the program will be run on the simulator.  This causes
13038 an alternate runtime library to be linked in which supports, for
13039 example, file I/O@.  You must not use this option when generating
13040 programs that will run on real hardware; you must provide your own
13041 runtime library for whatever I/O functions are needed.
13043 @item -memregs=@var{number}
13044 @opindex memregs=
13045 Specifies the number of memory-based pseudo-registers GCC will use
13046 during code generation.  These pseudo-registers will be used like real
13047 registers, so there is a tradeoff between GCC's ability to fit the
13048 code into available registers, and the performance penalty of using
13049 memory instead of registers.  Note that all modules in a program must
13050 be compiled with the same value for this option.  Because of that, you
13051 must not use this option with the default runtime libraries gcc
13052 builds.
13054 @end table
13056 @node M32R/D Options
13057 @subsection M32R/D Options
13058 @cindex M32R/D options
13060 These @option{-m} options are defined for Renesas M32R/D architectures:
13062 @table @gcctabopt
13063 @item -m32r2
13064 @opindex m32r2
13065 Generate code for the M32R/2@.
13067 @item -m32rx
13068 @opindex m32rx
13069 Generate code for the M32R/X@.
13071 @item -m32r
13072 @opindex m32r
13073 Generate code for the M32R@.  This is the default.
13075 @item -mmodel=small
13076 @opindex mmodel=small
13077 Assume all objects live in the lower 16MB of memory (so that their addresses
13078 can be loaded with the @code{ld24} instruction), and assume all subroutines
13079 are reachable with the @code{bl} instruction.
13080 This is the default.
13082 The addressability of a particular object can be set with the
13083 @code{model} attribute.
13085 @item -mmodel=medium
13086 @opindex mmodel=medium
13087 Assume objects may be anywhere in the 32-bit address space (the compiler
13088 will generate @code{seth/add3} instructions to load their addresses), and
13089 assume all subroutines are reachable with the @code{bl} instruction.
13091 @item -mmodel=large
13092 @opindex mmodel=large
13093 Assume objects may be anywhere in the 32-bit address space (the compiler
13094 will generate @code{seth/add3} instructions to load their addresses), and
13095 assume subroutines may not be reachable with the @code{bl} instruction
13096 (the compiler will generate the much slower @code{seth/add3/jl}
13097 instruction sequence).
13099 @item -msdata=none
13100 @opindex msdata=none
13101 Disable use of the small data area.  Variables will be put into
13102 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
13103 @code{section} attribute has been specified).
13104 This is the default.
13106 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
13107 Objects may be explicitly put in the small data area with the
13108 @code{section} attribute using one of these sections.
13110 @item -msdata=sdata
13111 @opindex msdata=sdata
13112 Put small global and static data in the small data area, but do not
13113 generate special code to reference them.
13115 @item -msdata=use
13116 @opindex msdata=use
13117 Put small global and static data in the small data area, and generate
13118 special instructions to reference them.
13120 @item -G @var{num}
13121 @opindex G
13122 @cindex smaller data references
13123 Put global and static objects less than or equal to @var{num} bytes
13124 into the small data or bss sections instead of the normal data or bss
13125 sections.  The default value of @var{num} is 8.
13126 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
13127 for this option to have any effect.
13129 All modules should be compiled with the same @option{-G @var{num}} value.
13130 Compiling with different values of @var{num} may or may not work; if it
13131 doesn't the linker will give an error message---incorrect code will not be
13132 generated.
13134 @item -mdebug
13135 @opindex mdebug
13136 Makes the M32R specific code in the compiler display some statistics
13137 that might help in debugging programs.
13139 @item -malign-loops
13140 @opindex malign-loops
13141 Align all loops to a 32-byte boundary.
13143 @item -mno-align-loops
13144 @opindex mno-align-loops
13145 Do not enforce a 32-byte alignment for loops.  This is the default.
13147 @item -missue-rate=@var{number}
13148 @opindex missue-rate=@var{number}
13149 Issue @var{number} instructions per cycle.  @var{number} can only be 1
13150 or 2.
13152 @item -mbranch-cost=@var{number}
13153 @opindex mbranch-cost=@var{number}
13154 @var{number} can only be 1 or 2.  If it is 1 then branches will be
13155 preferred over conditional code, if it is 2, then the opposite will
13156 apply.
13158 @item -mflush-trap=@var{number}
13159 @opindex mflush-trap=@var{number}
13160 Specifies the trap number to use to flush the cache.  The default is
13161 12.  Valid numbers are between 0 and 15 inclusive.
13163 @item -mno-flush-trap
13164 @opindex mno-flush-trap
13165 Specifies that the cache cannot be flushed by using a trap.
13167 @item -mflush-func=@var{name}
13168 @opindex mflush-func=@var{name}
13169 Specifies the name of the operating system function to call to flush
13170 the cache.  The default is @emph{_flush_cache}, but a function call
13171 will only be used if a trap is not available.
13173 @item -mno-flush-func
13174 @opindex mno-flush-func
13175 Indicates that there is no OS function for flushing the cache.
13177 @end table
13179 @node M680x0 Options
13180 @subsection M680x0 Options
13181 @cindex M680x0 options
13183 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
13184 The default settings depend on which architecture was selected when
13185 the compiler was configured; the defaults for the most common choices
13186 are given below.
13188 @table @gcctabopt
13189 @item -march=@var{arch}
13190 @opindex march
13191 Generate code for a specific M680x0 or ColdFire instruction set
13192 architecture.  Permissible values of @var{arch} for M680x0
13193 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
13194 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
13195 architectures are selected according to Freescale's ISA classification
13196 and the permissible values are: @samp{isaa}, @samp{isaaplus},
13197 @samp{isab} and @samp{isac}.
13199 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
13200 code for a ColdFire target.  The @var{arch} in this macro is one of the
13201 @option{-march} arguments given above.
13203 When used together, @option{-march} and @option{-mtune} select code
13204 that runs on a family of similar processors but that is optimized
13205 for a particular microarchitecture.
13207 @item -mcpu=@var{cpu}
13208 @opindex mcpu
13209 Generate code for a specific M680x0 or ColdFire processor.
13210 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
13211 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
13212 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
13213 below, which also classifies the CPUs into families:
13215 @multitable @columnfractions 0.20 0.80
13216 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
13217 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
13218 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
13219 @item @samp{5206e} @tab @samp{5206e}
13220 @item @samp{5208} @tab @samp{5207} @samp{5208}
13221 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
13222 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
13223 @item @samp{5216} @tab @samp{5214} @samp{5216}
13224 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
13225 @item @samp{5225} @tab @samp{5224} @samp{5225}
13226 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
13227 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
13228 @item @samp{5249} @tab @samp{5249}
13229 @item @samp{5250} @tab @samp{5250}
13230 @item @samp{5271} @tab @samp{5270} @samp{5271}
13231 @item @samp{5272} @tab @samp{5272}
13232 @item @samp{5275} @tab @samp{5274} @samp{5275}
13233 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
13234 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
13235 @item @samp{5307} @tab @samp{5307}
13236 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
13237 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
13238 @item @samp{5407} @tab @samp{5407}
13239 @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}
13240 @end multitable
13242 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
13243 @var{arch} is compatible with @var{cpu}.  Other combinations of
13244 @option{-mcpu} and @option{-march} are rejected.
13246 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
13247 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
13248 where the value of @var{family} is given by the table above.
13250 @item -mtune=@var{tune}
13251 @opindex mtune
13252 Tune the code for a particular microarchitecture, within the
13253 constraints set by @option{-march} and @option{-mcpu}.
13254 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
13255 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
13256 and @samp{cpu32}.  The ColdFire microarchitectures
13257 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
13259 You can also use @option{-mtune=68020-40} for code that needs
13260 to run relatively well on 68020, 68030 and 68040 targets.
13261 @option{-mtune=68020-60} is similar but includes 68060 targets
13262 as well.  These two options select the same tuning decisions as
13263 @option{-m68020-40} and @option{-m68020-60} respectively.
13265 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
13266 when tuning for 680x0 architecture @var{arch}.  It also defines
13267 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
13268 option is used.  If gcc is tuning for a range of architectures,
13269 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
13270 it defines the macros for every architecture in the range.
13272 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
13273 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
13274 of the arguments given above.
13276 @item -m68000
13277 @itemx -mc68000
13278 @opindex m68000
13279 @opindex mc68000
13280 Generate output for a 68000.  This is the default
13281 when the compiler is configured for 68000-based systems.
13282 It is equivalent to @option{-march=68000}.
13284 Use this option for microcontrollers with a 68000 or EC000 core,
13285 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
13287 @item -m68010
13288 @opindex m68010
13289 Generate output for a 68010.  This is the default
13290 when the compiler is configured for 68010-based systems.
13291 It is equivalent to @option{-march=68010}.
13293 @item -m68020
13294 @itemx -mc68020
13295 @opindex m68020
13296 @opindex mc68020
13297 Generate output for a 68020.  This is the default
13298 when the compiler is configured for 68020-based systems.
13299 It is equivalent to @option{-march=68020}.
13301 @item -m68030
13302 @opindex m68030
13303 Generate output for a 68030.  This is the default when the compiler is
13304 configured for 68030-based systems.  It is equivalent to
13305 @option{-march=68030}.
13307 @item -m68040
13308 @opindex m68040
13309 Generate output for a 68040.  This is the default when the compiler is
13310 configured for 68040-based systems.  It is equivalent to
13311 @option{-march=68040}.
13313 This option inhibits the use of 68881/68882 instructions that have to be
13314 emulated by software on the 68040.  Use this option if your 68040 does not
13315 have code to emulate those instructions.
13317 @item -m68060
13318 @opindex m68060
13319 Generate output for a 68060.  This is the default when the compiler is
13320 configured for 68060-based systems.  It is equivalent to
13321 @option{-march=68060}.
13323 This option inhibits the use of 68020 and 68881/68882 instructions that
13324 have to be emulated by software on the 68060.  Use this option if your 68060
13325 does not have code to emulate those instructions.
13327 @item -mcpu32
13328 @opindex mcpu32
13329 Generate output for a CPU32.  This is the default
13330 when the compiler is configured for CPU32-based systems.
13331 It is equivalent to @option{-march=cpu32}.
13333 Use this option for microcontrollers with a
13334 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
13335 68336, 68340, 68341, 68349 and 68360.
13337 @item -m5200
13338 @opindex m5200
13339 Generate output for a 520X ColdFire CPU@.  This is the default
13340 when the compiler is configured for 520X-based systems.
13341 It is equivalent to @option{-mcpu=5206}, and is now deprecated
13342 in favor of that option.
13344 Use this option for microcontroller with a 5200 core, including
13345 the MCF5202, MCF5203, MCF5204 and MCF5206.
13347 @item -m5206e
13348 @opindex m5206e
13349 Generate output for a 5206e ColdFire CPU@.  The option is now
13350 deprecated in favor of the equivalent @option{-mcpu=5206e}.
13352 @item -m528x
13353 @opindex m528x
13354 Generate output for a member of the ColdFire 528X family.
13355 The option is now deprecated in favor of the equivalent
13356 @option{-mcpu=528x}.
13358 @item -m5307
13359 @opindex m5307
13360 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
13361 in favor of the equivalent @option{-mcpu=5307}.
13363 @item -m5407
13364 @opindex m5407
13365 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
13366 in favor of the equivalent @option{-mcpu=5407}.
13368 @item -mcfv4e
13369 @opindex mcfv4e
13370 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
13371 This includes use of hardware floating point instructions.
13372 The option is equivalent to @option{-mcpu=547x}, and is now
13373 deprecated in favor of that option.
13375 @item -m68020-40
13376 @opindex m68020-40
13377 Generate output for a 68040, without using any of the new instructions.
13378 This results in code which can run relatively efficiently on either a
13379 68020/68881 or a 68030 or a 68040.  The generated code does use the
13380 68881 instructions that are emulated on the 68040.
13382 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
13384 @item -m68020-60
13385 @opindex m68020-60
13386 Generate output for a 68060, without using any of the new instructions.
13387 This results in code which can run relatively efficiently on either a
13388 68020/68881 or a 68030 or a 68040.  The generated code does use the
13389 68881 instructions that are emulated on the 68060.
13391 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
13393 @item -mhard-float
13394 @itemx -m68881
13395 @opindex mhard-float
13396 @opindex m68881
13397 Generate floating-point instructions.  This is the default for 68020
13398 and above, and for ColdFire devices that have an FPU@.  It defines the
13399 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
13400 on ColdFire targets.
13402 @item -msoft-float
13403 @opindex msoft-float
13404 Do not generate floating-point instructions; use library calls instead.
13405 This is the default for 68000, 68010, and 68832 targets.  It is also
13406 the default for ColdFire devices that have no FPU.
13408 @item -mdiv
13409 @itemx -mno-div
13410 @opindex mdiv
13411 @opindex mno-div
13412 Generate (do not generate) ColdFire hardware divide and remainder
13413 instructions.  If @option{-march} is used without @option{-mcpu},
13414 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
13415 architectures.  Otherwise, the default is taken from the target CPU
13416 (either the default CPU, or the one specified by @option{-mcpu}).  For
13417 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
13418 @option{-mcpu=5206e}.
13420 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
13422 @item -mshort
13423 @opindex mshort
13424 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13425 Additionally, parameters passed on the stack are also aligned to a
13426 16-bit boundary even on targets whose API mandates promotion to 32-bit.
13428 @item -mno-short
13429 @opindex mno-short
13430 Do not consider type @code{int} to be 16 bits wide.  This is the default.
13432 @item -mnobitfield
13433 @itemx -mno-bitfield
13434 @opindex mnobitfield
13435 @opindex mno-bitfield
13436 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
13437 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
13439 @item -mbitfield
13440 @opindex mbitfield
13441 Do use the bit-field instructions.  The @option{-m68020} option implies
13442 @option{-mbitfield}.  This is the default if you use a configuration
13443 designed for a 68020.
13445 @item -mrtd
13446 @opindex mrtd
13447 Use a different function-calling convention, in which functions
13448 that take a fixed number of arguments return with the @code{rtd}
13449 instruction, which pops their arguments while returning.  This
13450 saves one instruction in the caller since there is no need to pop
13451 the arguments there.
13453 This calling convention is incompatible with the one normally
13454 used on Unix, so you cannot use it if you need to call libraries
13455 compiled with the Unix compiler.
13457 Also, you must provide function prototypes for all functions that
13458 take variable numbers of arguments (including @code{printf});
13459 otherwise incorrect code will be generated for calls to those
13460 functions.
13462 In addition, seriously incorrect code will result if you call a
13463 function with too many arguments.  (Normally, extra arguments are
13464 harmlessly ignored.)
13466 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13467 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13469 @item -mno-rtd
13470 @opindex mno-rtd
13471 Do not use the calling conventions selected by @option{-mrtd}.
13472 This is the default.
13474 @item -malign-int
13475 @itemx -mno-align-int
13476 @opindex malign-int
13477 @opindex mno-align-int
13478 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13479 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13480 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13481 Aligning variables on 32-bit boundaries produces code that runs somewhat
13482 faster on processors with 32-bit busses at the expense of more memory.
13484 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13485 align structures containing the above types  differently than
13486 most published application binary interface specifications for the m68k.
13488 @item -mpcrel
13489 @opindex mpcrel
13490 Use the pc-relative addressing mode of the 68000 directly, instead of
13491 using a global offset table.  At present, this option implies @option{-fpic},
13492 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
13493 not presently supported with @option{-mpcrel}, though this could be supported for
13494 68020 and higher processors.
13496 @item -mno-strict-align
13497 @itemx -mstrict-align
13498 @opindex mno-strict-align
13499 @opindex mstrict-align
13500 Do not (do) assume that unaligned memory references will be handled by
13501 the system.
13503 @item -msep-data
13504 Generate code that allows the data segment to be located in a different
13505 area of memory from the text segment.  This allows for execute in place in
13506 an environment without virtual memory management.  This option implies
13507 @option{-fPIC}.
13509 @item -mno-sep-data
13510 Generate code that assumes that the data segment follows the text segment.
13511 This is the default.
13513 @item -mid-shared-library
13514 Generate code that supports shared libraries via the library ID method.
13515 This allows for execute in place and shared libraries in an environment
13516 without virtual memory management.  This option implies @option{-fPIC}.
13518 @item -mno-id-shared-library
13519 Generate code that doesn't assume ID based shared libraries are being used.
13520 This is the default.
13522 @item -mshared-library-id=n
13523 Specified the identification number of the ID based shared library being
13524 compiled.  Specifying a value of 0 will generate more compact code, specifying
13525 other values will force the allocation of that number to the current
13526 library but is no more space or time efficient than omitting this option.
13528 @item -mxgot
13529 @itemx -mno-xgot
13530 @opindex mxgot
13531 @opindex mno-xgot
13532 When generating position-independent code for ColdFire, generate code
13533 that works if the GOT has more than 8192 entries.  This code is
13534 larger and slower than code generated without this option.  On M680x0
13535 processors, this option is not needed; @option{-fPIC} suffices.
13537 GCC normally uses a single instruction to load values from the GOT@.
13538 While this is relatively efficient, it only works if the GOT
13539 is smaller than about 64k.  Anything larger causes the linker
13540 to report an error such as:
13542 @cindex relocation truncated to fit (ColdFire)
13543 @smallexample
13544 relocation truncated to fit: R_68K_GOT16O foobar
13545 @end smallexample
13547 If this happens, you should recompile your code with @option{-mxgot}.
13548 It should then work with very large GOTs.  However, code generated with
13549 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13550 the value of a global symbol.
13552 Note that some linkers, including newer versions of the GNU linker,
13553 can create multiple GOTs and sort GOT entries.  If you have such a linker,
13554 you should only need to use @option{-mxgot} when compiling a single
13555 object file that accesses more than 8192 GOT entries.  Very few do.
13557 These options have no effect unless GCC is generating
13558 position-independent code.
13560 @end table
13562 @node M68hc1x Options
13563 @subsection M68hc1x Options
13564 @cindex M68hc1x options
13566 These are the @samp{-m} options defined for the 68hc11 and 68hc12
13567 microcontrollers.  The default values for these options depends on
13568 which style of microcontroller was selected when the compiler was configured;
13569 the defaults for the most common choices are given below.
13571 @table @gcctabopt
13572 @item -m6811
13573 @itemx -m68hc11
13574 @opindex m6811
13575 @opindex m68hc11
13576 Generate output for a 68HC11.  This is the default
13577 when the compiler is configured for 68HC11-based systems.
13579 @item -m6812
13580 @itemx -m68hc12
13581 @opindex m6812
13582 @opindex m68hc12
13583 Generate output for a 68HC12.  This is the default
13584 when the compiler is configured for 68HC12-based systems.
13586 @item -m68S12
13587 @itemx -m68hcs12
13588 @opindex m68S12
13589 @opindex m68hcs12
13590 Generate output for a 68HCS12.
13592 @item -mauto-incdec
13593 @opindex mauto-incdec
13594 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
13595 addressing modes.
13597 @item -minmax
13598 @itemx -mnominmax
13599 @opindex minmax
13600 @opindex mnominmax
13601 Enable the use of 68HC12 min and max instructions.
13603 @item -mlong-calls
13604 @itemx -mno-long-calls
13605 @opindex mlong-calls
13606 @opindex mno-long-calls
13607 Treat all calls as being far away (near).  If calls are assumed to be
13608 far away, the compiler will use the @code{call} instruction to
13609 call a function and the @code{rtc} instruction for returning.
13611 @item -mshort
13612 @opindex mshort
13613 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13615 @item -msoft-reg-count=@var{count}
13616 @opindex msoft-reg-count
13617 Specify the number of pseudo-soft registers which are used for the
13618 code generation.  The maximum number is 32.  Using more pseudo-soft
13619 register may or may not result in better code depending on the program.
13620 The default is 4 for 68HC11 and 2 for 68HC12.
13622 @end table
13624 @node MCore Options
13625 @subsection MCore Options
13626 @cindex MCore options
13628 These are the @samp{-m} options defined for the Motorola M*Core
13629 processors.
13631 @table @gcctabopt
13633 @item -mhardlit
13634 @itemx -mno-hardlit
13635 @opindex mhardlit
13636 @opindex mno-hardlit
13637 Inline constants into the code stream if it can be done in two
13638 instructions or less.
13640 @item -mdiv
13641 @itemx -mno-div
13642 @opindex mdiv
13643 @opindex mno-div
13644 Use the divide instruction.  (Enabled by default).
13646 @item -mrelax-immediate
13647 @itemx -mno-relax-immediate
13648 @opindex mrelax-immediate
13649 @opindex mno-relax-immediate
13650 Allow arbitrary sized immediates in bit operations.
13652 @item -mwide-bitfields
13653 @itemx -mno-wide-bitfields
13654 @opindex mwide-bitfields
13655 @opindex mno-wide-bitfields
13656 Always treat bit-fields as int-sized.
13658 @item -m4byte-functions
13659 @itemx -mno-4byte-functions
13660 @opindex m4byte-functions
13661 @opindex mno-4byte-functions
13662 Force all functions to be aligned to a four byte boundary.
13664 @item -mcallgraph-data
13665 @itemx -mno-callgraph-data
13666 @opindex mcallgraph-data
13667 @opindex mno-callgraph-data
13668 Emit callgraph information.
13670 @item -mslow-bytes
13671 @itemx -mno-slow-bytes
13672 @opindex mslow-bytes
13673 @opindex mno-slow-bytes
13674 Prefer word access when reading byte quantities.
13676 @item -mlittle-endian
13677 @itemx -mbig-endian
13678 @opindex mlittle-endian
13679 @opindex mbig-endian
13680 Generate code for a little endian target.
13682 @item -m210
13683 @itemx -m340
13684 @opindex m210
13685 @opindex m340
13686 Generate code for the 210 processor.
13688 @item -mno-lsim
13689 @opindex mno-lsim
13690 Assume that run-time support has been provided and so omit the
13691 simulator library (@file{libsim.a)} from the linker command line.
13693 @item -mstack-increment=@var{size}
13694 @opindex mstack-increment
13695 Set the maximum amount for a single stack increment operation.  Large
13696 values can increase the speed of programs which contain functions
13697 that need a large amount of stack space, but they can also trigger a
13698 segmentation fault if the stack is extended too much.  The default
13699 value is 0x1000.
13701 @end table
13703 @node MeP Options
13704 @subsection MeP Options
13705 @cindex MeP options
13707 @table @gcctabopt
13709 @item -mabsdiff
13710 @opindex mabsdiff
13711 Enables the @code{abs} instruction, which is the absolute difference
13712 between two registers.
13714 @item -mall-opts
13715 @opindex mall-opts
13716 Enables all the optional instructions - average, multiply, divide, bit
13717 operations, leading zero, absolute difference, min/max, clip, and
13718 saturation.
13721 @item -maverage
13722 @opindex maverage
13723 Enables the @code{ave} instruction, which computes the average of two
13724 registers.
13726 @item -mbased=@var{n}
13727 @opindex mbased=
13728 Variables of size @var{n} bytes or smaller will be placed in the
13729 @code{.based} section by default.  Based variables use the @code{$tp}
13730 register as a base register, and there is a 128 byte limit to the
13731 @code{.based} section.
13733 @item -mbitops
13734 @opindex mbitops
13735 Enables the bit operation instructions - bit test (@code{btstm}), set
13736 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13737 test-and-set (@code{tas}).
13739 @item -mc=@var{name}
13740 @opindex mc=
13741 Selects which section constant data will be placed in.  @var{name} may
13742 be @code{tiny}, @code{near}, or @code{far}.
13744 @item -mclip
13745 @opindex mclip
13746 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13747 useful unless you also provide @code{-mminmax}.
13749 @item -mconfig=@var{name}
13750 @opindex mconfig=
13751 Selects one of the build-in core configurations.  Each MeP chip has
13752 one or more modules in it; each module has a core CPU and a variety of
13753 coprocessors, optional instructions, and peripherals.  The
13754 @code{MeP-Integrator} tool, not part of GCC, provides these
13755 configurations through this option; using this option is the same as
13756 using all the corresponding command line options.  The default
13757 configuration is @code{default}.
13759 @item -mcop
13760 @opindex mcop
13761 Enables the coprocessor instructions.  By default, this is a 32-bit
13762 coprocessor.  Note that the coprocessor is normally enabled via the
13763 @code{-mconfig=} option.
13765 @item -mcop32
13766 @opindex mcop32
13767 Enables the 32-bit coprocessor's instructions.
13769 @item -mcop64
13770 @opindex mcop64
13771 Enables the 64-bit coprocessor's instructions.
13773 @item -mivc2
13774 @opindex mivc2
13775 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13777 @item -mdc
13778 @opindex mdc
13779 Causes constant variables to be placed in the @code{.near} section.
13781 @item -mdiv
13782 @opindex mdiv
13783 Enables the @code{div} and @code{divu} instructions.
13785 @item -meb
13786 @opindex meb
13787 Generate big-endian code.
13789 @item -mel
13790 @opindex mel
13791 Generate little-endian code.
13793 @item -mio-volatile
13794 @opindex mio-volatile
13795 Tells the compiler that any variable marked with the @code{io}
13796 attribute is to be considered volatile.
13798 @item -ml
13799 @opindex ml
13800 Causes variables to be assigned to the @code{.far} section by default.
13802 @item -mleadz
13803 @opindex mleadz
13804 Enables the @code{leadz} (leading zero) instruction.
13806 @item -mm
13807 @opindex mm
13808 Causes variables to be assigned to the @code{.near} section by default.
13810 @item -mminmax
13811 @opindex mminmax
13812 Enables the @code{min} and @code{max} instructions.
13814 @item -mmult
13815 @opindex mmult
13816 Enables the multiplication and multiply-accumulate instructions.
13818 @item -mno-opts
13819 @opindex mno-opts
13820 Disables all the optional instructions enabled by @code{-mall-opts}.
13822 @item -mrepeat
13823 @opindex mrepeat
13824 Enables the @code{repeat} and @code{erepeat} instructions, used for
13825 low-overhead looping.
13827 @item -ms
13828 @opindex ms
13829 Causes all variables to default to the @code{.tiny} section.  Note
13830 that there is a 65536 byte limit to this section.  Accesses to these
13831 variables use the @code{%gp} base register.
13833 @item -msatur
13834 @opindex msatur
13835 Enables the saturation instructions.  Note that the compiler does not
13836 currently generate these itself, but this option is included for
13837 compatibility with other tools, like @code{as}.
13839 @item -msdram
13840 @opindex msdram
13841 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13843 @item -msim
13844 @opindex msim
13845 Link the simulator runtime libraries.
13847 @item -msimnovec
13848 @opindex msimnovec
13849 Link the simulator runtime libraries, excluding built-in support
13850 for reset and exception vectors and tables.
13852 @item -mtf
13853 @opindex mtf
13854 Causes all functions to default to the @code{.far} section.  Without
13855 this option, functions default to the @code{.near} section.
13857 @item -mtiny=@var{n}
13858 @opindex mtiny=
13859 Variables that are @var{n} bytes or smaller will be allocated to the
13860 @code{.tiny} section.  These variables use the @code{$gp} base
13861 register.  The default for this option is 4, but note that there's a
13862 65536 byte limit to the @code{.tiny} section.
13864 @end table
13866 @node MicroBlaze Options
13867 @subsection MicroBlaze Options
13868 @cindex MicroBlaze Options
13870 @table @gcctabopt
13872 @item -msoft-float
13873 @opindex msoft-float
13874 Use software emulation for floating point (default).
13876 @item -mhard-float
13877 @opindex mhard-float
13878 Use hardware floating point instructions.
13880 @item -mmemcpy
13881 @opindex mmemcpy
13882 Do not optimize block moves, use @code{memcpy}.
13884 @item -mno-clearbss
13885 @opindex mno-clearbss
13886 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
13888 @item -mcpu=@var{cpu-type}
13889 @opindex mcpu=
13890 Use features of and schedule code for given CPU.
13891 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}}, 
13892 where @var{X} is a major version, @var{YY} is the minor version, and 
13893 @var{Z} is compatiblity code.  Example values are @samp{v3.00.a}, 
13894 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}. 
13896 @item -mxl-soft-mul
13897 @opindex mxl-soft-mul
13898 Use software multiply emulation (default).
13900 @item -mxl-soft-div
13901 @opindex mxl-soft-div
13902 Use software emulation for divides (default).
13904 @item -mxl-barrel-shift
13905 @opindex mxl-barrel-shift
13906 Use the hardware barrel shifter.
13908 @item -mxl-pattern-compare
13909 @opindex mxl-pattern-compare
13910 Use pattern compare instructions.
13912 @item -msmall-divides
13913 @opindex msmall-divides
13914 Use table lookup optimization for small signed integer divisions.
13916 @item -mxl-stack-check
13917 @opindex mxl-stack-check
13918 This option is deprecated.  Use -fstack-check instead.
13920 @item -mxl-gp-opt
13921 @opindex mxl-gp-opt
13922 Use GP relative sdata/sbss sections.
13924 @item -mxl-multiply-high
13925 @opindex mxl-multiply-high
13926 Use multiply high instructions for high part of 32x32 multiply.
13928 @item -mxl-float-convert
13929 @opindex mxl-float-convert
13930 Use hardware floating point converstion instructions.
13932 @item -mxl-float-sqrt
13933 @opindex mxl-float-sqrt
13934 Use hardware floating point square root instruction.
13936 @item -mxl-mode-@var{app-model}
13937 Select application model @var{app-model}.  Valid models are 
13938 @table @samp
13939 @item executable
13940 normal executable (default), uses startup code @file{crt0.o}.
13942 @item xmdstub
13943 for use with Xilinx Microprocessor Debugger (XMD) based 
13944 software intrusive debug agent called xmdstub. This uses startup file 
13945 @file{crt1.o} and sets the start address of the program to be 0x800.
13947 @item bootstrap
13948 for applications that are loaded using a bootloader.
13949 This model uses startup file @file{crt2.o} which does not contain a processor 
13950 reset vector handler. This is suitable for transferring control on a 
13951 processor reset to the bootloader rather than the application.
13953 @item novectors
13954 for applications that do not require any of the 
13955 MicroBlaze vectors. This option may be useful for applications running
13956 within a monitoring application. This model uses @file{crt3.o} as a startup file.
13957 @end table
13959 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for 
13960 @option{-mxl-mode-@var{app-model}}.
13962 @end table
13964 @node MIPS Options
13965 @subsection MIPS Options
13966 @cindex MIPS options
13968 @table @gcctabopt
13970 @item -EB
13971 @opindex EB
13972 Generate big-endian code.
13974 @item -EL
13975 @opindex EL
13976 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13977 configurations.
13979 @item -march=@var{arch}
13980 @opindex march
13981 Generate code that will run on @var{arch}, which can be the name of a
13982 generic MIPS ISA, or the name of a particular processor.
13983 The ISA names are:
13984 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13985 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13986 The processor names are:
13987 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13988 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13989 @samp{5kc}, @samp{5kf},
13990 @samp{20kc},
13991 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13992 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13993 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13994 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13995 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
13996 @samp{loongson2e}, @samp{loongson2f},
13997 @samp{m4k},
13998 @samp{octeon},
13999 @samp{orion},
14000 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
14001 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
14002 @samp{rm7000}, @samp{rm9000},
14003 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
14004 @samp{sb1},
14005 @samp{sr71000},
14006 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
14007 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
14008 and @samp{xlr}.
14009 The special value @samp{from-abi} selects the
14010 most compatible architecture for the selected ABI (that is,
14011 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
14013 Native Linux/GNU toolchains also support the value @samp{native},
14014 which selects the best architecture option for the host processor.
14015 @option{-march=native} has no effect if GCC does not recognize
14016 the processor.
14018 In processor names, a final @samp{000} can be abbreviated as @samp{k}
14019 (for example, @samp{-march=r2k}).  Prefixes are optional, and
14020 @samp{vr} may be written @samp{r}.
14022 Names of the form @samp{@var{n}f2_1} refer to processors with
14023 FPUs clocked at half the rate of the core, names of the form
14024 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
14025 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
14026 processors with FPUs clocked a ratio of 3:2 with respect to the core.
14027 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
14028 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
14029 accepted as synonyms for @samp{@var{n}f1_1}.
14031 GCC defines two macros based on the value of this option.  The first
14032 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
14033 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
14034 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
14035 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
14036 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
14038 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
14039 above.  In other words, it will have the full prefix and will not
14040 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
14041 the macro names the resolved architecture (either @samp{"mips1"} or
14042 @samp{"mips3"}).  It names the default architecture when no
14043 @option{-march} option is given.
14045 @item -mtune=@var{arch}
14046 @opindex mtune
14047 Optimize for @var{arch}.  Among other things, this option controls
14048 the way instructions are scheduled, and the perceived cost of arithmetic
14049 operations.  The list of @var{arch} values is the same as for
14050 @option{-march}.
14052 When this option is not used, GCC will optimize for the processor
14053 specified by @option{-march}.  By using @option{-march} and
14054 @option{-mtune} together, it is possible to generate code that will
14055 run on a family of processors, but optimize the code for one
14056 particular member of that family.
14058 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
14059 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
14060 @samp{-march} ones described above.
14062 @item -mips1
14063 @opindex mips1
14064 Equivalent to @samp{-march=mips1}.
14066 @item -mips2
14067 @opindex mips2
14068 Equivalent to @samp{-march=mips2}.
14070 @item -mips3
14071 @opindex mips3
14072 Equivalent to @samp{-march=mips3}.
14074 @item -mips4
14075 @opindex mips4
14076 Equivalent to @samp{-march=mips4}.
14078 @item -mips32
14079 @opindex mips32
14080 Equivalent to @samp{-march=mips32}.
14082 @item -mips32r2
14083 @opindex mips32r2
14084 Equivalent to @samp{-march=mips32r2}.
14086 @item -mips64
14087 @opindex mips64
14088 Equivalent to @samp{-march=mips64}.
14090 @item -mips64r2
14091 @opindex mips64r2
14092 Equivalent to @samp{-march=mips64r2}.
14094 @item -mips16
14095 @itemx -mno-mips16
14096 @opindex mips16
14097 @opindex mno-mips16
14098 Generate (do not generate) MIPS16 code.  If GCC is targetting a
14099 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
14101 MIPS16 code generation can also be controlled on a per-function basis
14102 by means of @code{mips16} and @code{nomips16} attributes.
14103 @xref{Function Attributes}, for more information.
14105 @item -mflip-mips16
14106 @opindex mflip-mips16
14107 Generate MIPS16 code on alternating functions.  This option is provided
14108 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
14109 not intended for ordinary use in compiling user code.
14111 @item -minterlink-mips16
14112 @itemx -mno-interlink-mips16
14113 @opindex minterlink-mips16
14114 @opindex mno-interlink-mips16
14115 Require (do not require) that non-MIPS16 code be link-compatible with
14116 MIPS16 code.
14118 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
14119 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
14120 therefore disables direct jumps unless GCC knows that the target of the
14121 jump is not MIPS16.
14123 @item -mabi=32
14124 @itemx -mabi=o64
14125 @itemx -mabi=n32
14126 @itemx -mabi=64
14127 @itemx -mabi=eabi
14128 @opindex mabi=32
14129 @opindex mabi=o64
14130 @opindex mabi=n32
14131 @opindex mabi=64
14132 @opindex mabi=eabi
14133 Generate code for the given ABI@.
14135 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
14136 generates 64-bit code when you select a 64-bit architecture, but you
14137 can use @option{-mgp32} to get 32-bit code instead.
14139 For information about the O64 ABI, see
14140 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
14142 GCC supports a variant of the o32 ABI in which floating-point registers
14143 are 64 rather than 32 bits wide.  You can select this combination with
14144 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
14145 and @samp{mfhc1} instructions and is therefore only supported for
14146 MIPS32R2 processors.
14148 The register assignments for arguments and return values remain the
14149 same, but each scalar value is passed in a single 64-bit register
14150 rather than a pair of 32-bit registers.  For example, scalar
14151 floating-point values are returned in @samp{$f0} only, not a
14152 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
14153 remains the same, but all 64 bits are saved.
14155 @item -mabicalls
14156 @itemx -mno-abicalls
14157 @opindex mabicalls
14158 @opindex mno-abicalls
14159 Generate (do not generate) code that is suitable for SVR4-style
14160 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
14161 systems.
14163 @item -mshared
14164 @itemx -mno-shared
14165 Generate (do not generate) code that is fully position-independent,
14166 and that can therefore be linked into shared libraries.  This option
14167 only affects @option{-mabicalls}.
14169 All @option{-mabicalls} code has traditionally been position-independent,
14170 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
14171 as an extension, the GNU toolchain allows executables to use absolute
14172 accesses for locally-binding symbols.  It can also use shorter GP
14173 initialization sequences and generate direct calls to locally-defined
14174 functions.  This mode is selected by @option{-mno-shared}.
14176 @option{-mno-shared} depends on binutils 2.16 or higher and generates
14177 objects that can only be linked by the GNU linker.  However, the option
14178 does not affect the ABI of the final executable; it only affects the ABI
14179 of relocatable objects.  Using @option{-mno-shared} will generally make
14180 executables both smaller and quicker.
14182 @option{-mshared} is the default.
14184 @item -mplt
14185 @itemx -mno-plt
14186 @opindex mplt
14187 @opindex mno-plt
14188 Assume (do not assume) that the static and dynamic linkers
14189 support PLTs and copy relocations.  This option only affects
14190 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
14191 has no effect without @samp{-msym32}.
14193 You can make @option{-mplt} the default by configuring
14194 GCC with @option{--with-mips-plt}.  The default is
14195 @option{-mno-plt} otherwise.
14197 @item -mxgot
14198 @itemx -mno-xgot
14199 @opindex mxgot
14200 @opindex mno-xgot
14201 Lift (do not lift) the usual restrictions on the size of the global
14202 offset table.
14204 GCC normally uses a single instruction to load values from the GOT@.
14205 While this is relatively efficient, it will only work if the GOT
14206 is smaller than about 64k.  Anything larger will cause the linker
14207 to report an error such as:
14209 @cindex relocation truncated to fit (MIPS)
14210 @smallexample
14211 relocation truncated to fit: R_MIPS_GOT16 foobar
14212 @end smallexample
14214 If this happens, you should recompile your code with @option{-mxgot}.
14215 It should then work with very large GOTs, although it will also be
14216 less efficient, since it will take three instructions to fetch the
14217 value of a global symbol.
14219 Note that some linkers can create multiple GOTs.  If you have such a
14220 linker, you should only need to use @option{-mxgot} when a single object
14221 file accesses more than 64k's worth of GOT entries.  Very few do.
14223 These options have no effect unless GCC is generating position
14224 independent code.
14226 @item -mgp32
14227 @opindex mgp32
14228 Assume that general-purpose registers are 32 bits wide.
14230 @item -mgp64
14231 @opindex mgp64
14232 Assume that general-purpose registers are 64 bits wide.
14234 @item -mfp32
14235 @opindex mfp32
14236 Assume that floating-point registers are 32 bits wide.
14238 @item -mfp64
14239 @opindex mfp64
14240 Assume that floating-point registers are 64 bits wide.
14242 @item -mhard-float
14243 @opindex mhard-float
14244 Use floating-point coprocessor instructions.
14246 @item -msoft-float
14247 @opindex msoft-float
14248 Do not use floating-point coprocessor instructions.  Implement
14249 floating-point calculations using library calls instead.
14251 @item -msingle-float
14252 @opindex msingle-float
14253 Assume that the floating-point coprocessor only supports single-precision
14254 operations.
14256 @item -mdouble-float
14257 @opindex mdouble-float
14258 Assume that the floating-point coprocessor supports double-precision
14259 operations.  This is the default.
14261 @item -mllsc
14262 @itemx -mno-llsc
14263 @opindex mllsc
14264 @opindex mno-llsc
14265 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
14266 implement atomic memory built-in functions.  When neither option is
14267 specified, GCC will use the instructions if the target architecture
14268 supports them.
14270 @option{-mllsc} is useful if the runtime environment can emulate the
14271 instructions and @option{-mno-llsc} can be useful when compiling for
14272 nonstandard ISAs.  You can make either option the default by
14273 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
14274 respectively.  @option{--with-llsc} is the default for some
14275 configurations; see the installation documentation for details.
14277 @item -mdsp
14278 @itemx -mno-dsp
14279 @opindex mdsp
14280 @opindex mno-dsp
14281 Use (do not use) revision 1 of the MIPS DSP ASE@.
14282 @xref{MIPS DSP Built-in Functions}.  This option defines the
14283 preprocessor macro @samp{__mips_dsp}.  It also defines
14284 @samp{__mips_dsp_rev} to 1.
14286 @item -mdspr2
14287 @itemx -mno-dspr2
14288 @opindex mdspr2
14289 @opindex mno-dspr2
14290 Use (do not use) revision 2 of the MIPS DSP ASE@.
14291 @xref{MIPS DSP Built-in Functions}.  This option defines the
14292 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
14293 It also defines @samp{__mips_dsp_rev} to 2.
14295 @item -msmartmips
14296 @itemx -mno-smartmips
14297 @opindex msmartmips
14298 @opindex mno-smartmips
14299 Use (do not use) the MIPS SmartMIPS ASE.
14301 @item -mpaired-single
14302 @itemx -mno-paired-single
14303 @opindex mpaired-single
14304 @opindex mno-paired-single
14305 Use (do not use) paired-single floating-point instructions.
14306 @xref{MIPS Paired-Single Support}.  This option requires
14307 hardware floating-point support to be enabled.
14309 @item -mdmx
14310 @itemx -mno-mdmx
14311 @opindex mdmx
14312 @opindex mno-mdmx
14313 Use (do not use) MIPS Digital Media Extension instructions.
14314 This option can only be used when generating 64-bit code and requires
14315 hardware floating-point support to be enabled.
14317 @item -mips3d
14318 @itemx -mno-mips3d
14319 @opindex mips3d
14320 @opindex mno-mips3d
14321 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
14322 The option @option{-mips3d} implies @option{-mpaired-single}.
14324 @item -mmt
14325 @itemx -mno-mt
14326 @opindex mmt
14327 @opindex mno-mt
14328 Use (do not use) MT Multithreading instructions.
14330 @item -mlong64
14331 @opindex mlong64
14332 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
14333 an explanation of the default and the way that the pointer size is
14334 determined.
14336 @item -mlong32
14337 @opindex mlong32
14338 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
14340 The default size of @code{int}s, @code{long}s and pointers depends on
14341 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
14342 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
14343 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
14344 or the same size as integer registers, whichever is smaller.
14346 @item -msym32
14347 @itemx -mno-sym32
14348 @opindex msym32
14349 @opindex mno-sym32
14350 Assume (do not assume) that all symbols have 32-bit values, regardless
14351 of the selected ABI@.  This option is useful in combination with
14352 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
14353 to generate shorter and faster references to symbolic addresses.
14355 @item -G @var{num}
14356 @opindex G
14357 Put definitions of externally-visible data in a small data section
14358 if that data is no bigger than @var{num} bytes.  GCC can then access
14359 the data more efficiently; see @option{-mgpopt} for details.
14361 The default @option{-G} option depends on the configuration.
14363 @item -mlocal-sdata
14364 @itemx -mno-local-sdata
14365 @opindex mlocal-sdata
14366 @opindex mno-local-sdata
14367 Extend (do not extend) the @option{-G} behavior to local data too,
14368 such as to static variables in C@.  @option{-mlocal-sdata} is the
14369 default for all configurations.
14371 If the linker complains that an application is using too much small data,
14372 you might want to try rebuilding the less performance-critical parts with
14373 @option{-mno-local-sdata}.  You might also want to build large
14374 libraries with @option{-mno-local-sdata}, so that the libraries leave
14375 more room for the main program.
14377 @item -mextern-sdata
14378 @itemx -mno-extern-sdata
14379 @opindex mextern-sdata
14380 @opindex mno-extern-sdata
14381 Assume (do not assume) that externally-defined data will be in
14382 a small data section if that data is within the @option{-G} limit.
14383 @option{-mextern-sdata} is the default for all configurations.
14385 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
14386 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
14387 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
14388 is placed in a small data section.  If @var{Var} is defined by another
14389 module, you must either compile that module with a high-enough
14390 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
14391 definition.  If @var{Var} is common, you must link the application
14392 with a high-enough @option{-G} setting.
14394 The easiest way of satisfying these restrictions is to compile
14395 and link every module with the same @option{-G} option.  However,
14396 you may wish to build a library that supports several different
14397 small data limits.  You can do this by compiling the library with
14398 the highest supported @option{-G} setting and additionally using
14399 @option{-mno-extern-sdata} to stop the library from making assumptions
14400 about externally-defined data.
14402 @item -mgpopt
14403 @itemx -mno-gpopt
14404 @opindex mgpopt
14405 @opindex mno-gpopt
14406 Use (do not use) GP-relative accesses for symbols that are known to be
14407 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
14408 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
14409 configurations.
14411 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
14412 might not hold the value of @code{_gp}.  For example, if the code is
14413 part of a library that might be used in a boot monitor, programs that
14414 call boot monitor routines will pass an unknown value in @code{$gp}.
14415 (In such situations, the boot monitor itself would usually be compiled
14416 with @option{-G0}.)
14418 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
14419 @option{-mno-extern-sdata}.
14421 @item -membedded-data
14422 @itemx -mno-embedded-data
14423 @opindex membedded-data
14424 @opindex mno-embedded-data
14425 Allocate variables to the read-only data section first if possible, then
14426 next in the small data section if possible, otherwise in data.  This gives
14427 slightly slower code than the default, but reduces the amount of RAM required
14428 when executing, and thus may be preferred for some embedded systems.
14430 @item -muninit-const-in-rodata
14431 @itemx -mno-uninit-const-in-rodata
14432 @opindex muninit-const-in-rodata
14433 @opindex mno-uninit-const-in-rodata
14434 Put uninitialized @code{const} variables in the read-only data section.
14435 This option is only meaningful in conjunction with @option{-membedded-data}.
14437 @item -mcode-readable=@var{setting}
14438 @opindex mcode-readable
14439 Specify whether GCC may generate code that reads from executable sections.
14440 There are three possible settings:
14442 @table @gcctabopt
14443 @item -mcode-readable=yes
14444 Instructions may freely access executable sections.  This is the
14445 default setting.
14447 @item -mcode-readable=pcrel
14448 MIPS16 PC-relative load instructions can access executable sections,
14449 but other instructions must not do so.  This option is useful on 4KSc
14450 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
14451 It is also useful on processors that can be configured to have a dual
14452 instruction/data SRAM interface and that, like the M4K, automatically
14453 redirect PC-relative loads to the instruction RAM.
14455 @item -mcode-readable=no
14456 Instructions must not access executable sections.  This option can be
14457 useful on targets that are configured to have a dual instruction/data
14458 SRAM interface but that (unlike the M4K) do not automatically redirect
14459 PC-relative loads to the instruction RAM.
14460 @end table
14462 @item -msplit-addresses
14463 @itemx -mno-split-addresses
14464 @opindex msplit-addresses
14465 @opindex mno-split-addresses
14466 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
14467 relocation operators.  This option has been superseded by
14468 @option{-mexplicit-relocs} but is retained for backwards compatibility.
14470 @item -mexplicit-relocs
14471 @itemx -mno-explicit-relocs
14472 @opindex mexplicit-relocs
14473 @opindex mno-explicit-relocs
14474 Use (do not use) assembler relocation operators when dealing with symbolic
14475 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
14476 is to use assembler macros instead.
14478 @option{-mexplicit-relocs} is the default if GCC was configured
14479 to use an assembler that supports relocation operators.
14481 @item -mcheck-zero-division
14482 @itemx -mno-check-zero-division
14483 @opindex mcheck-zero-division
14484 @opindex mno-check-zero-division
14485 Trap (do not trap) on integer division by zero.
14487 The default is @option{-mcheck-zero-division}.
14489 @item -mdivide-traps
14490 @itemx -mdivide-breaks
14491 @opindex mdivide-traps
14492 @opindex mdivide-breaks
14493 MIPS systems check for division by zero by generating either a
14494 conditional trap or a break instruction.  Using traps results in
14495 smaller code, but is only supported on MIPS II and later.  Also, some
14496 versions of the Linux kernel have a bug that prevents trap from
14497 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
14498 allow conditional traps on architectures that support them and
14499 @option{-mdivide-breaks} to force the use of breaks.
14501 The default is usually @option{-mdivide-traps}, but this can be
14502 overridden at configure time using @option{--with-divide=breaks}.
14503 Divide-by-zero checks can be completely disabled using
14504 @option{-mno-check-zero-division}.
14506 @item -mmemcpy
14507 @itemx -mno-memcpy
14508 @opindex mmemcpy
14509 @opindex mno-memcpy
14510 Force (do not force) the use of @code{memcpy()} for non-trivial block
14511 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
14512 most constant-sized copies.
14514 @item -mlong-calls
14515 @itemx -mno-long-calls
14516 @opindex mlong-calls
14517 @opindex mno-long-calls
14518 Disable (do not disable) use of the @code{jal} instruction.  Calling
14519 functions using @code{jal} is more efficient but requires the caller
14520 and callee to be in the same 256 megabyte segment.
14522 This option has no effect on abicalls code.  The default is
14523 @option{-mno-long-calls}.
14525 @item -mmad
14526 @itemx -mno-mad
14527 @opindex mmad
14528 @opindex mno-mad
14529 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
14530 instructions, as provided by the R4650 ISA@.
14532 @item -mfused-madd
14533 @itemx -mno-fused-madd
14534 @opindex mfused-madd
14535 @opindex mno-fused-madd
14536 Enable (disable) use of the floating point multiply-accumulate
14537 instructions, when they are available.  The default is
14538 @option{-mfused-madd}.
14540 When multiply-accumulate instructions are used, the intermediate
14541 product is calculated to infinite precision and is not subject to
14542 the FCSR Flush to Zero bit.  This may be undesirable in some
14543 circumstances.
14545 @item -nocpp
14546 @opindex nocpp
14547 Tell the MIPS assembler to not run its preprocessor over user
14548 assembler files (with a @samp{.s} suffix) when assembling them.
14550 @item -mfix-r4000
14551 @itemx -mno-fix-r4000
14552 @opindex mfix-r4000
14553 @opindex mno-fix-r4000
14554 Work around certain R4000 CPU errata:
14555 @itemize @minus
14556 @item
14557 A double-word or a variable shift may give an incorrect result if executed
14558 immediately after starting an integer division.
14559 @item
14560 A double-word or a variable shift may give an incorrect result if executed
14561 while an integer multiplication is in progress.
14562 @item
14563 An integer division may give an incorrect result if started in a delay slot
14564 of a taken branch or a jump.
14565 @end itemize
14567 @item -mfix-r4400
14568 @itemx -mno-fix-r4400
14569 @opindex mfix-r4400
14570 @opindex mno-fix-r4400
14571 Work around certain R4400 CPU errata:
14572 @itemize @minus
14573 @item
14574 A double-word or a variable shift may give an incorrect result if executed
14575 immediately after starting an integer division.
14576 @end itemize
14578 @item -mfix-r10000
14579 @itemx -mno-fix-r10000
14580 @opindex mfix-r10000
14581 @opindex mno-fix-r10000
14582 Work around certain R10000 errata:
14583 @itemize @minus
14584 @item
14585 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14586 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
14587 @end itemize
14589 This option can only be used if the target architecture supports
14590 branch-likely instructions.  @option{-mfix-r10000} is the default when
14591 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14592 otherwise.
14594 @item -mfix-vr4120
14595 @itemx -mno-fix-vr4120
14596 @opindex mfix-vr4120
14597 Work around certain VR4120 errata:
14598 @itemize @minus
14599 @item
14600 @code{dmultu} does not always produce the correct result.
14601 @item
14602 @code{div} and @code{ddiv} do not always produce the correct result if one
14603 of the operands is negative.
14604 @end itemize
14605 The workarounds for the division errata rely on special functions in
14606 @file{libgcc.a}.  At present, these functions are only provided by
14607 the @code{mips64vr*-elf} configurations.
14609 Other VR4120 errata require a nop to be inserted between certain pairs of
14610 instructions.  These errata are handled by the assembler, not by GCC itself.
14612 @item -mfix-vr4130
14613 @opindex mfix-vr4130
14614 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
14615 workarounds are implemented by the assembler rather than by GCC,
14616 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14617 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14618 instructions are available instead.
14620 @item -mfix-sb1
14621 @itemx -mno-fix-sb1
14622 @opindex mfix-sb1
14623 Work around certain SB-1 CPU core errata.
14624 (This flag currently works around the SB-1 revision 2
14625 ``F1'' and ``F2'' floating point errata.)
14627 @item -mr10k-cache-barrier=@var{setting}
14628 @opindex mr10k-cache-barrier
14629 Specify whether GCC should insert cache barriers to avoid the
14630 side-effects of speculation on R10K processors.
14632 In common with many processors, the R10K tries to predict the outcome
14633 of a conditional branch and speculatively executes instructions from
14634 the ``taken'' branch.  It later aborts these instructions if the
14635 predicted outcome was wrong.  However, on the R10K, even aborted
14636 instructions can have side effects.
14638 This problem only affects kernel stores and, depending on the system,
14639 kernel loads.  As an example, a speculatively-executed store may load
14640 the target memory into cache and mark the cache line as dirty, even if
14641 the store itself is later aborted.  If a DMA operation writes to the
14642 same area of memory before the ``dirty'' line is flushed, the cached
14643 data will overwrite the DMA-ed data.  See the R10K processor manual
14644 for a full description, including other potential problems.
14646 One workaround is to insert cache barrier instructions before every memory
14647 access that might be speculatively executed and that might have side
14648 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
14649 controls GCC's implementation of this workaround.  It assumes that
14650 aborted accesses to any byte in the following regions will not have
14651 side effects:
14653 @enumerate
14654 @item
14655 the memory occupied by the current function's stack frame;
14657 @item
14658 the memory occupied by an incoming stack argument;
14660 @item
14661 the memory occupied by an object with a link-time-constant address.
14662 @end enumerate
14664 It is the kernel's responsibility to ensure that speculative
14665 accesses to these regions are indeed safe.
14667 If the input program contains a function declaration such as:
14669 @smallexample
14670 void foo (void);
14671 @end smallexample
14673 then the implementation of @code{foo} must allow @code{j foo} and
14674 @code{jal foo} to be executed speculatively.  GCC honors this
14675 restriction for functions it compiles itself.  It expects non-GCC
14676 functions (such as hand-written assembly code) to do the same.
14678 The option has three forms:
14680 @table @gcctabopt
14681 @item -mr10k-cache-barrier=load-store
14682 Insert a cache barrier before a load or store that might be
14683 speculatively executed and that might have side effects even
14684 if aborted.
14686 @item -mr10k-cache-barrier=store
14687 Insert a cache barrier before a store that might be speculatively
14688 executed and that might have side effects even if aborted.
14690 @item -mr10k-cache-barrier=none
14691 Disable the insertion of cache barriers.  This is the default setting.
14692 @end table
14694 @item -mflush-func=@var{func}
14695 @itemx -mno-flush-func
14696 @opindex mflush-func
14697 Specifies the function to call to flush the I and D caches, or to not
14698 call any such function.  If called, the function must take the same
14699 arguments as the common @code{_flush_func()}, that is, the address of the
14700 memory range for which the cache is being flushed, the size of the
14701 memory range, and the number 3 (to flush both caches).  The default
14702 depends on the target GCC was configured for, but commonly is either
14703 @samp{_flush_func} or @samp{__cpu_flush}.
14705 @item mbranch-cost=@var{num}
14706 @opindex mbranch-cost
14707 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14708 This cost is only a heuristic and is not guaranteed to produce
14709 consistent results across releases.  A zero cost redundantly selects
14710 the default, which is based on the @option{-mtune} setting.
14712 @item -mbranch-likely
14713 @itemx -mno-branch-likely
14714 @opindex mbranch-likely
14715 @opindex mno-branch-likely
14716 Enable or disable use of Branch Likely instructions, regardless of the
14717 default for the selected architecture.  By default, Branch Likely
14718 instructions may be generated if they are supported by the selected
14719 architecture.  An exception is for the MIPS32 and MIPS64 architectures
14720 and processors which implement those architectures; for those, Branch
14721 Likely instructions will not be generated by default because the MIPS32
14722 and MIPS64 architectures specifically deprecate their use.
14724 @item -mfp-exceptions
14725 @itemx -mno-fp-exceptions
14726 @opindex mfp-exceptions
14727 Specifies whether FP exceptions are enabled.  This affects how we schedule
14728 FP instructions for some processors.  The default is that FP exceptions are
14729 enabled.
14731 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14732 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
14733 FP pipe.
14735 @item -mvr4130-align
14736 @itemx -mno-vr4130-align
14737 @opindex mvr4130-align
14738 The VR4130 pipeline is two-way superscalar, but can only issue two
14739 instructions together if the first one is 8-byte aligned.  When this
14740 option is enabled, GCC will align pairs of instructions that it
14741 thinks should execute in parallel.
14743 This option only has an effect when optimizing for the VR4130.
14744 It normally makes code faster, but at the expense of making it bigger.
14745 It is enabled by default at optimization level @option{-O3}.
14747 @item -msynci
14748 @itemx -mno-synci
14749 @opindex msynci
14750 Enable (disable) generation of @code{synci} instructions on
14751 architectures that support it.  The @code{synci} instructions (if
14752 enabled) will be generated when @code{__builtin___clear_cache()} is
14753 compiled.
14755 This option defaults to @code{-mno-synci}, but the default can be
14756 overridden by configuring with @code{--with-synci}.
14758 When compiling code for single processor systems, it is generally safe
14759 to use @code{synci}.  However, on many multi-core (SMP) systems, it
14760 will not invalidate the instruction caches on all cores and may lead
14761 to undefined behavior.
14763 @item -mrelax-pic-calls
14764 @itemx -mno-relax-pic-calls
14765 @opindex mrelax-pic-calls
14766 Try to turn PIC calls that are normally dispatched via register
14767 @code{$25} into direct calls.  This is only possible if the linker can
14768 resolve the destination at link-time and if the destination is within
14769 range for a direct call.
14771 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14772 an assembler and a linker that supports the @code{.reloc} assembly
14773 directive and @code{-mexplicit-relocs} is in effect.  With
14774 @code{-mno-explicit-relocs}, this optimization can be performed by the
14775 assembler and the linker alone without help from the compiler.
14777 @item -mmcount-ra-address
14778 @itemx -mno-mcount-ra-address
14779 @opindex mmcount-ra-address
14780 @opindex mno-mcount-ra-address
14781 Emit (do not emit) code that allows @code{_mcount} to modify the
14782 calling function's return address.  When enabled, this option extends
14783 the usual @code{_mcount} interface with a new @var{ra-address}
14784 parameter, which has type @code{intptr_t *} and is passed in register
14785 @code{$12}.  @code{_mcount} can then modify the return address by
14786 doing both of the following:
14787 @itemize
14788 @item
14789 Returning the new address in register @code{$31}.
14790 @item
14791 Storing the new address in @code{*@var{ra-address}},
14792 if @var{ra-address} is nonnull.
14793 @end itemize
14795 The default is @option{-mno-mcount-ra-address}.
14797 @end table
14799 @node MMIX Options
14800 @subsection MMIX Options
14801 @cindex MMIX Options
14803 These options are defined for the MMIX:
14805 @table @gcctabopt
14806 @item -mlibfuncs
14807 @itemx -mno-libfuncs
14808 @opindex mlibfuncs
14809 @opindex mno-libfuncs
14810 Specify that intrinsic library functions are being compiled, passing all
14811 values in registers, no matter the size.
14813 @item -mepsilon
14814 @itemx -mno-epsilon
14815 @opindex mepsilon
14816 @opindex mno-epsilon
14817 Generate floating-point comparison instructions that compare with respect
14818 to the @code{rE} epsilon register.
14820 @item -mabi=mmixware
14821 @itemx -mabi=gnu
14822 @opindex mabi=mmixware
14823 @opindex mabi=gnu
14824 Generate code that passes function parameters and return values that (in
14825 the called function) are seen as registers @code{$0} and up, as opposed to
14826 the GNU ABI which uses global registers @code{$231} and up.
14828 @item -mzero-extend
14829 @itemx -mno-zero-extend
14830 @opindex mzero-extend
14831 @opindex mno-zero-extend
14832 When reading data from memory in sizes shorter than 64 bits, use (do not
14833 use) zero-extending load instructions by default, rather than
14834 sign-extending ones.
14836 @item -mknuthdiv
14837 @itemx -mno-knuthdiv
14838 @opindex mknuthdiv
14839 @opindex mno-knuthdiv
14840 Make the result of a division yielding a remainder have the same sign as
14841 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
14842 remainder follows the sign of the dividend.  Both methods are
14843 arithmetically valid, the latter being almost exclusively used.
14845 @item -mtoplevel-symbols
14846 @itemx -mno-toplevel-symbols
14847 @opindex mtoplevel-symbols
14848 @opindex mno-toplevel-symbols
14849 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
14850 code can be used with the @code{PREFIX} assembly directive.
14852 @item -melf
14853 @opindex melf
14854 Generate an executable in the ELF format, rather than the default
14855 @samp{mmo} format used by the @command{mmix} simulator.
14857 @item -mbranch-predict
14858 @itemx -mno-branch-predict
14859 @opindex mbranch-predict
14860 @opindex mno-branch-predict
14861 Use (do not use) the probable-branch instructions, when static branch
14862 prediction indicates a probable branch.
14864 @item -mbase-addresses
14865 @itemx -mno-base-addresses
14866 @opindex mbase-addresses
14867 @opindex mno-base-addresses
14868 Generate (do not generate) code that uses @emph{base addresses}.  Using a
14869 base address automatically generates a request (handled by the assembler
14870 and the linker) for a constant to be set up in a global register.  The
14871 register is used for one or more base address requests within the range 0
14872 to 255 from the value held in the register.  The generally leads to short
14873 and fast code, but the number of different data items that can be
14874 addressed is limited.  This means that a program that uses lots of static
14875 data may require @option{-mno-base-addresses}.
14877 @item -msingle-exit
14878 @itemx -mno-single-exit
14879 @opindex msingle-exit
14880 @opindex mno-single-exit
14881 Force (do not force) generated code to have a single exit point in each
14882 function.
14883 @end table
14885 @node MN10300 Options
14886 @subsection MN10300 Options
14887 @cindex MN10300 options
14889 These @option{-m} options are defined for Matsushita MN10300 architectures:
14891 @table @gcctabopt
14892 @item -mmult-bug
14893 @opindex mmult-bug
14894 Generate code to avoid bugs in the multiply instructions for the MN10300
14895 processors.  This is the default.
14897 @item -mno-mult-bug
14898 @opindex mno-mult-bug
14899 Do not generate code to avoid bugs in the multiply instructions for the
14900 MN10300 processors.
14902 @item -mam33
14903 @opindex mam33
14904 Generate code which uses features specific to the AM33 processor.
14906 @item -mno-am33
14907 @opindex mno-am33
14908 Do not generate code which uses features specific to the AM33 processor.  This
14909 is the default.
14911 @item -mreturn-pointer-on-d0
14912 @opindex mreturn-pointer-on-d0
14913 When generating a function which returns a pointer, return the pointer
14914 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
14915 only in a0, and attempts to call such functions without a prototype
14916 would result in errors.  Note that this option is on by default; use
14917 @option{-mno-return-pointer-on-d0} to disable it.
14919 @item -mno-crt0
14920 @opindex mno-crt0
14921 Do not link in the C run-time initialization object file.
14923 @item -mrelax
14924 @opindex mrelax
14925 Indicate to the linker that it should perform a relaxation optimization pass
14926 to shorten branches, calls and absolute memory addresses.  This option only
14927 has an effect when used on the command line for the final link step.
14929 This option makes symbolic debugging impossible.
14930 @end table
14932 @node PDP-11 Options
14933 @subsection PDP-11 Options
14934 @cindex PDP-11 Options
14936 These options are defined for the PDP-11:
14938 @table @gcctabopt
14939 @item -mfpu
14940 @opindex mfpu
14941 Use hardware FPP floating point.  This is the default.  (FIS floating
14942 point on the PDP-11/40 is not supported.)
14944 @item -msoft-float
14945 @opindex msoft-float
14946 Do not use hardware floating point.
14948 @item -mac0
14949 @opindex mac0
14950 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
14952 @item -mno-ac0
14953 @opindex mno-ac0
14954 Return floating-point results in memory.  This is the default.
14956 @item -m40
14957 @opindex m40
14958 Generate code for a PDP-11/40.
14960 @item -m45
14961 @opindex m45
14962 Generate code for a PDP-11/45.  This is the default.
14964 @item -m10
14965 @opindex m10
14966 Generate code for a PDP-11/10.
14968 @item -mbcopy-builtin
14969 @opindex mbcopy-builtin
14970 Use inline @code{movmemhi} patterns for copying memory.  This is the
14971 default.
14973 @item -mbcopy
14974 @opindex mbcopy
14975 Do not use inline @code{movmemhi} patterns for copying memory.
14977 @item -mint16
14978 @itemx -mno-int32
14979 @opindex mint16
14980 @opindex mno-int32
14981 Use 16-bit @code{int}.  This is the default.
14983 @item -mint32
14984 @itemx -mno-int16
14985 @opindex mint32
14986 @opindex mno-int16
14987 Use 32-bit @code{int}.
14989 @item -mfloat64
14990 @itemx -mno-float32
14991 @opindex mfloat64
14992 @opindex mno-float32
14993 Use 64-bit @code{float}.  This is the default.
14995 @item -mfloat32
14996 @itemx -mno-float64
14997 @opindex mfloat32
14998 @opindex mno-float64
14999 Use 32-bit @code{float}.
15001 @item -mabshi
15002 @opindex mabshi
15003 Use @code{abshi2} pattern.  This is the default.
15005 @item -mno-abshi
15006 @opindex mno-abshi
15007 Do not use @code{abshi2} pattern.
15009 @item -mbranch-expensive
15010 @opindex mbranch-expensive
15011 Pretend that branches are expensive.  This is for experimenting with
15012 code generation only.
15014 @item -mbranch-cheap
15015 @opindex mbranch-cheap
15016 Do not pretend that branches are expensive.  This is the default.
15018 @item -msplit
15019 @opindex msplit
15020 Generate code for a system with split I&D@.
15022 @item -mno-split
15023 @opindex mno-split
15024 Generate code for a system without split I&D@.  This is the default.
15026 @item -munix-asm
15027 @opindex munix-asm
15028 Use Unix assembler syntax.  This is the default when configured for
15029 @samp{pdp11-*-bsd}.
15031 @item -mdec-asm
15032 @opindex mdec-asm
15033 Use DEC assembler syntax.  This is the default when configured for any
15034 PDP-11 target other than @samp{pdp11-*-bsd}.
15035 @end table
15037 @node picoChip Options
15038 @subsection picoChip Options
15039 @cindex picoChip options
15041 These @samp{-m} options are defined for picoChip implementations:
15043 @table @gcctabopt
15045 @item -mae=@var{ae_type}
15046 @opindex mcpu
15047 Set the instruction set, register set, and instruction scheduling
15048 parameters for array element type @var{ae_type}.  Supported values
15049 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
15051 @option{-mae=ANY} selects a completely generic AE type.  Code
15052 generated with this option will run on any of the other AE types.  The
15053 code will not be as efficient as it would be if compiled for a specific
15054 AE type, and some types of operation (e.g., multiplication) will not
15055 work properly on all types of AE.
15057 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
15058 for compiled code, and is the default.
15060 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
15061 option may suffer from poor performance of byte (char) manipulation,
15062 since the DSP AE does not provide hardware support for byte load/stores.
15064 @item -msymbol-as-address
15065 Enable the compiler to directly use a symbol name as an address in a
15066 load/store instruction, without first loading it into a
15067 register.  Typically, the use of this option will generate larger
15068 programs, which run faster than when the option isn't used.  However, the
15069 results vary from program to program, so it is left as a user option,
15070 rather than being permanently enabled.
15072 @item -mno-inefficient-warnings
15073 Disables warnings about the generation of inefficient code.  These
15074 warnings can be generated, for example, when compiling code which
15075 performs byte-level memory operations on the MAC AE type.  The MAC AE has
15076 no hardware support for byte-level memory operations, so all byte
15077 load/stores must be synthesized from word load/store operations.  This is
15078 inefficient and a warning will be generated indicating to the programmer
15079 that they should rewrite the code to avoid byte operations, or to target
15080 an AE type which has the necessary hardware support.  This option enables
15081 the warning to be turned off.
15083 @end table
15085 @node PowerPC Options
15086 @subsection PowerPC Options
15087 @cindex PowerPC options
15089 These are listed under @xref{RS/6000 and PowerPC Options}.
15091 @node RS/6000 and PowerPC Options
15092 @subsection IBM RS/6000 and PowerPC Options
15093 @cindex RS/6000 and PowerPC Options
15094 @cindex IBM RS/6000 and PowerPC Options
15096 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
15097 @table @gcctabopt
15098 @item -mpower
15099 @itemx -mno-power
15100 @itemx -mpower2
15101 @itemx -mno-power2
15102 @itemx -mpowerpc
15103 @itemx -mno-powerpc
15104 @itemx -mpowerpc-gpopt
15105 @itemx -mno-powerpc-gpopt
15106 @itemx -mpowerpc-gfxopt
15107 @itemx -mno-powerpc-gfxopt
15108 @need 800
15109 @itemx -mpowerpc64
15110 @itemx -mno-powerpc64
15111 @itemx -mmfcrf
15112 @itemx -mno-mfcrf
15113 @itemx -mpopcntb
15114 @itemx -mno-popcntb
15115 @itemx -mpopcntd
15116 @itemx -mno-popcntd
15117 @itemx -mfprnd
15118 @itemx -mno-fprnd
15119 @need 800
15120 @itemx -mcmpb
15121 @itemx -mno-cmpb
15122 @itemx -mmfpgpr
15123 @itemx -mno-mfpgpr
15124 @itemx -mhard-dfp
15125 @itemx -mno-hard-dfp
15126 @opindex mpower
15127 @opindex mno-power
15128 @opindex mpower2
15129 @opindex mno-power2
15130 @opindex mpowerpc
15131 @opindex mno-powerpc
15132 @opindex mpowerpc-gpopt
15133 @opindex mno-powerpc-gpopt
15134 @opindex mpowerpc-gfxopt
15135 @opindex mno-powerpc-gfxopt
15136 @opindex mpowerpc64
15137 @opindex mno-powerpc64
15138 @opindex mmfcrf
15139 @opindex mno-mfcrf
15140 @opindex mpopcntb
15141 @opindex mno-popcntb
15142 @opindex mpopcntd
15143 @opindex mno-popcntd
15144 @opindex mfprnd
15145 @opindex mno-fprnd
15146 @opindex mcmpb
15147 @opindex mno-cmpb
15148 @opindex mmfpgpr
15149 @opindex mno-mfpgpr
15150 @opindex mhard-dfp
15151 @opindex mno-hard-dfp
15152 GCC supports two related instruction set architectures for the
15153 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
15154 instructions supported by the @samp{rios} chip set used in the original
15155 RS/6000 systems and the @dfn{PowerPC} instruction set is the
15156 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
15157 the IBM 4xx, 6xx, and follow-on microprocessors.
15159 Neither architecture is a subset of the other.  However there is a
15160 large common subset of instructions supported by both.  An MQ
15161 register is included in processors supporting the POWER architecture.
15163 You use these options to specify which instructions are available on the
15164 processor you are using.  The default value of these options is
15165 determined when configuring GCC@.  Specifying the
15166 @option{-mcpu=@var{cpu_type}} overrides the specification of these
15167 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
15168 rather than the options listed above.
15170 The @option{-mpower} option allows GCC to generate instructions that
15171 are found only in the POWER architecture and to use the MQ register.
15172 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
15173 to generate instructions that are present in the POWER2 architecture but
15174 not the original POWER architecture.
15176 The @option{-mpowerpc} option allows GCC to generate instructions that
15177 are found only in the 32-bit subset of the PowerPC architecture.
15178 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
15179 GCC to use the optional PowerPC architecture instructions in the
15180 General Purpose group, including floating-point square root.  Specifying
15181 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
15182 use the optional PowerPC architecture instructions in the Graphics
15183 group, including floating-point select.
15185 The @option{-mmfcrf} option allows GCC to generate the move from
15186 condition register field instruction implemented on the POWER4
15187 processor and other processors that support the PowerPC V2.01
15188 architecture.
15189 The @option{-mpopcntb} option allows GCC to generate the popcount and
15190 double precision FP reciprocal estimate instruction implemented on the
15191 POWER5 processor and other processors that support the PowerPC V2.02
15192 architecture.
15193 The @option{-mpopcntd} option allows GCC to generate the popcount
15194 instruction implemented on the POWER7 processor and other processors
15195 that support the PowerPC V2.06 architecture.
15196 The @option{-mfprnd} option allows GCC to generate the FP round to
15197 integer instructions implemented on the POWER5+ processor and other
15198 processors that support the PowerPC V2.03 architecture.
15199 The @option{-mcmpb} option allows GCC to generate the compare bytes
15200 instruction implemented on the POWER6 processor and other processors
15201 that support the PowerPC V2.05 architecture.
15202 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
15203 general purpose register instructions implemented on the POWER6X
15204 processor and other processors that support the extended PowerPC V2.05
15205 architecture.
15206 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
15207 point instructions implemented on some POWER processors.
15209 The @option{-mpowerpc64} option allows GCC to generate the additional
15210 64-bit instructions that are found in the full PowerPC64 architecture
15211 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
15212 @option{-mno-powerpc64}.
15214 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
15215 will use only the instructions in the common subset of both
15216 architectures plus some special AIX common-mode calls, and will not use
15217 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
15218 permits GCC to use any instruction from either architecture and to
15219 allow use of the MQ register; specify this for the Motorola MPC601.
15221 @item -mnew-mnemonics
15222 @itemx -mold-mnemonics
15223 @opindex mnew-mnemonics
15224 @opindex mold-mnemonics
15225 Select which mnemonics to use in the generated assembler code.  With
15226 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
15227 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
15228 assembler mnemonics defined for the POWER architecture.  Instructions
15229 defined in only one architecture have only one mnemonic; GCC uses that
15230 mnemonic irrespective of which of these options is specified.
15232 GCC defaults to the mnemonics appropriate for the architecture in
15233 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
15234 value of these option.  Unless you are building a cross-compiler, you
15235 should normally not specify either @option{-mnew-mnemonics} or
15236 @option{-mold-mnemonics}, but should instead accept the default.
15238 @item -mcpu=@var{cpu_type}
15239 @opindex mcpu
15240 Set architecture type, register usage, choice of mnemonics, and
15241 instruction scheduling parameters for machine type @var{cpu_type}.
15242 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
15243 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
15244 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
15245 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
15246 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
15247 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
15248 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
15249 @samp{G4}, @samp{G5}, @samp{titan}, @samp{power}, @samp{power2}, @samp{power3},
15250 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
15251 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
15252 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
15254 @option{-mcpu=common} selects a completely generic processor.  Code
15255 generated under this option will run on any POWER or PowerPC processor.
15256 GCC will use only the instructions in the common subset of both
15257 architectures, and will not use the MQ register.  GCC assumes a generic
15258 processor model for scheduling purposes.
15260 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
15261 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
15262 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
15263 types, with an appropriate, generic processor model assumed for
15264 scheduling purposes.
15266 The other options specify a specific processor.  Code generated under
15267 those options will run best on that processor, and may not run at all on
15268 others.
15270 The @option{-mcpu} options automatically enable or disable the
15271 following options:
15273 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
15274 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
15275 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
15276 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
15278 The particular options set for any particular CPU will vary between
15279 compiler versions, depending on what setting seems to produce optimal
15280 code for that CPU; it doesn't necessarily reflect the actual hardware's
15281 capabilities.  If you wish to set an individual option to a particular
15282 value, you may specify it after the @option{-mcpu} option, like
15283 @samp{-mcpu=970 -mno-altivec}.
15285 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
15286 not enabled or disabled by the @option{-mcpu} option at present because
15287 AIX does not have full support for these options.  You may still
15288 enable or disable them individually if you're sure it'll work in your
15289 environment.
15291 @item -mtune=@var{cpu_type}
15292 @opindex mtune
15293 Set the instruction scheduling parameters for machine type
15294 @var{cpu_type}, but do not set the architecture type, register usage, or
15295 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
15296 values for @var{cpu_type} are used for @option{-mtune} as for
15297 @option{-mcpu}.  If both are specified, the code generated will use the
15298 architecture, registers, and mnemonics set by @option{-mcpu}, but the
15299 scheduling parameters set by @option{-mtune}.
15301 @item -mcmodel=small
15302 @opindex mcmodel=small
15303 Generate PowerPC64 code for the small model: The TOC is limited to
15304 64k.
15306 @item -mcmodel=medium
15307 @opindex mcmodel=medium
15308 Generate PowerPC64 code for the medium model: The TOC and other static
15309 data may be up to a total of 4G in size.
15311 @item -mcmodel=large
15312 @opindex mcmodel=large
15313 Generate PowerPC64 code for the large model: The TOC may be up to 4G
15314 in size.  Other data and code is only limited by the 64-bit address
15315 space.
15317 @item -maltivec
15318 @itemx -mno-altivec
15319 @opindex maltivec
15320 @opindex mno-altivec
15321 Generate code that uses (does not use) AltiVec instructions, and also
15322 enable the use of built-in functions that allow more direct access to
15323 the AltiVec instruction set.  You may also need to set
15324 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
15325 enhancements.
15327 @item -mvrsave
15328 @itemx -mno-vrsave
15329 @opindex mvrsave
15330 @opindex mno-vrsave
15331 Generate VRSAVE instructions when generating AltiVec code.
15333 @item -mgen-cell-microcode
15334 @opindex mgen-cell-microcode
15335 Generate Cell microcode instructions
15337 @item -mwarn-cell-microcode
15338 @opindex mwarn-cell-microcode
15339 Warning when a Cell microcode instruction is going to emitted.  An example
15340 of a Cell microcode instruction is a variable shift.
15342 @item -msecure-plt
15343 @opindex msecure-plt
15344 Generate code that allows ld and ld.so to build executables and shared
15345 libraries with non-exec .plt and .got sections.  This is a PowerPC
15346 32-bit SYSV ABI option.
15348 @item -mbss-plt
15349 @opindex mbss-plt
15350 Generate code that uses a BSS .plt section that ld.so fills in, and
15351 requires .plt and .got sections that are both writable and executable.
15352 This is a PowerPC 32-bit SYSV ABI option.
15354 @item -misel
15355 @itemx -mno-isel
15356 @opindex misel
15357 @opindex mno-isel
15358 This switch enables or disables the generation of ISEL instructions.
15360 @item -misel=@var{yes/no}
15361 This switch has been deprecated.  Use @option{-misel} and
15362 @option{-mno-isel} instead.
15364 @item -mspe
15365 @itemx -mno-spe
15366 @opindex mspe
15367 @opindex mno-spe
15368 This switch enables or disables the generation of SPE simd
15369 instructions.
15371 @item -mpaired
15372 @itemx -mno-paired
15373 @opindex mpaired
15374 @opindex mno-paired
15375 This switch enables or disables the generation of PAIRED simd
15376 instructions.
15378 @item -mspe=@var{yes/no}
15379 This option has been deprecated.  Use @option{-mspe} and
15380 @option{-mno-spe} instead.
15382 @item -mvsx
15383 @itemx -mno-vsx
15384 @opindex mvsx
15385 @opindex mno-vsx
15386 Generate code that uses (does not use) vector/scalar (VSX)
15387 instructions, and also enable the use of built-in functions that allow
15388 more direct access to the VSX instruction set.
15390 @item -mfloat-gprs=@var{yes/single/double/no}
15391 @itemx -mfloat-gprs
15392 @opindex mfloat-gprs
15393 This switch enables or disables the generation of floating point
15394 operations on the general purpose registers for architectures that
15395 support it.
15397 The argument @var{yes} or @var{single} enables the use of
15398 single-precision floating point operations.
15400 The argument @var{double} enables the use of single and
15401 double-precision floating point operations.
15403 The argument @var{no} disables floating point operations on the
15404 general purpose registers.
15406 This option is currently only available on the MPC854x.
15408 @item -m32
15409 @itemx -m64
15410 @opindex m32
15411 @opindex m64
15412 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
15413 targets (including GNU/Linux).  The 32-bit environment sets int, long
15414 and pointer to 32 bits and generates code that runs on any PowerPC
15415 variant.  The 64-bit environment sets int to 32 bits and long and
15416 pointer to 64 bits, and generates code for PowerPC64, as for
15417 @option{-mpowerpc64}.
15419 @item -mfull-toc
15420 @itemx -mno-fp-in-toc
15421 @itemx -mno-sum-in-toc
15422 @itemx -mminimal-toc
15423 @opindex mfull-toc
15424 @opindex mno-fp-in-toc
15425 @opindex mno-sum-in-toc
15426 @opindex mminimal-toc
15427 Modify generation of the TOC (Table Of Contents), which is created for
15428 every executable file.  The @option{-mfull-toc} option is selected by
15429 default.  In that case, GCC will allocate at least one TOC entry for
15430 each unique non-automatic variable reference in your program.  GCC
15431 will also place floating-point constants in the TOC@.  However, only
15432 16,384 entries are available in the TOC@.
15434 If you receive a linker error message that saying you have overflowed
15435 the available TOC space, you can reduce the amount of TOC space used
15436 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
15437 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
15438 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
15439 generate code to calculate the sum of an address and a constant at
15440 run-time instead of putting that sum into the TOC@.  You may specify one
15441 or both of these options.  Each causes GCC to produce very slightly
15442 slower and larger code at the expense of conserving TOC space.
15444 If you still run out of space in the TOC even when you specify both of
15445 these options, specify @option{-mminimal-toc} instead.  This option causes
15446 GCC to make only one TOC entry for every file.  When you specify this
15447 option, GCC will produce code that is slower and larger but which
15448 uses extremely little TOC space.  You may wish to use this option
15449 only on files that contain less frequently executed code.
15451 @item -maix64
15452 @itemx -maix32
15453 @opindex maix64
15454 @opindex maix32
15455 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
15456 @code{long} type, and the infrastructure needed to support them.
15457 Specifying @option{-maix64} implies @option{-mpowerpc64} and
15458 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
15459 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
15461 @item -mxl-compat
15462 @itemx -mno-xl-compat
15463 @opindex mxl-compat
15464 @opindex mno-xl-compat
15465 Produce code that conforms more closely to IBM XL compiler semantics
15466 when using AIX-compatible ABI@.  Pass floating-point arguments to
15467 prototyped functions beyond the register save area (RSA) on the stack
15468 in addition to argument FPRs.  Do not assume that most significant
15469 double in 128-bit long double value is properly rounded when comparing
15470 values and converting to double.  Use XL symbol names for long double
15471 support routines.
15473 The AIX calling convention was extended but not initially documented to
15474 handle an obscure K&R C case of calling a function that takes the
15475 address of its arguments with fewer arguments than declared.  IBM XL
15476 compilers access floating point arguments which do not fit in the
15477 RSA from the stack when a subroutine is compiled without
15478 optimization.  Because always storing floating-point arguments on the
15479 stack is inefficient and rarely needed, this option is not enabled by
15480 default and only is necessary when calling subroutines compiled by IBM
15481 XL compilers without optimization.
15483 @item -mpe
15484 @opindex mpe
15485 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
15486 application written to use message passing with special startup code to
15487 enable the application to run.  The system must have PE installed in the
15488 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
15489 must be overridden with the @option{-specs=} option to specify the
15490 appropriate directory location.  The Parallel Environment does not
15491 support threads, so the @option{-mpe} option and the @option{-pthread}
15492 option are incompatible.
15494 @item -malign-natural
15495 @itemx -malign-power
15496 @opindex malign-natural
15497 @opindex malign-power
15498 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
15499 @option{-malign-natural} overrides the ABI-defined alignment of larger
15500 types, such as floating-point doubles, on their natural size-based boundary.
15501 The option @option{-malign-power} instructs GCC to follow the ABI-specified
15502 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
15504 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
15505 is not supported.
15507 @item -msoft-float
15508 @itemx -mhard-float
15509 @opindex msoft-float
15510 @opindex mhard-float
15511 Generate code that does not use (uses) the floating-point register set.
15512 Software floating point emulation is provided if you use the
15513 @option{-msoft-float} option, and pass the option to GCC when linking.
15515 @item -msingle-float
15516 @itemx -mdouble-float
15517 @opindex msingle-float
15518 @opindex mdouble-float
15519 Generate code for single or double-precision floating point operations.
15520 @option{-mdouble-float} implies @option{-msingle-float}.
15522 @item -msimple-fpu
15523 @opindex msimple-fpu
15524 Do not generate sqrt and div instructions for hardware floating point unit.
15526 @item -mfpu
15527 @opindex mfpu
15528 Specify type of floating point unit.  Valid values are @var{sp_lite}
15529 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
15530 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
15531 and @var{dp_full} (equivalent to -mdouble-float).
15533 @item -mxilinx-fpu
15534 @opindex mxilinx-fpu
15535 Perform optimizations for floating point unit on Xilinx PPC 405/440.
15537 @item -mmultiple
15538 @itemx -mno-multiple
15539 @opindex mmultiple
15540 @opindex mno-multiple
15541 Generate code that uses (does not use) the load multiple word
15542 instructions and the store multiple word instructions.  These
15543 instructions are generated by default on POWER systems, and not
15544 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
15545 endian PowerPC systems, since those instructions do not work when the
15546 processor is in little endian mode.  The exceptions are PPC740 and
15547 PPC750 which permit the instructions usage in little endian mode.
15549 @item -mstring
15550 @itemx -mno-string
15551 @opindex mstring
15552 @opindex mno-string
15553 Generate code that uses (does not use) the load string instructions
15554 and the store string word instructions to save multiple registers and
15555 do small block moves.  These instructions are generated by default on
15556 POWER systems, and not generated on PowerPC systems.  Do not use
15557 @option{-mstring} on little endian PowerPC systems, since those
15558 instructions do not work when the processor is in little endian mode.
15559 The exceptions are PPC740 and PPC750 which permit the instructions
15560 usage in little endian mode.
15562 @item -mupdate
15563 @itemx -mno-update
15564 @opindex mupdate
15565 @opindex mno-update
15566 Generate code that uses (does not use) the load or store instructions
15567 that update the base register to the address of the calculated memory
15568 location.  These instructions are generated by default.  If you use
15569 @option{-mno-update}, there is a small window between the time that the
15570 stack pointer is updated and the address of the previous frame is
15571 stored, which means code that walks the stack frame across interrupts or
15572 signals may get corrupted data.
15574 @item -mavoid-indexed-addresses
15575 @itemx -mno-avoid-indexed-addresses
15576 @opindex mavoid-indexed-addresses
15577 @opindex mno-avoid-indexed-addresses
15578 Generate code that tries to avoid (not avoid) the use of indexed load
15579 or store instructions. These instructions can incur a performance
15580 penalty on Power6 processors in certain situations, such as when
15581 stepping through large arrays that cross a 16M boundary.  This option
15582 is enabled by default when targetting Power6 and disabled otherwise.
15584 @item -mfused-madd
15585 @itemx -mno-fused-madd
15586 @opindex mfused-madd
15587 @opindex mno-fused-madd
15588 Generate code that uses (does not use) the floating point multiply and
15589 accumulate instructions.  These instructions are generated by default if
15590 hardware floating is used.
15592 @item -mmulhw
15593 @itemx -mno-mulhw
15594 @opindex mmulhw
15595 @opindex mno-mulhw
15596 Generate code that uses (does not use) the half-word multiply and
15597 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15598 These instructions are generated by default when targetting those
15599 processors.
15601 @item -mdlmzb
15602 @itemx -mno-dlmzb
15603 @opindex mdlmzb
15604 @opindex mno-dlmzb
15605 Generate code that uses (does not use) the string-search @samp{dlmzb}
15606 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
15607 generated by default when targetting those processors.
15609 @item -mno-bit-align
15610 @itemx -mbit-align
15611 @opindex mno-bit-align
15612 @opindex mbit-align
15613 On System V.4 and embedded PowerPC systems do not (do) force structures
15614 and unions that contain bit-fields to be aligned to the base type of the
15615 bit-field.
15617 For example, by default a structure containing nothing but 8
15618 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15619 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
15620 the structure would be aligned to a 1 byte boundary and be one byte in
15621 size.
15623 @item -mno-strict-align
15624 @itemx -mstrict-align
15625 @opindex mno-strict-align
15626 @opindex mstrict-align
15627 On System V.4 and embedded PowerPC systems do not (do) assume that
15628 unaligned memory references will be handled by the system.
15630 @item -mrelocatable
15631 @itemx -mno-relocatable
15632 @opindex mrelocatable
15633 @opindex mno-relocatable
15634 Generate code that allows (does not allow) a static executable to be
15635 relocated to a different address at runtime.  A simple embedded
15636 PowerPC system loader should relocate the entire contents of
15637 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
15638 a table of 32-bit addresses generated by this option.  For this to
15639 work, all objects linked together must be compiled with
15640 @option{-mrelocatable} or @option{-mrelocatable-lib}.
15641 @option{-mrelocatable} code aligns the stack to an 8 byte boundary.
15643 @item -mrelocatable-lib
15644 @itemx -mno-relocatable-lib
15645 @opindex mrelocatable-lib
15646 @opindex mno-relocatable-lib
15647 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
15648 @code{.fixup} section to allow static executables to be relocated at
15649 runtime, but @option{-mrelocatable-lib} does not use the smaller stack
15650 alignment of @option{-mrelocatable}.  Objects compiled with
15651 @option{-mrelocatable-lib} may be linked with objects compiled with
15652 any combination of the @option{-mrelocatable} options.
15654 @item -mno-toc
15655 @itemx -mtoc
15656 @opindex mno-toc
15657 @opindex mtoc
15658 On System V.4 and embedded PowerPC systems do not (do) assume that
15659 register 2 contains a pointer to a global area pointing to the addresses
15660 used in the program.
15662 @item -mlittle
15663 @itemx -mlittle-endian
15664 @opindex mlittle
15665 @opindex mlittle-endian
15666 On System V.4 and embedded PowerPC systems compile code for the
15667 processor in little endian mode.  The @option{-mlittle-endian} option is
15668 the same as @option{-mlittle}.
15670 @item -mbig
15671 @itemx -mbig-endian
15672 @opindex mbig
15673 @opindex mbig-endian
15674 On System V.4 and embedded PowerPC systems compile code for the
15675 processor in big endian mode.  The @option{-mbig-endian} option is
15676 the same as @option{-mbig}.
15678 @item -mdynamic-no-pic
15679 @opindex mdynamic-no-pic
15680 On Darwin and Mac OS X systems, compile code so that it is not
15681 relocatable, but that its external references are relocatable.  The
15682 resulting code is suitable for applications, but not shared
15683 libraries.
15685 @item -mprioritize-restricted-insns=@var{priority}
15686 @opindex mprioritize-restricted-insns
15687 This option controls the priority that is assigned to
15688 dispatch-slot restricted instructions during the second scheduling
15689 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
15690 @var{no/highest/second-highest} priority to dispatch slot restricted
15691 instructions.
15693 @item -msched-costly-dep=@var{dependence_type}
15694 @opindex msched-costly-dep
15695 This option controls which dependences are considered costly
15696 by the target during instruction scheduling.  The argument
15697 @var{dependence_type} takes one of the following values:
15698 @var{no}: no dependence is costly,
15699 @var{all}: all dependences are costly,
15700 @var{true_store_to_load}: a true dependence from store to load is costly,
15701 @var{store_to_load}: any dependence from store to load is costly,
15702 @var{number}: any dependence which latency >= @var{number} is costly.
15704 @item -minsert-sched-nops=@var{scheme}
15705 @opindex minsert-sched-nops
15706 This option controls which nop insertion scheme will be used during
15707 the second scheduling pass.  The argument @var{scheme} takes one of the
15708 following values:
15709 @var{no}: Don't insert nops.
15710 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15711 according to the scheduler's grouping.
15712 @var{regroup_exact}: Insert nops to force costly dependent insns into
15713 separate groups.  Insert exactly as many nops as needed to force an insn
15714 to a new group, according to the estimated processor grouping.
15715 @var{number}: Insert nops to force costly dependent insns into
15716 separate groups.  Insert @var{number} nops to force an insn to a new group.
15718 @item -mcall-sysv
15719 @opindex mcall-sysv
15720 On System V.4 and embedded PowerPC systems compile code using calling
15721 conventions that adheres to the March 1995 draft of the System V
15722 Application Binary Interface, PowerPC processor supplement.  This is the
15723 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15725 @item -mcall-sysv-eabi
15726 @itemx -mcall-eabi
15727 @opindex mcall-sysv-eabi
15728 @opindex mcall-eabi
15729 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15731 @item -mcall-sysv-noeabi
15732 @opindex mcall-sysv-noeabi
15733 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15735 @item -mcall-aixdesc
15736 @opindex m
15737 On System V.4 and embedded PowerPC systems compile code for the AIX
15738 operating system.
15740 @item -mcall-linux
15741 @opindex mcall-linux
15742 On System V.4 and embedded PowerPC systems compile code for the
15743 Linux-based GNU system.
15745 @item -mcall-gnu
15746 @opindex mcall-gnu
15747 On System V.4 and embedded PowerPC systems compile code for the
15748 Hurd-based GNU system.
15750 @item -mcall-freebsd
15751 @opindex mcall-freebsd
15752 On System V.4 and embedded PowerPC systems compile code for the
15753 FreeBSD operating system.
15755 @item -mcall-netbsd
15756 @opindex mcall-netbsd
15757 On System V.4 and embedded PowerPC systems compile code for the
15758 NetBSD operating system.
15760 @item -mcall-openbsd
15761 @opindex mcall-netbsd
15762 On System V.4 and embedded PowerPC systems compile code for the
15763 OpenBSD operating system.
15765 @item -maix-struct-return
15766 @opindex maix-struct-return
15767 Return all structures in memory (as specified by the AIX ABI)@.
15769 @item -msvr4-struct-return
15770 @opindex msvr4-struct-return
15771 Return structures smaller than 8 bytes in registers (as specified by the
15772 SVR4 ABI)@.
15774 @item -mabi=@var{abi-type}
15775 @opindex mabi
15776 Extend the current ABI with a particular extension, or remove such extension.
15777 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
15778 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
15780 @item -mabi=spe
15781 @opindex mabi=spe
15782 Extend the current ABI with SPE ABI extensions.  This does not change
15783 the default ABI, instead it adds the SPE ABI extensions to the current
15784 ABI@.
15786 @item -mabi=no-spe
15787 @opindex mabi=no-spe
15788 Disable Booke SPE ABI extensions for the current ABI@.
15790 @item -mabi=ibmlongdouble
15791 @opindex mabi=ibmlongdouble
15792 Change the current ABI to use IBM extended precision long double.
15793 This is a PowerPC 32-bit SYSV ABI option.
15795 @item -mabi=ieeelongdouble
15796 @opindex mabi=ieeelongdouble
15797 Change the current ABI to use IEEE extended precision long double.
15798 This is a PowerPC 32-bit Linux ABI option.
15800 @item -mprototype
15801 @itemx -mno-prototype
15802 @opindex mprototype
15803 @opindex mno-prototype
15804 On System V.4 and embedded PowerPC systems assume that all calls to
15805 variable argument functions are properly prototyped.  Otherwise, the
15806 compiler must insert an instruction before every non prototyped call to
15807 set or clear bit 6 of the condition code register (@var{CR}) to
15808 indicate whether floating point values were passed in the floating point
15809 registers in case the function takes a variable arguments.  With
15810 @option{-mprototype}, only calls to prototyped variable argument functions
15811 will set or clear the bit.
15813 @item -msim
15814 @opindex msim
15815 On embedded PowerPC systems, assume that the startup module is called
15816 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
15817 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
15818 configurations.
15820 @item -mmvme
15821 @opindex mmvme
15822 On embedded PowerPC systems, assume that the startup module is called
15823 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
15824 @file{libc.a}.
15826 @item -mads
15827 @opindex mads
15828 On embedded PowerPC systems, assume that the startup module is called
15829 @file{crt0.o} and the standard C libraries are @file{libads.a} and
15830 @file{libc.a}.
15832 @item -myellowknife
15833 @opindex myellowknife
15834 On embedded PowerPC systems, assume that the startup module is called
15835 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
15836 @file{libc.a}.
15838 @item -mvxworks
15839 @opindex mvxworks
15840 On System V.4 and embedded PowerPC systems, specify that you are
15841 compiling for a VxWorks system.
15843 @item -memb
15844 @opindex memb
15845 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
15846 header to indicate that @samp{eabi} extended relocations are used.
15848 @item -meabi
15849 @itemx -mno-eabi
15850 @opindex meabi
15851 @opindex mno-eabi
15852 On System V.4 and embedded PowerPC systems do (do not) adhere to the
15853 Embedded Applications Binary Interface (eabi) which is a set of
15854 modifications to the System V.4 specifications.  Selecting @option{-meabi}
15855 means that the stack is aligned to an 8 byte boundary, a function
15856 @code{__eabi} is called to from @code{main} to set up the eabi
15857 environment, and the @option{-msdata} option can use both @code{r2} and
15858 @code{r13} to point to two separate small data areas.  Selecting
15859 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
15860 do not call an initialization function from @code{main}, and the
15861 @option{-msdata} option will only use @code{r13} to point to a single
15862 small data area.  The @option{-meabi} option is on by default if you
15863 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
15865 @item -msdata=eabi
15866 @opindex msdata=eabi
15867 On System V.4 and embedded PowerPC systems, put small initialized
15868 @code{const} global and static data in the @samp{.sdata2} section, which
15869 is pointed to by register @code{r2}.  Put small initialized
15870 non-@code{const} global and static data in the @samp{.sdata} section,
15871 which is pointed to by register @code{r13}.  Put small uninitialized
15872 global and static data in the @samp{.sbss} section, which is adjacent to
15873 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
15874 incompatible with the @option{-mrelocatable} option.  The
15875 @option{-msdata=eabi} option also sets the @option{-memb} option.
15877 @item -msdata=sysv
15878 @opindex msdata=sysv
15879 On System V.4 and embedded PowerPC systems, put small global and static
15880 data in the @samp{.sdata} section, which is pointed to by register
15881 @code{r13}.  Put small uninitialized global and static data in the
15882 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15883 The @option{-msdata=sysv} option is incompatible with the
15884 @option{-mrelocatable} option.
15886 @item -msdata=default
15887 @itemx -msdata
15888 @opindex msdata=default
15889 @opindex msdata
15890 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15891 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15892 same as @option{-msdata=sysv}.
15894 @item -msdata=data
15895 @opindex msdata=data
15896 On System V.4 and embedded PowerPC systems, put small global
15897 data in the @samp{.sdata} section.  Put small uninitialized global
15898 data in the @samp{.sbss} section.  Do not use register @code{r13}
15899 to address small data however.  This is the default behavior unless
15900 other @option{-msdata} options are used.
15902 @item -msdata=none
15903 @itemx -mno-sdata
15904 @opindex msdata=none
15905 @opindex mno-sdata
15906 On embedded PowerPC systems, put all initialized global and static data
15907 in the @samp{.data} section, and all uninitialized data in the
15908 @samp{.bss} section.
15910 @item -mblock-move-inline-limit=@var{num}
15911 @opindex mblock-move-inline-limit
15912 Inline all block moves (such as calls to @code{memcpy} or structure
15913 copies) less than or equal to @var{num} bytes.  The minimum value for
15914 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
15915 targets.  The default value is target-specific.
15917 @item -G @var{num}
15918 @opindex G
15919 @cindex smaller data references (PowerPC)
15920 @cindex .sdata/.sdata2 references (PowerPC)
15921 On embedded PowerPC systems, put global and static items less than or
15922 equal to @var{num} bytes into the small data or bss sections instead of
15923 the normal data or bss section.  By default, @var{num} is 8.  The
15924 @option{-G @var{num}} switch is also passed to the linker.
15925 All modules should be compiled with the same @option{-G @var{num}} value.
15927 @item -mregnames
15928 @itemx -mno-regnames
15929 @opindex mregnames
15930 @opindex mno-regnames
15931 On System V.4 and embedded PowerPC systems do (do not) emit register
15932 names in the assembly language output using symbolic forms.
15934 @item -mlongcall
15935 @itemx -mno-longcall
15936 @opindex mlongcall
15937 @opindex mno-longcall
15938 By default assume that all calls are far away so that a longer more
15939 expensive calling sequence is required.  This is required for calls
15940 further than 32 megabytes (33,554,432 bytes) from the current location.
15941 A short call will be generated if the compiler knows
15942 the call cannot be that far away.  This setting can be overridden by
15943 the @code{shortcall} function attribute, or by @code{#pragma
15944 longcall(0)}.
15946 Some linkers are capable of detecting out-of-range calls and generating
15947 glue code on the fly.  On these systems, long calls are unnecessary and
15948 generate slower code.  As of this writing, the AIX linker can do this,
15949 as can the GNU linker for PowerPC/64.  It is planned to add this feature
15950 to the GNU linker for 32-bit PowerPC systems as well.
15952 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
15953 callee, L42'', plus a ``branch island'' (glue code).  The two target
15954 addresses represent the callee and the ``branch island''.  The
15955 Darwin/PPC linker will prefer the first address and generate a ``bl
15956 callee'' if the PPC ``bl'' instruction will reach the callee directly;
15957 otherwise, the linker will generate ``bl L42'' to call the ``branch
15958 island''.  The ``branch island'' is appended to the body of the
15959 calling function; it computes the full 32-bit address of the callee
15960 and jumps to it.
15962 On Mach-O (Darwin) systems, this option directs the compiler emit to
15963 the glue for every direct call, and the Darwin linker decides whether
15964 to use or discard it.
15966 In the future, we may cause GCC to ignore all longcall specifications
15967 when the linker is known to generate glue.
15969 @item -mtls-markers
15970 @itemx -mno-tls-markers
15971 @opindex mtls-markers
15972 @opindex mno-tls-markers
15973 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
15974 specifying the function argument.  The relocation allows ld to
15975 reliably associate function call with argument setup instructions for
15976 TLS optimization, which in turn allows gcc to better schedule the
15977 sequence.
15979 @item -pthread
15980 @opindex pthread
15981 Adds support for multithreading with the @dfn{pthreads} library.
15982 This option sets flags for both the preprocessor and linker.
15984 @item -mrecip
15985 @itemx -mno-recip
15986 @opindex mrecip
15987 This option will enable GCC to use the reciprocal estimate and
15988 reciprocal square root estimate instructions with additional
15989 Newton-Raphson steps to increase precision instead of doing a divide or
15990 square root and divide for floating point arguments.  You should use
15991 the @option{-ffast-math} option when using @option{-mrecip} (or at
15992 least @option{-funsafe-math-optimizations},
15993 @option{-finite-math-only}, @option{-freciprocal-math} and
15994 @option{-fno-trapping-math}).  Note that while the throughput of the
15995 sequence is generally higher than the throughput of the non-reciprocal
15996 instruction, the precision of the sequence can be decreased by up to 2
15997 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
15998 roots.
16000 @item -mrecip=@var{opt}
16001 @opindex mrecip=opt
16002 This option allows to control which reciprocal estimate instructions
16003 may be used.  @var{opt} is a comma separated list of options, that may
16004 be preceeded by a @code{!} to invert the option:
16005 @code{all}: enable all estimate instructions,
16006 @code{default}: enable the default instructions, equvalent to @option{-mrecip},
16007 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
16008 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
16009 @code{divf}: enable the single precision reciprocal approximation instructions;
16010 @code{divd}: enable the double precision reciprocal approximation instructions;
16011 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
16012 @code{rsqrtf}: enable the single precision reciprocal square root approximation instructions;
16013 @code{rsqrtd}: enable the double precision reciprocal square root approximation instructions;
16015 So for example, @option{-mrecip=all,!rsqrtd} would enable the
16016 all of the reciprocal estimate instructions, except for the
16017 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
16018 which handle the double precision reciprocal square root calculations.
16020 @item -mrecip-precision
16021 @itemx -mno-recip-precision
16022 @opindex mrecip-precision
16023 Assume (do not assume) that the reciprocal estimate instructions
16024 provide higher precision estimates than is mandated by the powerpc
16025 ABI.  Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
16026 automatically selects @option{-mrecip-precision}.  The double
16027 precision square root estimate instructions are not generated by
16028 default on low precision machines, since they do not provide an
16029 estimate that converges after three steps.
16031 @item -mveclibabi=@var{type}
16032 @opindex mveclibabi
16033 Specifies the ABI type to use for vectorizing intrinsics using an
16034 external library.  The only type supported at present is @code{mass},
16035 which specifies to use IBM's Mathematical Acceleration Subsystem
16036 (MASS) libraries for vectorizing intrinsics using external libraries.
16037 GCC will currently emit calls to @code{acosd2}, @code{acosf4},
16038 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
16039 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
16040 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
16041 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
16042 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
16043 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
16044 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
16045 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
16046 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
16047 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
16048 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
16049 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
16050 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
16051 for power7.  Both @option{-ftree-vectorize} and
16052 @option{-funsafe-math-optimizations} have to be enabled.  The MASS
16053 libraries will have to be specified at link time.
16055 @item -mfriz
16056 @itemx -mno-friz
16057 @opindex mfriz
16058 Generate (do not generate) the @code{friz} instruction when the
16059 @option{-funsafe-math-optimizations} option is used to optimize
16060 rounding a floating point value to 64-bit integer and back to floating
16061 point.  The @code{friz} instruction does not return the same value if
16062 the floating point number is too large to fit in an integer.
16063 @end table
16065 @node RX Options
16066 @subsection RX Options
16067 @cindex RX Options
16069 These command line options are defined for RX targets:
16071 @table @gcctabopt
16072 @item -m64bit-doubles
16073 @itemx -m32bit-doubles
16074 @opindex m64bit-doubles
16075 @opindex m32bit-doubles
16076 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
16077 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
16078 @option{-m32bit-doubles}.  @emph{Note} RX floating point hardware only
16079 works on 32-bit values, which is why the default is
16080 @option{-m32bit-doubles}.
16082 @item -fpu
16083 @itemx -nofpu
16084 @opindex fpu
16085 @opindex nofpu
16086 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
16087 floating point hardware.  The default is enabled for the @var{RX600}
16088 series and disabled for the @var{RX200} series.
16090 Floating point instructions will only be generated for 32-bit floating
16091 point values however, so if the @option{-m64bit-doubles} option is in
16092 use then the FPU hardware will not be used for doubles.
16094 @emph{Note} If the @option{-fpu} option is enabled then
16095 @option{-funsafe-math-optimizations} is also enabled automatically.
16096 This is because the RX FPU instructions are themselves unsafe.
16098 @item -mcpu=@var{name}
16099 @opindex -mcpu
16100 Selects the type of RX CPU to be targeted.  Currently three types are
16101 supported, the generic @var{RX600} and @var{RX200} series hardware and
16102 the specific @var{RX610} cpu.  The default is @var{RX600}.
16104 The only difference between @var{RX600} and @var{RX610} is that the
16105 @var{RX610} does not support the @code{MVTIPL} instruction.
16107 The @var{RX200} series does not have a hardware floating point unit
16108 and so @option{-nofpu} is enabled by default when this type is
16109 selected.
16111 @item -mbig-endian-data
16112 @itemx -mlittle-endian-data
16113 @opindex mbig-endian-data
16114 @opindex mlittle-endian-data
16115 Store data (but not code) in the big-endian format.  The default is
16116 @option{-mlittle-endian-data}, ie to store data in the little endian
16117 format.
16119 @item -msmall-data-limit=@var{N}
16120 @opindex msmall-data-limit
16121 Specifies the maximum size in bytes of global and static variables
16122 which can be placed into the small data area.  Using the small data
16123 area can lead to smaller and faster code, but the size of area is
16124 limited and it is up to the programmer to ensure that the area does
16125 not overflow.  Also when the small data area is used one of the RX's
16126 registers (@code{r13}) is reserved for use pointing to this area, so
16127 it is no longer available for use by the compiler.  This could result
16128 in slower and/or larger code if variables which once could have been
16129 held in @code{r13} are now pushed onto the stack.
16131 Note, common variables (variables which have not been initialised) and
16132 constants are not placed into the small data area as they are assigned
16133 to other sections in the output executable.
16135 The default value is zero, which disables this feature.  Note, this
16136 feature is not enabled by default with higher optimization levels
16137 (@option{-O2} etc) because of the potentially detrimental effects of
16138 reserving register @code{r13}.  It is up to the programmer to
16139 experiment and discover whether this feature is of benefit to their
16140 program.
16142 @item -msim
16143 @itemx -mno-sim
16144 @opindex msim
16145 @opindex mno-sim
16146 Use the simulator runtime.  The default is to use the libgloss board
16147 specific runtime.
16149 @item -mas100-syntax
16150 @itemx -mno-as100-syntax
16151 @opindex mas100-syntax
16152 @opindex mno-as100-syntax
16153 When generating assembler output use a syntax that is compatible with
16154 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
16155 assembler but it has some restrictions so generating it is not the
16156 default option.
16158 @item -mmax-constant-size=@var{N}
16159 @opindex mmax-constant-size
16160 Specifies the maximum size, in bytes, of a constant that can be used as
16161 an operand in a RX instruction.  Although the RX instruction set does
16162 allow constants of up to 4 bytes in length to be used in instructions,
16163 a longer value equates to a longer instruction.  Thus in some
16164 circumstances it can be beneficial to restrict the size of constants
16165 that are used in instructions.  Constants that are too big are instead
16166 placed into a constant pool and referenced via register indirection.
16168 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
16169 or 4 means that constants of any size are allowed.
16171 @item -mrelax
16172 @opindex mrelax
16173 Enable linker relaxation.  Linker relaxation is a process whereby the
16174 linker will attempt to reduce the size of a program by finding shorter
16175 versions of various instructions.  Disabled by default.
16177 @item -mint-register=@var{N}
16178 @opindex mint-register
16179 Specify the number of registers to reserve for fast interrupt handler
16180 functions.  The value @var{N} can be between 0 and 4.  A value of 1
16181 means that register @code{r13} will be reserved for the exclusive use
16182 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
16183 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
16184 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
16185 A value of 0, the default, does not reserve any registers.
16187 @item -msave-acc-in-interrupts
16188 @opindex msave-acc-in-interrupts
16189 Specifies that interrupt handler functions should preserve the
16190 accumulator register.  This is only necessary if normal code might use
16191 the accumulator register, for example because it performs 64-bit
16192 multiplications.  The default is to ignore the accumulator as this
16193 makes the interrupt handlers faster.
16195 @end table
16197 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
16198 has special significance to the RX port when used with the
16199 @code{interrupt} function attribute.  This attribute indicates a
16200 function intended to process fast interrupts.  GCC will will ensure
16201 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
16202 and/or @code{r13} and only provided that the normal use of the
16203 corresponding registers have been restricted via the
16204 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
16205 options.
16207 @node S/390 and zSeries Options
16208 @subsection S/390 and zSeries Options
16209 @cindex S/390 and zSeries Options
16211 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
16213 @table @gcctabopt
16214 @item -mhard-float
16215 @itemx -msoft-float
16216 @opindex mhard-float
16217 @opindex msoft-float
16218 Use (do not use) the hardware floating-point instructions and registers
16219 for floating-point operations.  When @option{-msoft-float} is specified,
16220 functions in @file{libgcc.a} will be used to perform floating-point
16221 operations.  When @option{-mhard-float} is specified, the compiler
16222 generates IEEE floating-point instructions.  This is the default.
16224 @item -mhard-dfp
16225 @itemx -mno-hard-dfp
16226 @opindex mhard-dfp
16227 @opindex mno-hard-dfp
16228 Use (do not use) the hardware decimal-floating-point instructions for
16229 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
16230 specified, functions in @file{libgcc.a} will be used to perform
16231 decimal-floating-point operations.  When @option{-mhard-dfp} is
16232 specified, the compiler generates decimal-floating-point hardware
16233 instructions.  This is the default for @option{-march=z9-ec} or higher.
16235 @item -mlong-double-64
16236 @itemx -mlong-double-128
16237 @opindex mlong-double-64
16238 @opindex mlong-double-128
16239 These switches control the size of @code{long double} type. A size
16240 of 64bit makes the @code{long double} type equivalent to the @code{double}
16241 type. This is the default.
16243 @item -mbackchain
16244 @itemx -mno-backchain
16245 @opindex mbackchain
16246 @opindex mno-backchain
16247 Store (do not store) the address of the caller's frame as backchain pointer
16248 into the callee's stack frame.
16249 A backchain may be needed to allow debugging using tools that do not understand
16250 DWARF-2 call frame information.
16251 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
16252 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
16253 the backchain is placed into the topmost word of the 96/160 byte register
16254 save area.
16256 In general, code compiled with @option{-mbackchain} is call-compatible with
16257 code compiled with @option{-mmo-backchain}; however, use of the backchain
16258 for debugging purposes usually requires that the whole binary is built with
16259 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
16260 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
16261 to build a linux kernel use @option{-msoft-float}.
16263 The default is to not maintain the backchain.
16265 @item -mpacked-stack
16266 @itemx -mno-packed-stack
16267 @opindex mpacked-stack
16268 @opindex mno-packed-stack
16269 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
16270 specified, the compiler uses the all fields of the 96/160 byte register save
16271 area only for their default purpose; unused fields still take up stack space.
16272 When @option{-mpacked-stack} is specified, register save slots are densely
16273 packed at the top of the register save area; unused space is reused for other
16274 purposes, allowing for more efficient use of the available stack space.
16275 However, when @option{-mbackchain} is also in effect, the topmost word of
16276 the save area is always used to store the backchain, and the return address
16277 register is always saved two words below the backchain.
16279 As long as the stack frame backchain is not used, code generated with
16280 @option{-mpacked-stack} is call-compatible with code generated with
16281 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
16282 S/390 or zSeries generated code that uses the stack frame backchain at run
16283 time, not just for debugging purposes.  Such code is not call-compatible
16284 with code compiled with @option{-mpacked-stack}.  Also, note that the
16285 combination of @option{-mbackchain},
16286 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
16287 to build a linux kernel use @option{-msoft-float}.
16289 The default is to not use the packed stack layout.
16291 @item -msmall-exec
16292 @itemx -mno-small-exec
16293 @opindex msmall-exec
16294 @opindex mno-small-exec
16295 Generate (or do not generate) code using the @code{bras} instruction
16296 to do subroutine calls.
16297 This only works reliably if the total executable size does not
16298 exceed 64k.  The default is to use the @code{basr} instruction instead,
16299 which does not have this limitation.
16301 @item -m64
16302 @itemx -m31
16303 @opindex m64
16304 @opindex m31
16305 When @option{-m31} is specified, generate code compliant to the
16306 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
16307 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
16308 particular to generate 64-bit instructions.  For the @samp{s390}
16309 targets, the default is @option{-m31}, while the @samp{s390x}
16310 targets default to @option{-m64}.
16312 @item -mzarch
16313 @itemx -mesa
16314 @opindex mzarch
16315 @opindex mesa
16316 When @option{-mzarch} is specified, generate code using the
16317 instructions available on z/Architecture.
16318 When @option{-mesa} is specified, generate code using the
16319 instructions available on ESA/390.  Note that @option{-mesa} is
16320 not possible with @option{-m64}.
16321 When generating code compliant to the GNU/Linux for S/390 ABI,
16322 the default is @option{-mesa}.  When generating code compliant
16323 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
16325 @item -mmvcle
16326 @itemx -mno-mvcle
16327 @opindex mmvcle
16328 @opindex mno-mvcle
16329 Generate (or do not generate) code using the @code{mvcle} instruction
16330 to perform block moves.  When @option{-mno-mvcle} is specified,
16331 use a @code{mvc} loop instead.  This is the default unless optimizing for
16332 size.
16334 @item -mdebug
16335 @itemx -mno-debug
16336 @opindex mdebug
16337 @opindex mno-debug
16338 Print (or do not print) additional debug information when compiling.
16339 The default is to not print debug information.
16341 @item -march=@var{cpu-type}
16342 @opindex march
16343 Generate code that will run on @var{cpu-type}, which is the name of a system
16344 representing a certain processor type.  Possible values for
16345 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
16346 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
16347 When generating code using the instructions available on z/Architecture,
16348 the default is @option{-march=z900}.  Otherwise, the default is
16349 @option{-march=g5}.
16351 @item -mtune=@var{cpu-type}
16352 @opindex mtune
16353 Tune to @var{cpu-type} everything applicable about the generated code,
16354 except for the ABI and the set of available instructions.
16355 The list of @var{cpu-type} values is the same as for @option{-march}.
16356 The default is the value used for @option{-march}.
16358 @item -mtpf-trace
16359 @itemx -mno-tpf-trace
16360 @opindex mtpf-trace
16361 @opindex mno-tpf-trace
16362 Generate code that adds (does not add) in TPF OS specific branches to trace
16363 routines in the operating system.  This option is off by default, even
16364 when compiling for the TPF OS@.
16366 @item -mfused-madd
16367 @itemx -mno-fused-madd
16368 @opindex mfused-madd
16369 @opindex mno-fused-madd
16370 Generate code that uses (does not use) the floating point multiply and
16371 accumulate instructions.  These instructions are generated by default if
16372 hardware floating point is used.
16374 @item -mwarn-framesize=@var{framesize}
16375 @opindex mwarn-framesize
16376 Emit a warning if the current function exceeds the given frame size.  Because
16377 this is a compile time check it doesn't need to be a real problem when the program
16378 runs.  It is intended to identify functions which most probably cause
16379 a stack overflow.  It is useful to be used in an environment with limited stack
16380 size e.g.@: the linux kernel.
16382 @item -mwarn-dynamicstack
16383 @opindex mwarn-dynamicstack
16384 Emit a warning if the function calls alloca or uses dynamically
16385 sized arrays.  This is generally a bad idea with a limited stack size.
16387 @item -mstack-guard=@var{stack-guard}
16388 @itemx -mstack-size=@var{stack-size}
16389 @opindex mstack-guard
16390 @opindex mstack-size
16391 If these options are provided the s390 back end emits additional instructions in
16392 the function prologue which trigger a trap if the stack size is @var{stack-guard}
16393 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
16394 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
16395 the frame size of the compiled function is chosen.
16396 These options are intended to be used to help debugging stack overflow problems.
16397 The additionally emitted code causes only little overhead and hence can also be
16398 used in production like systems without greater performance degradation.  The given
16399 values have to be exact powers of 2 and @var{stack-size} has to be greater than
16400 @var{stack-guard} without exceeding 64k.
16401 In order to be efficient the extra code makes the assumption that the stack starts
16402 at an address aligned to the value given by @var{stack-size}.
16403 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
16404 @end table
16406 @node Score Options
16407 @subsection Score Options
16408 @cindex Score Options
16410 These options are defined for Score implementations:
16412 @table @gcctabopt
16413 @item -meb
16414 @opindex meb
16415 Compile code for big endian mode.  This is the default.
16417 @item -mel
16418 @opindex mel
16419 Compile code for little endian mode.
16421 @item -mnhwloop
16422 @opindex mnhwloop
16423 Disable generate bcnz instruction.
16425 @item -muls
16426 @opindex muls
16427 Enable generate unaligned load and store instruction.
16429 @item -mmac
16430 @opindex mmac
16431 Enable the use of multiply-accumulate instructions. Disabled by default.
16433 @item -mscore5
16434 @opindex mscore5
16435 Specify the SCORE5 as the target architecture.
16437 @item -mscore5u
16438 @opindex mscore5u
16439 Specify the SCORE5U of the target architecture.
16441 @item -mscore7
16442 @opindex mscore7
16443 Specify the SCORE7 as the target architecture. This is the default.
16445 @item -mscore7d
16446 @opindex mscore7d
16447 Specify the SCORE7D as the target architecture.
16448 @end table
16450 @node SH Options
16451 @subsection SH Options
16453 These @samp{-m} options are defined for the SH implementations:
16455 @table @gcctabopt
16456 @item -m1
16457 @opindex m1
16458 Generate code for the SH1.
16460 @item -m2
16461 @opindex m2
16462 Generate code for the SH2.
16464 @item -m2e
16465 Generate code for the SH2e.
16467 @item -m2a-nofpu
16468 @opindex m2a-nofpu
16469 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
16470 that the floating-point unit is not used.
16472 @item -m2a-single-only
16473 @opindex m2a-single-only
16474 Generate code for the SH2a-FPU, in such a way that no double-precision
16475 floating point operations are used.
16477 @item -m2a-single
16478 @opindex m2a-single
16479 Generate code for the SH2a-FPU assuming the floating-point unit is in
16480 single-precision mode by default.
16482 @item -m2a
16483 @opindex m2a
16484 Generate code for the SH2a-FPU assuming the floating-point unit is in
16485 double-precision mode by default.
16487 @item -m3
16488 @opindex m3
16489 Generate code for the SH3.
16491 @item -m3e
16492 @opindex m3e
16493 Generate code for the SH3e.
16495 @item -m4-nofpu
16496 @opindex m4-nofpu
16497 Generate code for the SH4 without a floating-point unit.
16499 @item -m4-single-only
16500 @opindex m4-single-only
16501 Generate code for the SH4 with a floating-point unit that only
16502 supports single-precision arithmetic.
16504 @item -m4-single
16505 @opindex m4-single
16506 Generate code for the SH4 assuming the floating-point unit is in
16507 single-precision mode by default.
16509 @item -m4
16510 @opindex m4
16511 Generate code for the SH4.
16513 @item -m4a-nofpu
16514 @opindex m4a-nofpu
16515 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
16516 floating-point unit is not used.
16518 @item -m4a-single-only
16519 @opindex m4a-single-only
16520 Generate code for the SH4a, in such a way that no double-precision
16521 floating point operations are used.
16523 @item -m4a-single
16524 @opindex m4a-single
16525 Generate code for the SH4a assuming the floating-point unit is in
16526 single-precision mode by default.
16528 @item -m4a
16529 @opindex m4a
16530 Generate code for the SH4a.
16532 @item -m4al
16533 @opindex m4al
16534 Same as @option{-m4a-nofpu}, except that it implicitly passes
16535 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
16536 instructions at the moment.
16538 @item -mb
16539 @opindex mb
16540 Compile code for the processor in big endian mode.
16542 @item -ml
16543 @opindex ml
16544 Compile code for the processor in little endian mode.
16546 @item -mdalign
16547 @opindex mdalign
16548 Align doubles at 64-bit boundaries.  Note that this changes the calling
16549 conventions, and thus some functions from the standard C library will
16550 not work unless you recompile it first with @option{-mdalign}.
16552 @item -mrelax
16553 @opindex mrelax
16554 Shorten some address references at link time, when possible; uses the
16555 linker option @option{-relax}.
16557 @item -mbigtable
16558 @opindex mbigtable
16559 Use 32-bit offsets in @code{switch} tables.  The default is to use
16560 16-bit offsets.
16562 @item -mbitops
16563 @opindex mbitops
16564 Enable the use of bit manipulation instructions on SH2A.
16566 @item -mfmovd
16567 @opindex mfmovd
16568 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
16569 alignment constraints.
16571 @item -mhitachi
16572 @opindex mhitachi
16573 Comply with the calling conventions defined by Renesas.
16575 @item -mrenesas
16576 @opindex mhitachi
16577 Comply with the calling conventions defined by Renesas.
16579 @item -mno-renesas
16580 @opindex mhitachi
16581 Comply with the calling conventions defined for GCC before the Renesas
16582 conventions were available.  This option is the default for all
16583 targets of the SH toolchain except for @samp{sh-symbianelf}.
16585 @item -mnomacsave
16586 @opindex mnomacsave
16587 Mark the @code{MAC} register as call-clobbered, even if
16588 @option{-mhitachi} is given.
16590 @item -mieee
16591 @opindex mieee
16592 Increase IEEE-compliance of floating-point code.
16593 At the moment, this is equivalent to @option{-fno-finite-math-only}.
16594 When generating 16 bit SH opcodes, getting IEEE-conforming results for
16595 comparisons of NANs / infinities incurs extra overhead in every
16596 floating point comparison, therefore the default is set to
16597 @option{-ffinite-math-only}.
16599 @item -minline-ic_invalidate
16600 @opindex minline-ic_invalidate
16601 Inline code to invalidate instruction cache entries after setting up
16602 nested function trampolines.
16603 This option has no effect if -musermode is in effect and the selected
16604 code generation option (e.g. -m4) does not allow the use of the icbi
16605 instruction.
16606 If the selected code generation option does not allow the use of the icbi
16607 instruction, and -musermode is not in effect, the inlined code will
16608 manipulate the instruction cache address array directly with an associative
16609 write.  This not only requires privileged mode, but it will also
16610 fail if the cache line had been mapped via the TLB and has become unmapped.
16612 @item -misize
16613 @opindex misize
16614 Dump instruction size and location in the assembly code.
16616 @item -mpadstruct
16617 @opindex mpadstruct
16618 This option is deprecated.  It pads structures to multiple of 4 bytes,
16619 which is incompatible with the SH ABI@.
16621 @item -mspace
16622 @opindex mspace
16623 Optimize for space instead of speed.  Implied by @option{-Os}.
16625 @item -mprefergot
16626 @opindex mprefergot
16627 When generating position-independent code, emit function calls using
16628 the Global Offset Table instead of the Procedure Linkage Table.
16630 @item -musermode
16631 @opindex musermode
16632 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
16633 if the inlined code would not work in user mode.
16634 This is the default when the target is @code{sh-*-linux*}.
16636 @item -multcost=@var{number}
16637 @opindex multcost=@var{number}
16638 Set the cost to assume for a multiply insn.
16640 @item -mdiv=@var{strategy}
16641 @opindex mdiv=@var{strategy}
16642 Set the division strategy to use for SHmedia code.  @var{strategy} must be
16643 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
16644 inv:call2, inv:fp .
16645 "fp" performs the operation in floating point.  This has a very high latency,
16646 but needs only a few instructions, so it might be a good choice if
16647 your code has enough easily exploitable ILP to allow the compiler to
16648 schedule the floating point instructions together with other instructions.
16649 Division by zero causes a floating point exception.
16650 "inv" uses integer operations to calculate the inverse of the divisor,
16651 and then multiplies the dividend with the inverse.  This strategy allows
16652 cse and hoisting of the inverse calculation.  Division by zero calculates
16653 an unspecified result, but does not trap.
16654 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
16655 have been found, or if the entire operation has been hoisted to the same
16656 place, the last stages of the inverse calculation are intertwined with the
16657 final multiply to reduce the overall latency, at the expense of using a few
16658 more instructions, and thus offering fewer scheduling opportunities with
16659 other code.
16660 "call" calls a library function that usually implements the inv:minlat
16661 strategy.
16662 This gives high code density for m5-*media-nofpu compilations.
16663 "call2" uses a different entry point of the same library function, where it
16664 assumes that a pointer to a lookup table has already been set up, which
16665 exposes the pointer load to cse / code hoisting optimizations.
16666 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16667 code generation, but if the code stays unoptimized, revert to the "call",
16668 "call2", or "fp" strategies, respectively.  Note that the
16669 potentially-trapping side effect of division by zero is carried by a
16670 separate instruction, so it is possible that all the integer instructions
16671 are hoisted out, but the marker for the side effect stays where it is.
16672 A recombination to fp operations or a call is not possible in that case.
16673 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
16674 that the inverse calculation was nor separated from the multiply, they speed
16675 up division where the dividend fits into 20 bits (plus sign where applicable),
16676 by inserting a test to skip a number of operations in this case; this test
16677 slows down the case of larger dividends.  inv20u assumes the case of a such
16678 a small dividend to be unlikely, and inv20l assumes it to be likely.
16680 @item -maccumulate-outgoing-args
16681 @opindex maccumulate-outgoing-args
16682 Reserve space once for outgoing arguments in the function prologue rather 
16683 than around each call.  Generally beneficial for performance and size.  Also
16684 needed for unwinding to avoid changing the stack frame around conditional code.
16686 @item -mdivsi3_libfunc=@var{name}
16687 @opindex mdivsi3_libfunc=@var{name}
16688 Set the name of the library function used for 32 bit signed division to
16689 @var{name}.  This only affect the name used in the call and inv:call
16690 division strategies, and the compiler will still expect the same
16691 sets of input/output/clobbered registers as if this option was not present.
16693 @item -mfixed-range=@var{register-range}
16694 @opindex mfixed-range
16695 Generate code treating the given register range as fixed registers.
16696 A fixed register is one that the register allocator can not use.  This is
16697 useful when compiling kernel code.  A register range is specified as
16698 two registers separated by a dash.  Multiple register ranges can be
16699 specified separated by a comma.
16701 @item -madjust-unroll
16702 @opindex madjust-unroll
16703 Throttle unrolling to avoid thrashing target registers.
16704 This option only has an effect if the gcc code base supports the
16705 TARGET_ADJUST_UNROLL_MAX target hook.
16707 @item -mindexed-addressing
16708 @opindex mindexed-addressing
16709 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16710 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16711 semantics for the indexed addressing mode.  The architecture allows the
16712 implementation of processors with 64 bit MMU, which the OS could use to
16713 get 32 bit addressing, but since no current hardware implementation supports
16714 this or any other way to make the indexed addressing mode safe to use in
16715 the 32 bit ABI, the default is -mno-indexed-addressing.
16717 @item -mgettrcost=@var{number}
16718 @opindex mgettrcost=@var{number}
16719 Set the cost assumed for the gettr instruction to @var{number}.
16720 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16722 @item -mpt-fixed
16723 @opindex mpt-fixed
16724 Assume pt* instructions won't trap.  This will generally generate better
16725 scheduled code, but is unsafe on current hardware.  The current architecture
16726 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16727 This has the unintentional effect of making it unsafe to schedule ptabs /
16728 ptrel before a branch, or hoist it out of a loop.  For example,
16729 __do_global_ctors, a part of libgcc that runs constructors at program
16730 startup, calls functions in a list which is delimited by @minus{}1.  With the
16731 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16732 That means that all the constructors will be run a bit quicker, but when
16733 the loop comes to the end of the list, the program crashes because ptabs
16734 loads @minus{}1 into a target register.  Since this option is unsafe for any
16735 hardware implementing the current architecture specification, the default
16736 is -mno-pt-fixed.  Unless the user specifies a specific cost with
16737 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16738 this deters register allocation using target registers for storing
16739 ordinary integers.
16741 @item -minvalid-symbols
16742 @opindex minvalid-symbols
16743 Assume symbols might be invalid.  Ordinary function symbols generated by
16744 the compiler will always be valid to load with movi/shori/ptabs or
16745 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16746 to generate symbols that will cause ptabs / ptrel to trap.
16747 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16748 It will then prevent cross-basic-block cse, hoisting and most scheduling
16749 of symbol loads.  The default is @option{-mno-invalid-symbols}.
16750 @end table
16752 @node Solaris 2 Options
16753 @subsection Solaris 2 Options
16754 @cindex Solaris 2 options
16756 These @samp{-m} options are supported on Solaris 2:
16758 @table @gcctabopt
16759 @item -mimpure-text
16760 @opindex mimpure-text
16761 @option{-mimpure-text}, used in addition to @option{-shared}, tells
16762 the compiler to not pass @option{-z text} to the linker when linking a
16763 shared object.  Using this option, you can link position-dependent
16764 code into a shared object.
16766 @option{-mimpure-text} suppresses the ``relocations remain against
16767 allocatable but non-writable sections'' linker error message.
16768 However, the necessary relocations will trigger copy-on-write, and the
16769 shared object is not actually shared across processes.  Instead of
16770 using @option{-mimpure-text}, you should compile all source code with
16771 @option{-fpic} or @option{-fPIC}.
16773 @end table
16775 These switches are supported in addition to the above on Solaris 2:
16777 @table @gcctabopt
16778 @item -threads
16779 @opindex threads
16780 Add support for multithreading using the Solaris threads library.  This
16781 option sets flags for both the preprocessor and linker.  This option does
16782 not affect the thread safety of object code produced by the compiler or
16783 that of libraries supplied with it.
16785 @item -pthreads
16786 @opindex pthreads
16787 Add support for multithreading using the POSIX threads library.  This
16788 option sets flags for both the preprocessor and linker.  This option does
16789 not affect the thread safety of object code produced  by the compiler or
16790 that of libraries supplied with it.
16792 @item -pthread
16793 @opindex pthread
16794 This is a synonym for @option{-pthreads}.
16795 @end table
16797 @node SPARC Options
16798 @subsection SPARC Options
16799 @cindex SPARC options
16801 These @samp{-m} options are supported on the SPARC:
16803 @table @gcctabopt
16804 @item -mno-app-regs
16805 @itemx -mapp-regs
16806 @opindex mno-app-regs
16807 @opindex mapp-regs
16808 Specify @option{-mapp-regs} to generate output using the global registers
16809 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
16810 is the default.
16812 To be fully SVR4 ABI compliant at the cost of some performance loss,
16813 specify @option{-mno-app-regs}.  You should compile libraries and system
16814 software with this option.
16816 @item -mfpu
16817 @itemx -mhard-float
16818 @opindex mfpu
16819 @opindex mhard-float
16820 Generate output containing floating point instructions.  This is the
16821 default.
16823 @item -mno-fpu
16824 @itemx -msoft-float
16825 @opindex mno-fpu
16826 @opindex msoft-float
16827 Generate output containing library calls for floating point.
16828 @strong{Warning:} the requisite libraries are not available for all SPARC
16829 targets.  Normally the facilities of the machine's usual C compiler are
16830 used, but this cannot be done directly in cross-compilation.  You must make
16831 your own arrangements to provide suitable library functions for
16832 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
16833 @samp{sparclite-*-*} do provide software floating point support.
16835 @option{-msoft-float} changes the calling convention in the output file;
16836 therefore, it is only useful if you compile @emph{all} of a program with
16837 this option.  In particular, you need to compile @file{libgcc.a}, the
16838 library that comes with GCC, with @option{-msoft-float} in order for
16839 this to work.
16841 @item -mhard-quad-float
16842 @opindex mhard-quad-float
16843 Generate output containing quad-word (long double) floating point
16844 instructions.
16846 @item -msoft-quad-float
16847 @opindex msoft-quad-float
16848 Generate output containing library calls for quad-word (long double)
16849 floating point instructions.  The functions called are those specified
16850 in the SPARC ABI@.  This is the default.
16852 As of this writing, there are no SPARC implementations that have hardware
16853 support for the quad-word floating point instructions.  They all invoke
16854 a trap handler for one of these instructions, and then the trap handler
16855 emulates the effect of the instruction.  Because of the trap handler overhead,
16856 this is much slower than calling the ABI library routines.  Thus the
16857 @option{-msoft-quad-float} option is the default.
16859 @item -mno-unaligned-doubles
16860 @itemx -munaligned-doubles
16861 @opindex mno-unaligned-doubles
16862 @opindex munaligned-doubles
16863 Assume that doubles have 8 byte alignment.  This is the default.
16865 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
16866 alignment only if they are contained in another type, or if they have an
16867 absolute address.  Otherwise, it assumes they have 4 byte alignment.
16868 Specifying this option avoids some rare compatibility problems with code
16869 generated by other compilers.  It is not the default because it results
16870 in a performance loss, especially for floating point code.
16872 @item -mno-faster-structs
16873 @itemx -mfaster-structs
16874 @opindex mno-faster-structs
16875 @opindex mfaster-structs
16876 With @option{-mfaster-structs}, the compiler assumes that structures
16877 should have 8 byte alignment.  This enables the use of pairs of
16878 @code{ldd} and @code{std} instructions for copies in structure
16879 assignment, in place of twice as many @code{ld} and @code{st} pairs.
16880 However, the use of this changed alignment directly violates the SPARC
16881 ABI@.  Thus, it's intended only for use on targets where the developer
16882 acknowledges that their resulting code will not be directly in line with
16883 the rules of the ABI@.
16885 @item -mcpu=@var{cpu_type}
16886 @opindex mcpu
16887 Set the instruction set, register set, and instruction scheduling parameters
16888 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
16889 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
16890 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
16891 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
16892 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
16894 Default instruction scheduling parameters are used for values that select
16895 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
16896 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
16898 Here is a list of each supported architecture and their supported
16899 implementations.
16901 @smallexample
16902     v7:             cypress
16903     v8:             supersparc, hypersparc
16904     sparclite:      f930, f934, sparclite86x
16905     sparclet:       tsc701
16906     v9:             ultrasparc, ultrasparc3, niagara, niagara2
16907 @end smallexample
16909 By default (unless configured otherwise), GCC generates code for the V7
16910 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
16911 additionally optimizes it for the Cypress CY7C602 chip, as used in the
16912 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
16913 SPARCStation 1, 2, IPX etc.
16915 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
16916 architecture.  The only difference from V7 code is that the compiler emits
16917 the integer multiply and integer divide instructions which exist in SPARC-V8
16918 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
16919 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
16920 2000 series.
16922 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
16923 the SPARC architecture.  This adds the integer multiply, integer divide step
16924 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
16925 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
16926 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
16927 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
16928 MB86934 chip, which is the more recent SPARClite with FPU@.
16930 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
16931 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
16932 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
16933 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
16934 optimizes it for the TEMIC SPARClet chip.
16936 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
16937 architecture.  This adds 64-bit integer and floating-point move instructions,
16938 3 additional floating-point condition code registers and conditional move
16939 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
16940 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
16941 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
16942 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
16943 @option{-mcpu=niagara}, the compiler additionally optimizes it for
16944 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
16945 additionally optimizes it for Sun UltraSPARC T2 chips.
16947 @item -mtune=@var{cpu_type}
16948 @opindex mtune
16949 Set the instruction scheduling parameters for machine type
16950 @var{cpu_type}, but do not set the instruction set or register set that the
16951 option @option{-mcpu=@var{cpu_type}} would.
16953 The same values for @option{-mcpu=@var{cpu_type}} can be used for
16954 @option{-mtune=@var{cpu_type}}, but the only useful values are those
16955 that select a particular cpu implementation.  Those are @samp{cypress},
16956 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
16957 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
16958 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
16960 @item -mv8plus
16961 @itemx -mno-v8plus
16962 @opindex mv8plus
16963 @opindex mno-v8plus
16964 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
16965 difference from the V8 ABI is that the global and out registers are
16966 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
16967 mode for all SPARC-V9 processors.
16969 @item -mvis
16970 @itemx -mno-vis
16971 @opindex mvis
16972 @opindex mno-vis
16973 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
16974 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
16975 @end table
16977 These @samp{-m} options are supported in addition to the above
16978 on SPARC-V9 processors in 64-bit environments:
16980 @table @gcctabopt
16981 @item -mlittle-endian
16982 @opindex mlittle-endian
16983 Generate code for a processor running in little-endian mode.  It is only
16984 available for a few configurations and most notably not on Solaris and Linux.
16986 @item -m32
16987 @itemx -m64
16988 @opindex m32
16989 @opindex m64
16990 Generate code for a 32-bit or 64-bit environment.
16991 The 32-bit environment sets int, long and pointer to 32 bits.
16992 The 64-bit environment sets int to 32 bits and long and pointer
16993 to 64 bits.
16995 @item -mcmodel=medlow
16996 @opindex mcmodel=medlow
16997 Generate code for the Medium/Low code model: 64-bit addresses, programs
16998 must be linked in the low 32 bits of memory.  Programs can be statically
16999 or dynamically linked.
17001 @item -mcmodel=medmid
17002 @opindex mcmodel=medmid
17003 Generate code for the Medium/Middle code model: 64-bit addresses, programs
17004 must be linked in the low 44 bits of memory, the text and data segments must
17005 be less than 2GB in size and the data segment must be located within 2GB of
17006 the text segment.
17008 @item -mcmodel=medany
17009 @opindex mcmodel=medany
17010 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
17011 may be linked anywhere in memory, the text and data segments must be less
17012 than 2GB in size and the data segment must be located within 2GB of the
17013 text segment.
17015 @item -mcmodel=embmedany
17016 @opindex mcmodel=embmedany
17017 Generate code for the Medium/Anywhere code model for embedded systems:
17018 64-bit addresses, the text and data segments must be less than 2GB in
17019 size, both starting anywhere in memory (determined at link time).  The
17020 global register %g4 points to the base of the data segment.  Programs
17021 are statically linked and PIC is not supported.
17023 @item -mstack-bias
17024 @itemx -mno-stack-bias
17025 @opindex mstack-bias
17026 @opindex mno-stack-bias
17027 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
17028 frame pointer if present, are offset by @minus{}2047 which must be added back
17029 when making stack frame references.  This is the default in 64-bit mode.
17030 Otherwise, assume no such offset is present.
17031 @end table
17033 @node SPU Options
17034 @subsection SPU Options
17035 @cindex SPU options
17037 These @samp{-m} options are supported on the SPU:
17039 @table @gcctabopt
17040 @item -mwarn-reloc
17041 @itemx -merror-reloc
17042 @opindex mwarn-reloc
17043 @opindex merror-reloc
17045 The loader for SPU does not handle dynamic relocations.  By default, GCC
17046 will give an error when it generates code that requires a dynamic
17047 relocation.  @option{-mno-error-reloc} disables the error,
17048 @option{-mwarn-reloc} will generate a warning instead.
17050 @item -msafe-dma
17051 @itemx -munsafe-dma
17052 @opindex msafe-dma
17053 @opindex munsafe-dma
17055 Instructions which initiate or test completion of DMA must not be
17056 reordered with respect to loads and stores of the memory which is being
17057 accessed.  Users typically address this problem using the volatile
17058 keyword, but that can lead to inefficient code in places where the
17059 memory is known to not change.  Rather than mark the memory as volatile
17060 we treat the DMA instructions as potentially effecting all memory.  With
17061 @option{-munsafe-dma} users must use the volatile keyword to protect
17062 memory accesses.
17064 @item -mbranch-hints
17065 @opindex mbranch-hints
17067 By default, GCC will generate a branch hint instruction to avoid
17068 pipeline stalls for always taken or probably taken branches.  A hint
17069 will not be generated closer than 8 instructions away from its branch.
17070 There is little reason to disable them, except for debugging purposes,
17071 or to make an object a little bit smaller.
17073 @item -msmall-mem
17074 @itemx -mlarge-mem
17075 @opindex msmall-mem
17076 @opindex mlarge-mem
17078 By default, GCC generates code assuming that addresses are never larger
17079 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
17080 a full 32 bit address.
17082 @item -mstdmain
17083 @opindex mstdmain
17085 By default, GCC links against startup code that assumes the SPU-style
17086 main function interface (which has an unconventional parameter list).
17087 With @option{-mstdmain}, GCC will link your program against startup
17088 code that assumes a C99-style interface to @code{main}, including a
17089 local copy of @code{argv} strings.
17091 @item -mfixed-range=@var{register-range}
17092 @opindex mfixed-range
17093 Generate code treating the given register range as fixed registers.
17094 A fixed register is one that the register allocator can not use.  This is
17095 useful when compiling kernel code.  A register range is specified as
17096 two registers separated by a dash.  Multiple register ranges can be
17097 specified separated by a comma.
17099 @item -mea32
17100 @itemx -mea64
17101 @opindex mea32
17102 @opindex mea64
17103 Compile code assuming that pointers to the PPU address space accessed
17104 via the @code{__ea} named address space qualifier are either 32 or 64
17105 bits wide.  The default is 32 bits.  As this is an ABI changing option,
17106 all object code in an executable must be compiled with the same setting.
17108 @item -maddress-space-conversion
17109 @itemx -mno-address-space-conversion
17110 @opindex maddress-space-conversion
17111 @opindex mno-address-space-conversion
17112 Allow/disallow treating the @code{__ea} address space as superset
17113 of the generic address space.  This enables explicit type casts
17114 between @code{__ea} and generic pointer as well as implicit
17115 conversions of generic pointers to @code{__ea} pointers.  The
17116 default is to allow address space pointer conversions.
17118 @item -mcache-size=@var{cache-size}
17119 @opindex mcache-size
17120 This option controls the version of libgcc that the compiler links to an
17121 executable and selects a software-managed cache for accessing variables
17122 in the @code{__ea} address space with a particular cache size.  Possible
17123 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
17124 and @samp{128}.  The default cache size is 64KB.
17126 @item -matomic-updates
17127 @itemx -mno-atomic-updates
17128 @opindex matomic-updates
17129 @opindex mno-atomic-updates
17130 This option controls the version of libgcc that the compiler links to an
17131 executable and selects whether atomic updates to the software-managed
17132 cache of PPU-side variables are used.  If you use atomic updates, changes
17133 to a PPU variable from SPU code using the @code{__ea} named address space
17134 qualifier will not interfere with changes to other PPU variables residing
17135 in the same cache line from PPU code.  If you do not use atomic updates,
17136 such interference may occur; however, writing back cache lines will be
17137 more efficient.  The default behavior is to use atomic updates.
17139 @item -mdual-nops
17140 @itemx -mdual-nops=@var{n}
17141 @opindex mdual-nops
17142 By default, GCC will insert nops to increase dual issue when it expects
17143 it to increase performance.  @var{n} can be a value from 0 to 10.  A
17144 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
17145 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
17147 @item -mhint-max-nops=@var{n}
17148 @opindex mhint-max-nops
17149 Maximum number of nops to insert for a branch hint.  A branch hint must
17150 be at least 8 instructions away from the branch it is effecting.  GCC
17151 will insert up to @var{n} nops to enforce this, otherwise it will not
17152 generate the branch hint.
17154 @item -mhint-max-distance=@var{n}
17155 @opindex mhint-max-distance
17156 The encoding of the branch hint instruction limits the hint to be within
17157 256 instructions of the branch it is effecting.  By default, GCC makes
17158 sure it is within 125.
17160 @item -msafe-hints
17161 @opindex msafe-hints
17162 Work around a hardware bug which causes the SPU to stall indefinitely.
17163 By default, GCC will insert the @code{hbrp} instruction to make sure
17164 this stall won't happen.
17166 @end table
17168 @node System V Options
17169 @subsection Options for System V
17171 These additional options are available on System V Release 4 for
17172 compatibility with other compilers on those systems:
17174 @table @gcctabopt
17175 @item -G
17176 @opindex G
17177 Create a shared object.
17178 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
17180 @item -Qy
17181 @opindex Qy
17182 Identify the versions of each tool used by the compiler, in a
17183 @code{.ident} assembler directive in the output.
17185 @item -Qn
17186 @opindex Qn
17187 Refrain from adding @code{.ident} directives to the output file (this is
17188 the default).
17190 @item -YP,@var{dirs}
17191 @opindex YP
17192 Search the directories @var{dirs}, and no others, for libraries
17193 specified with @option{-l}.
17195 @item -Ym,@var{dir}
17196 @opindex Ym
17197 Look in the directory @var{dir} to find the M4 preprocessor.
17198 The assembler uses this option.
17199 @c This is supposed to go with a -Yd for predefined M4 macro files, but
17200 @c the generic assembler that comes with Solaris takes just -Ym.
17201 @end table
17203 @node V850 Options
17204 @subsection V850 Options
17205 @cindex V850 Options
17207 These @samp{-m} options are defined for V850 implementations:
17209 @table @gcctabopt
17210 @item -mlong-calls
17211 @itemx -mno-long-calls
17212 @opindex mlong-calls
17213 @opindex mno-long-calls
17214 Treat all calls as being far away (near).  If calls are assumed to be
17215 far away, the compiler will always load the functions address up into a
17216 register, and call indirect through the pointer.
17218 @item -mno-ep
17219 @itemx -mep
17220 @opindex mno-ep
17221 @opindex mep
17222 Do not optimize (do optimize) basic blocks that use the same index
17223 pointer 4 or more times to copy pointer into the @code{ep} register, and
17224 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
17225 option is on by default if you optimize.
17227 @item -mno-prolog-function
17228 @itemx -mprolog-function
17229 @opindex mno-prolog-function
17230 @opindex mprolog-function
17231 Do not use (do use) external functions to save and restore registers
17232 at the prologue and epilogue of a function.  The external functions
17233 are slower, but use less code space if more than one function saves
17234 the same number of registers.  The @option{-mprolog-function} option
17235 is on by default if you optimize.
17237 @item -mspace
17238 @opindex mspace
17239 Try to make the code as small as possible.  At present, this just turns
17240 on the @option{-mep} and @option{-mprolog-function} options.
17242 @item -mtda=@var{n}
17243 @opindex mtda
17244 Put static or global variables whose size is @var{n} bytes or less into
17245 the tiny data area that register @code{ep} points to.  The tiny data
17246 area can hold up to 256 bytes in total (128 bytes for byte references).
17248 @item -msda=@var{n}
17249 @opindex msda
17250 Put static or global variables whose size is @var{n} bytes or less into
17251 the small data area that register @code{gp} points to.  The small data
17252 area can hold up to 64 kilobytes.
17254 @item -mzda=@var{n}
17255 @opindex mzda
17256 Put static or global variables whose size is @var{n} bytes or less into
17257 the first 32 kilobytes of memory.
17259 @item -mv850
17260 @opindex mv850
17261 Specify that the target processor is the V850.
17263 @item -mbig-switch
17264 @opindex mbig-switch
17265 Generate code suitable for big switch tables.  Use this option only if
17266 the assembler/linker complain about out of range branches within a switch
17267 table.
17269 @item -mapp-regs
17270 @opindex mapp-regs
17271 This option will cause r2 and r5 to be used in the code generated by
17272 the compiler.  This setting is the default.
17274 @item -mno-app-regs
17275 @opindex mno-app-regs
17276 This option will cause r2 and r5 to be treated as fixed registers.
17278 @item -mv850e2v3
17279 @opindex mv850e2v3
17280 Specify that the target processor is the V850E2V3.  The preprocessor
17281 constants @samp{__v850e2v3__} will be defined if
17282 this option is used.
17284 @item -mv850e2
17285 @opindex mv850e2
17286 Specify that the target processor is the V850E2.  The preprocessor
17287 constants @samp{__v850e2__} will be defined if
17289 @item -mv850e1
17290 @opindex mv850e1
17291 Specify that the target processor is the V850E1.  The preprocessor
17292 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
17294 @item -mv850e
17295 @opindex mv850e
17296 Specify that the target processor is the V850E@.  The preprocessor
17297 constant @samp{__v850e__} will be defined if this option is used.
17299 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
17300 nor @option{-mv850e2} nor @option{-mv850e2v3}
17301 are defined then a default target processor will be chosen and the
17302 relevant @samp{__v850*__} preprocessor constant will be defined.
17304 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
17305 defined, regardless of which processor variant is the target.
17307 @item -mdisable-callt
17308 @opindex mdisable-callt
17309 This option will suppress generation of the CALLT instruction for the
17310 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture.  The default is
17311 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
17313 @end table
17315 @node VAX Options
17316 @subsection VAX Options
17317 @cindex VAX options
17319 These @samp{-m} options are defined for the VAX:
17321 @table @gcctabopt
17322 @item -munix
17323 @opindex munix
17324 Do not output certain jump instructions (@code{aobleq} and so on)
17325 that the Unix assembler for the VAX cannot handle across long
17326 ranges.
17328 @item -mgnu
17329 @opindex mgnu
17330 Do output those jump instructions, on the assumption that you
17331 will assemble with the GNU assembler.
17333 @item -mg
17334 @opindex mg
17335 Output code for g-format floating point numbers instead of d-format.
17336 @end table
17338 @node VxWorks Options
17339 @subsection VxWorks Options
17340 @cindex VxWorks Options
17342 The options in this section are defined for all VxWorks targets.
17343 Options specific to the target hardware are listed with the other
17344 options for that target.
17346 @table @gcctabopt
17347 @item -mrtp
17348 @opindex mrtp
17349 GCC can generate code for both VxWorks kernels and real time processes
17350 (RTPs).  This option switches from the former to the latter.  It also
17351 defines the preprocessor macro @code{__RTP__}.
17353 @item -non-static
17354 @opindex non-static
17355 Link an RTP executable against shared libraries rather than static
17356 libraries.  The options @option{-static} and @option{-shared} can
17357 also be used for RTPs (@pxref{Link Options}); @option{-static}
17358 is the default.
17360 @item -Bstatic
17361 @itemx -Bdynamic
17362 @opindex Bstatic
17363 @opindex Bdynamic
17364 These options are passed down to the linker.  They are defined for
17365 compatibility with Diab.
17367 @item -Xbind-lazy
17368 @opindex Xbind-lazy
17369 Enable lazy binding of function calls.  This option is equivalent to
17370 @option{-Wl,-z,now} and is defined for compatibility with Diab.
17372 @item -Xbind-now
17373 @opindex Xbind-now
17374 Disable lazy binding of function calls.  This option is the default and
17375 is defined for compatibility with Diab.
17376 @end table
17378 @node x86-64 Options
17379 @subsection x86-64 Options
17380 @cindex x86-64 options
17382 These are listed under @xref{i386 and x86-64 Options}.
17384 @node i386 and x86-64 Windows Options
17385 @subsection i386 and x86-64 Windows Options
17386 @cindex i386 and x86-64 Windows Options
17388 These additional options are available for Windows targets:
17390 @table @gcctabopt
17391 @item -mconsole
17392 @opindex mconsole
17393 This option is available for Cygwin and MinGW targets.  It
17394 specifies that a console application is to be generated, by
17395 instructing the linker to set the PE header subsystem type
17396 required for console applications.
17397 This is the default behavior for Cygwin and MinGW targets.
17399 @item -mdll
17400 @opindex mdll
17401 This option is available for Cygwin and MinGW targets.  It
17402 specifies that a DLL - a dynamic link library - is to be
17403 generated, enabling the selection of the required runtime
17404 startup object and entry point.
17406 @item -mnop-fun-dllimport
17407 @opindex mnop-fun-dllimport
17408 This option is available for Cygwin and MinGW targets.  It
17409 specifies that the dllimport attribute should be ignored.
17411 @item -mthread
17412 @opindex mthread
17413 This option is available for MinGW targets. It specifies
17414 that MinGW-specific thread support is to be used.
17416 @item -municode
17417 @opindex municode
17418 This option is available for mingw-w64 targets.  It specifies
17419 that the UNICODE macro is getting pre-defined and that the
17420 unicode capable runtime startup code is chosen.
17422 @item -mwin32
17423 @opindex mwin32
17424 This option is available for Cygwin and MinGW targets.  It
17425 specifies that the typical Windows pre-defined macros are to
17426 be set in the pre-processor, but does not influence the choice
17427 of runtime library/startup code.
17429 @item -mwindows
17430 @opindex mwindows
17431 This option is available for Cygwin and MinGW targets.  It
17432 specifies that a GUI application is to be generated by
17433 instructing the linker to set the PE header subsystem type
17434 appropriately.
17436 @item -fno-set-stack-executable
17437 @opindex fno-set-stack-executable
17438 This option is available for MinGW targets. It specifies that
17439 the executable flag for stack used by nested functions isn't
17440 set. This is necessary for binaries running in kernel mode of
17441 Windows, as there the user32 API, which is used to set executable
17442 privileges, isn't available.
17444 @item -mpe-aligned-commons
17445 @opindex mpe-aligned-commons
17446 This option is available for Cygwin and MinGW targets.  It
17447 specifies that the GNU extension to the PE file format that
17448 permits the correct alignment of COMMON variables should be
17449 used when generating code.  It will be enabled by default if
17450 GCC detects that the target assembler found during configuration
17451 supports the feature.
17452 @end table
17454 See also under @ref{i386 and x86-64 Options} for standard options.
17456 @node Xstormy16 Options
17457 @subsection Xstormy16 Options
17458 @cindex Xstormy16 Options
17460 These options are defined for Xstormy16:
17462 @table @gcctabopt
17463 @item -msim
17464 @opindex msim
17465 Choose startup files and linker script suitable for the simulator.
17466 @end table
17468 @node Xtensa Options
17469 @subsection Xtensa Options
17470 @cindex Xtensa Options
17472 These options are supported for Xtensa targets:
17474 @table @gcctabopt
17475 @item -mconst16
17476 @itemx -mno-const16
17477 @opindex mconst16
17478 @opindex mno-const16
17479 Enable or disable use of @code{CONST16} instructions for loading
17480 constant values.  The @code{CONST16} instruction is currently not a
17481 standard option from Tensilica.  When enabled, @code{CONST16}
17482 instructions are always used in place of the standard @code{L32R}
17483 instructions.  The use of @code{CONST16} is enabled by default only if
17484 the @code{L32R} instruction is not available.
17486 @item -mfused-madd
17487 @itemx -mno-fused-madd
17488 @opindex mfused-madd
17489 @opindex mno-fused-madd
17490 Enable or disable use of fused multiply/add and multiply/subtract
17491 instructions in the floating-point option.  This has no effect if the
17492 floating-point option is not also enabled.  Disabling fused multiply/add
17493 and multiply/subtract instructions forces the compiler to use separate
17494 instructions for the multiply and add/subtract operations.  This may be
17495 desirable in some cases where strict IEEE 754-compliant results are
17496 required: the fused multiply add/subtract instructions do not round the
17497 intermediate result, thereby producing results with @emph{more} bits of
17498 precision than specified by the IEEE standard.  Disabling fused multiply
17499 add/subtract instructions also ensures that the program output is not
17500 sensitive to the compiler's ability to combine multiply and add/subtract
17501 operations.
17503 @item -mserialize-volatile
17504 @itemx -mno-serialize-volatile
17505 @opindex mserialize-volatile
17506 @opindex mno-serialize-volatile
17507 When this option is enabled, GCC inserts @code{MEMW} instructions before
17508 @code{volatile} memory references to guarantee sequential consistency.
17509 The default is @option{-mserialize-volatile}.  Use
17510 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
17512 @item -mforce-no-pic
17513 @opindex mforce-no-pic
17514 For targets, like GNU/Linux, where all user-mode Xtensa code must be
17515 position-independent code (PIC), this option disables PIC for compiling
17516 kernel code.
17518 @item -mtext-section-literals
17519 @itemx -mno-text-section-literals
17520 @opindex mtext-section-literals
17521 @opindex mno-text-section-literals
17522 Control the treatment of literal pools.  The default is
17523 @option{-mno-text-section-literals}, which places literals in a separate
17524 section in the output file.  This allows the literal pool to be placed
17525 in a data RAM/ROM, and it also allows the linker to combine literal
17526 pools from separate object files to remove redundant literals and
17527 improve code size.  With @option{-mtext-section-literals}, the literals
17528 are interspersed in the text section in order to keep them as close as
17529 possible to their references.  This may be necessary for large assembly
17530 files.
17532 @item -mtarget-align
17533 @itemx -mno-target-align
17534 @opindex mtarget-align
17535 @opindex mno-target-align
17536 When this option is enabled, GCC instructs the assembler to
17537 automatically align instructions to reduce branch penalties at the
17538 expense of some code density.  The assembler attempts to widen density
17539 instructions to align branch targets and the instructions following call
17540 instructions.  If there are not enough preceding safe density
17541 instructions to align a target, no widening will be performed.  The
17542 default is @option{-mtarget-align}.  These options do not affect the
17543 treatment of auto-aligned instructions like @code{LOOP}, which the
17544 assembler will always align, either by widening density instructions or
17545 by inserting no-op instructions.
17547 @item -mlongcalls
17548 @itemx -mno-longcalls
17549 @opindex mlongcalls
17550 @opindex mno-longcalls
17551 When this option is enabled, GCC instructs the assembler to translate
17552 direct calls to indirect calls unless it can determine that the target
17553 of a direct call is in the range allowed by the call instruction.  This
17554 translation typically occurs for calls to functions in other source
17555 files.  Specifically, the assembler translates a direct @code{CALL}
17556 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
17557 The default is @option{-mno-longcalls}.  This option should be used in
17558 programs where the call target can potentially be out of range.  This
17559 option is implemented in the assembler, not the compiler, so the
17560 assembly code generated by GCC will still show direct call
17561 instructions---look at the disassembled object code to see the actual
17562 instructions.  Note that the assembler will use an indirect call for
17563 every cross-file call, not just those that really will be out of range.
17564 @end table
17566 @node zSeries Options
17567 @subsection zSeries Options
17568 @cindex zSeries options
17570 These are listed under @xref{S/390 and zSeries Options}.
17572 @node Code Gen Options
17573 @section Options for Code Generation Conventions
17574 @cindex code generation conventions
17575 @cindex options, code generation
17576 @cindex run-time options
17578 These machine-independent options control the interface conventions
17579 used in code generation.
17581 Most of them have both positive and negative forms; the negative form
17582 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
17583 one of the forms is listed---the one which is not the default.  You
17584 can figure out the other form by either removing @samp{no-} or adding
17587 @table @gcctabopt
17588 @item -fbounds-check
17589 @opindex fbounds-check
17590 For front-ends that support it, generate additional code to check that
17591 indices used to access arrays are within the declared range.  This is
17592 currently only supported by the Java and Fortran front-ends, where
17593 this option defaults to true and false respectively.
17595 @item -ftrapv
17596 @opindex ftrapv
17597 This option generates traps for signed overflow on addition, subtraction,
17598 multiplication operations.
17600 @item -fwrapv
17601 @opindex fwrapv
17602 This option instructs the compiler to assume that signed arithmetic
17603 overflow of addition, subtraction and multiplication wraps around
17604 using twos-complement representation.  This flag enables some optimizations
17605 and disables others.  This option is enabled by default for the Java
17606 front-end, as required by the Java language specification.
17608 @item -fexceptions
17609 @opindex fexceptions
17610 Enable exception handling.  Generates extra code needed to propagate
17611 exceptions.  For some targets, this implies GCC will generate frame
17612 unwind information for all functions, which can produce significant data
17613 size overhead, although it does not affect execution.  If you do not
17614 specify this option, GCC will enable it by default for languages like
17615 C++ which normally require exception handling, and disable it for
17616 languages like C that do not normally require it.  However, you may need
17617 to enable this option when compiling C code that needs to interoperate
17618 properly with exception handlers written in C++.  You may also wish to
17619 disable this option if you are compiling older C++ programs that don't
17620 use exception handling.
17622 @item -fnon-call-exceptions
17623 @opindex fnon-call-exceptions
17624 Generate code that allows trapping instructions to throw exceptions.
17625 Note that this requires platform-specific runtime support that does
17626 not exist everywhere.  Moreover, it only allows @emph{trapping}
17627 instructions to throw exceptions, i.e.@: memory references or floating
17628 point instructions.  It does not allow exceptions to be thrown from
17629 arbitrary signal handlers such as @code{SIGALRM}.
17631 @item -funwind-tables
17632 @opindex funwind-tables
17633 Similar to @option{-fexceptions}, except that it will just generate any needed
17634 static data, but will not affect the generated code in any other way.
17635 You will normally not enable this option; instead, a language processor
17636 that needs this handling would enable it on your behalf.
17638 @item -fasynchronous-unwind-tables
17639 @opindex fasynchronous-unwind-tables
17640 Generate unwind table in dwarf2 format, if supported by target machine.  The
17641 table is exact at each instruction boundary, so it can be used for stack
17642 unwinding from asynchronous events (such as debugger or garbage collector).
17644 @item -fpcc-struct-return
17645 @opindex fpcc-struct-return
17646 Return ``short'' @code{struct} and @code{union} values in memory like
17647 longer ones, rather than in registers.  This convention is less
17648 efficient, but it has the advantage of allowing intercallability between
17649 GCC-compiled files and files compiled with other compilers, particularly
17650 the Portable C Compiler (pcc).
17652 The precise convention for returning structures in memory depends
17653 on the target configuration macros.
17655 Short structures and unions are those whose size and alignment match
17656 that of some integer type.
17658 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
17659 switch is not binary compatible with code compiled with the
17660 @option{-freg-struct-return} switch.
17661 Use it to conform to a non-default application binary interface.
17663 @item -freg-struct-return
17664 @opindex freg-struct-return
17665 Return @code{struct} and @code{union} values in registers when possible.
17666 This is more efficient for small structures than
17667 @option{-fpcc-struct-return}.
17669 If you specify neither @option{-fpcc-struct-return} nor
17670 @option{-freg-struct-return}, GCC defaults to whichever convention is
17671 standard for the target.  If there is no standard convention, GCC
17672 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17673 the principal compiler.  In those cases, we can choose the standard, and
17674 we chose the more efficient register return alternative.
17676 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17677 switch is not binary compatible with code compiled with the
17678 @option{-fpcc-struct-return} switch.
17679 Use it to conform to a non-default application binary interface.
17681 @item -fshort-enums
17682 @opindex fshort-enums
17683 Allocate to an @code{enum} type only as many bytes as it needs for the
17684 declared range of possible values.  Specifically, the @code{enum} type
17685 will be equivalent to the smallest integer type which has enough room.
17687 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17688 code that is not binary compatible with code generated without that switch.
17689 Use it to conform to a non-default application binary interface.
17691 @item -fshort-double
17692 @opindex fshort-double
17693 Use the same size for @code{double} as for @code{float}.
17695 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17696 code that is not binary compatible with code generated without that switch.
17697 Use it to conform to a non-default application binary interface.
17699 @item -fshort-wchar
17700 @opindex fshort-wchar
17701 Override the underlying type for @samp{wchar_t} to be @samp{short
17702 unsigned int} instead of the default for the target.  This option is
17703 useful for building programs to run under WINE@.
17705 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17706 code that is not binary compatible with code generated without that switch.
17707 Use it to conform to a non-default application binary interface.
17709 @item -fno-common
17710 @opindex fno-common
17711 In C code, controls the placement of uninitialized global variables.
17712 Unix C compilers have traditionally permitted multiple definitions of
17713 such variables in different compilation units by placing the variables
17714 in a common block.
17715 This is the behavior specified by @option{-fcommon}, and is the default
17716 for GCC on most targets.
17717 On the other hand, this behavior is not required by ISO C, and on some
17718 targets may carry a speed or code size penalty on variable references.
17719 The @option{-fno-common} option specifies that the compiler should place
17720 uninitialized global variables in the data section of the object file,
17721 rather than generating them as common blocks.
17722 This has the effect that if the same variable is declared
17723 (without @code{extern}) in two different compilations,
17724 you will get a multiple-definition error when you link them.
17725 In this case, you must compile with @option{-fcommon} instead.
17726 Compiling with @option{-fno-common} is useful on targets for which
17727 it provides better performance, or if you wish to verify that the
17728 program will work on other systems which always treat uninitialized
17729 variable declarations this way.
17731 @item -fno-ident
17732 @opindex fno-ident
17733 Ignore the @samp{#ident} directive.
17735 @item -finhibit-size-directive
17736 @opindex finhibit-size-directive
17737 Don't output a @code{.size} assembler directive, or anything else that
17738 would cause trouble if the function is split in the middle, and the
17739 two halves are placed at locations far apart in memory.  This option is
17740 used when compiling @file{crtstuff.c}; you should not need to use it
17741 for anything else.
17743 @item -fverbose-asm
17744 @opindex fverbose-asm
17745 Put extra commentary information in the generated assembly code to
17746 make it more readable.  This option is generally only of use to those
17747 who actually need to read the generated assembly code (perhaps while
17748 debugging the compiler itself).
17750 @option{-fno-verbose-asm}, the default, causes the
17751 extra information to be omitted and is useful when comparing two assembler
17752 files.
17754 @item -frecord-gcc-switches
17755 @opindex frecord-gcc-switches
17756 This switch causes the command line that was used to invoke the
17757 compiler to be recorded into the object file that is being created.
17758 This switch is only implemented on some targets and the exact format
17759 of the recording is target and binary file format dependent, but it
17760 usually takes the form of a section containing ASCII text.  This
17761 switch is related to the @option{-fverbose-asm} switch, but that
17762 switch only records information in the assembler output file as
17763 comments, so it never reaches the object file.
17765 @item -fpic
17766 @opindex fpic
17767 @cindex global offset table
17768 @cindex PIC
17769 Generate position-independent code (PIC) suitable for use in a shared
17770 library, if supported for the target machine.  Such code accesses all
17771 constant addresses through a global offset table (GOT)@.  The dynamic
17772 loader resolves the GOT entries when the program starts (the dynamic
17773 loader is not part of GCC; it is part of the operating system).  If
17774 the GOT size for the linked executable exceeds a machine-specific
17775 maximum size, you get an error message from the linker indicating that
17776 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17777 instead.  (These maximums are 8k on the SPARC and 32k
17778 on the m68k and RS/6000.  The 386 has no such limit.)
17780 Position-independent code requires special support, and therefore works
17781 only on certain machines.  For the 386, GCC supports PIC for System V
17782 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
17783 position-independent.
17785 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17786 are defined to 1.
17788 @item -fPIC
17789 @opindex fPIC
17790 If supported for the target machine, emit position-independent code,
17791 suitable for dynamic linking and avoiding any limit on the size of the
17792 global offset table.  This option makes a difference on the m68k,
17793 PowerPC and SPARC@.
17795 Position-independent code requires special support, and therefore works
17796 only on certain machines.
17798 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17799 are defined to 2.
17801 @item -fpie
17802 @itemx -fPIE
17803 @opindex fpie
17804 @opindex fPIE
17805 These options are similar to @option{-fpic} and @option{-fPIC}, but
17806 generated position independent code can be only linked into executables.
17807 Usually these options are used when @option{-pie} GCC option will be
17808 used during linking.
17810 @option{-fpie} and @option{-fPIE} both define the macros
17811 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
17812 for @option{-fpie} and 2 for @option{-fPIE}.
17814 @item -fno-jump-tables
17815 @opindex fno-jump-tables
17816 Do not use jump tables for switch statements even where it would be
17817 more efficient than other code generation strategies.  This option is
17818 of use in conjunction with @option{-fpic} or @option{-fPIC} for
17819 building code which forms part of a dynamic linker and cannot
17820 reference the address of a jump table.  On some targets, jump tables
17821 do not require a GOT and this option is not needed.
17823 @item -ffixed-@var{reg}
17824 @opindex ffixed
17825 Treat the register named @var{reg} as a fixed register; generated code
17826 should never refer to it (except perhaps as a stack pointer, frame
17827 pointer or in some other fixed role).
17829 @var{reg} must be the name of a register.  The register names accepted
17830 are machine-specific and are defined in the @code{REGISTER_NAMES}
17831 macro in the machine description macro file.
17833 This flag does not have a negative form, because it specifies a
17834 three-way choice.
17836 @item -fcall-used-@var{reg}
17837 @opindex fcall-used
17838 Treat the register named @var{reg} as an allocable register that is
17839 clobbered by function calls.  It may be allocated for temporaries or
17840 variables that do not live across a call.  Functions compiled this way
17841 will not save and restore the register @var{reg}.
17843 It is an error to used this flag with the frame pointer or stack pointer.
17844 Use of this flag for other registers that have fixed pervasive roles in
17845 the machine's execution model will produce disastrous results.
17847 This flag does not have a negative form, because it specifies a
17848 three-way choice.
17850 @item -fcall-saved-@var{reg}
17851 @opindex fcall-saved
17852 Treat the register named @var{reg} as an allocable register saved by
17853 functions.  It may be allocated even for temporaries or variables that
17854 live across a call.  Functions compiled this way will save and restore
17855 the register @var{reg} if they use it.
17857 It is an error to used this flag with the frame pointer or stack pointer.
17858 Use of this flag for other registers that have fixed pervasive roles in
17859 the machine's execution model will produce disastrous results.
17861 A different sort of disaster will result from the use of this flag for
17862 a register in which function values may be returned.
17864 This flag does not have a negative form, because it specifies a
17865 three-way choice.
17867 @item -fpack-struct[=@var{n}]
17868 @opindex fpack-struct
17869 Without a value specified, pack all structure members together without
17870 holes.  When a value is specified (which must be a small power of two), pack
17871 structure members according to this value, representing the maximum
17872 alignment (that is, objects with default alignment requirements larger than
17873 this will be output potentially unaligned at the next fitting location.
17875 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
17876 code that is not binary compatible with code generated without that switch.
17877 Additionally, it makes the code suboptimal.
17878 Use it to conform to a non-default application binary interface.
17880 @item -finstrument-functions
17881 @opindex finstrument-functions
17882 Generate instrumentation calls for entry and exit to functions.  Just
17883 after function entry and just before function exit, the following
17884 profiling functions will be called with the address of the current
17885 function and its call site.  (On some platforms,
17886 @code{__builtin_return_address} does not work beyond the current
17887 function, so the call site information may not be available to the
17888 profiling functions otherwise.)
17890 @smallexample
17891 void __cyg_profile_func_enter (void *this_fn,
17892                                void *call_site);
17893 void __cyg_profile_func_exit  (void *this_fn,
17894                                void *call_site);
17895 @end smallexample
17897 The first argument is the address of the start of the current function,
17898 which may be looked up exactly in the symbol table.
17900 This instrumentation is also done for functions expanded inline in other
17901 functions.  The profiling calls will indicate where, conceptually, the
17902 inline function is entered and exited.  This means that addressable
17903 versions of such functions must be available.  If all your uses of a
17904 function are expanded inline, this may mean an additional expansion of
17905 code size.  If you use @samp{extern inline} in your C code, an
17906 addressable version of such functions must be provided.  (This is
17907 normally the case anyways, but if you get lucky and the optimizer always
17908 expands the functions inline, you might have gotten away without
17909 providing static copies.)
17911 A function may be given the attribute @code{no_instrument_function}, in
17912 which case this instrumentation will not be done.  This can be used, for
17913 example, for the profiling functions listed above, high-priority
17914 interrupt routines, and any functions from which the profiling functions
17915 cannot safely be called (perhaps signal handlers, if the profiling
17916 routines generate output or allocate memory).
17918 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
17919 @opindex finstrument-functions-exclude-file-list
17921 Set the list of functions that are excluded from instrumentation (see
17922 the description of @code{-finstrument-functions}).  If the file that
17923 contains a function definition matches with one of @var{file}, then
17924 that function is not instrumented.  The match is done on substrings:
17925 if the @var{file} parameter is a substring of the file name, it is
17926 considered to be a match.
17928 For example:
17930 @smallexample
17931 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
17932 @end smallexample
17934 @noindent
17935 will exclude any inline function defined in files whose pathnames
17936 contain @code{/bits/stl} or @code{include/sys}.
17938 If, for some reason, you want to include letter @code{','} in one of
17939 @var{sym}, write @code{'\,'}. For example,
17940 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
17941 (note the single quote surrounding the option).
17943 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
17944 @opindex finstrument-functions-exclude-function-list
17946 This is similar to @code{-finstrument-functions-exclude-file-list},
17947 but this option sets the list of function names to be excluded from
17948 instrumentation.  The function name to be matched is its user-visible
17949 name, such as @code{vector<int> blah(const vector<int> &)}, not the
17950 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
17951 match is done on substrings: if the @var{sym} parameter is a substring
17952 of the function name, it is considered to be a match.  For C99 and C++
17953 extended identifiers, the function name must be given in UTF-8, not
17954 using universal character names.
17956 @item -fstack-check
17957 @opindex fstack-check
17958 Generate code to verify that you do not go beyond the boundary of the
17959 stack.  You should specify this flag if you are running in an
17960 environment with multiple threads, but only rarely need to specify it in
17961 a single-threaded environment since stack overflow is automatically
17962 detected on nearly all systems if there is only one stack.
17964 Note that this switch does not actually cause checking to be done; the
17965 operating system or the language runtime must do that.  The switch causes
17966 generation of code to ensure that they see the stack being extended.
17968 You can additionally specify a string parameter: @code{no} means no
17969 checking, @code{generic} means force the use of old-style checking,
17970 @code{specific} means use the best checking method and is equivalent
17971 to bare @option{-fstack-check}.
17973 Old-style checking is a generic mechanism that requires no specific
17974 target support in the compiler but comes with the following drawbacks:
17976 @enumerate
17977 @item
17978 Modified allocation strategy for large objects: they will always be
17979 allocated dynamically if their size exceeds a fixed threshold.
17981 @item
17982 Fixed limit on the size of the static frame of functions: when it is
17983 topped by a particular function, stack checking is not reliable and
17984 a warning is issued by the compiler.
17986 @item
17987 Inefficiency: because of both the modified allocation strategy and the
17988 generic implementation, the performances of the code are hampered.
17989 @end enumerate
17991 Note that old-style stack checking is also the fallback method for
17992 @code{specific} if no target support has been added in the compiler.
17994 @item -fstack-limit-register=@var{reg}
17995 @itemx -fstack-limit-symbol=@var{sym}
17996 @itemx -fno-stack-limit
17997 @opindex fstack-limit-register
17998 @opindex fstack-limit-symbol
17999 @opindex fno-stack-limit
18000 Generate code to ensure that the stack does not grow beyond a certain value,
18001 either the value of a register or the address of a symbol.  If the stack
18002 would grow beyond the value, a signal is raised.  For most targets,
18003 the signal is raised before the stack overruns the boundary, so
18004 it is possible to catch the signal without taking special precautions.
18006 For instance, if the stack starts at absolute address @samp{0x80000000}
18007 and grows downwards, you can use the flags
18008 @option{-fstack-limit-symbol=__stack_limit} and
18009 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
18010 of 128KB@.  Note that this may only work with the GNU linker.
18012 @item -fsplit-stack
18013 @opindex fsplit-stack
18014 Generate code to automatically split the stack before it overflows.
18015 The resulting program has a discontiguous stack which can only
18016 overflow if the program is unable to allocate any more memory.  This
18017 is most useful when running threaded programs, as it is no longer
18018 necessary to calculate a good stack size to use for each thread.  This
18019 is currently only implemented for the i386 and x86_64 backends running
18020 GNU/Linux.
18022 When code compiled with @option{-fsplit-stack} calls code compiled
18023 without @option{-fsplit-stack}, there may not be much stack space
18024 available for the latter code to run.  If compiling all code,
18025 including library code, with @option{-fsplit-stack} is not an option,
18026 then the linker can fix up these calls so that the code compiled
18027 without @option{-fsplit-stack} always has a large stack.  Support for
18028 this is implemented in the gold linker in GNU binutils release 2.21
18029 and later.
18031 @item -fleading-underscore
18032 @opindex fleading-underscore
18033 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
18034 change the way C symbols are represented in the object file.  One use
18035 is to help link with legacy assembly code.
18037 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
18038 generate code that is not binary compatible with code generated without that
18039 switch.  Use it to conform to a non-default application binary interface.
18040 Not all targets provide complete support for this switch.
18042 @item -ftls-model=@var{model}
18043 @opindex ftls-model
18044 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
18045 The @var{model} argument should be one of @code{global-dynamic},
18046 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
18048 The default without @option{-fpic} is @code{initial-exec}; with
18049 @option{-fpic} the default is @code{global-dynamic}.
18051 @item -fvisibility=@var{default|internal|hidden|protected}
18052 @opindex fvisibility
18053 Set the default ELF image symbol visibility to the specified option---all
18054 symbols will be marked with this unless overridden within the code.
18055 Using this feature can very substantially improve linking and
18056 load times of shared object libraries, produce more optimized
18057 code, provide near-perfect API export and prevent symbol clashes.
18058 It is @strong{strongly} recommended that you use this in any shared objects
18059 you distribute.
18061 Despite the nomenclature, @code{default} always means public ie;
18062 available to be linked against from outside the shared object.
18063 @code{protected} and @code{internal} are pretty useless in real-world
18064 usage so the only other commonly used option will be @code{hidden}.
18065 The default if @option{-fvisibility} isn't specified is
18066 @code{default}, i.e., make every
18067 symbol public---this causes the same behavior as previous versions of
18068 GCC@.
18070 A good explanation of the benefits offered by ensuring ELF
18071 symbols have the correct visibility is given by ``How To Write
18072 Shared Libraries'' by Ulrich Drepper (which can be found at
18073 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
18074 solution made possible by this option to marking things hidden when
18075 the default is public is to make the default hidden and mark things
18076 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
18077 and @code{__attribute__ ((visibility("default")))} instead of
18078 @code{__declspec(dllexport)} you get almost identical semantics with
18079 identical syntax.  This is a great boon to those working with
18080 cross-platform projects.
18082 For those adding visibility support to existing code, you may find
18083 @samp{#pragma GCC visibility} of use.  This works by you enclosing
18084 the declarations you wish to set visibility for with (for example)
18085 @samp{#pragma GCC visibility push(hidden)} and
18086 @samp{#pragma GCC visibility pop}.
18087 Bear in mind that symbol visibility should be viewed @strong{as
18088 part of the API interface contract} and thus all new code should
18089 always specify visibility when it is not the default ie; declarations
18090 only for use within the local DSO should @strong{always} be marked explicitly
18091 as hidden as so to avoid PLT indirection overheads---making this
18092 abundantly clear also aids readability and self-documentation of the code.
18093 Note that due to ISO C++ specification requirements, operator new and
18094 operator delete must always be of default visibility.
18096 Be aware that headers from outside your project, in particular system
18097 headers and headers from any other library you use, may not be
18098 expecting to be compiled with visibility other than the default.  You
18099 may need to explicitly say @samp{#pragma GCC visibility push(default)}
18100 before including any such headers.
18102 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
18103 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
18104 no modifications.  However, this means that calls to @samp{extern}
18105 functions with no explicit visibility will use the PLT, so it is more
18106 effective to use @samp{__attribute ((visibility))} and/or
18107 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
18108 declarations should be treated as hidden.
18110 Note that @samp{-fvisibility} does affect C++ vague linkage
18111 entities. This means that, for instance, an exception class that will
18112 be thrown between DSOs must be explicitly marked with default
18113 visibility so that the @samp{type_info} nodes will be unified between
18114 the DSOs.
18116 An overview of these techniques, their benefits and how to use them
18117 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
18119 @item -fstrict-volatile-bitfields
18120 This option should be used if accesses to volatile bitfields (or other
18121 structure fields, although the compiler usually honors those types
18122 anyway) should use a single access in a mode of the same size as the
18123 container's type, aligned to a natural alignment if possible.  For
18124 example, targets with memory-mapped peripheral registers might require
18125 all such accesses to be 16 bits wide; with this flag the user could
18126 declare all peripheral bitfields as ``unsigned short'' (assuming short
18127 is 16 bits on these targets) to force GCC to use 16 bit accesses
18128 instead of, perhaps, a more efficient 32 bit access.
18130 If this option is disabled, the compiler will use the most efficient
18131 instruction.  In the previous example, that might be a 32-bit load
18132 instruction, even though that will access bytes that do not contain
18133 any portion of the bitfield, or memory-mapped registers unrelated to
18134 the one being updated.
18136 If the target requires strict alignment, and honoring the container
18137 type would require violating this alignment, a warning is issued.
18138 However, the access happens as the user requested, under the
18139 assumption that the user knows something about the target hardware
18140 that GCC is unaware of.
18142 The default value of this option is determined by the application binary
18143 interface for the target processor.
18145 @end table
18147 @c man end
18149 @node Environment Variables
18150 @section Environment Variables Affecting GCC
18151 @cindex environment variables
18153 @c man begin ENVIRONMENT
18154 This section describes several environment variables that affect how GCC
18155 operates.  Some of them work by specifying directories or prefixes to use
18156 when searching for various kinds of files.  Some are used to specify other
18157 aspects of the compilation environment.
18159 Note that you can also specify places to search using options such as
18160 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
18161 take precedence over places specified using environment variables, which
18162 in turn take precedence over those specified by the configuration of GCC@.
18163 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
18164 GNU Compiler Collection (GCC) Internals}.
18166 @table @env
18167 @item LANG
18168 @itemx LC_CTYPE
18169 @c @itemx LC_COLLATE
18170 @itemx LC_MESSAGES
18171 @c @itemx LC_MONETARY
18172 @c @itemx LC_NUMERIC
18173 @c @itemx LC_TIME
18174 @itemx LC_ALL
18175 @findex LANG
18176 @findex LC_CTYPE
18177 @c @findex LC_COLLATE
18178 @findex LC_MESSAGES
18179 @c @findex LC_MONETARY
18180 @c @findex LC_NUMERIC
18181 @c @findex LC_TIME
18182 @findex LC_ALL
18183 @cindex locale
18184 These environment variables control the way that GCC uses
18185 localization information that allow GCC to work with different
18186 national conventions.  GCC inspects the locale categories
18187 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
18188 so.  These locale categories can be set to any value supported by your
18189 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
18190 Kingdom encoded in UTF-8.
18192 The @env{LC_CTYPE} environment variable specifies character
18193 classification.  GCC uses it to determine the character boundaries in
18194 a string; this is needed for some multibyte encodings that contain quote
18195 and escape characters that would otherwise be interpreted as a string
18196 end or escape.
18198 The @env{LC_MESSAGES} environment variable specifies the language to
18199 use in diagnostic messages.
18201 If the @env{LC_ALL} environment variable is set, it overrides the value
18202 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
18203 and @env{LC_MESSAGES} default to the value of the @env{LANG}
18204 environment variable.  If none of these variables are set, GCC
18205 defaults to traditional C English behavior.
18207 @item TMPDIR
18208 @findex TMPDIR
18209 If @env{TMPDIR} is set, it specifies the directory to use for temporary
18210 files.  GCC uses temporary files to hold the output of one stage of
18211 compilation which is to be used as input to the next stage: for example,
18212 the output of the preprocessor, which is the input to the compiler
18213 proper.
18215 @item GCC_EXEC_PREFIX
18216 @findex GCC_EXEC_PREFIX
18217 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
18218 names of the subprograms executed by the compiler.  No slash is added
18219 when this prefix is combined with the name of a subprogram, but you can
18220 specify a prefix that ends with a slash if you wish.
18222 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
18223 an appropriate prefix to use based on the pathname it was invoked with.
18225 If GCC cannot find the subprogram using the specified prefix, it
18226 tries looking in the usual places for the subprogram.
18228 The default value of @env{GCC_EXEC_PREFIX} is
18229 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
18230 the installed compiler. In many cases @var{prefix} is the value
18231 of @code{prefix} when you ran the @file{configure} script.
18233 Other prefixes specified with @option{-B} take precedence over this prefix.
18235 This prefix is also used for finding files such as @file{crt0.o} that are
18236 used for linking.
18238 In addition, the prefix is used in an unusual way in finding the
18239 directories to search for header files.  For each of the standard
18240 directories whose name normally begins with @samp{/usr/local/lib/gcc}
18241 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
18242 replacing that beginning with the specified prefix to produce an
18243 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
18244 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
18245 These alternate directories are searched first; the standard directories
18246 come next. If a standard directory begins with the configured
18247 @var{prefix} then the value of @var{prefix} is replaced by
18248 @env{GCC_EXEC_PREFIX} when looking for header files.
18250 @item COMPILER_PATH
18251 @findex COMPILER_PATH
18252 The value of @env{COMPILER_PATH} is a colon-separated list of
18253 directories, much like @env{PATH}.  GCC tries the directories thus
18254 specified when searching for subprograms, if it can't find the
18255 subprograms using @env{GCC_EXEC_PREFIX}.
18257 @item LIBRARY_PATH
18258 @findex LIBRARY_PATH
18259 The value of @env{LIBRARY_PATH} is a colon-separated list of
18260 directories, much like @env{PATH}.  When configured as a native compiler,
18261 GCC tries the directories thus specified when searching for special
18262 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
18263 using GCC also uses these directories when searching for ordinary
18264 libraries for the @option{-l} option (but directories specified with
18265 @option{-L} come first).
18267 @item LANG
18268 @findex LANG
18269 @cindex locale definition
18270 This variable is used to pass locale information to the compiler.  One way in
18271 which this information is used is to determine the character set to be used
18272 when character literals, string literals and comments are parsed in C and C++.
18273 When the compiler is configured to allow multibyte characters,
18274 the following values for @env{LANG} are recognized:
18276 @table @samp
18277 @item C-JIS
18278 Recognize JIS characters.
18279 @item C-SJIS
18280 Recognize SJIS characters.
18281 @item C-EUCJP
18282 Recognize EUCJP characters.
18283 @end table
18285 If @env{LANG} is not defined, or if it has some other value, then the
18286 compiler will use mblen and mbtowc as defined by the default locale to
18287 recognize and translate multibyte characters.
18288 @end table
18290 @noindent
18291 Some additional environments variables affect the behavior of the
18292 preprocessor.
18294 @include cppenv.texi
18296 @c man end
18298 @node Precompiled Headers
18299 @section Using Precompiled Headers
18300 @cindex precompiled headers
18301 @cindex speed of compilation
18303 Often large projects have many header files that are included in every
18304 source file.  The time the compiler takes to process these header files
18305 over and over again can account for nearly all of the time required to
18306 build the project.  To make builds faster, GCC allows users to
18307 `precompile' a header file; then, if builds can use the precompiled
18308 header file they will be much faster.
18310 To create a precompiled header file, simply compile it as you would any
18311 other file, if necessary using the @option{-x} option to make the driver
18312 treat it as a C or C++ header file.  You will probably want to use a
18313 tool like @command{make} to keep the precompiled header up-to-date when
18314 the headers it contains change.
18316 A precompiled header file will be searched for when @code{#include} is
18317 seen in the compilation.  As it searches for the included file
18318 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
18319 compiler looks for a precompiled header in each directory just before it
18320 looks for the include file in that directory.  The name searched for is
18321 the name specified in the @code{#include} with @samp{.gch} appended.  If
18322 the precompiled header file can't be used, it is ignored.
18324 For instance, if you have @code{#include "all.h"}, and you have
18325 @file{all.h.gch} in the same directory as @file{all.h}, then the
18326 precompiled header file will be used if possible, and the original
18327 header will be used otherwise.
18329 Alternatively, you might decide to put the precompiled header file in a
18330 directory and use @option{-I} to ensure that directory is searched
18331 before (or instead of) the directory containing the original header.
18332 Then, if you want to check that the precompiled header file is always
18333 used, you can put a file of the same name as the original header in this
18334 directory containing an @code{#error} command.
18336 This also works with @option{-include}.  So yet another way to use
18337 precompiled headers, good for projects not designed with precompiled
18338 header files in mind, is to simply take most of the header files used by
18339 a project, include them from another header file, precompile that header
18340 file, and @option{-include} the precompiled header.  If the header files
18341 have guards against multiple inclusion, they will be skipped because
18342 they've already been included (in the precompiled header).
18344 If you need to precompile the same header file for different
18345 languages, targets, or compiler options, you can instead make a
18346 @emph{directory} named like @file{all.h.gch}, and put each precompiled
18347 header in the directory, perhaps using @option{-o}.  It doesn't matter
18348 what you call the files in the directory, every precompiled header in
18349 the directory will be considered.  The first precompiled header
18350 encountered in the directory that is valid for this compilation will
18351 be used; they're searched in no particular order.
18353 There are many other possibilities, limited only by your imagination,
18354 good sense, and the constraints of your build system.
18356 A precompiled header file can be used only when these conditions apply:
18358 @itemize
18359 @item
18360 Only one precompiled header can be used in a particular compilation.
18362 @item
18363 A precompiled header can't be used once the first C token is seen.  You
18364 can have preprocessor directives before a precompiled header; you can
18365 even include a precompiled header from inside another header, so long as
18366 there are no C tokens before the @code{#include}.
18368 @item
18369 The precompiled header file must be produced for the same language as
18370 the current compilation.  You can't use a C precompiled header for a C++
18371 compilation.
18373 @item
18374 The precompiled header file must have been produced by the same compiler
18375 binary as the current compilation is using.
18377 @item
18378 Any macros defined before the precompiled header is included must
18379 either be defined in the same way as when the precompiled header was
18380 generated, or must not affect the precompiled header, which usually
18381 means that they don't appear in the precompiled header at all.
18383 The @option{-D} option is one way to define a macro before a
18384 precompiled header is included; using a @code{#define} can also do it.
18385 There are also some options that define macros implicitly, like
18386 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
18387 defined this way.
18389 @item If debugging information is output when using the precompiled
18390 header, using @option{-g} or similar, the same kind of debugging information
18391 must have been output when building the precompiled header.  However,
18392 a precompiled header built using @option{-g} can be used in a compilation
18393 when no debugging information is being output.
18395 @item The same @option{-m} options must generally be used when building
18396 and using the precompiled header.  @xref{Submodel Options},
18397 for any cases where this rule is relaxed.
18399 @item Each of the following options must be the same when building and using
18400 the precompiled header:
18402 @gccoptlist{-fexceptions}
18404 @item
18405 Some other command-line options starting with @option{-f},
18406 @option{-p}, or @option{-O} must be defined in the same way as when
18407 the precompiled header was generated.  At present, it's not clear
18408 which options are safe to change and which are not; the safest choice
18409 is to use exactly the same options when generating and using the
18410 precompiled header.  The following are known to be safe:
18412 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
18413 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
18414 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
18415 -pedantic-errors}
18417 @end itemize
18419 For all of these except the last, the compiler will automatically
18420 ignore the precompiled header if the conditions aren't met.  If you
18421 find an option combination that doesn't work and doesn't cause the
18422 precompiled header to be ignored, please consider filing a bug report,
18423 see @ref{Bugs}.
18425 If you do use differing options when generating and using the
18426 precompiled header, the actual behavior will be a mixture of the
18427 behavior for the options.  For instance, if you use @option{-g} to
18428 generate the precompiled header but not when using it, you may or may
18429 not get debugging information for routines in the precompiled header.